MathFunctions (common 2.5.1 API)

java.lang.Object
- com.elikill58.negativity.api.maths.mathcollection.MathFunctions

```
public final class MathFunctions
extends Object
```
MathFunctions - the most popular math functions. Many of function implemented by this class could be found in java Math package (in fact functions from MathFunctions typically calls original functions from the Math package). The reason why it was "re-implemented" is: if you decide to implement your own function you do not need to change anything in the parser, jut modify function implementation in this class.

Constructor Summary

Constructors
Constructor and Description

MathFunctions()

Constructors
Constructor and Description
`MathFunctions()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`abs(double a)`
`static int`	`decimalDigitsBefore(double value)` For very small number returns the position of first significant digit, ie 0.1 = 1, 0.01 = 2
`static double`	`div(double a, double b)` Division a / b applying canonical rounding if canonical rounding is enabled
`static double`	`factorial(double n)` Factorial
`static double`	`factorial(int n)` Factorial
`static double`	`floor(double a)` Floor function.
`static boolean`	`isInteger(double x)` Check whether double value is almost integer.
`static double`	`ln(double a)` Natural logarithm
`static double`	`minus(double a, double b)` Subtraction a - b applying canonical rounding if canonical rounding is enabled
`static double`	`mod(double a, double b)` Modulo operator a % b
`static double`	`multiply(double a, double b)` Multiplication a * b applying canonical rounding if canonical rounding is enabled
`static double`	`plus(double a, double b)` Addition a + b applying canonical rounding if canonical rounding is enabled
`static double`	`power(double a, double b)` Power function a^b
`static double`	`round(double value, int places)` Double rounding
`static double`	`sqrt(double a)` Square root.
`static double`	`tetration(double a, double n)` Tetration, exponential power, power series
`static double`	`ulp(double value)` Unit in the last place(ULP) for double
`static int`	`ulpDecimalDigitsBefore(double value)` Unit in The Last Place - number of decimal digits before

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

- Constructor Detail
  - MathFunctions
```
public MathFunctions()
```
- Method Detail
  - plus
```
public static final double plus(double a,
                                double b)
```
    Addition a + b applying canonical rounding if canonical rounding is enabled
    
    Parameters:
    
    a - The a parameter
    
    b - The b parameter
    
    Returns:
    
    The result of addition
  - minus
```
public static final double minus(double a,
                                 double b)
```
    Subtraction a - b applying canonical rounding if canonical rounding is enabled
    
    Parameters:
    
    a - The a parameter
    
    b - The b parameter
    
    Returns:
    
    The result of subtraction
  - multiply
```
public static final double multiply(double a,
                                    double b)
```
    Multiplication a * b applying canonical rounding if canonical rounding is enabled
    
    Parameters:
    
    a - The a parameter
    
    b - The b parameter
    
    Returns:
    
    The result of multiplication
  - div
```
public static final double div(double a,
                               double b)
```
    Division a / b applying canonical rounding if canonical rounding is enabled
    
    Parameters:
    
    a - The a parameter
    
    b - The b parameter
    
    Returns:
    
    The result of division
  - abs
```
public static final double abs(double a)
```
  - factorial
```
public static final double factorial(int n)
```
    Factorial
    
    Parameters:
    
    n - the n function parameter
    
    Returns:
    
    Factorial if n >=0, otherwise returns Double.NaN.
  - factorial
```
public static final double factorial(double n)
```
    Factorial
    
    Parameters:
    
    n - the n function parameter
    
    Returns:
    
    if n <> Double.NaN return factorial( (int)Math.round(n) ), otherwise returns Double.NaN.
  - power
```
public static final double power(double a,
                                 double b)
```
    Power function a^b
    
    Parameters:
    
    a - the a function parameter
    
    b - the b function parameter
    
    Returns:
    
    if a,b <> Double.NaN returns Math.pow(a, b), otherwise returns Double.NaN.
  - tetration
```
public static final double tetration(double a,
                                     double n)
```
    Tetration, exponential power, power series
    
    Parameters:
    
    a - base
    
    n - exponent
    
    Returns:
    
    Tetration result.
  - mod
```
public static final double mod(double a,
                               double b)
```
    Modulo operator a % b
    
    Parameters:
    
    a - the a function parameter
    
    b - the b function parameter
    
    Returns:
    
    if a,b <> Double.NaN returns a % b.
  - ln
```
public static final double ln(double a)
```
    Natural logarithm
    
    Parameters:
    
    a - the a function parameter
    
    Returns:
    
    if a <> Double.NaN returns Math.log(1/a), otherwise returns Double.NaN.
  - sqrt
```
public static final double sqrt(double a)
```
    Square root.
    
    Parameters:
    
    a - the a function parameter
    
    Returns:
    
    if a <> Double.NaN returns Math.sqrt(a), otherwise returns Double.NaN.
  - floor
```
public static final double floor(double a)
```
    Floor function.
    
    Parameters:
    
    a - the a function parameter
    
    Returns:
    
    if a <> Double.NaN returns Math.floor(a), otherwise returns Double.NaN.
  - round
```
public static final double round(double value,
                                 int places)
```
    Double rounding
    
    Parameters:
    
    value - double value to be rounded
    
    places - decimal places
    
    Returns:
    
    Rounded value
  - decimalDigitsBefore
```
public static final int decimalDigitsBefore(double value)
```
    For very small number returns the position of first significant digit, ie 0.1 = 1, 0.01 = 2
    
    Parameters:
    
    value - Double value, small one.
    
    Returns:
    
    Number of digits, number of places.
  - ulp
```
public static final double ulp(double value)
```
    Unit in the last place(ULP) for double
    
    Parameters:
    
    value - Double number
    
    Returns:
    
    ULP for a given double.
  - ulpDecimalDigitsBefore
```
public static final int ulpDecimalDigitsBefore(double value)
```
    Unit in The Last Place - number of decimal digits before
    
    Parameters:
    
    value - Double number
    
    Returns:
    
    Positive number of digits N for ulp = 1e-{N+1}, if ulp is > 1 then -1 is returned. Returned proper value is always between -1 and +322. If value is NaN then -2 is returned.
  - isInteger
```
public static final boolean isInteger(double x)
```
    Check whether double value is almost integer.
    
    Parameters:
    
    x - Number
    
    Returns:
    
    True if double value is almost integer, otherwise false. BinaryRelations.DEFAULT_COMPARISON_EPSILON
    
    See Also:
    
    BinaryRelations.DEFAULT_COMPARISON_EPSILON

Class MathFunctions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MathFunctions

Method Detail

plus

minus

multiply

div

abs

factorial

factorial

power

tetration

mod

ln

sqrt

floor

round

decimalDigitsBefore

ulp

ulpDecimalDigitsBefore

isInteger