Fraction (Pitaya 0.2 API)

java.lang.Object
- java.lang.Number
- - org.kocakosm.pitaya.math.Fraction

All Implemented Interfaces:

Serializable, Comparable<Fraction>
```
public final class Fraction
extends Number
implements Comparable<Fraction>
```
Number implementation that represents fractions accurately. Instances of this class are immutable.

Author:

Osman KOCAK

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Fraction`	`ONE` `Fraction` representation of 1.
`static Fraction`	`ONE_HALF` `Fraction` representation of 1/2.
`static Fraction`	`ONE_QUARTER` `Fraction` representation of 1/4.
`static Fraction`	`ONE_THIRD` `Fraction` representation of 1/3.
`static Fraction`	`THREE_QUARTERS` `Fraction` representation of 3/4.
`static Fraction`	`TWO_QUARTERS` `Fraction` representation of 2/4.
`static Fraction`	`TWO_THIRDS` `Fraction` representation of 2/3.
`static Fraction`	`ZERO` `Fraction` representation of 0.

Constructor Summary

Constructors
Constructor and Description
`Fraction(BigInteger numerator, BigInteger denominator)` Creates a new `Fraction`.
`Fraction(int numerator, int denominator)` Creates a new `Fraction`.

Method Summary

Methods
Modifier and Type	Method and Description
`Fraction`	`absoluteValue()` Returns a `Fraction` which is the absolute value of this one.
`BigDecimal`	`bigDecimalValue()` Returns the value of this `Fraction` as a `BigDecimal`, rounded in accordance to IEEE 754R Decimal128 format.
`int`	`compareTo(Fraction f)`
`BigInteger`	`denominator()` Returns this `Fraction`'s denominator.
`Fraction`	`dividedBy(Fraction f)` Divides this value by the given one and returns the result in reduced form.
`double`	`doubleValue()`
`boolean`	`equals(Object o)`
`float`	`floatValue()`
`int`	`hashCode()`
`int`	`intValue()`
`Fraction`	`inverted()` Returns the inverse of this `Fraction`.
`long`	`longValue()`
`Fraction`	`minus(Fraction f)` Subtracts the given value from this one and returns the result in reduced form.
`Fraction`	`multipliedBy(Fraction f)` Multiplies this value by the given one and returns the result in reduced form.
`Fraction`	`negated()` Returns the opposite of this `Fraction`.
`BigInteger`	`numerator()` Returns this `Fraction`'s numerator.
`Fraction`	`plus(Fraction f)` Adds the given value to this one and returns the result in reduced form.
`Fraction`	`power(int exponent)` Returns the `Fraction` obtained by raising this to the given power, in reduced form.
`Fraction`	`reduced()` Returns the reduced form of this `Fraction`.
`int`	`sign()` Returns the sign of this `Fraction`, that is, this method returns `1` if this fraction is positive, `0` if it is equal to `0`, and `-1` if it is negative.
`String`	`toString()`
`static Fraction`	`valueOf(BigInteger val)` Returns the `Fraction` representation of the given value.
`static Fraction`	`valueOf(int val)` Returns the `Fraction` representation of the given value.
`static Fraction`	`valueOf(Integer val)` Returns the `Fraction` representation of the given value.
`static Fraction`	`valueOf(String str)` Creates a `Fraction` from its `String` representation.

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ZERO
```
public static final Fraction ZERO
```
    Fraction representation of 0.
  - ONE
```
public static final Fraction ONE
```
    Fraction representation of 1.
  - ONE_HALF
```
public static final Fraction ONE_HALF
```
    Fraction representation of 1/2.
  - ONE_THIRD
```
public static final Fraction ONE_THIRD
```
    Fraction representation of 1/3.
  - TWO_THIRDS
```
public static final Fraction TWO_THIRDS
```
    Fraction representation of 2/3.
  - ONE_QUARTER
```
public static final Fraction ONE_QUARTER
```
    Fraction representation of 1/4.
  - TWO_QUARTERS
```
public static final Fraction TWO_QUARTERS
```
    Fraction representation of 2/4.
  - THREE_QUARTERS
```
public static final Fraction THREE_QUARTERS
```
    Fraction representation of 3/4.
- Constructor Detail
  - Fraction
```
public Fraction(int numerator,
        int denominator)
```
    Creates a new Fraction.
    
    Parameters:
    numerator - the numerator.
    denominator - the denominator.
    
    Throws:
    
    IllegalArgumentException - if denominator equals zero.
  - Fraction
```
public Fraction(BigInteger numerator,
        BigInteger denominator)
```
    Creates a new Fraction.
    
    Parameters:
    numerator - the numerator.
    denominator - the denominator.
    
    Throws:
    
    NullPointerException - if one of the arguments is null.
    
    IllegalArgumentException - if denominator equals zero.
- Method Detail
  - valueOf
```
public static Fraction valueOf(int val)
```
    Returns the Fraction representation of the given value.
    
    Parameters:
    val - an int value.
    
    Returns:
    the Fraction representation of the given value.
  - valueOf
```
public static Fraction valueOf(Integer val)
```
    Returns the Fraction representation of the given value.
    
    Parameters:
    val - an Integer value.
    
    Returns:
    the Fraction representation of the given value.
    
    Throws:
    
    NullPointerException - if val is null.
  - valueOf
```
public static Fraction valueOf(BigInteger val)
```
    Returns the Fraction representation of the given value.
    
    Parameters:
    val - a BigInteger value.
    
    Returns:
    the Fraction representation of the given value.
    
    Throws:
    
    NullPointerException - if val is null.
  - valueOf
```
public static Fraction valueOf(String str)
```
    Creates a Fraction from its String representation.
    
    Parameters:
    str - the Fraction's String representation.
    
    Returns:
    the created Fraction.
    
    Throws:
    
    IllegalArgumentException - if str doesn't represent a Fraction or if its denominator equals zero.
  - plus
```
public Fraction plus(Fraction f)
```
    Adds the given value to this one and returns the result in reduced form.
    
    Parameters:
    f - the fraction to add to this one.
    
    Returns:
    this + f in reduced form.
    
    Throws:
    
    NullPointerException - if f is null.
  - minus
```
public Fraction minus(Fraction f)
```
    Subtracts the given value from this one and returns the result in reduced form.
    
    Parameters:
    f - the fraction to subtract from this one.
    
    Returns:
    this - f in reduced form.
    
    Throws:
    
    NullPointerException - if f is null.
  - multipliedBy
```
public Fraction multipliedBy(Fraction f)
```
    Multiplies this value by the given one and returns the result in reduced form.
    
    Parameters:
    f - the fraction to multiply this one with.
    
    Returns:
    this * f in reduced form.
    
    Throws:
    
    NullPointerException - if f is null.
  - dividedBy
```
public Fraction dividedBy(Fraction f)
```
    Divides this value by the given one and returns the result in reduced form.
    
    Parameters:
    f - the fraction to divide this one with.
    
    Returns:
    this / f in reduced form.
    
    Throws:
    
    NullPointerException - if f is null.
    
    ArithmeticException - if f equals zero.
  - power
```
public Fraction power(int exponent)
```
    Returns the Fraction obtained by raising this to the given power, in reduced form.
    
    Parameters:
    exponent - the power to raise this fraction to.
    
    Returns:
    this ^ exponent in reduced form.
    
    Throws:
    
    ArithmeticException - if exponent is negative.
  - sign
```
public int sign()
```
    Returns the sign of this Fraction, that is, this method returns 1 if this fraction is positive, 0 if it is equal to 0, and -1 if it is negative.
    
    Returns:
    the sign of this Fraction.
  - absoluteValue
```
public Fraction absoluteValue()
```
    Returns a Fraction which is the absolute value of this one.
    
    Returns:
    the absolute value of this Fraction.
  - negated
```
public Fraction negated()
```
    Returns the opposite of this Fraction. The result is not reduced before being returned.
    
    Returns:
    -this.
  - inverted
```
public Fraction inverted()
```
    Returns the inverse of this Fraction. The result is not reduced before being returned.
    
    Returns:
    1 / this.
  - reduced
```
public Fraction reduced()
```
    Returns the reduced form of this Fraction. Also, note that the sign information will be held by the numerator.
    
    Returns:
    the reduced form of this Fraction.
  - numerator
```
public BigInteger numerator()
```
    Returns this Fraction's numerator.
    
    Returns:
    this Fraction's numerator.
  - denominator
```
public BigInteger denominator()
```
    Returns this Fraction's denominator.
    
    Returns:
    this Fraction's denominator.
  - bigDecimalValue
```
public BigDecimal bigDecimalValue()
```
    Returns the value of this Fraction as a BigDecimal, rounded in accordance to IEEE 754R Decimal128 format.
    
    Returns:
    the value of this Fraction as a BigDecimal.
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class Number
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class Number
  - floatValue
```
public float floatValue()
```
    Specified by:
    
    floatValue in class Number
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class Number
  - compareTo
```
public int compareTo(Fraction f)
```
    Specified by:
    
    compareTo in interface Comparable<Fraction>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Fraction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

ZERO

ONE

ONE_HALF

ONE_THIRD

TWO_THIRDS

ONE_QUARTER

TWO_QUARTERS

THREE_QUARTERS

Constructor Detail

Fraction

Fraction

Method Detail

valueOf

valueOf

valueOf

valueOf

plus

minus

multipliedBy

dividedBy

power

sign

absoluteValue

negated

inverted

reduced

numerator

denominator

bigDecimalValue

intValue

longValue

floatValue

doubleValue

compareTo

equals

hashCode

toString