RationalNumber

java.lang.Object
- java.lang.Number
- - com.screenscraper.profiling.session.units.RationalNumber

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RationalNumber>
```
public final class RationalNumber
extends java.lang.Number
implements java.lang.Comparable<RationalNumber>, java.io.Serializable
```
********************************************************************** Code initially from some university's CS website (then modified by me)
This class has been modified to add many methods, and to check for overflow on arithmetic operations, and if found, calculate the result from double values. Once a RationalNumber has been approximated, any operations using that rational number with other rational numbers will yield an approximated value.
Immutable ADT for RationalNumber numbers.
Invariants ----------- - gcd(numerator, denominator) = 1, i.e, the rational number is in reduced form - denominator >= 1, the denominator is always a positive integer - 0/1 is the unique representation of 0
We employ some tricks to stave of overflow, but if you need arbitrary precision rationals, use BigRationalNumber.
***********************************************************************

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static RationalNumber`	`E` This is the constant e, as approximated from Math.E
`static RationalNumber`	`MAX_VALUE` The maximum value that can be contained in a rational number
`static RationalNumber`	`MIN_VALUE` The minimum value that can be contained in a rational number
`static RationalNumber`	`NEGATIVE_ONE` The number -1
`static RationalNumber`	`ONE` The number 1
`static RationalNumber`	`ONE_FOURTH` The number 1/4
`static RationalNumber`	`ONE_HALF` The number 1/2
`static RationalNumber`	`ONE_THIRD` The number 1/3
`static RationalNumber`	`PI` This is the constant pi, as approximated from Math.PI
`static RationalNumber`	`THREE_FOURTHS` The number 3/4
`static RationalNumber`	`TWO_THIRDS` The number 2/3
`static RationalNumber`	`ZERO` The number 0

Constructor Summary

Constructors
Constructor and Description
`RationalNumber(double decimal)` Creates a new Rational Number from the given double.
`RationalNumber(long numerator, long denominator)` Creates a new rational number with the given numerator and denominator
`RationalNumber(RationalNumber number)` Copy constructor
`RationalNumber(java.lang.String s)` Creates a new Rational Number from the given value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RationalNumber`	`absoluteValue()` Returns the absolute value of this rational number
`RationalNumber`	`add(double amount)` Returns this number plus another number, and attempts to stave off overflow
`RationalNumber`	`add(RationalNumber amount)` Returns this number plus another number, and attempts to stave off overflow
`int`	`compareTo(RationalNumber otherNumber)`
`RationalNumber`	`dividedBy(double amount)` Returns this number divided by amount
`RationalNumber`	`dividedBy(long amount)` Returns this number divided by amount
`RationalNumber`	`dividedBy(RationalNumber amount)` Returns this number divided by amount
`double`	`doubleValue()`
`boolean`	`equals(java.lang.Object other)`
`float`	`floatValue()`
`long`	`getDenominator()` Returns the denominator of the current rational number
`long`	`getNumerator()` Returns the numerator of the current rational number
`RationalNumber`	`getRationalPart()` Gets the fraction portion of the number.
`long`	`getWholePart()` Gets the whole number (integer) portion of the number
`boolean`	`greaterThan(double other)` Determines whether this rational number is greater than the other number
`boolean`	`greaterThan(RationalNumber other)` Determines whether this rational number is greater than the other rational number
`boolean`	`greaterThanOrEqual(double other)` Determines whether this rational number is greater than or equal to the other number
`boolean`	`greaterThanOrEqual(RationalNumber other)` Determines whether this rational number is greater than or equal to the other rational number
`int`	`hashCode()`
`int`	`intValue()`
`boolean`	`isApproximated()` Returns true if this number has been approximated (overflow didn't allow a large enough numerator and denominator)
`boolean`	`lessThan(double other)` Determines whether this rational number is less than the other number
`boolean`	`lessThan(RationalNumber other)` Determines whether this rational number is less than the other rational number
`boolean`	`lessThanOrEqual(double other)` Determines whether this rational number is less than or equal to the other number
`boolean`	`lessThanOrEqual(RationalNumber other)` Determines whether this rational number is less than or equal to the other rational number
`long`	`longValue()`
`static RationalNumber`	`mediant(RationalNumber firstRationalNumber, RationalNumber secondRationalNumber)` create and return a new rational (firstRationalNumber.numerator + secondRationalNumber.numerator) / (firstRationalNumber.denominator + secondRationalNumber.denominator)
`RationalNumber`	`minus(double amount)` Returns this number minus another number
`RationalNumber`	`minus(long amount)` Returns this number minus another number
`RationalNumber`	`minus(RationalNumber amount)` Returns this number minus another number
`RationalNumber`	`negate()` Returns the negative value of this number
`RationalNumber`	`plus(double amount)` Returns this number plus another number, and attempts to stave off overflow
`RationalNumber`	`plus(long amount)` Returns this number plus another number, and attempts to stave off overflow
`RationalNumber`	`plus(RationalNumber amount)` Returns this number plus another number, and attempts to stave off overflow
`RationalNumber`	`power(double power)` Raises the rational number to a power
`RationalNumber`	`power(RationalNumber power)` Raises the rational number to a power
`RationalNumber`	`reciprocal()` Gets the reciprocal of this number
`RationalNumber`	`roundToNearestMultiple(RationalNumber multiple)` Returns a new rational number that is the nearest multiple of the given rational number.
`RationalNumber`	`times(double amount)` Returns this number times another number, and attempts to prevent overflow
`RationalNumber`	`times(long amount)` Returns this number times another number, and attempts to prevent overflow
`RationalNumber`	`times(RationalNumber amount)` Returns this number times another number, and attempts to prevent overflow
`java.lang.String`	`toString()`
`java.lang.String`	`toStringWithWholePart()` Converts the number to a fraction, such as 1 3/4
`static RationalNumber`	`valueOf(double rationalNumber)` Returns the rational number represented by the given string
`static RationalNumber`	`valueOf(long number)` Returns the rational number represented by the given string
`static RationalNumber`	`valueOf(java.lang.String rationalNumber)` Returns the rational number represented by the given string

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 RationalNumber ZERO
```
    The number 0
  - ONE
```
public static final RationalNumber ONE
```
    The number 1
  - NEGATIVE_ONE
```
public static final RationalNumber NEGATIVE_ONE
```
    The number -1
  - ONE_HALF
```
public static final RationalNumber ONE_HALF
```
    The number 1/2
  - ONE_THIRD
```
public static final RationalNumber ONE_THIRD
```
    The number 1/3
  - ONE_FOURTH
```
public static final RationalNumber ONE_FOURTH
```
    The number 1/4
  - TWO_THIRDS
```
public static final RationalNumber TWO_THIRDS
```
    The number 2/3
  - THREE_FOURTHS
```
public static final RationalNumber THREE_FOURTHS
```
    The number 3/4
  - MAX_VALUE
```
public static final RationalNumber MAX_VALUE
```
    The maximum value that can be contained in a rational number
  - MIN_VALUE
```
public static final RationalNumber MIN_VALUE
```
    The minimum value that can be contained in a rational number
  - E
```
@NotNull
public static final RationalNumber E
```
    This is the constant e, as approximated from Math.E
  - PI
```
@NotNull
public static final RationalNumber PI
```
    This is the constant pi, as approximated from Math.PI
- Constructor Detail
  - RationalNumber
```
public RationalNumber(long numerator,
                      long denominator)
```
    Creates a new rational number with the given numerator and denominator
    
    Parameters:
    
    numerator - The numerator in the rational number
    
    denominator - The denominator in the rational number
  - RationalNumber
```
public RationalNumber(@NotNull
                      RationalNumber number)
```
    Copy constructor
    
    Parameters:
    
    number - The number to copy
  - RationalNumber
```
public RationalNumber(double decimal)
```
    Creates a new Rational Number from the given double. Attempts to convert it to a fraction before storing it.
    
    Parameters:
    
    decimal - The decimal value to store for the value of the fraction
  - RationalNumber
```
public RationalNumber(@NotNull
                      java.lang.String s)
               throws java.text.ParseException
```
    Creates a new Rational Number from the given value. Separates the numerator and denominator by a "/"
    
    Parameters:
    
    s - The value to store for the value of the fraction.
    
    Throws:
    
    java.text.ParseException - If there was a parse exception
- Method Detail
  - valueOf
```
public static RationalNumber valueOf(@NotNull
                                     java.lang.String rationalNumber)
                              throws java.text.ParseException
```
    Returns the rational number represented by the given string
    
    Parameters:
    
    rationalNumber - The text containing the rational number
    
    Returns:
    
    The rational number
    
    Throws:
    
    java.text.ParseException - If the text could not be parsed as a rational number
  - valueOf
```
public static RationalNumber valueOf(long number)
```
    Returns the rational number represented by the given string
    
    Parameters:
    
    number - The whole number to convert to a rational number
    
    Returns:
    
    The rational number
  - valueOf
```
public static RationalNumber valueOf(double rationalNumber)
```
    Returns the rational number represented by the given string
    
    Parameters:
    
    rationalNumber - The rational number as best represented by a double
    
    Returns:
    
    The rational number
  - roundToNearestMultiple
```
public RationalNumber roundToNearestMultiple(@NotNull
                                             RationalNumber multiple)
```
    Returns a new rational number that is the nearest multiple of the given rational number. For example, if this number were 5/12 and the multiple given were 1/2 then this would return 1/2. If the number were 71/10 and the multiple were 1/2, this would return 7 (aka 14/2)
    
    Parameters:
    
    multiple - The multiple to return
    
    Returns:
    
    A new rational number that is the nearest whole multiple of the given multiple
  - getNumerator
```
public long getNumerator()
```
    Returns the numerator of the current rational number
    
    Returns:
    
    The current numerator
  - getDenominator
```
public long getDenominator()
```
    Returns the denominator of the current rational number
    
    Returns:
    
    The current denominator
  - getWholePart
```
public long getWholePart()
```
    Gets the whole number (integer) portion of the number
    
    Returns:
    
    The whole number (integer) portion of the number
  - getRationalPart
```
public RationalNumber getRationalPart()
```
    Gets the fraction portion of the number. This will be a value -1 < x < 1
    
    Returns:
    
    The fraction portion of the number
  - mediant
```
public static RationalNumber mediant(@NotNull
                                     RationalNumber firstRationalNumber,
                                     @NotNull
                                     RationalNumber secondRationalNumber)
```
    create and return a new rational (firstRationalNumber.numerator + secondRationalNumber.numerator) / (firstRationalNumber.denominator + secondRationalNumber.denominator)
    
    Parameters:
    
    firstRationalNumber - The first rational number
    
    secondRationalNumber - The second rational number
    
    Returns:
    
    The median t value of the two given rational numbers
  - times
```
@NotNull
public RationalNumber times(long amount)
```
    Returns this number times another number, and attempts to prevent overflow
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The new number
  - times
```
@NotNull
public RationalNumber times(double amount)
```
    Returns this number times another number, and attempts to prevent overflow
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The new number
  - times
```
@NotNull
public RationalNumber times(@NotNull
                                      RationalNumber amount)
```
    Returns this number times another number, and attempts to prevent overflow
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The new number
  - add
```
public RationalNumber add(double amount)
```
    Returns this number plus another number, and attempts to stave off overflow
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The other new number
  - add
```
public RationalNumber add(@NotNull
                          RationalNumber amount)
```
    Returns this number plus another number, and attempts to stave off overflow
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The other new number
  - plus
```
public RationalNumber plus(long amount)
```
    Returns this number plus another number, and attempts to stave off overflow
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The other new number
  - plus
```
public RationalNumber plus(double amount)
```
    Returns this number plus another number, and attempts to stave off overflow
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The other new number
  - plus
```
public RationalNumber plus(@NotNull
                           RationalNumber amount)
```
    Returns this number plus another number, and attempts to stave off overflow
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The other new number
  - negate
```
public RationalNumber negate()
```
    Returns the negative value of this number
    
    Returns:
    
    The negative of this number
  - minus
```
public RationalNumber minus(long amount)
```
    Returns this number minus another number
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The result
  - minus
```
public RationalNumber minus(double amount)
```
    Returns this number minus another number
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The result
  - minus
```
public RationalNumber minus(@NotNull
                            RationalNumber amount)
```
    Returns this number minus another number
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    The result
  - reciprocal
```
public RationalNumber reciprocal()
```
    Gets the reciprocal of this number
    
    Returns:
    
    The reciprocal of this number
  - dividedBy
```
@NotNull
public RationalNumber dividedBy(long amount)
```
    Returns this number divided by amount
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    This number divided by the other number
  - dividedBy
```
@NotNull
public RationalNumber dividedBy(double amount)
```
    Returns this number divided by amount
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    This number divided by the other number
  - dividedBy
```
@NotNull
public RationalNumber dividedBy(@NotNull
                                          RationalNumber amount)
```
    Returns this number divided by amount
    
    Parameters:
    
    amount - The other number
    
    Returns:
    
    This number divided by the other number
  - power
```
public RationalNumber power(double power)
```
    Raises the rational number to a power
    
    Parameters:
    
    power - The power to raise the number to
    
    Returns:
    
    The new rational number
  - absoluteValue
```
@NotNull
public RationalNumber absoluteValue()
```
    Returns the absolute value of this rational number
    
    Returns:
    
    The absolute value of this rational number
  - power
```
public RationalNumber power(@NotNull
                            RationalNumber power)
```
    Raises the rational number to a power
    
    Parameters:
    
    power - The power to raise the number to
    
    Returns:
    
    The new rational number
  - lessThan
```
public boolean lessThan(double other)
```
    Determines whether this rational number is less than the other number
    
    Parameters:
    
    other - The other number
    
    Returns:
    
    True iff this number is less than the other
  - lessThan
```
public boolean lessThan(@NotNull
                        RationalNumber other)
```
    Determines whether this rational number is less than the other rational number
    
    Parameters:
    
    other - The other rational number
    
    Returns:
    
    True iff this number is less than the other
  - lessThanOrEqual
```
public boolean lessThanOrEqual(double other)
```
    Determines whether this rational number is less than or equal to the other number
    
    Parameters:
    
    other - The other number
    
    Returns:
    
    True iff this number is less than or equal to the other
  - lessThanOrEqual
```
public boolean lessThanOrEqual(@NotNull
                               RationalNumber other)
```
    Determines whether this rational number is less than or equal to the other rational number
    
    Parameters:
    
    other - The other rational number
    
    Returns:
    
    True iff this number is less than or equal to the other
  - greaterThan
```
public boolean greaterThan(double other)
```
    Determines whether this rational number is greater than the other number
    
    Parameters:
    
    other - The other number
    
    Returns:
    
    True iff this number is greater than the other
  - greaterThan
```
public boolean greaterThan(@NotNull
                           RationalNumber other)
```
    Determines whether this rational number is greater than the other rational number
    
    Parameters:
    
    other - The other rational number
    
    Returns:
    
    True iff this number is greater than the other
  - greaterThanOrEqual
```
public boolean greaterThanOrEqual(double other)
```
    Determines whether this rational number is greater than or equal to the other number
    
    Parameters:
    
    other - The other number
    
    Returns:
    
    True iff this number is greater than or equal to the other
  - greaterThanOrEqual
```
public boolean greaterThanOrEqual(@NotNull
                                  RationalNumber other)
```
    Determines whether this rational number is greater than or equal to the other rational number
    
    Parameters:
    
    other - The other rational number
    
    Returns:
    
    True iff this number is greater than or equal to the other
  - isApproximated
```
public boolean isApproximated()
```
    Returns true if this number has been approximated (overflow didn't allow a large enough numerator and denominator)
    
    Returns:
    
    True iff the value is approximate, false otherwise
  - toStringWithWholePart
```
public java.lang.String toStringWithWholePart()
```
    Converts the number to a fraction, such as 1 3/4
    
    Returns:
    
    The number as a fraction with a whole number portion
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public int compareTo(RationalNumber otherNumber)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<RationalNumber>
  - equals
```
public boolean equals(@Nullable
                      java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class java.lang.Number
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class java.lang.Number
  - floatValue
```
public float floatValue()
```
    Specified by:
    
    floatValue in class java.lang.Number
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class java.lang.Number

Class RationalNumber

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

ZERO

ONE

NEGATIVE_ONE

ONE_HALF

ONE_THIRD

ONE_FOURTH

TWO_THIRDS

THREE_FOURTHS

MAX_VALUE

MIN_VALUE

E

PI

Constructor Detail

RationalNumber

RationalNumber

RationalNumber

RationalNumber

Method Detail

valueOf

valueOf

valueOf

roundToNearestMultiple

getNumerator

getDenominator

getWholePart

getRationalPart

mediant

times

times

times

add

add

plus

plus

plus

negate

minus

minus

minus

reciprocal

dividedBy

dividedBy

dividedBy

power

absoluteValue

power

lessThan

lessThan

lessThanOrEqual

lessThanOrEqual

greaterThan

greaterThan

greaterThanOrEqual

greaterThanOrEqual

isApproximated

toStringWithWholePart

toString

compareTo

equals

hashCode

intValue

longValue

floatValue

doubleValue