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

Modifier and Type	Field and Description
private Number	acc
private final NumberSystem	ns

Access	Constructor and Description
private	Calculator(NumberSystem the `NumberSystem` ns) Returns a new instance of a `Calculator` initialized with the given `NumberSystem`.
private	Calculator() Returns a new instance of a `Calculator` initialized with the default `NumberSystem`, as set at `Calculus#currentNumberSystem()` This implementation is not thread-safe, hence threads should not share instances of this.

Method Summary

Modifier and Type	Method and Description
public Calculator	Returns: self abs() Calculates the absolute value of this `Calculator`´s accumulator, then stores the result in the accumulator.
public Calculator	Returns: self add(Number number) Adds `number` to this `Calculator`´s accumulator, then stores the result in the accumulator.
public Calculator	Returns: self divide(Number number) Divides this `Calculator`´s accumulator by `number`, then stores the result in the accumulator.
public Calculator	Returns: self exp() Calculates Euler's constant taken to the power of this `Calculator`´s accumulator, then stores the result in the accumulator.
private static Calculator	Returns: a `Calculator` initialized with the default `NumberSystem` getInstance() Returns a new instance of a `Calculator` initialized with the default `NumberSystem`, as set at `Calculus#currentNumberSystem()` This implementation is not thread-safe, hence threads should not share instances of this.
public boolean	Returns: whether this `Calculator`´s accumulator is less than ONE isLessThanOne()
private Calculator	Returns: self load(Number number) Loads `number` into this `Calculator`´s accumulator.
public Calculator	Returns: self log() Calculates the natural logarithm of this `Calculator`´s accumulator, then stores the result in the accumulator.
public Calculator	Returns: self multiply(Number number) Multiplies `number` with this `Calculator`´s accumulator, then stores the result in the accumulator.
public Calculator	Returns: self negate() Calculates the additive inverse value of this `Calculator`´s accumulator, then stores the result in the accumulator.
public static Calculator	Returns: default `Calculator` with `number` loaded into its accumulator of(Number number) Shortcut for `getDefault().load(number)`.
public Number	Returns: a narrowed version of this `Calculator`´s accumulator peek() Allows to 'peek' at this `Calculator`´s accumulator.
public Calculator	Returns: self power(int exponent) Takes this `Calculator`´s accumulator to the integer power of `exponent`, then stores the result in the accumulator.
public Calculator	Returns: self reciprocal() Calculates the multiplicative inverse value of this `Calculator`´s accumulator, then stores the result in the accumulator.
public Calculator	Returns: self subtract(Number number) Subtracts `number` from this `Calculator`´s accumulator, then stores the result in the accumulator.

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

acc	back to summary
private Number acc

ns	back to summary
private final NumberSystem ns

Calculator	back to summary
private Calculator(NumberSystem ns) Returns a new instance of a `Calculator` initialized with the given `NumberSystem`. Parameters ns:NumberSystem the `NumberSystem`

Calculator	back to summary
private Calculator() Returns a new instance of a `Calculator` initialized with the default `NumberSystem`, as set at `Calculus#currentNumberSystem()` This implementation is not thread-safe, hence threads should not share instances of this.

Method Detail

abs back to summary

abs	back to summary
public Calculator abs() Calculates the absolute value of this `Calculator`´s accumulator, then stores the result in the accumulator. Returns:Calculator self

public Calculator abs()

Calculates the absolute value of this Calculator´s accumulator, then stores the result in the accumulator.

Returns:Calculator: self

add back to summary

add	back to summary
public Calculator add(Number number) Adds `number` to this `Calculator`´s accumulator, then stores the result in the accumulator. Returns:Calculator self

public Calculator add(Number number)

Adds number to this Calculator´s accumulator, then stores the result in the accumulator.

Returns:Calculator: self

divide back to summary

divide	back to summary
public Calculator divide(Number number) Divides this `Calculator`´s accumulator by `number`, then stores the result in the accumulator. Returns:Calculator self

public Calculator divide(Number number)

Divides this Calculator´s accumulator by number, then stores the result in the accumulator.

Returns:Calculator: self

exp back to summary

exp	back to summary
public Calculator exp() Calculates Euler's constant taken to the power of this `Calculator`´s accumulator, then stores the result in the accumulator. Returns:Calculator self

public Calculator exp()

Calculates Euler's constant taken to the power of this Calculator´s accumulator, then stores the result in the accumulator.

Returns:Calculator: self

getInstance back to summary

getInstance	back to summary
private static Calculator getInstance() Returns a new instance of a `Calculator` initialized with the default `NumberSystem`, as set at `Calculus#currentNumberSystem()` This implementation is not thread-safe, hence threads should not share instances of this. Returns:Calculator a `Calculator` initialized with the default `NumberSystem`

private static Calculator getInstance()

Returns a new instance of a Calculator initialized with the default NumberSystem, as set at Calculus#currentNumberSystem()

This implementation is *not* thread-safe, hence threads should not share instances of this.

Returns:Calculator: a Calculator initialized with the default NumberSystem

isLessThanOne	back to summary
public boolean isLessThanOne() Returns:boolean whether this `Calculator`´s accumulator is less than ONE

load back to summary

load	back to summary
private Calculator load(Number number) Loads `number` into this `Calculator`´s accumulator. Returns:Calculator self

private Calculator load(Number number)

Loads number into this Calculator´s accumulator.

Returns:Calculator: self

log back to summary

log	back to summary
public Calculator log() Calculates the natural logarithm of this `Calculator`´s accumulator, then stores the result in the accumulator. Returns:Calculator self

public Calculator log()

Calculates the natural logarithm of this Calculator´s accumulator, then stores the result in the accumulator.

Returns:Calculator: self

multiply back to summary

multiply	back to summary
public Calculator multiply(Number number) Multiplies `number` with this `Calculator`´s accumulator, then stores the result in the accumulator. Returns:Calculator self

public Calculator multiply(Number number)

Multiplies number with this Calculator´s accumulator, then stores the result in the accumulator.

Returns:Calculator: self

negate back to summary

negate	back to summary
public Calculator negate() Calculates the additive inverse value of this `Calculator`´s accumulator, then stores the result in the accumulator. Returns:Calculator self

public Calculator negate()

Calculates the additive inverse value of this Calculator´s accumulator, then stores the result in the accumulator.

Returns:Calculator: self

of back to summary

of	back to summary
public static Calculator of(Number number) Shortcut for `getDefault().load(number)`. See `getInstance()` and `load(Number)` Returns:Calculator default `Calculator` with `number` loaded into its accumulator

public static Calculator of(Number number)

Shortcut for getDefault().load(number). See getInstance() and load(Number)

Returns:Calculator: default Calculator with number loaded into its accumulator

peek back to summary

peek	back to summary
public Number peek() Allows to 'peek' at this `Calculator`´s accumulator. The `Number` returned is narrowed to best represent the numerical value w/o loss of precision within the `NumberSystem` as configured for this `Calculator` instance. Returns:Number a narrowed version of this `Calculator`´s accumulator

public Number peek()

Allows to 'peek' at this Calculator´s accumulator. The Number returned is narrowed to best represent the numerical value w/o loss of precision within the NumberSystem as configured for this Calculator instance.

Returns:Number: a narrowed version of this Calculator´s accumulator

power back to summary

power	back to summary
public Calculator power(int exponent) Takes this `Calculator`´s accumulator to the integer power of `exponent`, then stores the result in the accumulator. Returns:Calculator self

public Calculator power(int exponent)

Takes this Calculator´s accumulator to the integer power of exponent, then stores the result in the accumulator.

Returns:Calculator: self

reciprocal back to summary

reciprocal	back to summary
public Calculator reciprocal() Calculates the multiplicative inverse value of this `Calculator`´s accumulator, then stores the result in the accumulator. Returns:Calculator self

public Calculator reciprocal()

Calculates the multiplicative inverse value of this Calculator´s accumulator, then stores the result in the accumulator.

Returns:Calculator: self

subtract back to summary

subtract	back to summary
public Calculator subtract(Number number) Subtracts `number` from this `Calculator`´s accumulator, then stores the result in the accumulator. Returns:Calculator self

public Calculator subtract(Number number)

Subtracts number from this Calculator´s accumulator, then stores the result in the accumulator.

Returns:Calculator: self

public final Class Calculator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail