Maths (mathz 0.0.1 API)

java.lang.Object
- mikera.util.Maths

```
public final class Maths
extends Object
```
Helpful maths functions Focus on using floats rather than doubles for speed

Author:

Mike

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`E`
`static float`	`HALF_PI`
`static float`	`PI`
`static float`	`QUARTER_PI`
`static float`	`ROOT_THREE`
`static float`	`ROOT_TWO`
`static float`	`TAU`
`static float`	`TWO_PI`

Constructor Summary

Constructors
Constructor and Description

Maths()

Constructors
Constructor and Description
`Maths()`

Method Summary

Methods
Modifier and Type	Method and Description
`static float`	`abs(float a)`
`static int`	`abs(int a)`
`static int`	`abs2(int a)`
`static int`	`abs3(int a)`
`static float`	`alternateSqrt(float x)` Interesting way to approximate a square root....
`static float`	`approxSqrt(float x)`
`static double`	`bound(double min, double v, double max)`
`static float`	`bound(float min, float v, float max)`
`static int`	`bound(int min, int v, int max)`
`static int`	`clampToInteger(double value, int min, int max)`
`static int`	`clampToInteger(float value, int min, int max)`
`static float`	`cos(double a)`
`static float`	`cos(float a)`
`static float`	`fastInverseSqrt(float x)`
`static float`	`fastPower(float a, float b)` Computes a fast approximation to `Math.pow(a, b)`.
`static int`	`floor(double a)`
`static int`	`floor(float a)`
`static float`	`fmod(float n, float d)`
`static double`	`frac(double a)`
`static float`	`frac(float a)`
`static float`	`inverseSigmoid(float a)`
`static float`	`lerp(float t, float a, float b)`
`static double`	`max(double a, double b, double c)`
`static float`	`max(float a, float b)`
`static float`	`max(float a, float b, float c)`
`static float`	`max(float a, float b, float c, float d)`
`static int`	`max(int a, int b)`
`static int`	`max(int a, int b, int c)`
`static int`	`max2(int a, int b)`
`static float`	`middle(float a, float b, float c)` Return the middle value of 3 numbers Can use faster "bound" method if first and last parameters are in order
`static int`	`middle(int a, int b, int c)` Return the middle value of 3 numbers Can use faster "bound" method if first and last parameters are in order
`static double`	`min(double a, double b, double c)`
`static float`	`min(float a, float b)`
`static float`	`min(float a, float b, float c)`
`static float`	`min(float a, float b, float c, float d)`
`static int`	`min(int a, int b)`
`static int`	`min(int a, int b, int c)`
`static int`	`min2(int a, int b)`
`static int`	`mod(int number, int divisor)` Integer modulus function
`static boolean`	`notNearZero(double d)`
`static long`	`quantize(long increase, long boundary, long base)` Detects the number of times that boundary is passed when adding increase to base
`static float`	`round(float f, int dp)`
`static int`	`roundUp(double d)`
`static int`	`roundUp(float d)`
`static int`	`roundUp(Number d)`
`static double`	`sigmoid(double a)`
`static float`	`sigmoid(float a)`
`static float`	`sigmoidDerivative(float a)`
`static int`	`sign(double a)`
`static int`	`sign(float a)`
`static int`	`sign(int a)`
`static int`	`sign(long a)`
`static int`	`sign2(int a)` Mike's fast integer sign algorithm
`static int`	`sign2fast(int a)`
`static float`	`sin(double a)`
`static float`	`sin(float a)`
`static float`	`smoothFactor(float t)`
`static float`	`smoothStep(float a, float b, float x)`
`static double`	`softMaximum(double x, double y)` Soft maximum function
`static double`	`sqrt(double a)`
`static float`	`sqrt(float a)`
`static int`	`square(byte b)`
`static double`	`square(double a)`
`static float`	`square(float a)`
`static int`	`square(int a)`
`static double`	`tanh(double a)`
`static float`	`tanh(float a)`
`static float`	`tanhDerivative(float a)`
`static double`	`tanhScaled(double a)`
`static double`	`tanhScaledDerivative(double a)`

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

Field Detail

ROOT_TWO
```
public static final float ROOT_TWO
```

ROOT_THREE
```
public static final float ROOT_THREE
```

E
```
public static final float E
```

PI
```
public static final float PI
```
See Also:
Constant Field Values

TWO_PI
```
public static final float TWO_PI
```
See Also:
Constant Field Values

TAU
```
public static final float TAU
```
See Also:
Constant Field Values

HALF_PI
```
public static final float HALF_PI
```
See Also:
Constant Field Values

QUARTER_PI
```
public static final float QUARTER_PI
```
See Also:
Constant Field Values

Constructor Detail
- Maths
```
public Maths()
```

Method Detail

sqrt
```
public static float sqrt(float a)
```

sqrt
```
public static double sqrt(double a)
```

fastInverseSqrt

public static float fastInverseSqrt(float x)

alternateSqrt
```
public static float alternateSqrt(float x)
```
Interesting way to approximate a square root.... however seems to be slower than standard Math.sqrt() approach

Parameters:
x -

Returns:

approxSqrt

public static float approxSqrt(float x)

clampToInteger

public static int clampToInteger(double value,
                 int min,
                 int max)

clampToInteger

public static int clampToInteger(float value,
                 int min,
                 int max)

middle
```
public static int middle(int a,
         int b,
         int c)
```
Return the middle value of 3 numbers Can use faster "bound" method if first and last parameters are in order

middle
```
public static float middle(float a,
           float b,
           float c)
```
Return the middle value of 3 numbers Can use faster "bound" method if first and last parameters are in order

sign
```
public static int sign(double a)
```

sign
```
public static int sign(float a)
```

sign
```
public static final int sign(int a)
```

sign2
```
public static final int sign2(int a)
```
Mike's fast integer sign algorithm

Parameters:
a -

Returns:
Sign of the given number (-1, 0 or 1)

sign2fast
```
public static int sign2fast(int a)
```

sign
```
public static int sign(long a)
```

fmod

public static float fmod(float n,
         float d)

mod
```
public static int mod(int number,
      int divisor)
```
Integer modulus function

Parameters:
n - number
d - divisor

Returns:

quantize
```
public static long quantize(long increase,
            long boundary,
            long base)
```
Detects the number of times that boundary is passed when adding increase to base

Parameters:
increase -
boundary -
base -

Returns:

min

public static double min(double a,
         double b,
         double c)

max

public static double max(double a,
         double b,
         double c)

min

public static float min(float a,
        float b,
        float c)

max

public static float max(float a,
        float b,
        float c)

min

public static final float min(float a,
        float b,
        float c,
        float d)

max

public static final float max(float a,
        float b,
        float c,
        float d)

abs
```
public static int abs(int a)
```

abs2
```
public static int abs2(int a)
```

abs3
```
public static int abs3(int a)
```

abs
```
public static float abs(float a)
```

min

public static int min(int a,
      int b)

max

public static int max(int a,
      int b)

min2

public static int min2(int a,
       int b)

max2

public static int max2(int a,
       int b)

min

public static float min(float a,
        float b)

max

public static float max(float a,
        float b)

min

public static int min(int a,
      int b,
      int c)

max

public static int max(int a,
      int b,
      int c)

sigmoid
```
public static float sigmoid(float a)
```

sigmoid

public static double sigmoid(double a)

tanh
```
public static float tanh(float a)
```

tanh
```
public static double tanh(double a)
```

tanhScaled

public static double tanhScaled(double a)

tanhScaledDerivative

public static double tanhScaledDerivative(double a)

inverseSigmoid

public static float inverseSigmoid(float a)

sigmoidDerivative

public static float sigmoidDerivative(float a)

tanhDerivative

public static float tanhDerivative(float a)

sin
```
public static float sin(double a)
```

cos
```
public static float cos(double a)
```

sin
```
public static float sin(float a)
```

cos
```
public static float cos(float a)
```

floor
```
public static int floor(float a)
```

frac
```
public static float frac(float a)
```

frac
```
public static double frac(double a)
```

floor
```
public static int floor(double a)
```

square
```
public static int square(byte b)
```

square
```
public static int square(int a)
```

square
```
public static float square(float a)
```

square

public static double square(double a)

round

public static float round(float f,
          int dp)

roundUp
```
public static int roundUp(double d)
```

roundUp
```
public static int roundUp(Number d)
```

roundUp
```
public static int roundUp(float d)
```

softMaximum

public static double softMaximum(double x,
                 double y)

Soft maximum function

fastPower
```
public static final float fastPower(float a,
              float b)
```
Computes a fast approximation to Math.pow(a, b). Adapted from http://www.dctsystems.co.uk/Software/power.html.

Parameters:
a - a positive number
b - a number

Returns:
a^b

smoothStep

public static final float smoothStep(float a,
               float b,
               float x)

lerp

public static final float lerp(float t,
         float a,
         float b)

smoothFactor

public static final float smoothFactor(float t)

bound

public static final float bound(float min,
          float v,
          float max)

bound

public static final double bound(double min,
           double v,
           double max)

bound

public static final int bound(int min,
        int v,
        int max)

notNearZero

public static boolean notNearZero(double d)

Class Maths

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROOT_TWO

ROOT_THREE

E

PI

TWO_PI

TAU

HALF_PI

QUARTER_PI

Constructor Detail

Maths

Method Detail

sqrt

sqrt

fastInverseSqrt

alternateSqrt

approxSqrt

clampToInteger

clampToInteger

middle

middle

sign

sign

sign

sign2

sign2fast

sign

fmod

mod

quantize

min

max

min

max

min

max

abs

abs2

abs3

abs

min

max

min2

max2

min

max

min

max

sigmoid

sigmoid

tanh

tanh

tanhScaled

tanhScaledDerivative

inverseSigmoid

sigmoidDerivative

tanhDerivative

sin

cos

sin

cos

floor

frac

frac

floor

square

square

square

square

round

roundUp

roundUp

roundUp

softMaximum

fastPower