MathUtil

java.lang.Object
- icy.math.MathUtil

public class MathUtil
extends java.lang.Object

Math utilities class.

Author:: stephane

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`INFINITE_STRING`
`static double`	`POW2_16_DOUBLE`
`static float`	`POW2_16_FLOAT`
`static double`	`POW2_32_DOUBLE`
`static float`	`POW2_32_FLOAT`
`static double`	`POW2_64_DOUBLE`
`static float`	`POW2_64_FLOAT`
`static double`	`POW2_8_DOUBLE`
`static float`	`POW2_8_FLOAT`

Constructor Summary

Constructors
Constructor and Description

MathUtil()

Constructors
Constructor and Description
`MathUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`add(double[] array, double value)` Add the the specified value to all elements in an array
`static void`	`add(float[] array, float value)` Add the the specified value to all elements in an array
`static double`	`closest(double value, double[] source)` Return the value in `source` which is the closest to `value` Returns `0` if source is null or empty.
`static double`	`cubicRoot(double value)` Calculate the cubic root of the specified value.
`static void`	`divide(double[] array, double value)` Divides all elements in an array by the specified value
`static void`	`divide(float[] array, float value)` Divides all elements in an array by the specified value
`static double`	`formatDegreeAngle(double angle)` Format the specified degree angle to stay in [0..360[ range
`static double`	`formatDegreeAngle2(double angle)` Format the specified degree angle to stay in [-180..180] range
`static double`	`formatRadianAngle(double angle)` Format the specified degree angle to stay in [0..2PI[ range
`static double`	`formatRadianAngle2(double angle)` Format the specified degree angle to stay in [-PI..PI] range
`static double`	`frac(double value)`
`static java.lang.String`	`getBytesString(double value)` Deprecated. please use `UnitUtil.getBytesString(double)` instead.
`static void`	`log(double[] array)` Replace all values in the array by their logarithm Be careful, all values should be >0 values
`static void`	`log(float[] array)` Replace all values in the array by their logarithm Be careful, all values should be >0 values
`static void`	`madd(double[] array, double mulValue, double addValue)` Multiply and add all elements in an array by the specified values
`static void`	`madd(float[] array, float mulValue, float addValue)` Multiply and add all elements in an array by the specified values
`static int`	`max(byte[] array, boolean signed)` Deprecated. use `ArrayMath.max(byte[], boolean)` instead
`static double`	`max(double[] array)` Deprecated. use `ArrayMath.max(double[])` instead
`static float`	`max(float[] array)` Deprecated. use `ArrayMath.max(float[])` instead
`static long`	`max(int[] array, boolean signed)` Deprecated. use `ArrayMath.max(int[], boolean)` instead
`static double`	`max(java.lang.Object array, boolean signed)` Deprecated. use `ArrayMath.max(Object, boolean)` instead
`static int`	`max(short[] array, boolean signed)` Deprecated. use `ArrayMath.max(short[], boolean)` instead
`static int`	`min(byte[] array, boolean signed)` Deprecated. use `ArrayMath.min(byte[], boolean)` instead
`static double`	`min(double[] array)` Deprecated. use `ArrayMath.min(double[])` instead
`static float`	`min(float[] array)` Deprecated. use `ArrayMath.min(float[])` instead
`static long`	`min(int[] array, boolean signed)` Deprecated. use `ArrayMath.min(int[], boolean)` instead
`static double`	`min(java.lang.Object array, boolean signed)` Deprecated. use `ArrayMath.min(Object, boolean)` instead
`static int`	`min(short[] array, boolean signed)` Deprecated. use `ArrayMath.min(short[], boolean)` instead
`static void`	`mul(double[] array, double value)` Multiply all elements in an array by the specified value
`static void`	`mul(float[] array, float value)` Multiply all elements in an array by the specified value
`static double`	`nextMultiple(double value, double mul)` Return the next multiple of "mul" for the specified value nextMultiple(200, 64) = 256
`static double`	`nextPow10(double value)` Return the next power of 10 for the specified value nextPow10(0.0067) = 0.01 nextPow10(-28.7) = -10
`static long`	`nextPow2(long value)` Return the next power of 2 for the specified value nextPow2(17) = 32 nextPow2(16) = 32 nextPow2(-12) = -8 nextPow2(-8) = -4
`static long`	`nextPow2Mask(long value)` Return the next power of 2 mask for the specified value nextPow2Mask(17) = 31 nextPow2Mask(16) = 31 nextPow2Mask(-12) = -8 nextPow2Mask(-8) = -4
`static void`	`normalize(double[] array)` Normalize an array
`static void`	`normalize(float[] array)` Normalize an array
`static double`	`prevMultiple(double value, double mul)` Return the previous multiple of "mul" for the specified value prevMultiple(200, 64) = 192
`static double`	`prevPow10(double value)` Return the previous power of 10 for the specified value prevPow10(0.0067) = 0.001 prevPow10(-28.7) = -100
`static long`	`prevPow2(long value)` Return the previous power of 2 for the specified value prevPow2(17) = 16 prevPow2(16) = 8 prevPow2(-12) = -16 prevPow2(-8) = -16
`static double`	`round(double d, int numDecimal)` Round specified value to specified number of decimal.
`static double`	`roundSignificant(double d, int numDigit)` Round specified value to specified number of significant digit.
`static double`	`roundSignificant(double d, int numDigit, boolean keepInteger)` Round specified value to specified number of significant digit.

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

- Field Detail
  - INFINITE_STRING
```
public static final java.lang.String INFINITE_STRING
```
    See Also:
    Constant Field Values
  - POW2_8_DOUBLE
```
public static final double POW2_8_DOUBLE
```
  - POW2_8_FLOAT
```
public static final float POW2_8_FLOAT
```
  - POW2_16_DOUBLE
```
public static final double POW2_16_DOUBLE
```
  - POW2_16_FLOAT
```
public static final float POW2_16_FLOAT
```
  - POW2_32_DOUBLE
```
public static final double POW2_32_DOUBLE
```
  - POW2_32_FLOAT
```
public static final float POW2_32_FLOAT
```
  - POW2_64_DOUBLE
```
public static final double POW2_64_DOUBLE
```
  - POW2_64_FLOAT
```
public static final float POW2_64_FLOAT
```
- Constructor Detail
  - MathUtil
```
public MathUtil()
```
- Method Detail
  - getBytesString
```
@Deprecated
public static java.lang.String getBytesString(double value)
```
    Deprecated. please use UnitUtil.getBytesString(double) instead.
  - frac
```
public static double frac(double value)
```
  - normalize
```
public static void normalize(float[] array)
```
    Normalize an array
    
    Parameters:
    array - elements to normalize
  - normalize
```
public static void normalize(double[] array)
```
    Normalize an array
    
    Parameters:
    array - elements to normalize
  - log
```
public static void log(double[] array)
```
    Replace all values in the array by their logarithm
    Be careful, all values should be >0 values
    
    Parameters:
    array - elements to logarithm
  - log
```
public static void log(float[] array)
```
    Replace all values in the array by their logarithm
    Be careful, all values should be >0 values
    
    Parameters:
    array - elements to logarithm
  - add
```
public static void add(double[] array,
       double value)
```
    Add the the specified value to all elements in an array
    
    Parameters:
    array - elements to modify
    value -
  - add
```
public static void add(float[] array,
       float value)
```
    Add the the specified value to all elements in an array
    
    Parameters:
    array - elements to modify
    value -
  - madd
```
public static void madd(double[] array,
        double mulValue,
        double addValue)
```
    Multiply and add all elements in an array by the specified values
    
    Parameters:
    array - elements to modify
    mulValue -
    addValue -
  - madd
```
public static void madd(float[] array,
        float mulValue,
        float addValue)
```
    Multiply and add all elements in an array by the specified values
    
    Parameters:
    array - elements to modify
    mulValue -
    addValue -
  - mul
```
public static void mul(double[] array,
       double value)
```
    Multiply all elements in an array by the specified value
    
    Parameters:
    array - elements to modify
    value - value to multiply by
  - mul
```
public static void mul(float[] array,
       float value)
```
    Multiply all elements in an array by the specified value
    
    Parameters:
    array - elements to modify
    value - value to multiply by
  - divide
```
public static void divide(double[] array,
          double value)
```
    Divides all elements in an array by the specified value
    
    Parameters:
    array - elements to modify
    value - value used as divisor
  - divide
```
public static void divide(float[] array,
          float value)
```
    Divides all elements in an array by the specified value
    
    Parameters:
    array - elements to modify
    value - value used as divisor
  - min
```
@Deprecated
public static double min(java.lang.Object array,
                    boolean signed)
```
    Deprecated. use ArrayMath.min(Object, boolean) instead
  - min
```
@Deprecated
public static int min(byte[] array,
                 boolean signed)
```
    Deprecated. use ArrayMath.min(byte[], boolean) instead
  - min
```
@Deprecated
public static int min(short[] array,
                 boolean signed)
```
    Deprecated. use ArrayMath.min(short[], boolean) instead
  - min
```
@Deprecated
public static long min(int[] array,
                  boolean signed)
```
    Deprecated. use ArrayMath.min(int[], boolean) instead
  - min
```
@Deprecated
public static float min(float[] array)
```
    Deprecated. use ArrayMath.min(float[]) instead
  - min
```
@Deprecated
public static double min(double[] array)
```
    Deprecated. use ArrayMath.min(double[]) instead
  - max
```
@Deprecated
public static double max(java.lang.Object array,
                    boolean signed)
```
    Deprecated. use ArrayMath.max(Object, boolean) instead
  - max
```
@Deprecated
public static int max(byte[] array,
                 boolean signed)
```
    Deprecated. use ArrayMath.max(byte[], boolean) instead
  - max
```
@Deprecated
public static int max(short[] array,
                 boolean signed)
```
    Deprecated. use ArrayMath.max(short[], boolean) instead
  - max
```
@Deprecated
public static long max(int[] array,
                  boolean signed)
```
    Deprecated. use ArrayMath.max(int[], boolean) instead
  - max
```
@Deprecated
public static float max(float[] array)
```
    Deprecated. use ArrayMath.max(float[]) instead
  - max
```
@Deprecated
public static double max(double[] array)
```
    Deprecated. use ArrayMath.max(double[]) instead
  - roundSignificant
```
public static double roundSignificant(double d,
                      int numDigit,
                      boolean keepInteger)
```
    Round specified value to specified number of significant digit.
    If keepInteger is true then integer part of number is entirely conserved.
    If numDigit is <= 0 then the value stay unchanged.
  - roundSignificant
```
public static double roundSignificant(double d,
                      int numDigit)
```
    Round specified value to specified number of significant digit.
  - round
```
public static double round(double d,
           int numDecimal)
```
    Round specified value to specified number of decimal.
  - prevMultiple
```
public static double prevMultiple(double value,
                  double mul)
```
    Return the previous multiple of "mul" for the specified value
    - prevMultiple(200, 64) = 192
    Parameters:
    value -
    mul -
  - nextMultiple
```
public static double nextMultiple(double value,
                  double mul)
```
    Return the next multiple of "mul" for the specified value
    - nextMultiple(200, 64) = 256
    Parameters:
    value -
    mul -
  - nextPow2
```
public static long nextPow2(long value)
```
    Return the next power of 2 for the specified value
    - nextPow2(17) = 32
    - nextPow2(16) = 32
    - nextPow2(-12) = -8
    - nextPow2(-8) = -4
    Parameters:
    value -
    
    Returns:
    next power of 2
  - nextPow2Mask
```
public static long nextPow2Mask(long value)
```
    Return the next power of 2 mask for the specified value
    - nextPow2Mask(17) = 31
    - nextPow2Mask(16) = 31
    - nextPow2Mask(-12) = -8
    - nextPow2Mask(-8) = -4
    Parameters:
    value -
    
    Returns:
    next power of 2 mask
  - prevPow2
```
public static long prevPow2(long value)
```
    Return the previous power of 2 for the specified value
    - prevPow2(17) = 16
    - prevPow2(16) = 8
    - prevPow2(-12) = -16
    - prevPow2(-8) = -16
    Parameters:
    value -
    
    Returns:
    previous power of 2
  - nextPow10
```
public static double nextPow10(double value)
```
    Return the next power of 10 for the specified value
    - nextPow10(0.0067) = 0.01
    - nextPow10(-28.7) = -10
    Parameters:
    value -
  - prevPow10
```
public static double prevPow10(double value)
```
    Return the previous power of 10 for the specified value
    - prevPow10(0.0067) = 0.001
    - prevPow10(-28.7) = -100
    Parameters:
    value -
  - formatDegreeAngle
```
public static double formatDegreeAngle(double angle)
```
    Format the specified degree angle to stay in [0..360[ range
  - formatDegreeAngle2
```
public static double formatDegreeAngle2(double angle)
```
    Format the specified degree angle to stay in [-180..180] range
  - formatRadianAngle
```
public static double formatRadianAngle(double angle)
```
    Format the specified degree angle to stay in [0..2PI[ range
  - formatRadianAngle2
```
public static double formatRadianAngle2(double angle)
```
    Format the specified degree angle to stay in [-PI..PI] range
  - closest
```
public static double closest(double value,
             double[] source)
```
    Return the value in source which is the closest to value Returns 0 if source is null or empty.
  - cubicRoot
```
public static double cubicRoot(double value)
```
    Calculate the cubic root of the specified value.

Class MathUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INFINITE_STRING

POW2_8_DOUBLE

POW2_8_FLOAT

POW2_16_DOUBLE

POW2_16_FLOAT

POW2_32_DOUBLE

POW2_32_FLOAT

POW2_64_DOUBLE

POW2_64_FLOAT

Constructor Detail

MathUtil

Method Detail

getBytesString

frac

normalize

normalize

log

log

add

add

madd

madd

mul

mul

divide

divide

min

min

min

min

min

min

max

max

max

max

max

max

roundSignificant

roundSignificant

round

prevMultiple

nextMultiple

nextPow2

nextPow2Mask

prevPow2

nextPow10

prevPow10

formatDegreeAngle

formatDegreeAngle2

formatRadianAngle

formatRadianAngle2

closest

cubicRoot