Rational (Manifold :: Science 2025.1.22 API)

java.lang.Object
- java.lang.Number
- - manifold.science.util.Rational

All Implemented Interfaces:

Serializable, Comparable<Rational>, manifold.collections.api.range.Sequential<Rational,Rational,Void>, manifold.ext.rt.api.ComparableUsing<Rational>
```
public final class Rational
extends Number
implements manifold.collections.api.range.Sequential<Rational,Rational,Void>, manifold.ext.rt.api.ComparableUsing<Rational>, 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
  manifold.ext.rt.api.ComparableUsing.EqualityMode, manifold.ext.rt.api.ComparableUsing.Operator

Field Summary

Fields
Modifier and Type Field and Description

static Rational HALF

static Rational ONE

static Rational TEN

static Rational ZERO

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

Method Summary

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

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

Methods inherited from class java.lang.Object
clone, emptyArray, 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(BigInteger numerator)

get

public static Rational get(Number numerator)

get

public static Rational get(String decimal)

get

public static Rational get(BigDecimal bd)

get

public static Rational get(BigInteger numerator,
                           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 BigInteger getNumerator()
```

getDenominator
```
public BigInteger getDenominator()
```

wholePart
```
public BigInteger wholePart()
```

fractionPart
```
public Rational fractionPart()
```

intValue
```
public int intValue()
```
Specified by:

intValue in class Number

longValue
```
public long longValue()
```
Specified by:

longValue in class Number

doubleValue
```
public double doubleValue()
```
Specified by:

doubleValue in class Number

floatValue
```
public float floatValue()
```
Specified by:

floatValue in class Number

toBigInteger
```
public BigInteger toBigInteger()
```

toBigDecimal
```
public BigDecimal toBigDecimal()
```

toBigDecimal

public BigDecimal toBigDecimal(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(BigInteger bg)
```

plus
```
public Rational plus(BigDecimal bd)
```

plus

public Rational plus(Rational rational)

plus
```
public Rational plus(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(BigInteger bi)
```

minus
```
public Rational minus(BigDecimal bd)
```

minus

public Rational minus(Rational rational)

minus
```
public Rational minus(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(BigInteger bi)
```

times
```
public Rational times(BigDecimal bd)
```

times

public Rational times(Rational rational)

times
```
public Rational times(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(BigInteger bi)
```

div
```
public Rational div(BigDecimal bd)
```

div

public Rational div(Rational rational)

div
```
public Rational div(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(BigInteger bi)
```

rem
```
public Rational rem(BigDecimal bd)
```

rem

public Rational rem(Rational rational)

rem
```
public Rational rem(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,
                               Void unit)

Specified by:: nextInSequence in interface manifold.collections.api.range.Sequential<Rational,Rational,Void>

nextNthInSequence

public Rational nextNthInSequence(Rational step,
                                  Void unit,
                                  int index)

Specified by:: nextNthInSequence in interface manifold.collections.api.range.Sequential<Rational,Rational,Void>

previousInSequence

public Rational previousInSequence(Rational step,
                                   Void unit)

Specified by:: previousInSequence in interface manifold.collections.api.range.Sequential<Rational,Rational,Void>

previousNthInSequence

public Rational previousNthInSequence(Rational step,
                                      Void unit,
                                      int index)

Specified by:: previousNthInSequence in interface manifold.collections.api.range.Sequential<Rational,Rational,Void>

signum
```
public int signum()
```

compareTo
```
public int compareTo(Rational that)
```
Specified by:

compareTo in interface Comparable<Rational>

equalityMode
```
public manifold.ext.rt.api.ComparableUsing.EqualityMode equalityMode()
```
Use compareTo() for == and != operators.

Specified by:

equalityMode in interface manifold.ext.rt.api.ComparableUsing<Rational>

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toFractionString
```
public String toFractionString()
```

toMixedString
```
public String toMixedString()
```

toDecimalString
```
public String toDecimalString()
```
Creates a BigDecimal and calls BigDecimal.toString()

toPlainDecimalString
```
public String toPlainDecimalString()
```
Creates a BigDecimal and calls BigDecimal.toPlainString()

toEngineeringString
```
public String toEngineeringString()
```
Creates a BigDecimal and calls BigDecimal.toEngineeringString()

toString
```
public String toString()
```
Overrides:

toString in class Object

Class Rational

Nested Class Summary

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

Field Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

ONE

TEN

HALF

Method Detail

get

get

get

get

get

get

get

get

get

get

get

isReduced

reduce

getNumerator

getDenominator

wholePart

fractionPart

intValue

longValue

doubleValue

floatValue

toBigInteger

toBigDecimal

toBigDecimal

plus

plus

plus

plus

plus

plus

plus

plus

minus

minus

minus

minus

minus

minus

minus

minus

times

times

times

times

times

times

times

times

div

div

div

div

div

div

div

div

rem

rem

rem

rem

rem

rem

rem

rem

unaryMinus

inc