manifold.science.util

Class Rational

java.lang.Object

java.lang.Number

manifold.science.util.Rational

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Rational>, Sequential<Rational,Rational,java.lang.Void>, ComparableUsing<Rational>

public final class Rational
extends java.lang.Number
implements Sequential<Rational,Rational,java.lang.Void>, ComparableUsing<Rational>, java.io.Serializable

Models rational numbers as an immutable fraction using BigInteger to maintain arbitrary precision. Note as a performance measure this class does not maintain its value in reduced form. You must call reduce() to get a separate instance for the reduced form. Call isReduced() to determine if an instance is in reduced form.

This class implements arithmetic, negation, and relational operators via operator overloading provided by the manifold-ext dependency.

Use the CoercionConstants and MetricScaleUnit classes to conveniently use literal values as Rational numbers:

   import static manifold.science.measures.MetricScaleUnit.M;
   import static manifold.science.util.CoercionConstants.r;
   ...
   Rational pi = 3.14r;
   Rational oneThird = 1r/3;
   Rational yocto = "1/1000000000000000000000000"r;
   Rational fiveMillion = 5M;
 

WARNING: this class is under development and should be considered experimental.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface manifold.ext.rt.api.ComparableUsing

ComparableUsing.EqualityMode, ComparableUsing.Operator

Field Summary

Fields

Modifier and Type	Field and Description
static Rational	HALF
static Rational	ONE
static Rational	TEN
static Rational	ZERO

Method Summary

Modifier and Type	Method and Description
Rational	abs()
int	compareTo(Rational that)
Rational	dec() Supports unary decrement operator --
Rational	div(java.math.BigDecimal bd)
Rational	div(java.math.BigInteger bi)
Rational	div(double d)
Rational	div(float f)
Rational	div(int i)
Rational	div(long l)
Rational	div(java.lang.Number n)
Rational	div(Rational rational)
double	doubleValue()
ComparableUsing.EqualityMode	equalityMode() Use compareTo() for == and != operators.
boolean	equals(java.lang.Object o)
float	floatValue()
Rational	fractionPart()
static Rational	get(java.math.BigDecimal bd)
static Rational	get(java.math.BigInteger numerator)
static Rational	get(java.math.BigInteger numerator, java.math.BigInteger denominator)
static Rational	get(double d)
static Rational	get(float f)
static Rational	get(int numerator)
static Rational	get(int numerator, int denominator)
static Rational	get(long numerator)
static Rational	get(long numerator, long denominator)
static Rational	get(java.lang.Number numerator)
static Rational	get(java.lang.String decimal)
java.math.BigInteger	getDenominator()
java.math.BigInteger	getNumerator()
int	hashCode()
Rational	inc() Supports unary increment operator ++
int	intValue()
Rational	invert()
boolean	isInteger()
boolean	isReduced()
long	longValue()
Rational	minus(java.math.BigDecimal bd)
Rational	minus(java.math.BigInteger bi)
Rational	minus(double d)
Rational	minus(float f)
Rational	minus(int i)
Rational	minus(long l)
Rational	minus(java.lang.Number n)
Rational	minus(Rational rational)
Rational	nextInSequence(Rational step, java.lang.Void unit)
Rational	nextNthInSequence(Rational step, java.lang.Void unit, int index)
Rational	plus(java.math.BigDecimal bd)
Rational	plus(java.math.BigInteger bg)
Rational	plus(double d)
Rational	plus(float f)
Rational	plus(int i)
Rational	plus(long l)
Rational	plus(java.lang.Number n)
Rational	plus(Rational rational)
Rational	pow(int exponent)
Rational	previousInSequence(Rational step, java.lang.Void unit)
Rational	previousNthInSequence(Rational step, java.lang.Void unit, int index)
Rational	reduce()
Rational	rem(java.math.BigDecimal bd)
Rational	rem(java.math.BigInteger bi)
Rational	rem(double d)
Rational	rem(float f)
Rational	rem(int i)
Rational	rem(long l)
Rational	rem(java.lang.Number n)
Rational	rem(Rational rational)
int	signum()
Rational	sqrt() Deprecated.
Rational	times(java.math.BigDecimal bd)
Rational	times(java.math.BigInteger bi)
Rational	times(double d)
Rational	times(float f)
Rational	times(int i)
Rational	times(long l)
Rational	times(java.lang.Number n)
Rational	times(Rational rational)
java.math.BigDecimal	toBigDecimal()
java.math.BigDecimal	toBigDecimal(java.math.MathContext mc)
java.math.BigInteger	toBigInteger()
java.lang.String	toDecimalString() Creates a BigDecimal and calls BigDecimal.toString()
java.lang.String	toEngineeringString() Creates a BigDecimal and calls BigDecimal.toEngineeringString()
java.lang.String	toFractionString()
java.lang.String	toMixedString()
java.lang.String	toPlainDecimalString() Creates a BigDecimal and calls BigDecimal.toPlainString()
java.lang.String	toString()
Rational	unaryMinus()
java.math.BigInteger	wholePart()

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, jailbreak, notify, notifyAll, wait, wait, wait

Methods inherited from interface manifold.ext.rt.api.ComparableUsing

compareToUsing

Field Detail

ZERO

public static final Rational ZERO

ONE

public static final Rational ONE

TEN

public static final Rational TEN

HALF

public static final Rational HALF

Method Detail

get

public static Rational get(int numerator)

get

public static Rational get(int numerator,
                           int denominator)

get

public static Rational get(long numerator)

get

public static Rational get(long numerator,
                           long denominator)

get

public static Rational get(float f)

get

public static Rational get(double d)

get

public static Rational get(java.math.BigInteger numerator)

get

public static Rational get(java.lang.Number numerator)

get

public static Rational get(java.lang.String decimal)

get

public static Rational get(java.math.BigDecimal bd)

get

public static Rational get(java.math.BigInteger numerator,
                           java.math.BigInteger denominator)

isReduced

public boolean isReduced()

Returns:

true if this instance is in reduced form.

reduce

public Rational reduce()

Returns:

If this instance is already in reduced form, returns this instance, otherwise returns the reduced form of this instance as a separate instance.

getNumerator

public java.math.BigInteger getNumerator()

getDenominator

public java.math.BigInteger getDenominator()

wholePart

public java.math.BigInteger wholePart()

fractionPart

public Rational fractionPart()

intValue

public int intValue()

Specified by:

intValue in class java.lang.Number

longValue

public long longValue()

Specified by:

longValue in class java.lang.Number

doubleValue

public double doubleValue()

Specified by:

doubleValue in class java.lang.Number

floatValue

public float floatValue()

Specified by:

floatValue in class java.lang.Number

toBigInteger

public java.math.BigInteger toBigInteger()

toBigDecimal

public java.math.BigDecimal toBigDecimal()

toBigDecimal

public java.math.BigDecimal toBigDecimal(java.math.MathContext mc)

plus

public Rational plus(int i)

plus

public Rational plus(long l)

plus

public Rational plus(float f)

plus

public Rational plus(double d)

plus

public Rational plus(java.math.BigInteger bg)

plus

public Rational plus(java.math.BigDecimal bd)

plus

public Rational plus(Rational rational)

plus

public Rational plus(java.lang.Number n)

minus

public Rational minus(int i)

minus

public Rational minus(long l)

minus

public Rational minus(float f)

minus

public Rational minus(double d)

minus

public Rational minus(java.math.BigInteger bi)

minus

public Rational minus(java.math.BigDecimal bd)

minus

public Rational minus(Rational rational)

minus

public Rational minus(java.lang.Number n)

times

public Rational times(int i)

times

public Rational times(long l)

times

public Rational times(float f)

times

public Rational times(double d)

times

public Rational times(java.math.BigInteger bi)

times

public Rational times(java.math.BigDecimal bd)

times

public Rational times(Rational rational)

times

public Rational times(java.lang.Number n)

div

public Rational div(int i)

div

public Rational div(long l)

div

public Rational div(float f)

div

public Rational div(double d)

div

public Rational div(java.math.BigInteger bi)

div

public Rational div(java.math.BigDecimal bd)

div

public Rational div(Rational rational)

div

public Rational div(java.lang.Number n)

rem

public Rational rem(int i)

rem

public Rational rem(long l)

rem

public Rational rem(float f)

rem

public Rational rem(double d)

rem

public Rational rem(java.math.BigInteger bi)

rem

public Rational rem(java.math.BigDecimal bd)

rem

public Rational rem(Rational rational)

rem

public Rational rem(java.lang.Number n)

unaryMinus

public Rational unaryMinus()

inc

public Rational inc()

Supports unary increment operator ++

dec

public Rational dec()

Supports unary decrement operator --

invert

public Rational invert()

abs

public Rational abs()

pow

public Rational pow(int exponent)

sqrt

@Deprecated
public Rational sqrt()

Deprecated.

isInteger

public boolean isInteger()

nextInSequence

public Rational nextInSequence(Rational step,
                               java.lang.Void unit)

Specified by:

nextInSequence in interface Sequential<Rational,Rational,java.lang.Void>

nextNthInSequence

public Rational nextNthInSequence(Rational step,
                                  java.lang.Void unit,
                                  int index)

Specified by:

nextNthInSequence in interface Sequential<Rational,Rational,java.lang.Void>

previousInSequence

public Rational previousInSequence(Rational step,
                                   java.lang.Void unit)

Specified by:

previousInSequence in interface Sequential<Rational,Rational,java.lang.Void>

previousNthInSequence

public Rational previousNthInSequence(Rational step,
                                      java.lang.Void unit,
                                      int index)

Specified by:

previousNthInSequence in interface Sequential<Rational,Rational,java.lang.Void>

signum

public int signum()

compareTo

public int compareTo(Rational that)

Specified by:

compareTo in interface java.lang.Comparable<Rational>

equalityMode

public ComparableUsing.EqualityMode equalityMode()

Use compareTo() for == and != operators.

Specified by:

equalityMode in interface ComparableUsing<Rational>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toFractionString

public java.lang.String toFractionString()

toMixedString

public java.lang.String toMixedString()

toDecimalString

public java.lang.String toDecimalString()

Creates a BigDecimal and calls BigDecimal.toString()

toPlainDecimalString

public java.lang.String toPlainDecimalString()

Creates a BigDecimal and calls BigDecimal.toPlainString()

toEngineeringString

public java.lang.String toEngineeringString()

Creates a BigDecimal and calls BigDecimal.toEngineeringString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object