Units of Measurement Reference Implementation 2.2.2 · tech.units.indriya.function.RationalNumber

Modifier and Type	Field and Description
private final Object	$lock1
private final Object	$lock2
private final BigInteger	absDividend
private final BigInteger	absDivisor
public static char	DIVISION_CHARACTER The default `DIVISION_CHARACTER` is ÷ which (on Windows) can by typed using Alt+ 246.
private transient BigDecimal	divisionResult
private final int	hashCode
private final boolean	isInteger
private transient Long	longValue
public static final RationalNumber	ONE
private static final long	serialVersionUID Hides java.lang.Number.serialVersionUID.
private final int	signum
public static final RationalNumber	ZERO

Access	Constructor and Description
private	RationalNumber(int signum, BigInteger absDividend, BigInteger absDivisor)

Method Summary

Modifier and Type	Method and Description
public RationalNumber	Returns: `abs(this)` abs() Returns a `RationalNumber` whose value is the absolute value of this `RationalNumber`.
public RationalNumber	Returns: this + that add(RationalNumber that) Returns a new instance of `RationalNumber` representing the addition `this + that`.
public BigDecimal	Returns: this `RationalNumber` converted to `BigDecimal` representation bigDecimalValue() The `BigDecimal` representation of this `RationalNumber`.
public int	Returns: the value `0` if `this` equals (numerically) `that`; a value less than `0` if `this < that`; and a value greater than `0` if `this > that` compareTo(RationalNumber that) Compares two `RationalNumber` values numerically.
public RationalNumber	Returns: this / that divide(RationalNumber that) Returns a new instance of `RationalNumber` representing the division `this / that`.
public double	doubleValue() Implements abstract java.lang.Number.doubleValue. Returns the value of the specified number as a `double`.
public boolean	Returns: `true` if and only if the specified Object is a RationalNumber whose value is numerically equal to this RationalNumber. equals(Object Object to which this RationalNumber is to be compared. x) Overrides java.lang.Object.equals. Compares this RationalNumber with the specified Object for equality.
public float	floatValue() Implements abstract java.lang.Number.floatValue. Returns the value of the specified number as a `float`.
public BigInteger	Returns: sign(a/b) * abs(a), (given rational number a/b) getDividend() For a non-negative rational number, returns a non-negative dividend.
public BigInteger	Returns: abs(b), (given rational number a/b) getDivisor() By convention, returns a non-negative divisor.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	intValue() Implements abstract java.lang.Number.intValue. Returns the value of the specified number as an `int`.
public boolean	Returns: whether this `RationalNumber` represents an integer number isInteger()
private String	Returns: string with canonical string representation of this `RationalNumber` layoutChars(boolean `true` for fractional representation `5÷3`; `false` for decimal `1.66667`. useFractionalRepresentation, char divisionCharacter) Lay out this `RationalNumber` into a `String`.
public long	longValue() Implements abstract java.lang.Number.longValue. Returns the value of the specified number as a `long`.
public RationalNumber	Returns: this * that multiply(RationalNumber that) Returns a new instance of `RationalNumber` representing the multiplication `this * that`.
public RationalNumber	Returns: -this negate() Returns a new instance of `RationalNumber` representing the negation of `this`.
public static RationalNumber	Returns: dividend/divisor of(long dividend, long divisor) Returns a `RationalNumber` that represents the division `dividend/divisor`.
public static RationalNumber	of(double number) Returns a `RationalNumber` that represents the given double precision `number`, with an accuracy equivalent to `BigDecimal#valueOf(double)`.
public static RationalNumber	of(BigDecimal decimalValue) Returns a `RationalNumber` that represents the given BigDecimal decimalValue.
public static RationalNumber	Returns: dividend/divisor of(BigInteger the dividend dividend, BigInteger the divisor divisor) Returns a `RationalNumber` that represents the division `dividend/divisor`.
public static RationalNumber	Returns: number/1 ofInteger(long number) Returns a `RationalNumber` with divisor ONE.
public static RationalNumber	Returns: number/1 ofInteger(BigInteger number) Returns a `RationalNumber` with divisor ONE.
public RationalNumber	Returns: this^exponent pow(int exponent) Returns a new instance of `RationalNumber` representing the reciprocal of `this`.
public RationalNumber	Returns: 1/this reciprocal() Returns a new instance of `RationalNumber` representing the reciprocal of `this`.
public int	Returns: the sign of this `RationalNumber`: -1, 0 or +1 signum()
public RationalNumber	Returns: this - that subtract(RationalNumber that) Returns a new instance of `RationalNumber` representing the subtraction `this - that`.
public String	Returns: string representation of this `RationalNumber`, using fractional notation. toRationalString() Returns a string representation of this `RationalNumber`, using fractional notation, eg.
public String	Returns: string representation of this `RationalNumber`, using fractional notation. toRationalString(char the character to use instead of the default `÷` divisionCharacter) Returns a string representation of this `RationalNumber`, using fractional notation, eg.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Number:: byteValue shortValue

$lock1	back to summary
private final Object $lock1

$lock2	back to summary
private final Object $lock2

absDividend	back to summary
private final BigInteger absDividend

absDivisor	back to summary
private final BigInteger absDivisor

DIVISION_CHARACTER	back to summary
public static char DIVISION_CHARACTER The default `DIVISION_CHARACTER` is ÷ which (on Windows) can by typed using Alt+ 246. Note Number parsing will fail if this is a white-space character.

divisionResult	back to summary
private transient BigDecimal divisionResult

hashCode	back to summary
private final int hashCode

isInteger	back to summary
private final boolean isInteger

longValue	back to summary
private transient Long longValue

ONE	back to summary
public static final RationalNumber ONE

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.Number.serialVersionUID.

signum	back to summary
private final int signum

ZERO	back to summary
public static final RationalNumber ZERO

RationalNumber	back to summary
private RationalNumber(int signum, BigInteger absDividend, BigInteger absDivisor)

Method Detail

abs back to summary

abs	back to summary
public RationalNumber abs() Returns a `RationalNumber` whose value is the absolute value of this `RationalNumber`. Returns:RationalNumber `abs(this)`

public RationalNumber abs()

Returns a RationalNumber whose value is the absolute value of this RationalNumber.

Returns:RationalNumber: abs(this)

add back to summary

add	back to summary
public RationalNumber add(RationalNumber that) Returns a new instance of `RationalNumber` representing the addition `this + that`. Returns:RationalNumber this + that

public RationalNumber add(RationalNumber that)

Returns a new instance of RationalNumber representing the addition this + that.

Returns:RationalNumber: this + that

bigDecimalValue back to summary

bigDecimalValue	back to summary
public BigDecimal bigDecimalValue() The `BigDecimal` representation of this `RationalNumber`. Implementation Note: the conversion calculation is done lazily and thread-safe Returns:BigDecimal this `RationalNumber` converted to `BigDecimal` representation

public BigDecimal bigDecimalValue()

The BigDecimal representation of this RationalNumber.

Implementation Note:: the conversion calculation is done lazily and thread-safe

Returns:BigDecimal: this RationalNumber converted to BigDecimal representation

compareTo back to summary

compareTo	back to summary
public int compareTo(RationalNumber that) Compares two `RationalNumber` values numerically. Returns:int the value `0` if `this` equals (numerically) `that`; a value less than `0` if `this < that`; and a value greater than `0` if `this > that`

public int compareTo(RationalNumber that)

Compares two RationalNumber values numerically.

Returns:int: the value 0 if this equals (numerically) that; a value less than 0 if this < that; and a value greater than 0 if this > that

divide back to summary

divide	back to summary
public RationalNumber divide(RationalNumber that) Returns a new instance of `RationalNumber` representing the division `this / that`. Returns:RationalNumber this / that

public RationalNumber divide(RationalNumber that)

Returns a new instance of RationalNumber representing the division this / that.

Returns:RationalNumber: this / that

doubleValue back to summary

doubleValue	back to summary
public double doubleValue() Implements abstract java.lang.Number.doubleValue. Doc from java.lang.Number.doubleValue. Returns the value of the specified number as a `double`. Returns:double the numeric value represented by this object after conversion to type `double`. Annotations @Override

public double doubleValue()

Implements abstract java.lang.Number.doubleValue.

Doc from java.lang.Number.doubleValue.

Returns the value of the specified number as a double.

Returns:double

the numeric value represented by this object after conversion to type double.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object x) Overrides java.lang.Object.equals. Compares this RationalNumber with the specified Object for equality. Parameters x:Object Object to which this RationalNumber is to be compared. Returns:boolean `true` if and only if the specified Object is a RationalNumber whose value is numerically equal to this RationalNumber. Annotations @Override

public boolean equals(Object x)

Overrides java.lang.Object.equals.

Compares this RationalNumber with the specified Object for equality.

Parameters

x:Object: Object to which this RationalNumber is to be compared.

Returns:boolean

true if and only if the specified Object is a RationalNumber whose value is numerically equal to this RationalNumber.

Annotations

@Override

floatValue back to summary

floatValue	back to summary
public float floatValue() Implements abstract java.lang.Number.floatValue. Doc from java.lang.Number.floatValue. Returns the value of the specified number as a `float`. Returns:float the numeric value represented by this object after conversion to type `float`. Annotations @Override

public float floatValue()

Implements abstract java.lang.Number.floatValue.

Doc from java.lang.Number.floatValue.

Returns the value of the specified number as a float.

Returns:float

the numeric value represented by this object after conversion to type float.

Annotations

@Override

getDividend back to summary

getDividend	back to summary
public BigInteger getDividend() For a non-negative rational number, returns a non-negative dividend. Otherwise returns a negative dividend. In other words, by convention, the integer returned includes the sign of this `RationalNumber`, whereas @link `getDivisor()` does not and is always non-negative. Returns:BigInteger sign(a/b) * abs(a), (given rational number a/b)

public BigInteger getDividend()

For a non-negative rational number, returns a non-negative dividend. Otherwise returns a negative dividend. In other words, by convention, the integer returned includes the sign of this RationalNumber, whereas @link getDivisor() does not and is always non-negative.

Returns:BigInteger: sign(a/b) * abs(a), (given rational number a/b)

getDivisor	back to summary
public BigInteger getDivisor() By convention, returns a non-negative divisor. Returns:BigInteger abs(b), (given rational number a/b)

getDivisor

back to summary

public BigInteger getDivisor()

By convention, returns a non-negative divisor.

Returns:BigInteger: abs(b), (given rational number a/b)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

intValue back to summary

intValue	back to summary
public int intValue() Implements abstract java.lang.Number.intValue. Doc from java.lang.Number.intValue. Returns the value of the specified number as an `int`. Returns:int the numeric value represented by this object after conversion to type `int`. Annotations @Override

public int intValue()

Implements abstract java.lang.Number.intValue.

Doc from java.lang.Number.intValue.

Returns the value of the specified number as an int.

Returns:int

the numeric value represented by this object after conversion to type int.

Annotations

@Override

isInteger	back to summary
public boolean isInteger() Returns:boolean whether this `RationalNumber` represents an integer number

layoutChars back to summary

layoutChars	back to summary
private String layoutChars(boolean useFractionalRepresentation, char divisionCharacter) Lay out this `RationalNumber` into a `String`. Parameters useFractionalRepresentation:boolean `true` for fractional representation `5÷3`; `false` for decimal `1.66667`. Returns:String string with canonical string representation of this `RationalNumber`

private String layoutChars(boolean useFractionalRepresentation, char divisionCharacter)

Lay out this RationalNumber into a String.

Parameters

useFractionalRepresentation:boolean: true for fractional representation 5÷3; false for decimal 1.66667.

Returns:String

string with canonical string representation of this RationalNumber

longValue back to summary

longValue	back to summary
public long longValue() Implements abstract java.lang.Number.longValue. Doc from java.lang.Number.longValue. Returns the value of the specified number as a `long`. Returns:long the numeric value represented by this object after conversion to type `long`. Annotations @Override

public long longValue()

Implements abstract java.lang.Number.longValue.

Doc from java.lang.Number.longValue.

Returns the value of the specified number as a long.

Returns:long

the numeric value represented by this object after conversion to type long.

Annotations

@Override

multiply back to summary

multiply	back to summary
public RationalNumber multiply(RationalNumber that) Returns a new instance of `RationalNumber` representing the multiplication `this * that`. Returns:RationalNumber this * that

public RationalNumber multiply(RationalNumber that)

Returns a new instance of RationalNumber representing the multiplication this * that.

Returns:RationalNumber: this * that

negate back to summary

negate	back to summary
public RationalNumber negate() Returns a new instance of `RationalNumber` representing the negation of `this`. Returns:RationalNumber -this

public RationalNumber negate()

Returns a new instance of RationalNumber representing the negation of this.

Returns:RationalNumber: -this

of back to summary

of	back to summary
public static RationalNumber of(long dividend, long divisor) Returns a `RationalNumber` that represents the division `dividend/divisor`. Returns:RationalNumber dividend/divisor Exceptions IllegalArgumentException: if `divisor = 0`

public static RationalNumber of(long dividend, long divisor)

Returns a RationalNumber that represents the division dividend/divisor.

Returns:RationalNumber

dividend/divisor

Exceptions

IllegalArgumentException:: if divisor = 0

of	back to summary
public static RationalNumber of(double number) Returns a `RationalNumber` that represents the given double precision `number`, with an accuracy equivalent to `BigDecimal#valueOf(double)`.

of	back to summary
public static RationalNumber of(BigDecimal decimalValue) Returns a `RationalNumber` that represents the given BigDecimal decimalValue.

of back to summary

of	back to summary
public static RationalNumber of(BigInteger dividend, BigInteger divisor) Returns a `RationalNumber` that represents the division `dividend/divisor`. Implementation Note: this implementation stores dividend and divisor after canceling down from given parameters Parameters dividend:BigInteger the dividend divisor:BigInteger the divisor Returns:RationalNumber dividend/divisor Exceptions IllegalArgumentException: if `divisor = 0` NullPointerException: - if dividend is `null` or divisor is `null`

public static RationalNumber of(BigInteger dividend, BigInteger divisor)

Returns a RationalNumber that represents the division dividend/divisor.

Implementation Note:: this implementation stores dividend and divisor after canceling down from given parameters

Parameters

dividend:BigInteger: the dividend
divisor:BigInteger: the divisor

Returns:RationalNumber

dividend/divisor

Exceptions

IllegalArgumentException:: if divisor = 0
NullPointerException:: - if dividend is null or divisor is null

ofInteger back to summary

ofInteger	back to summary
public static RationalNumber ofInteger(long number) Returns a `RationalNumber` with divisor ONE. In other words, returns a `RationalNumber` that represents given integer `number`. Returns:RationalNumber number/1 Exceptions NullPointerException: - if number is `null`

public static RationalNumber ofInteger(long number)

Returns a RationalNumber with divisor ONE. In other words, returns a RationalNumber that represents given integer number.

Returns:RationalNumber

number/1

Exceptions

NullPointerException:: - if number is null

ofInteger back to summary

ofInteger	back to summary
public static RationalNumber ofInteger(BigInteger number) Returns a `RationalNumber` with divisor ONE. In other words, returns a `RationalNumber` that represents given integer `number`. Returns:RationalNumber number/1 Exceptions NullPointerException: - if number is `null`

public static RationalNumber ofInteger(BigInteger number)

Returns a RationalNumber with divisor ONE. In other words, returns a RationalNumber that represents given integer number.

Returns:RationalNumber

number/1

Exceptions

NullPointerException:: - if number is null

pow back to summary

pow	back to summary
public RationalNumber pow(int exponent) Returns a new instance of `RationalNumber` representing the reciprocal of `this`. Returns:RationalNumber this^exponent

public RationalNumber pow(int exponent)

Returns a new instance of RationalNumber representing the reciprocal of this.

Returns:RationalNumber: this^exponent

reciprocal back to summary

reciprocal	back to summary
public RationalNumber reciprocal() Returns a new instance of `RationalNumber` representing the reciprocal of `this`. Returns:RationalNumber 1/this

public RationalNumber reciprocal()

Returns a new instance of RationalNumber representing the reciprocal of this.

Returns:RationalNumber: 1/this

signum	back to summary
public int signum() Returns:int the sign of this `RationalNumber`: -1, 0 or +1

subtract back to summary

subtract	back to summary
public RationalNumber subtract(RationalNumber that) Returns a new instance of `RationalNumber` representing the subtraction `this - that`. Returns:RationalNumber this - that

public RationalNumber subtract(RationalNumber that)

Returns a new instance of RationalNumber representing the subtraction this - that.

Returns:RationalNumber: this - that

toRationalString back to summary

toRationalString	back to summary
public String toRationalString() Returns a string representation of this `RationalNumber`, using fractional notation, eg. `5÷3` or `-5÷3`. Returns:String string representation of this `RationalNumber`, using fractional notation. Since 2.0

public String toRationalString()

Returns a string representation of this RationalNumber, using fractional notation, eg. 5÷3 or -5÷3.

Returns:String: string representation of this RationalNumber, using fractional notation.
Since: 2.0

toRationalString back to summary

toRationalString	back to summary
public String toRationalString(char divisionCharacter) Returns a string representation of this `RationalNumber`, using fractional notation, eg. `5÷3` or `-5÷3`. Parameters divisionCharacter:char the character to use instead of the default `÷` Returns:String string representation of this `RationalNumber`, using fractional notation. Since 2.0

public String toRationalString(char divisionCharacter)

Returns a string representation of this RationalNumber, using fractional notation, eg. 5÷3 or -5÷3.

Parameters

divisionCharacter:char: the character to use instead of the default ÷

Returns:String

string representation of this RationalNumber, using fractional notation.

Since

2.0

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public final Class RationalNumber

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail