FastestMathLibWrapper (patrius 4.3 API)

java.lang.Object
- fr.cnes.sirius.patrius.math.framework.FastestMathLibWrapper

All Implemented Interfaces:

MathLibrary
```
public class FastestMathLibWrapper
extends Object
implements MathLibrary
```
This implementation encapsulates for each math method the fastest methods among:
- FastMath
- FastMath
- StrictFastMath
Since:

4.2

Author:

Emmanuel Bignon

Constructor Summary

Constructors
Constructor and Description

FastestMathLibWrapper()

Constructors
Constructor and Description
`FastestMathLibWrapper()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`abs(double x)` Absolute value.
`float`	`abs(float x)` Absolute value.
`int`	`abs(int x)` Absolute value.
`long`	`abs(long x)` Absolute value.
`double`	`acos(double x)` Compute the arc cosine of a number.
`double`	`acosh(double a)` Compute the inverse hyperbolic cosine of a number.
`double`	`asin(double x)` Compute the arc sine of a number.
`double`	`asinh(double a)` Compute the inverse hyperbolic sine of a number.
`double`	`atan(double x)` Arctangent function
`double`	`atan2(double y, double x)` Two arguments arctangent function
`double`	`atanh(double a)` Compute the inverse hyperbolic tangent of a number.
`double`	`cbrt(double x)` Compute the cubic root of a number.
`double`	`ceil(double x)` Get the smallest whole number larger than x.
`double`	`copySign(double magnitude, double sign)` Returns the first argument with the sign of the second argument.
`float`	`copySign(float magnitude, float sign)` Returns the first argument with the sign of the second argument.
`double`	`cos(double x)` Cosine function.
`double`	`cosh(double x)` Compute the hyperbolic cosine of a number.
`double`	`exp(double x)` Exponential function.
`double`	`expm1(double x)` Compute exp(x) - 1
`double`	`floor(double x)` Get the largest whole number smaller than x.
`int`	`getExponent(double d)` Return the exponent of a double number, removing the bias.
`int`	`getExponent(float f)` Return the exponent of a float number, removing the bias.
`double`	`hypot(double x, double y)` Returns the hypotenuse of a triangle with sides `x` and `y` - sqrt(x² +y²) avoiding intermediate overflow or underflow.
`double`	`IEEEremainder(double dividend, double divisor)` Computes the remainder as prescribed by the IEEE 754 standard.
`double`	`log(double x)` Natural logarithm.
`double`	`log10(double x)` Compute the base 10 logarithm.
`double`	`log1p(double x)` Computes log(1 + x).
`double`	`max(double a, double b)` Compute the maximum of two values
`float`	`max(float a, float b)` Compute the maximum of two values
`int`	`max(int a, int b)` Compute the maximum of two values
`long`	`max(long a, long b)` Compute the maximum of two values
`double`	`min(double a, double b)` Compute the minimum of two values
`float`	`min(float a, float b)` Compute the minimum of two values
`int`	`min(int a, int b)` Compute the minimum of two values
`long`	`min(long a, long b)` Compute the minimum of two values
`double`	`nextAfter(double d, double direction)` Get the next machine representable number after a number, moving in the direction of another number.
`float`	`nextAfter(float f, double direction)` Get the next machine representable number after a number, moving in the direction of another number.
`double`	`nextUp(double a)` Compute next number towards positive infinity.
`float`	`nextUp(float a)` Compute next number towards positive infinity.
`double`	`pow(double x, double y)` Power function.
`double`	`pow(double d, int e)` Raise a double to an int power.
`double`	`random()` Returns a pseudo-random number between 0.0 and 1.0.
`double`	`rint(double x)` Get the whole number that is the nearest to x, or the even one if x is exactly half way between two integers.
`long`	`round(double x)` Get the closest long to x.
`int`	`round(float x)` Get the closest int to x.
`double`	`scalb(double d, int n)` Multiply a double number by a power of 2.
`float`	`scalb(float f, int n)` Multiply a float number by a power of 2.
`double`	`signum(double a)` Compute the signum of a number.
`float`	`signum(float a)` Compute the signum of a number.
`double`	`sin(double x)` Sine function.
`double`	`sinh(double x)` Compute the hyperbolic sine of a number.
`double`	`sqrt(double a)` Compute the square root of a number.
`double`	`tan(double x)` Tangent function.
`double`	`tanh(double x)` Compute the hyperbolic tangent of a number.
`double`	`toDegrees(double x)` Convert radians to degrees, with error of less than 0.5 ULP
`double`	`toRadians(double x)` Convert degrees to radians, with error of less than 0.5 ULP
`double`	`ulp(double x)` Compute least significant bit (Unit in Last Position) for a number.
`float`	`ulp(float x)` Compute least significant bit (Unit in Last Position) for a number.

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

- Constructor Detail
  - FastestMathLibWrapper
```
public FastestMathLibWrapper()
```
- Method Detail
  - sqrt
```
public double sqrt(double a)
```
    Compute the square root of a number.
    
    Specified by:
    
    sqrt in interface MathLibrary
    
    Parameters:
    
    a - number on which evaluation is done
    
    Returns:
    
    square root of a
  - cosh
```
public double cosh(double x)
```
    Compute the hyperbolic cosine of a number.
    
    Specified by:
    
    cosh in interface MathLibrary
    
    Parameters:
    
    x - number on which evaluation is done
    
    Returns:
    
    hyperbolic cosine of x
  - sinh
```
public double sinh(double x)
```
    Compute the hyperbolic sine of a number.
    
    Specified by:
    
    sinh in interface MathLibrary
    
    Parameters:
    
    x - number on which evaluation is done
    
    Returns:
    
    hyperbolic sine of x
  - tanh
```
public double tanh(double x)
```
    Compute the hyperbolic tangent of a number.
    
    Specified by:
    
    tanh in interface MathLibrary
    
    Parameters:
    
    x - number on which evaluation is done
    
    Returns:
    
    hyperbolic tangent of x
  - acosh
```
public double acosh(double a)
```
    Compute the inverse hyperbolic cosine of a number.
    
    Specified by:
    
    acosh in interface MathLibrary
    
    Parameters:
    
    a - number on which evaluation is done
    
    Returns:
    
    inverse hyperbolic cosine of a
  - asinh
```
public double asinh(double a)
```
    Compute the inverse hyperbolic sine of a number.
    
    Specified by:
    
    asinh in interface MathLibrary
    
    Parameters:
    
    a - number on which evaluation is done
    
    Returns:
    
    inverse hyperbolic sine of a
  - atanh
```
public double atanh(double a)
```
    Compute the inverse hyperbolic tangent of a number.
    
    Specified by:
    
    atanh in interface MathLibrary
    
    Parameters:
    
    a - number on which evaluation is done
    
    Returns:
    
    inverse hyperbolic tangent of a
  - signum
```
public double signum(double a)
```
    Compute the signum of a number. The signum is -1 for negative numbers, +1 for positive numbers and 0 otherwise
    
    Specified by:
    
    signum in interface MathLibrary
    
    Parameters:
    
    a - number on which evaluation is done
    
    Returns:
    
    -1.0, -0.0, +0.0, +1.0 or NaN depending on sign of a
  - signum
```
public float signum(float a)
```
    Compute the signum of a number. The signum is -1 for negative numbers, +1 for positive numbers and 0 otherwise
    
    Specified by:
    
    signum in interface MathLibrary
    
    Parameters:
    
    a - number on which evaluation is done
    
    Returns:
    
    -1.0, -0.0, +0.0, +1.0 or NaN depending on sign of a
  - nextUp
```
public double nextUp(double a)
```
    Compute next number towards positive infinity.
    
    Specified by:
    
    nextUp in interface MathLibrary
    
    Parameters:
    
    a - number to which neighbor should be computed
    
    Returns:
    
    neighbor of a towards positive infinity
  - nextUp
```
public float nextUp(float a)
```
    Compute next number towards positive infinity.
    
    Specified by:
    
    nextUp in interface MathLibrary
    
    Parameters:
    
    a - number to which neighbor should be computed
    
    Returns:
    
    neighbor of a towards positive infinity
  - random
```
public double random()
```
    Returns a pseudo-random number between 0.0 and 1.0.
    
    Specified by:
    
    random in interface MathLibrary
    
    Returns:
    
    a random number between 0.0 and 1.0
  - exp
```
public double exp(double x)
```
    Exponential function. Computes exp(x), function result is nearly rounded. It will be correctly rounded to the theoretical value for 99.9% of input values, otherwise it will have a 1 UPL error. Method: Lookup intVal = exp(int(x)) Lookup fracVal = exp(int(x-int(x) / 1024.0) * 1024.0 ); Compute z as the exponential of the remaining bits by a polynomial minus one exp(x) = intVal * fracVal * (1 + z) Accuracy: Calculation is done with 63 bits of precision, so result should be correctly rounded for 99.9% of input values, with less than 1 ULP error otherwise.
    
    Specified by:
    
    exp in interface MathLibrary
    
    Parameters:
    
    x - a double
    
    Returns:
    
    double e^x
  - expm1
```
public double expm1(double x)
```
    Compute exp(x) - 1
    
    Specified by:
    
    expm1 in interface MathLibrary
    
    Parameters:
    
    x - number to compute shifted exponential
    
    Returns:
    
    exp(x) - 1
  - log
```
public double log(double x)
```
    Natural logarithm.
    
    Specified by:
    
    log in interface MathLibrary
    
    Parameters:
    
    x - a double
    
    Returns:
    
    log(x)
  - log1p
```
public double log1p(double x)
```
    Computes log(1 + x).
    
    Specified by:
    
    log1p in interface MathLibrary
    
    Parameters:
    
    x - Number.
    
    Returns:
    
    log(1 + x).
  - log10
```
public double log10(double x)
```
    Compute the base 10 logarithm.
    
    Specified by:
    
    log10 in interface MathLibrary
    
    Parameters:
    
    x - a number
    
    Returns:
    
    log10(x)
  - pow
```
public double pow(double x,
                  double y)
```
    Power function. Compute x^y.
    
    Specified by:
    
    pow in interface MathLibrary
    
    Parameters:
    
    x - a double
    
    y - a double
    
    Returns:
    
    double
  - pow
```
public double pow(double d,
                  int e)
```
    Raise a double to an int power.
    
    Specified by:
    
    pow in interface MathLibrary
    
    Parameters:
    
    d - Number to raise.
    
    e - Exponent.
    
    Returns:
    
    d^e
  - sin
```
public double sin(double x)
```
    Sine function.
    
    Specified by:
    
    sin in interface MathLibrary
    
    Parameters:
    
    x - Argument.
    
    Returns:
    
    sin(x)
  - cos
```
public double cos(double x)
```
    Cosine function.
    
    Specified by:
    
    cos in interface MathLibrary
    
    Parameters:
    
    x - Argument.
    
    Returns:
    
    cos(x)
  - tan
```
public double tan(double x)
```
    Tangent function.
    
    Specified by:
    
    tan in interface MathLibrary
    
    Parameters:
    
    x - Argument.
    
    Returns:
    
    tan(x)
  - atan
```
public double atan(double x)
```
    Arctangent function
    
    Specified by:
    
    atan in interface MathLibrary
    
    Parameters:
    
    x - a number
    
    Returns:
    
    atan(x)
  - atan2
```
public double atan2(double y,
                    double x)
```
    Two arguments arctangent function
    
    Specified by:
    
    atan2 in interface MathLibrary
    
    Parameters:
    
    y - ordinate
    
    x - abscissa
    
    Returns:
    
    phase angle of point (x,y) between -PI and PI
  - asin
```
public double asin(double x)
```
    Compute the arc sine of a number.
    
    Specified by:
    
    asin in interface MathLibrary
    
    Parameters:
    
    x - number on which evaluation is done
    
    Returns:
    
    arc sine of x
  - acos
```
public double acos(double x)
```
    Compute the arc cosine of a number.
    
    Specified by:
    
    acos in interface MathLibrary
    
    Parameters:
    
    x - number on which evaluation is done
    
    Returns:
    
    arc cosine of x
  - cbrt
```
public double cbrt(double x)
```
    Compute the cubic root of a number.
    
    Specified by:
    
    cbrt in interface MathLibrary
    
    Parameters:
    
    x - number on which evaluation is done
    
    Returns:
    
    cubic root of x
  - toRadians
```
public double toRadians(double x)
```
    Convert degrees to radians, with error of less than 0.5 ULP
    
    Specified by:
    
    toRadians in interface MathLibrary
    
    Parameters:
    
    x - angle in degrees
    
    Returns:
    
    x converted into radians
  - toDegrees
```
public double toDegrees(double x)
```
    Convert radians to degrees, with error of less than 0.5 ULP
    
    Specified by:
    
    toDegrees in interface MathLibrary
    
    Parameters:
    
    x - angle in radians
    
    Returns:
    
    x converted into degrees
  - abs
```
public int abs(int x)
```
    Absolute value.
    
    Specified by:
    
    abs in interface MathLibrary
    
    Parameters:
    
    x - number from which absolute value is requested
    
    Returns:
    
    abs(x)
  - abs
```
public long abs(long x)
```
    Absolute value.
    
    Specified by:
    
    abs in interface MathLibrary
    
    Parameters:
    
    x - number from which absolute value is requested
    
    Returns:
    
    abs(x)
  - abs
```
public float abs(float x)
```
    Absolute value.
    
    Specified by:
    
    abs in interface MathLibrary
    
    Parameters:
    
    x - number from which absolute value is requested
    
    Returns:
    
    abs(x)
  - abs
```
public double abs(double x)
```
    Absolute value.
    
    Specified by:
    
    abs in interface MathLibrary
    
    Parameters:
    
    x - number from which absolute value is requested
    
    Returns:
    
    abs(x)
  - ulp
```
public double ulp(double x)
```
    Compute least significant bit (Unit in Last Position) for a number.
    
    Specified by:
    
    ulp in interface MathLibrary
    
    Parameters:
    
    x - number from which ulp is requested
    
    Returns:
    
    ulp(x)
  - ulp
```
public float ulp(float x)
```
    Compute least significant bit (Unit in Last Position) for a number.
    
    Specified by:
    
    ulp in interface MathLibrary
    
    Parameters:
    
    x - number from which ulp is requested
    
    Returns:
    
    ulp(x)
  - scalb
```
public double scalb(double d,
                    int n)
```
    Multiply a double number by a power of 2.
    
    Specified by:
    
    scalb in interface MathLibrary
    
    Parameters:
    
    d - number to multiply
    
    n - power of 2
    
    Returns:
    
    d × 2ⁿ
  - scalb
```
public float scalb(float f,
                   int n)
```
    Multiply a float number by a power of 2.
    
    Specified by:
    
    scalb in interface MathLibrary
    
    Parameters:
    
    f - number to multiply
    
    n - power of 2
    
    Returns:
    
    f × 2ⁿ
  - nextAfter
```
public double nextAfter(double d,
                        double direction)
```
    Get the next machine representable number after a number, moving in the direction of another number.
    The ordering is as follows (increasing):
    - -INFINITY
    - -MAX_VALUE
    - -MIN_VALUE
    - -0.0
    - +0.0
    - +MIN_VALUE
    - +MAX_VALUE
    - +INFINITY
    Specified by:
    
    nextAfter in interface MathLibrary
    
    Parameters:
    
    d - base number
    
    direction - (the only important thing is whether direction is greater or smaller than d)
    
    Returns:
    
    the next machine representable number in the specified direction
  - nextAfter
```
public float nextAfter(float f,
                       double direction)
```
    Get the next machine representable number after a number, moving in the direction of another number.
    The ordering is as follows (increasing):
    - -INFINITY
    - -MAX_VALUE
    - -MIN_VALUE
    - -0.0
    - +0.0
    - +MIN_VALUE
    - +MAX_VALUE
    - +INFINITY
    Specified by:
    
    nextAfter in interface MathLibrary
    
    Parameters:
    
    f - base number
    
    direction - (the only important thing is whether direction is greater or smaller than f)
    
    Returns:
    
    the next machine representable number in the specified direction
  - floor
```
public double floor(double x)
```
    Get the largest whole number smaller than x.
    
    Specified by:
    
    floor in interface MathLibrary
    
    Parameters:
    
    x - number from which floor is requested
    
    Returns:
    
    a double number f such that f is an integer f <= x < f + 1.0
  - ceil
```
public double ceil(double x)
```
    Get the smallest whole number larger than x.
    
    Specified by:
    
    ceil in interface MathLibrary
    
    Parameters:
    
    x - number from which ceil is requested
    
    Returns:
    
    a double number c such that c is an integer c - 1.0 < x <= c
  - rint
```
public double rint(double x)
```
    Get the whole number that is the nearest to x, or the even one if x is exactly half way between two integers.
    
    Specified by:
    
    rint in interface MathLibrary
    
    Parameters:
    
    x - number from which nearest whole number is requested
    
    Returns:
    
    a double number r such that r is an integer r - 0.5 <= x <= r + 0.5
  - round
```
public long round(double x)
```
    Get the closest long to x.
    
    Specified by:
    
    round in interface MathLibrary
    
    Parameters:
    
    x - number from which closest long is requested
    
    Returns:
    
    closest long to x
  - round
```
public int round(float x)
```
    Get the closest int to x.
    
    Specified by:
    
    round in interface MathLibrary
    
    Parameters:
    
    x - number from which closest int is requested
    
    Returns:
    
    closest int to x
  - min
```
public int min(int a,
               int b)
```
    Compute the minimum of two values
    
    Specified by:
    
    min in interface MathLibrary
    
    Parameters:
    
    a - first value
    
    b - second value
    
    Returns:
    
    a if a is lesser or equal to b, b otherwise
  - min
```
public long min(long a,
                long b)
```
    Compute the minimum of two values
    
    Specified by:
    
    min in interface MathLibrary
    
    Parameters:
    
    a - first value
    
    b - second value
    
    Returns:
    
    a if a is lesser or equal to b, b otherwise
  - min
```
public float min(float a,
                 float b)
```
    Compute the minimum of two values
    
    Specified by:
    
    min in interface MathLibrary
    
    Parameters:
    
    a - first value
    
    b - second value
    
    Returns:
    
    a if a is lesser or equal to b, b otherwise
  - min
```
public double min(double a,
                  double b)
```
    Compute the minimum of two values
    
    Specified by:
    
    min in interface MathLibrary
    
    Parameters:
    
    a - first value
    
    b - second value
    
    Returns:
    
    a if a is lesser or equal to b, b otherwise
  - max
```
public int max(int a,
               int b)
```
    Compute the maximum of two values
    
    Specified by:
    
    max in interface MathLibrary
    
    Parameters:
    
    a - first value
    
    b - second value
    
    Returns:
    
    b if a is lesser or equal to b, a otherwise
  - max
```
public long max(long a,
                long b)
```
    Compute the maximum of two values
    
    Specified by:
    
    max in interface MathLibrary
    
    Parameters:
    
    a - first value
    
    b - second value
    
    Returns:
    
    b if a is lesser or equal to b, a otherwise
  - max
```
public float max(float a,
                 float b)
```
    Compute the maximum of two values
    
    Specified by:
    
    max in interface MathLibrary
    
    Parameters:
    
    a - first value
    
    b - second value
    
    Returns:
    
    b if a is lesser or equal to b, a otherwise
  - max
```
public double max(double a,
                  double b)
```
    Compute the maximum of two values
    
    Specified by:
    
    max in interface MathLibrary
    
    Parameters:
    
    a - first value
    
    b - second value
    
    Returns:
    
    b if a is lesser or equal to b, a otherwise
  - hypot
```
public double hypot(double x,
                    double y)
```
    Returns the hypotenuse of a triangle with sides x and y - sqrt(x² +y²)
    avoiding intermediate overflow or underflow.
    - If either argument is infinite, then the result is positive infinity.
    - else, if either argument is NaN then the result is NaN.
    Specified by:
    
    hypot in interface MathLibrary
    
    Parameters:
    
    x - a value
    
    y - a value
    
    Returns:
    
    sqrt(x² +y²)
  - IEEEremainder
```
public double IEEEremainder(double dividend,
                            double divisor)
```
    Computes the remainder as prescribed by the IEEE 754 standard. The remainder value is mathematically equal to x - y*n where n is the mathematical integer closest to the exact mathematical value of the quotient x/y. If two mathematical integers are equally close to x/y then n is the integer that is even.
    - If either operand is NaN, the result is NaN.
    - If the result is not NaN, the sign of the result equals the sign of the dividend.
    - If the dividend is an infinity, or the divisor is a zero, or both, the result is NaN.
    - If the dividend is finite and the divisor is an infinity, the result equals the dividend.
    - If the dividend is a zero and the divisor is finite, the result equals the dividend.
    Specified by:
    
    IEEEremainder in interface MathLibrary
    
    Parameters:
    
    dividend - the number to be divided
    
    divisor - the number by which to divide
    
    Returns:
    
    the remainder, rounded
  - copySign
```
public double copySign(double magnitude,
                       double sign)
```
    Returns the first argument with the sign of the second argument. A NaN sign argument is treated as positive.
    
    Specified by:
    
    copySign in interface MathLibrary
    
    Parameters:
    
    magnitude - the value to return
    
    sign - the sign for the returned value
    
    Returns:
    
    the magnitude with the same sign as the sign argument
  - copySign
```
public float copySign(float magnitude,
                      float sign)
```
    Returns the first argument with the sign of the second argument. A NaN sign argument is treated as positive.
    
    Specified by:
    
    copySign in interface MathLibrary
    
    Parameters:
    
    magnitude - the value to return
    
    sign - the sign for the returned value
    
    Returns:
    
    the magnitude with the same sign as the sign argument
  - getExponent
```
public int getExponent(double d)
```
    Return the exponent of a double number, removing the bias.
    For double numbers of the form 2^x, the unbiased exponent is exactly x.
    
    Specified by:
    
    getExponent in interface MathLibrary
    
    Parameters:
    
    d - number from which exponent is requested
    
    Returns:
    
    exponent for d in IEEE754 representation, without bias
  - getExponent
```
public int getExponent(float f)
```
    Return the exponent of a float number, removing the bias.
    For float numbers of the form 2^x, the unbiased exponent is exactly x.
    
    Specified by:
    
    getExponent in interface MathLibrary
    
    Parameters:
    
    f - number from which exponent is requested
    
    Returns:
    
    exponent for d in IEEE754 representation, without bias

Class FastestMathLibWrapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FastestMathLibWrapper

Method Detail

sqrt

cosh

sinh

tanh

acosh

asinh

atanh

signum

signum

nextUp

nextUp

random

exp

expm1

log

log1p

log10

pow

pow

sin

cos

tan

atan

atan2

asin

acos

cbrt

toRadians

toDegrees

abs

abs

abs

abs

ulp

ulp

scalb

scalb

nextAfter

nextAfter

floor

ceil

rint

round

round

min

min

min

min

max

max

max

max

hypot

IEEEremainder

copySign

copySign

getExponent

getExponent