Calculator (Units of Measurement Reference Implementation 2.1.3 API)

java.lang.Object
- tech.units.indriya.internal.function.Calculator

```
@API(status=INTERNAL)
public final class Calculator
extends Object
```
Provides arithmetic on Java Numbers utilizing a provided NumberSystem.

Since:

2.0

Version:

2.1, May 14, 2021

Author:

Andi Huber, Werner Keil

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Calculator`	`abs()` Calculates the absolute value of this `Calculator`´s accumulator, then stores the result in the accumulator.
`Calculator`	`add(Number number)` Adds `number` to this `Calculator`´s accumulator, then stores the result in the accumulator.
`Calculator`	`divide(Number number)` Divides this `Calculator`´s accumulator by `number`, then stores the result in the accumulator.
`Calculator`	`exp()` Calculates Euler's constant taken to the power of this `Calculator`´s accumulator, then stores the result in the accumulator.
`boolean`	`isLessThanOne()`
`Calculator`	`log()` Calculates the natural logarithm of this `Calculator`´s accumulator, then stores the result in the accumulator.
`Calculator`	`multiply(Number number)` Multiplies `number` with this `Calculator`´s accumulator, then stores the result in the accumulator.
`Calculator`	`negate()` Calculates the additive inverse value of this `Calculator`´s accumulator, then stores the result in the accumulator.
`static Calculator`	`of(Number number)` Shortcut for `getDefault().load(number)`.
`Number`	`peek()` Allows to 'peek' at this `Calculator`´s accumulator.
`Calculator`	`power(int exponent)` Takes this `Calculator`´s accumulator to the integer power of `exponent`, then stores the result in the accumulator.
`Calculator`	`reciprocal()` Calculates the multiplicative inverse value of this `Calculator`´s accumulator, then stores the result in the accumulator.
`Calculator`	`subtract(Number number)` Subtracts `number` from this `Calculator`´s accumulator, then stores the result in the accumulator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - of
```
public static Calculator of(Number number)
```
    Shortcut for getDefault().load(number). See getInstance() and load(Number)
    
    Parameters:
    
    number -
    
    Returns:
    
    default Calculator with number loaded into its accumulator
  - add
```
public Calculator add(Number number)
```
    Adds number to this Calculator´s accumulator, then stores the result in the accumulator.
    
    Parameters:
    
    number -
    
    Returns:
    
    self
  - subtract
```
public Calculator subtract(Number number)
```
    Subtracts number from this Calculator´s accumulator, then stores the result in the accumulator.
    
    Parameters:
    
    number -
    
    Returns:
    
    self
  - multiply
```
public Calculator multiply(Number number)
```
    Multiplies number with this Calculator´s accumulator, then stores the result in the accumulator.
    
    Parameters:
    
    number -
    
    Returns:
    
    self
  - divide
```
public Calculator divide(Number number)
```
    Divides this Calculator´s accumulator by number, then stores the result in the accumulator.
    
    Parameters:
    
    number -
    
    Returns:
    
    self
  - power
```
public Calculator power(int exponent)
```
    Takes this Calculator´s accumulator to the integer power of exponent, then stores the result in the accumulator.
    
    Parameters:
    
    exponent -
    
    Returns:
    
    self
  - abs
```
public Calculator abs()
```
    Calculates the absolute value of this Calculator´s accumulator, then stores the result in the accumulator.
    
    Returns:
    
    self
  - negate
```
public Calculator negate()
```
    Calculates the additive inverse value of this Calculator´s accumulator, then stores the result in the accumulator.
    
    Returns:
    
    self
  - reciprocal
```
public Calculator reciprocal()
```
    Calculates the multiplicative inverse value of this Calculator´s accumulator, then stores the result in the accumulator.
    
    Returns:
    
    self
  - exp
```
public Calculator exp()
```
    Calculates Euler's constant taken to the power of this Calculator´s accumulator, then stores the result in the accumulator.
    
    Returns:
    
    self
  - log
```
public Calculator log()
```
    Calculates the natural logarithm of this Calculator´s accumulator, then stores the result in the accumulator.
    
    Returns:
    
    self
  - peek
```
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:
    
    a narrowed version of this Calculator´s accumulator
  - isLessThanOne
```
public boolean isLessThanOne()
```
    Returns:
    
    whether this Calculator´s accumulator is less than ONE

Class Calculator

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

add

subtract

multiply

divide

power

abs

negate

reciprocal

exp

log

peek

isLessThanOne