Units of Measurement Reference Implementation 2.2.2 · tech.units.indriya.spi.NumberSystem

Modifier and Type	Class and Description
public static class	NumberSystem.DivisionResult Immutable value type, holder of 2 numbers.

Method Summary

Modifier and Type	Method and Description
public Number	Returns: `abs(number)` abs(Number number) Returns the absolute of given `number` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports.
public Number	Returns: `x + y` add(Number x, Number y) Returns the sum of given `x` and `y` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports.
public int	Returns: the value `0` if `x == y`; a value less than `0` if `x < y`; and a value greater than `0` if `x > y` compare(Number x, Number y) Compares two `Number` values numerically.
public Number	Returns: `x / y` divide(Number x, Number y) Returns the division of given `x` and `y` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports.
public Number[]	divideAndRemainder(Number x, Number y, boolean - whether the division remainder should be rounded towards zero roundRemainderTowardsZero) Returns a two-element Number array containing {x / y, x % y}
public default boolean	equals(Number x, Number y)
public Number	Returns: `e`^number, with `e` Euler's Constant) exp(Number number) Returns Euler's Constant to the power of of given `number` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports.
public boolean	Returns: whether `number` represents a whole number isInteger(Number number) Checks whether given `number` has fractional parts or not.
public boolean	isLessThanOne(Number number)
public boolean	isOne(Number number)
public boolean	isZero(Number number)
public Number	Returns: natural logarithm of number log(Number number) Returns the natural logarithm of given `number` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports.
public Number	Returns: `x * y` multiply(Number x, Number y) Returns the product of given `x` and `y` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports.
public Number	Returns: 'best' representation of `number` w/o loss of precision narrow(Number number) 'Narrows' given `number` as a `Number` that best represents the numeric value within the set of number types this NumberSystem supports.
public Number	Returns: `-number` negate(Number number) Returns the negation of given `number` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports.
public Number	Returns: number^exponent power(Number number, int - an integer exponent) Returns given `number` to the power of `exponent` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports.
public Number	Returns: `number^-1` reciprocal(Number number) Returns the reciprocal of given `number` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports.
public int	Returns: `signum(number)` signum(Number number) Returns the signum function of given `number`.
public Number	Returns: `x - y` subtract(Number x, Number y) Returns the difference of given `x` and `y` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports.

Method Detail

abs back to summary

abs	back to summary
public Number abs(Number number) Returns the absolute of given `number` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports. Returns:Number `abs(number)`

public Number abs(Number number)

Returns the absolute of given number as a Number that best represents the arithmetic result within the set of number types this NumberSystem supports.

Returns:Number: abs(number)

add back to summary

add	back to summary
public Number add(Number x, Number y) Returns the sum of given `x` and `y` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports. Returns:Number `x + y`

public Number add(Number x, Number y)

Returns the sum of given x and y as a Number that best represents the arithmetic result within the set of number types this NumberSystem supports.

Returns:Number: x + y

compare back to summary

compare	back to summary
public int compare(Number x, Number y) Compares two `Number` values numerically. Returns:int the value `0` if `x == y`; a value less than `0` if `x < y`; and a value greater than `0` if `x > y`

public int compare(Number x, Number y)

Compares two Number values numerically.

Returns:int: the value 0 if x == y; a value less than 0 if x < y; and a value greater than 0 if x > y

divide back to summary

divide	back to summary
public Number divide(Number x, Number y) Returns the division of given `x` and `y` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports. Returns:Number `x / y`

public Number divide(Number x, Number y)

Returns the division of given x and y as a Number that best represents the arithmetic result within the set of number types this NumberSystem supports.

Returns:Number: x / y

divideAndRemainder	back to summary
public Number[] divideAndRemainder(Number x, Number y, boolean roundRemainderTowardsZero) Returns a two-element Number array containing {x / y, x % y} Parameters roundRemainderTowardsZero:boolean - whether the division remainder should be rounded towards zero

divideAndRemainder

back to summary

public Number[] divideAndRemainder(Number x, Number y, boolean roundRemainderTowardsZero)

Returns a two-element Number array containing {x / y, x % y}

Parameters

roundRemainderTowardsZero:boolean: - whether the division remainder should be rounded towards zero

equals	back to summary
public default boolean equals(Number x, Number y)

exp back to summary

exp	back to summary
public Number exp(Number number) Returns Euler's Constant to the power of of given `number` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports. Returns:Number `e`^number, with `e` Euler's Constant)

public Number exp(Number number)

Returns Euler's Constant to the power of of given number as a Number that best represents the arithmetic result within the set of number types this NumberSystem supports.

Returns:Number: e^number, with e Euler's Constant)

isInteger back to summary

isInteger	back to summary
public boolean isInteger(Number number) Checks whether given `number` has fractional parts or not. Returns:boolean whether `number` represents a whole number

public boolean isInteger(Number number)

Checks whether given number has fractional parts or not.

Returns:boolean: whether number represents a whole number

isLessThanOne	back to summary
public boolean isLessThanOne(Number number)

isOne	back to summary
public boolean isOne(Number number)

isZero	back to summary
public boolean isZero(Number number)

log back to summary

log	back to summary
public Number log(Number number) Returns the natural logarithm of given `number` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports. Returns:Number natural logarithm of number

public Number log(Number number)

Returns the natural logarithm of given number as a Number that best represents the arithmetic result within the set of number types this NumberSystem supports.

Returns:Number: natural logarithm of number

multiply back to summary

multiply	back to summary
public Number multiply(Number x, Number y) Returns the product of given `x` and `y` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports. Returns:Number `x * y`

public Number multiply(Number x, Number y)

Returns the product of given x and y as a Number that best represents the arithmetic result within the set of number types this NumberSystem supports.

Returns:Number: x * y

narrow back to summary

narrow	back to summary
public Number narrow(Number number) 'Narrows' given `number` as a `Number` that best represents the numeric value within the set of number types this NumberSystem supports. eg. A BigInteger that is within range of Java's `Long` type can be narrowed to Long w/o loss of precision. Returns:Number 'best' representation of `number` w/o loss of precision

public Number narrow(Number number)

'Narrows' given number as a Number that best represents the numeric value within the set of number types this NumberSystem supports.

eg. A BigInteger that is within range of Java's Long type can be narrowed to Long w/o loss of precision.

Returns:Number: 'best' representation of number w/o loss of precision

negate back to summary

negate	back to summary
public Number negate(Number number) Returns the negation of given `number` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports. Returns:Number `-number`

public Number negate(Number number)

Returns the negation of given number as a Number that best represents the arithmetic result within the set of number types this NumberSystem supports.

Returns:Number: -number

power back to summary

power	back to summary
public Number power(Number number, int exponent) Returns given `number` to the power of `exponent` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports. Parameters exponent:int - an integer Returns:Number number^exponent Exceptions ArithmeticException: if `number` and `exponent` are ZERO

public Number power(Number number, int exponent)

Returns given number to the power of exponent as a Number that best represents the arithmetic result within the set of number types this NumberSystem supports.

Parameters

exponent:int: - an integer

Returns:Number

number^exponent

Exceptions

ArithmeticException:: if number and exponent are ZERO

reciprocal back to summary

reciprocal	back to summary
public Number reciprocal(Number number) Returns the reciprocal of given `number` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports. Returns:Number `number^-1`

public Number reciprocal(Number number)

Returns the reciprocal of given number as a Number that best represents the arithmetic result within the set of number types this NumberSystem supports.

Returns:Number: number^-1

signum back to summary

signum	back to summary
public int signum(Number number) Returns the signum function of given `number`. Returns:int `signum(number)`

public int signum(Number number)

Returns the signum function of given number.

Returns:int: signum(number)

subtract back to summary

subtract	back to summary
public Number subtract(Number x, Number y) Returns the difference of given `x` and `y` as a `Number` that best represents the arithmetic result within the set of number types this NumberSystem supports. Returns:Number `x - y`

public Number subtract(Number x, Number y)

Returns the difference of given x and y as a Number that best represents the arithmetic result within the set of number types this NumberSystem supports.

Returns:Number: x - y

Modifier and Type	Field and Description
public final Number	quotient originating from x / y
public final Number	remainder originating from x % y

public Interface NumberSystem

Nested and Inner Type Summary

Method Summary

Method Detail

public final Class NumberSystem.DivisionResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail