MathUtil (NOVA-Core 0.1.0-SNAPSHOT API)

java.lang.Object
- nova.core.util.math.MathUtil

public class MathUtil
extends java.lang.Object

Utility class for everything related to numbers.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`absClamp(double value, double bounds)` Clamps a value between -bounds to +bounds.
`static float`	`absClamp(float value, float bounds)` Clamps a value between -bounds to +bounds.
`static int`	`absClamp(int value, int bounds)` Clamps a value between -bounds to +bounds.
`static long`	`absClamp(long value, long bounds)` Clamps a value between -bounds to +bounds.
`static double`	`clamp(double a, double min, double max)` Clamps the given number so that `min <= a <= max`
`static float`	`clamp(float a, float min, float max)` Clamps the given number so that `min <= a <= max`
`static int`	`clamp(int a, int min, int max)` Clamps the given number so that `min <= a <= max`
`static long`	`clamp(long a, long min, long max)` Clamps the given number so that `min <= a <= max`
`static boolean`	`isBetween(double a, double x, double b)`
`static double`	`lerp(double a, double b, double f)` Linear interpolates isBetween point a and point b
`static float`	`lerp(float a, float b, float f)` Linear interpolates isBetween point a and point b
`static org.apache.commons.math3.geometry.euclidean.threed.Vector3D`	`lerp(org.apache.commons.math3.geometry.euclidean.threed.Vector3D a, org.apache.commons.math3.geometry.euclidean.threed.Vector3D b, float f)` Linear interpolates isBetween point a and point b
`static double`	`log(double x, double base)`
`static float`	`log(float x, float base)`
`static int`	`log(int x, int base)`
`static long`	`log(long x, long base)`
`static double`	`max(double... numbers)` Returns the biggest number contained in the provided array.
`static double`	`max(double a, double b)` Returns the bigger number of a and b.
`static double`	`max(double a, double b, double c)` Returns the bigger number of a, b and c.
`static float`	`max(float... numbers)` Returns the biggest number contained in the provided array.
`static float`	`max(float a, float b)` Returns the bigger number of a and b.
`static float`	`max(float a, float b, float c)` Returns the bigger number of a, b and c.
`static int`	`max(int... numbers)` Returns the biggest number contained in the provided array.
`static int`	`max(int a, int b)` Returns the bigger number of a and b.
`static int`	`max(int a, int b, int c)` Returns the bigger number of a, b and c.
`static long`	`max(long... numbers)` Returns the biggest number contained in the provided array.
`static long`	`max(long a, long b)` Returns the bigger number of a and b.
`static long`	`max(long a, long b, long c)` Returns the bigger number of a, b and c.
`static double`	`min(double... numbers)` Returns the smallest number contained in the provided array.
`static double`	`min(double a, double b)` Returns the smaller number of a and b.
`static double`	`min(double a, double b, double c)` Returns the smaller number of a, b and c.
`static float`	`min(float... numbers)` Returns the smallest number contained in the provided array.
`static float`	`min(float a, float b)` Returns the smaller number of a and b.
`static float`	`min(float a, float b, float c)` Returns the smaller number of a, b and c.
`static int`	`min(int... numbers)` Returns the smallest number contained in the provided array.
`static int`	`min(int a, int b)` Returns the smaller number of a and b.
`static int`	`min(int a, int b, int c)` Returns the smaller number of a, b and c.
`static long`	`min(long... numbers)` Returns the smallest number contained in the provided array.
`static long`	`min(long a, long b)` Returns the smaller number of a and b.
`static long`	`min(long a, long b, long c)` Returns the smaller number of a, b and c.
`static double`	`roundDecimals(double d, int decimalPlaces)` Rounds a number to a specific number place places
`static java.lang.String`	`toString(double d, boolean removeTrailingZeroes)`
`static double`	`truncate(double value, int truncation)`

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

- Method Detail
  - min
```
public static int min(int a,
                      int b)
```
    Returns the smaller number of a and b.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    Returns:
    
    min
  - min
```
public static int min(int a,
                      int b,
                      int c)
```
    Returns the smaller number of a, b and c.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    c - value.
    
    Returns:
    
    min
  - min
```
public static int min(int... numbers)
```
    Returns the smallest number contained in the provided array.
    
    Parameters:
    
    numbers - Array of numbers
    
    Returns:
    
    min
  - max
```
public static int max(int a,
                      int b)
```
    Returns the bigger number of a and b.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    Returns:
    
    max
  - max
```
public static int max(int a,
                      int b,
                      int c)
```
    Returns the bigger number of a, b and c.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    c - value.
    
    Returns:
    
    max
  - max
```
public static int max(int... numbers)
```
    Returns the biggest number contained in the provided array.
    
    Parameters:
    
    numbers - Array of numbers
    
    Returns:
    
    max
  - min
```
public static long min(long a,
                       long b)
```
    Returns the smaller number of a and b.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    Returns:
    
    min
  - min
```
public static long min(long a,
                       long b,
                       long c)
```
    Returns the smaller number of a, b and c.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    c - value.
    
    Returns:
    
    min
  - min
```
public static long min(long... numbers)
```
    Returns the smallest number contained in the provided array.
    
    Parameters:
    
    numbers - Array of numbers
    
    Returns:
    
    min
  - max
```
public static long max(long a,
                       long b)
```
    Returns the bigger number of a and b.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    Returns:
    
    max
  - max
```
public static long max(long a,
                       long b,
                       long c)
```
    Returns the bigger number of a, b and c.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    c - value.
    
    Returns:
    
    max
  - max
```
public static long max(long... numbers)
```
    Returns the biggest number contained in the provided array.
    
    Parameters:
    
    numbers - Array of numbers
    
    Returns:
    
    max
  - min
```
public static double min(double a,
                         double b)
```
    Returns the smaller number of a and b.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    Returns:
    
    min
  - min
```
public static double min(double a,
                         double b,
                         double c)
```
    Returns the smaller number of a, b and c.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    c - value.
    
    Returns:
    
    min
  - min
```
public static double min(double... numbers)
```
    Returns the smallest number contained in the provided array.
    
    Parameters:
    
    numbers - Array of numbers
    
    Returns:
    
    min
  - max
```
public static double max(double a,
                         double b)
```
    Returns the bigger number of a and b.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    Returns:
    
    max
  - max
```
public static double max(double a,
                         double b,
                         double c)
```
    Returns the bigger number of a, b and c.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    c - value.
    
    Returns:
    
    max
  - max
```
public static double max(double... numbers)
```
    Returns the biggest number contained in the provided array.
    
    Parameters:
    
    numbers - Array of numbers
    
    Returns:
    
    max
  - min
```
public static float min(float a,
                        float b)
```
    Returns the smaller number of a and b.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    Returns:
    
    min
  - min
```
public static float min(float a,
                        float b,
                        float c)
```
    Returns the smaller number of a, b and c.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    c - value.
    
    Returns:
    
    min
  - min
```
public static float min(float... numbers)
```
    Returns the smallest number contained in the provided array.
    
    Parameters:
    
    numbers - Array of numbers
    
    Returns:
    
    min
  - max
```
public static float max(float a,
                        float b)
```
    Returns the bigger number of a and b.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    Returns:
    
    max
  - max
```
public static float max(float a,
                        float b,
                        float c)
```
    Returns the bigger number of a, b and c.
    
    Parameters:
    
    a - value.
    
    b - value.
    
    c - value.
    
    Returns:
    
    max
  - max
```
public static float max(float... numbers)
```
    Returns the biggest number contained in the provided array.
    
    Parameters:
    
    numbers - Array of numbers
    
    Returns:
    
    max
  - clamp
```
public static int clamp(int a,
                        int min,
                        int max)
```
    Clamps the given number so that min <= a <= max
    
    Parameters:
    
    a - value.
    
    min - lower limit
    
    max - upper limit
    
    Returns:
    
    min <= a <= max
  - clamp
```
public static long clamp(long a,
                         long min,
                         long max)
```
    Clamps the given number so that min <= a <= max
    
    Parameters:
    
    a - value.
    
    min - lower limit
    
    max - upper limit
    
    Returns:
    
    min <= a <= max
  - clamp
```
public static double clamp(double a,
                           double min,
                           double max)
```
    Clamps the given number so that min <= a <= max
    
    Parameters:
    
    a - value
    
    min - lower limit
    
    max - upper limit
    
    Returns:
    
    min <= a <= max
  - clamp
```
public static float clamp(float a,
                          float min,
                          float max)
```
    Clamps the given number so that min <= a <= max
    
    Parameters:
    
    a - value.
    
    min - lower limit
    
    max - upper limit
    
    Returns:
    
    min <= a <= max
  - lerp
```
public static double lerp(double a,
                          double b,
                          double f)
```
    Linear interpolates isBetween point a and point b
    
    Parameters:
    
    a - value.
    
    b - value.
    
    f - A percentage value isBetween 0 to 1
    
    Returns:
    
    The interpolated value
  - lerp
```
public static float lerp(float a,
                         float b,
                         float f)
```
    Linear interpolates isBetween point a and point b
    
    Parameters:
    
    a - value.
    
    b - value.
    
    f - A percentage value isBetween 0 to 1
    
    Returns:
    
    The interpolated value
  - lerp
```
public static org.apache.commons.math3.geometry.euclidean.threed.Vector3D lerp(org.apache.commons.math3.geometry.euclidean.threed.Vector3D a,
                                                                               org.apache.commons.math3.geometry.euclidean.threed.Vector3D b,
                                                                               float f)
```
    Linear interpolates isBetween point a and point b
    
    Parameters:
    
    a - value.
    
    b - value.
    
    f - A percentage value isBetween 0 to 1
    
    Returns:
    
    The interpolated value
  - absClamp
```
public static int absClamp(int value,
                           int bounds)
```
    Clamps a value between -bounds to +bounds.
    
    Parameters:
    
    value - The value
    
    bounds - The maximum distance from 0
    
    Returns:
    
    A value clamped between two bounds
  - absClamp
```
public static long absClamp(long value,
                            long bounds)
```
    Clamps a value between -bounds to +bounds.
    
    Parameters:
    
    value - The value
    
    bounds - The maximum distance from 0
    
    Returns:
    
    A value clamped between two bounds
  - absClamp
```
public static double absClamp(double value,
                              double bounds)
```
    Clamps a value between -bounds to +bounds.
    
    Parameters:
    
    value - The value
    
    bounds - The maximum distance from 0
    
    Returns:
    
    A value clamped between two bounds
  - absClamp
```
public static float absClamp(float value,
                             float bounds)
```
    Clamps a value between -bounds to +bounds.
    
    Parameters:
    
    value - The value
    
    bounds - The maximum distance from 0
    
    Returns:
    
    A value clamped between two bounds
  - truncate
```
public static double truncate(double value,
                              int truncation)
```
  - log
```
public static int log(int x,
                      int base)
```
  - log
```
public static long log(long x,
                       long base)
```
  - log
```
public static double log(double x,
                         double base)
```
  - log
```
public static float log(float x,
                        float base)
```
  - isBetween
```
public static boolean isBetween(double a,
                                double x,
                                double b)
```
    Parameters:
    
    a - value.
    
    x - value.
    
    b - value.
    
    Returns:
    
    True if x is greater than a and less than b
  - roundDecimals
```
public static double roundDecimals(double d,
                                   int decimalPlaces)
```
    Rounds a number to a specific number place places
    
    Parameters:
    
    d - - the number
    
    decimalPlaces - The decimal places
    
    Returns:
    
    The rounded number
  - toString
```
public static java.lang.String toString(double d,
                                        boolean removeTrailingZeroes)
```

Class MathUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

min

min

min

max

max

max

min

min

min

max

max

max

min

min

min

max

max

max

min

min

min

max

max

max

clamp

clamp

clamp

clamp

lerp

lerp

lerp

absClamp

absClamp

absClamp

absClamp

truncate

log

log

log

log

isBetween

roundDecimals

toString