Modifier and Type	Class and Description
private static enum	DefaultNumberSystem.NumberType In order of increasing number type 'widening'.

Access	Constructor and Description
public	DefaultNumberSystem()

Method Summary

Modifier and Type	Method and Description
public Number	abs(final Number number) Implements tech.units.indriya.spi.NumberSystem.abs. 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	add(final Number x, final Number y) Implements tech.units.indriya.spi.NumberSystem.add. 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.
private Number	addWideAndNarrow(final DefaultNumberSystem.NumberType wideType, final Number wide, final DefaultNumberSystem.NumberType narrowType, final Number narrow)
private static Number[]	applyToArray(final Number[] array, final UnaryOperator<Number> operator)
private int	bitLengthOfInteger(final Number number)
public int	compare(final Number x, final Number y) Implements tech.units.indriya.spi.NumberSystem.compare. Compares two `Number` values numerically.
private int	compareWideVsNarrow(final DefaultNumberSystem.NumberType wideType, final Number wide, final DefaultNumberSystem.NumberType - currently unused (but future refactoring might use it) unusedNarrowType, final Number narrow)
private static BigInteger	copySignTo(final int sign, final BigInteger absNumber)
private static BigDecimal	copySignTo(final int sign, final BigDecimal absNumber)
public Number	divide(final Number x, final Number y) Implements tech.units.indriya.spi.NumberSystem.divide. 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(final Number x, final Number y, final boolean - whether the division remainder should be rounded towards zero roundRemainderTowardsZero) Implements tech.units.indriya.spi.NumberSystem.divideAndRemainder. Returns a two-element Number array containing {x / y, x % y}
public Number	exp(final Number number) Implements tech.units.indriya.spi.NumberSystem.exp. 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.
private BigInteger	integerToBigInteger(final Number number)
pack-priv static boolean	isFractional(final BigDecimal decimal) Whether given `BigDecimal` has (non-zero) fractional parts.
public boolean	isInteger(final Number number) Implements tech.units.indriya.spi.NumberSystem.isInteger. Checks whether given `number` has fractional parts or not.
private boolean	isInteger(final DefaultNumberSystem.NumberType numberType, final Number number) Whether given `Number` represents an integer.
private boolean	isIntegerOnly(final Number number) Whether the `Number`'s type can only represent integers.
public boolean	isLessThanOne(final Number number) Implements tech.units.indriya.spi.NumberSystem.isLessThanOne.
public boolean	isOne(final Number number) Implements tech.units.indriya.spi.NumberSystem.isOne.
public boolean	isZero(final Number number) Implements tech.units.indriya.spi.NumberSystem.isZero.
public Number	log(final Number number) Implements tech.units.indriya.spi.NumberSystem.log. 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	multiply(final Number x, final Number y) Implements tech.units.indriya.spi.NumberSystem.multiply. 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.
private Number	multiplyWideAndNarrow(final DefaultNumberSystem.NumberType wideType, final Number wide, final DefaultNumberSystem.NumberType narrowType, final Number narrow)
public Number	narrow(final Number number) Implements tech.units.indriya.spi.NumberSystem.narrow. 'Narrows' given `number` as a `Number` that best represents the numeric value within the set of number types this NumberSystem supports.
public Number	negate(final Number number) Implements tech.units.indriya.spi.NumberSystem.negate. 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	power(final Number number, final int - an integer exponent) Implements tech.units.indriya.spi.NumberSystem.power. 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	reciprocal(final Number number) Implements tech.units.indriya.spi.NumberSystem.reciprocal. 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	signum(final Number number) Implements tech.units.indriya.spi.NumberSystem.signum. Returns the signum function of given `number`.
public Number	subtract(final Number x, final Number y) Implements tech.units.indriya.spi.NumberSystem.subtract. 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.
private BigDecimal	toBigDecimal(final Number number)
private IllegalStateException	unexpectedCodeReach()
private IllegalArgumentException	unsupportedNumberType(final Number number)
private IllegalArgumentException	unsupportedNumberValue(final Number number)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DefaultNumberSystem	back to summary
public DefaultNumberSystem()

Method Detail

abs back to summary

abs	back to summary
public Number abs(final Number number) Implements tech.units.indriya.spi.NumberSystem.abs. Doc from tech.units.indriya.spi.NumberSystem.abs. 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)` Annotations @Override

public Number abs(final Number number)

Implements tech.units.indriya.spi.NumberSystem.abs.

Doc from tech.units.indriya.spi.NumberSystem.abs.

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)

Annotations

@Override

add back to summary

add	back to summary
public Number add(final Number x, final Number y) Implements tech.units.indriya.spi.NumberSystem.add. Doc from tech.units.indriya.spi.NumberSystem.add. 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` Annotations @Override

public Number add(final Number x, final Number y)

Implements tech.units.indriya.spi.NumberSystem.add.

Doc from tech.units.indriya.spi.NumberSystem.add.

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

Annotations

@Override

addWideAndNarrow	back to summary
private Number addWideAndNarrow(final DefaultNumberSystem.NumberType wideType, final Number wide, final DefaultNumberSystem.NumberType narrowType, final Number narrow)

applyToArray	back to summary
private static Number[] applyToArray(final Number[] array, final UnaryOperator<Number> operator)

bitLengthOfInteger	back to summary
private int bitLengthOfInteger(final Number number)

compare back to summary

compare	back to summary
public int compare(final Number x, final Number y) Implements tech.units.indriya.spi.NumberSystem.compare. Doc from tech.units.indriya.spi.NumberSystem.compare. 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` Annotations @Override

public int compare(final Number x, final Number y)

Implements tech.units.indriya.spi.NumberSystem.compare.

Doc from tech.units.indriya.spi.NumberSystem.compare.

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

Annotations

@Override

compareWideVsNarrow	back to summary
private int compareWideVsNarrow(final DefaultNumberSystem.NumberType wideType, final Number wide, final DefaultNumberSystem.NumberType unusedNarrowType, final Number narrow) Parameters unusedNarrowType:DefaultNumberSystem.NumberType - currently unused (but future refactoring might use it)

copySignTo	back to summary
private static BigInteger copySignTo(final int sign, final BigInteger absNumber)

copySignTo	back to summary
private static BigDecimal copySignTo(final int sign, final BigDecimal absNumber)

divide back to summary

divide	back to summary
public Number divide(final Number x, final Number y) Implements tech.units.indriya.spi.NumberSystem.divide. Doc from tech.units.indriya.spi.NumberSystem.divide. 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` Annotations @Override

public Number divide(final Number x, final Number y)

Implements tech.units.indriya.spi.NumberSystem.divide.

Doc from tech.units.indriya.spi.NumberSystem.divide.

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

Annotations

@Override

divideAndRemainder	back to summary
public Number[] divideAndRemainder(final Number x, final Number y, final boolean roundRemainderTowardsZero) Implements tech.units.indriya.spi.NumberSystem.divideAndRemainder. Doc from tech.units.indriya.spi.NumberSystem.divideAndRemainder. Returns a two-element Number array containing {x / y, x % y} Parameters roundRemainderTowardsZero:boolean - whether the division remainder should be rounded towards zero Annotations @Override

divideAndRemainder

back to summary

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

Implements tech.units.indriya.spi.NumberSystem.divideAndRemainder.

Doc from tech.units.indriya.spi.NumberSystem.divideAndRemainder.

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

Parameters

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

Annotations

@Override

exp back to summary

exp	back to summary
public Number exp(final Number number) Implements tech.units.indriya.spi.NumberSystem.exp. Doc from tech.units.indriya.spi.NumberSystem.exp. 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) Annotations @Override

public Number exp(final Number number)

Implements tech.units.indriya.spi.NumberSystem.exp.

Doc from tech.units.indriya.spi.NumberSystem.exp.

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)

Annotations

@Override

integerToBigInteger	back to summary
private BigInteger integerToBigInteger(final Number number)

isFractional back to summary

isFractional	back to summary
pack-priv static boolean isFractional(final BigDecimal decimal) Whether given `BigDecimal` has (non-zero) fractional parts. When `false`, given `BigDecimal` can be converted to a `BigInteger`. Implementation Note `BigDecimal#stripTrailingZeros()` creates a new `BigDecimal` just to do the check. See Also https://stackoverflow.com/questions/1078953/check-if-bigdecimal-is-integer-value

pack-priv static boolean isFractional(final BigDecimal decimal)

Whether given BigDecimal has (non-zero) fractional parts. When false, given BigDecimal can be converted to a BigInteger.

Implementation Note

BigDecimal#stripTrailingZeros() creates a new BigDecimal just to do the check.

See Also: https://stackoverflow.com/questions/1078953/check-if-bigdecimal-is-integer-value

isInteger back to summary

isInteger	back to summary
public boolean isInteger(final Number number) Implements tech.units.indriya.spi.NumberSystem.isInteger. Doc from tech.units.indriya.spi.NumberSystem.isInteger. Checks whether given `number` has fractional parts or not. Returns:boolean whether `number` represents a whole number Annotations @Override

public boolean isInteger(final Number number)

Implements tech.units.indriya.spi.NumberSystem.isInteger.

Doc from tech.units.indriya.spi.NumberSystem.isInteger.

Checks whether given number has fractional parts or not.

Returns:boolean

whether number represents a whole number

Annotations

@Override

isInteger	back to summary
private boolean isInteger(final DefaultNumberSystem.NumberType numberType, final Number number) Whether given `Number` represents an integer. Optimized for when we know the `NumberType` in advance.

isIntegerOnly back to summary

isIntegerOnly	back to summary
private boolean isIntegerOnly(final Number number) Whether the `Number`'s type can only represent integers. If `false` it can also represent fractional numbers. Note this does not check whether given number represents an integer.

private boolean isIntegerOnly(final Number number)

Whether the Number's type can only represent integers.

If false it can also represent fractional numbers.

Note

this does not check whether given number represents an integer.

isLessThanOne	back to summary
public boolean isLessThanOne(final Number number) Implements tech.units.indriya.spi.NumberSystem.isLessThanOne. Annotations @Override

isLessThanOne

back to summary

public boolean isLessThanOne(final Number number)

Implements tech.units.indriya.spi.NumberSystem.isLessThanOne.

Annotations

@Override

isOne	back to summary
public boolean isOne(final Number number) Implements tech.units.indriya.spi.NumberSystem.isOne. Annotations @Override

isOne

back to summary

public boolean isOne(final Number number)

Implements tech.units.indriya.spi.NumberSystem.isOne.

Annotations

@Override

isZero	back to summary
public boolean isZero(final Number number) Implements tech.units.indriya.spi.NumberSystem.isZero. Annotations @Override

isZero

back to summary

public boolean isZero(final Number number)

Implements tech.units.indriya.spi.NumberSystem.isZero.

Annotations

@Override

log back to summary

log	back to summary
public Number log(final Number number) Implements tech.units.indriya.spi.NumberSystem.log. Doc from tech.units.indriya.spi.NumberSystem.log. 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 Annotations @Override

public Number log(final Number number)

Implements tech.units.indriya.spi.NumberSystem.log.

Doc from tech.units.indriya.spi.NumberSystem.log.

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

Annotations

@Override

multiply back to summary

multiply	back to summary
public Number multiply(final Number x, final Number y) Implements tech.units.indriya.spi.NumberSystem.multiply. Doc from tech.units.indriya.spi.NumberSystem.multiply. 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` Annotations @Override

public Number multiply(final Number x, final Number y)

Implements tech.units.indriya.spi.NumberSystem.multiply.

Doc from tech.units.indriya.spi.NumberSystem.multiply.

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

Annotations

@Override

multiplyWideAndNarrow	back to summary
private Number multiplyWideAndNarrow(final DefaultNumberSystem.NumberType wideType, final Number wide, final DefaultNumberSystem.NumberType narrowType, final Number narrow)

narrow back to summary

narrow	back to summary
public Number narrow(final Number number) Implements tech.units.indriya.spi.NumberSystem.narrow. Doc from tech.units.indriya.spi.NumberSystem.narrow. '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 Annotations @Override

public Number narrow(final Number number)

Implements tech.units.indriya.spi.NumberSystem.narrow.

Doc from tech.units.indriya.spi.NumberSystem.narrow.

'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

Annotations

@Override

negate back to summary

negate	back to summary
public Number negate(final Number number) Implements tech.units.indriya.spi.NumberSystem.negate. Doc from tech.units.indriya.spi.NumberSystem.negate. 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` Annotations @Override

public Number negate(final Number number)

Implements tech.units.indriya.spi.NumberSystem.negate.

Doc from tech.units.indriya.spi.NumberSystem.negate.

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

Annotations

@Override

power back to summary

power	back to summary
public Number power(final Number number, final int exponent) Implements tech.units.indriya.spi.NumberSystem.power. Doc from tech.units.indriya.spi.NumberSystem.power. 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 Annotations @Override

public Number power(final Number number, final int exponent)

Implements tech.units.indriya.spi.NumberSystem.power.

Doc from tech.units.indriya.spi.NumberSystem.power.

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

Annotations

@Override

reciprocal back to summary

reciprocal	back to summary
public Number reciprocal(final Number number) Implements tech.units.indriya.spi.NumberSystem.reciprocal. Doc from tech.units.indriya.spi.NumberSystem.reciprocal. 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` Annotations @Override

public Number reciprocal(final Number number)

Implements tech.units.indriya.spi.NumberSystem.reciprocal.

Doc from tech.units.indriya.spi.NumberSystem.reciprocal.

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

Annotations

@Override

signum back to summary

signum	back to summary
public int signum(final Number number) Implements tech.units.indriya.spi.NumberSystem.signum. Doc from tech.units.indriya.spi.NumberSystem.signum. Returns the signum function of given `number`. Returns:int `signum(number)` Annotations @Override

public int signum(final Number number)

Implements tech.units.indriya.spi.NumberSystem.signum.

Doc from tech.units.indriya.spi.NumberSystem.signum.

Returns the signum function of given number.

Returns:int

signum(number)

Annotations

@Override

subtract back to summary

subtract	back to summary
public Number subtract(final Number x, final Number y) Implements tech.units.indriya.spi.NumberSystem.subtract. Doc from tech.units.indriya.spi.NumberSystem.subtract. 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` Annotations @Override

public Number subtract(final Number x, final Number y)

Implements tech.units.indriya.spi.NumberSystem.subtract.

Doc from tech.units.indriya.spi.NumberSystem.subtract.

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

Annotations

@Override

toBigDecimal	back to summary
private BigDecimal toBigDecimal(final Number number)

unexpectedCodeReach	back to summary
private IllegalStateException unexpectedCodeReach()

unsupportedNumberType	back to summary
private IllegalArgumentException unsupportedNumberType(final Number number)

unsupportedNumberValue	back to summary
private IllegalArgumentException unsupportedNumberValue(final Number number)

tech.units.indriya.function back to summary

private sealed Enum DefaultNumberSystem.NumberType

Class Inheritance

extends Enum<DefaultNumberSystem.NumberType>

java.lang.Object
java.lang.Enum
tech.units.indriya.function.DefaultNumberSystem.NumberType

In order of increasing number type 'widening'.

Field Summary

Modifier and Type	Field and Description
public static final DefaultNumberSystem.NumberType	BIG_DECIMAL
public static final DefaultNumberSystem.NumberType	BIG_INTEGER
public static final DefaultNumberSystem.NumberType	BYTE_BOXED
public static final DefaultNumberSystem.NumberType	DOUBLE_BOXED
public static final DefaultNumberSystem.NumberType	FLOAT_BOXED
public static final DefaultNumberSystem.NumberType	INTEGER_ATOMIC
public static final DefaultNumberSystem.NumberType	INTEGER_BOXED
private final boolean	integerOnly
public static final DefaultNumberSystem.NumberType	LONG_ATOMIC
public static final DefaultNumberSystem.NumberType	LONG_BOXED
private final Number	one
public static final DefaultNumberSystem.NumberType	RATIONAL
public static final DefaultNumberSystem.NumberType	SHORT_BOXED
private final Class<? extends Number>	type
private final Number	zero

Constructor Summary

Access	Constructor and Description
private	NumberType(final boolean integerOnly, final Class<? extends Number> type, final Number one, final Number zero)

Method Summary

Modifier and Type	Method and Description
public Class<? extends Number>	getType()
public boolean	isIntegerOnly() Whether the underlying number type can only represent integers.
pack-priv boolean	isZero(Number - must be of type `getType()` number) Whether given `Number` is ZERO.
public static DefaultNumberSystem.NumberType	valueOf(String name)
pack-priv static DefaultNumberSystem.NumberType	valueOf(final Number number)
public static DefaultNumberSystem.NumberType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BIG_DECIMAL	back to summary
public static final DefaultNumberSystem.NumberType BIG_DECIMAL

BIG_INTEGER	back to summary
public static final DefaultNumberSystem.NumberType BIG_INTEGER

BYTE_BOXED	back to summary
public static final DefaultNumberSystem.NumberType BYTE_BOXED

DOUBLE_BOXED	back to summary
public static final DefaultNumberSystem.NumberType DOUBLE_BOXED

FLOAT_BOXED	back to summary
public static final DefaultNumberSystem.NumberType FLOAT_BOXED

INTEGER_ATOMIC	back to summary
public static final DefaultNumberSystem.NumberType INTEGER_ATOMIC

INTEGER_BOXED	back to summary
public static final DefaultNumberSystem.NumberType INTEGER_BOXED

integerOnly	back to summary
private final boolean integerOnly

LONG_ATOMIC	back to summary
public static final DefaultNumberSystem.NumberType LONG_ATOMIC

LONG_BOXED	back to summary
public static final DefaultNumberSystem.NumberType LONG_BOXED

one	back to summary
private final Number one

RATIONAL	back to summary
public static final DefaultNumberSystem.NumberType RATIONAL

SHORT_BOXED	back to summary
public static final DefaultNumberSystem.NumberType SHORT_BOXED

type	back to summary
private final Class<? extends Number> type

zero	back to summary
private final Number zero

Constructor Detail

NumberType	back to summary
private NumberType(final boolean integerOnly, final Class<? extends Number> type, final Number one, final Number zero)

Method Detail

getType	back to summary
public Class<? extends Number> getType() Annotations @SuppressWarnings:unused

isIntegerOnly back to summary

public boolean isIntegerOnly()

Whether the underlying number type can only represent integers.

If false it can also represent fractional numbers.

isZero back to summary

pack-priv boolean isZero(Number number)

Whether given Number is ZERO.

API Note

For class internal use only, such that we have control over the number's type that gets passed in.

Parameters

number:Number: - must be of type getType()

valueOf	back to summary
public static DefaultNumberSystem.NumberType valueOf(String name)

valueOf	back to summary
pack-priv static DefaultNumberSystem.NumberType valueOf(final Number number)

values	back to summary
public static DefaultNumberSystem.NumberType[] values()

public Class DefaultNumberSystem

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private sealed Enum DefaultNumberSystem.NumberType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail