MathF (org.dayflower.pathtracer API)

java.lang.Object
- org.dayflower.pathtracer.math.MathF

```
public final class MathF
extends java.lang.Object
```
A class that consists exclusively of static methods and constants for various mathematical operations.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`EPSILON` An epsilon value.
`static float`	`PI` A `float` representation of pi.
`static float`	`PI_DIVIDED_BY_FOUR` A `float` representation of pi divided by `4.0F`.
`static float`	`PI_DIVIDED_BY_TWO` A `float` representation of pi divided by `2.0F`.
`static float`	`PI_MULTIPLIED_BY_TWO` A `float` representation of pi multiplied by `2.0F`.
`static float`	`PI_RECIPROCAL` A `float` representation of the reciprocal of pi.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static float`	`abs(float value)` Returns the absolute version of `value`.
`static int`	`abs(int value)` Returns the absolute version of `value`.
`static float`	`acos(float value)` Returns the arc cosine of `value`.
`static float`	`asin(float value)` Returns the arc sine of `value`.
`static float`	`atan(float value)` Returns the arc tangent of `value`.
`static float`	`atan2(float y, float x)` Returns the theta component of the point (r, theta) in polar coordinates that corresponds to the point (x, y) in Cartesian coordinates.
`static float`	`cos(float angle)` Returns the trigonometric cosine of `angle`.
`static boolean`	`equals(float a, float b)` Compares `a` and `b` for equality.
`static float`	`exp(float exponent)` Returns Euler's number `e` raised to the power of `exponent`.
`static float`	`floor(float value)` Returns the largest (closest to positive infinity) `float` value that is less than or equal to `value` and is equal to a mathematical integer.
`static float`	`max(float a, float b)` Returns the greater value of `a` and `b`.
`static float`	`max(float a, float b, float c)` Returns the greater value of `a`, `b` and `c`.
`static int`	`max(int a, int b)` Returns the greater value of `a` and `b`.
`static float`	`min(float a, float b)` Returns the smaller value of `a` and `b`.
`static float`	`min(float a, float b, float c)` Returns the smaller value of `a`, `b` and `c`.
`static int`	`min(int a, int b)` Returns the smaller value of `a` and `b`.
`static float`	`modulo(float value)` Returns the value that is computed as `value - floor(value)`.
`static float`	`nextFloat()` Returns a pseudorandom `float` value between `0.0F` (inclusive) and `1.0F` (exclusive).
`static float`	`pow(float base, float exponent)` Returns `base` raised to the power of `exponent`.
`static float`	`saturate(float value)` Returns a saturated (or clamped) value based on `value`.
`static float`	`saturate(float value, float minimum, float maximum)` Returns a saturated (or clamped) value based on `value`.
`static int`	`saturate(int value)` Returns a saturated (or clamped) value based on `value`.
`static int`	`saturate(int value, int minimum, int maximum)` Returns a saturated (or clamped) value based on `value`.
`static float`	`sin(float angle)` Returns the trigonometric sine of `angle`.
`static float[]`	`solveQuadraticSystem(float a, float b, float c)` Attempts to solve the quadratic system based on the values `a`, `b` and `c`.
`static float`	`sqrt(float value)` Returns the correctly rounded positive square root of `value`.
`static float`	`tan(float angle)` Returns the trigonometric tangent of `angle`.
`static float`	`toDegrees(float radians)` Returns an approximately equivalent angle measured in degrees from an angle measured in radians.
`static float`	`toFloat(double value)` Returns a `float` representation of a `double` value.
`static float`	`toRadians(float angleInDegrees)` Returns an approximately equivalent angle measured in radians from an angle measured in degrees.
`static float`	`wrapAround(float value, float a, float b)` Returns `value` or its wrapped around representation.

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

- Field Detail
  - EPSILON
```
public static final float EPSILON
```
    An epsilon value.
    
    See Also:
    
    Constant Field Values
  - PI
```
public static final float PI
```
    A float representation of pi.
  - PI_DIVIDED_BY_FOUR
```
public static final float PI_DIVIDED_BY_FOUR
```
    A float representation of pi divided by 4.0F.
  - PI_DIVIDED_BY_TWO
```
public static final float PI_DIVIDED_BY_TWO
```
    A float representation of pi divided by 2.0F.
  - PI_MULTIPLIED_BY_TWO
```
public static final float PI_MULTIPLIED_BY_TWO
```
    A float representation of pi multiplied by 2.0F.
  - PI_RECIPROCAL
```
public static final float PI_RECIPROCAL
```
    A float representation of the reciprocal of pi.
- Method Detail
  - equals
```
public static boolean equals(float a,
                             float b)
```
    Compares a and b for equality.
    Returns true if, and only if, a and b are equal, false otherwise.
    
    Parameters:
    
    a - a float value
    
    b - a float value
    
    Returns:
    
    true if, and only if, a and b are equal, false otherwise
  - abs
```
public static float abs(float value)
```
    Returns the absolute version of value.
    
    Parameters:
    
    value - a float value
    
    Returns:
    
    the absolute version of value
  - acos
```
public static float acos(float value)
```
    Returns the arc cosine of value.
    
    Parameters:
    
    value - a float value
    
    Returns:
    
    the arc cosine of value
  - asin
```
public static float asin(float value)
```
    Returns the arc sine of value.
    
    Parameters:
    
    value - a float value
    
    Returns:
    
    the arc sine of value
  - atan
```
public static float atan(float value)
```
    Returns the arc tangent of value.
    
    Parameters:
    
    value - a float value
    
    Returns:
    
    the arc tangent of value
  - atan2
```
public static float atan2(float y,
                          float x)
```
    Returns the theta component of the point (r, theta) in polar coordinates that corresponds to the point (x, y) in Cartesian coordinates.
    
    Parameters:
    
    y - the ordinate coordinate
    
    x - the abscissa coordinate
    
    Returns:
    
    the theta component of the point (r, theta) in polar coordinates that corresponds to the point (x, y) in Cartesian coordinates
  - cos
```
public static float cos(float angle)
```
    Returns the trigonometric cosine of angle.
    
    Parameters:
    
    angle - an angle, in radians
    
    Returns:
    
    the trigonometric cosine of angle
  - exp
```
public static float exp(float exponent)
```
    Returns Euler's number e raised to the power of exponent.
    
    Parameters:
    
    exponent - the exponent to raise e to
    
    Returns:
    
    Euler's number e raised to the power of exponent
  - floor
```
public static float floor(float value)
```
    Returns the largest (closest to positive infinity) float value that is less than or equal to value and is equal to a mathematical integer.
    
    Parameters:
    
    value - a value
    
    Returns:
    
    the largest (closest to positive infinity) float value that is less than or equal to value and is equal to a mathematical integer
  - max
```
public static float max(float a,
                        float b)
```
    Returns the greater value of a and b.
    
    Parameters:
    
    a - a value
    
    b - a value
    
    Returns:
    
    the greater value of a and b
  - max
```
public static float max(float a,
                        float b,
                        float c)
```
    Returns the greater value of a, b and c.
    
    Parameters:
    
    a - a value
    
    b - a value
    
    c - a value
    
    Returns:
    
    the greater value of a, b and c
  - min
```
public static float min(float a,
                        float b)
```
    Returns the smaller value of a and b.
    
    Parameters:
    
    a - a value
    
    b - a value
    
    Returns:
    
    the smaller value of a and b
  - min
```
public static float min(float a,
                        float b,
                        float c)
```
    Returns the smaller value of a, b and c.
    
    Parameters:
    
    a - a value
    
    b - a value
    
    c - a value
    
    Returns:
    
    the smaller value of a, b and c
  - modulo
```
public static float modulo(float value)
```
    Returns the value that is computed as value - floor(value).
    
    Parameters:
    
    value - a value
    
    Returns:
    
    the value that is computed as value - floor(value)
  - nextFloat
```
public static float nextFloat()
```
    Returns a pseudorandom float value between 0.0F (inclusive) and 1.0F (exclusive).
    
    Returns:
    
    a pseudorandom float value between 0.0F (inclusive) and 1.0F (exclusive)
  - pow
```
public static float pow(float base,
                        float exponent)
```
    Returns base raised to the power of exponent.
    
    Parameters:
    
    base - the base
    
    exponent - the exponent
    
    Returns:
    
    base raised to the power of exponent
  - saturate
```
public static float saturate(float value)
```
    Returns a saturated (or clamped) value based on value.
    Calling this method is equivalent to calling Math2.saturate(value, 0.0F, 1.0F).
    
    Parameters:
    
    value - the value to saturate (or clamp)
    
    Returns:
    
    a saturated (or clamped) value based on value
  - saturate
```
public static float saturate(float value,
                             float minimum,
                             float maximum)
```
    Returns a saturated (or clamped) value based on value.
    If value is less than minimum, minimum will be returned. If value is greater than maximum, maximum will be returned. Otherwise value will be returned.
    
    Parameters:
    
    value - the value to saturate (or clamp)
    
    minimum - the minimum value
    
    maximum - the maximum value
    
    Returns:
    
    a saturated (or clamped) value based on value
  - sin
```
public static float sin(float angle)
```
    Returns the trigonometric sine of angle.
    
    Parameters:
    
    angle - an angle, in radians
    
    Returns:
    
    the trigonometric sine of angle
  - sqrt
```
public static float sqrt(float value)
```
    Returns the correctly rounded positive square root of value.
    
    Parameters:
    
    value - a value
    
    Returns:
    
    the correctly rounded positive square root of value
  - tan
```
public static float tan(float angle)
```
    Returns the trigonometric tangent of angle.
    
    Parameters:
    
    angle - an angle, in radians
    
    Returns:
    
    the trigonometric tangent of angle
  - toDegrees
```
public static float toDegrees(float radians)
```
    Returns an approximately equivalent angle measured in degrees from an angle measured in radians.
    
    Parameters:
    
    radians - an angle, in radians
    
    Returns:
    
    an approximately equivalent angle measured in degrees from an angle measured in radians
  - toFloat
```
public static float toFloat(double value)
```
    Returns a float representation of a double value.
    
    Parameters:
    
    value - a double value
    
    Returns:
    
    a float representation of a double value
  - toRadians
```
public static float toRadians(float angleInDegrees)
```
    Returns an approximately equivalent angle measured in radians from an angle measured in degrees.
    
    Parameters:
    
    angleInDegrees - an angle, in degrees
    
    Returns:
    
    an approximately equivalent angle measured in radians from an angle measured in degrees
  - wrapAround
```
public static float wrapAround(float value,
                               float a,
                               float b)
```
    Returns value or its wrapped around representation.
    If value is greater than or equal to min(a, b) and less than or equal to max(a, b), value will be returned. Otherwise it will wrap around on either side until it is contained in the interval [min(a, b), max(a, b)].
    
    Parameters:
    
    value - the value to potentially wrap around
    
    a - one of the values in the interval to wrap around
    
    b - one of the values in the interval to wrap around
    
    Returns:
    
    value or its wrapped around representation
  - solveQuadraticSystem
```
public static float[] solveQuadraticSystem(float a,
                                           float b,
                                           float c)
```
    Attempts to solve the quadratic system based on the values a, b and c.
    Returns a float array with a length of 2 containing the result.
    If the quadratic system could not be solved, the result will contain the values Float.NaN.
    
    Parameters:
    
    a - a value
    
    b - a value
    
    c - a value
    
    Returns:
    
    a double array with a length of 2 containing the result
  - abs
```
public static int abs(int value)
```
    Returns the absolute version of value.
    
    Parameters:
    
    value - an int value
    
    Returns:
    
    the absolute version of value
  - max
```
public static int max(int a,
                      int b)
```
    Returns the greater value of a and b.
    
    Parameters:
    
    a - a value
    
    b - a value
    
    Returns:
    
    the greater value of a and b
  - min
```
public static int min(int a,
                      int b)
```
    Returns the smaller value of a and b.
    
    Parameters:
    
    a - a value
    
    b - a value
    
    Returns:
    
    the smaller value of a and b
  - saturate
```
public static int saturate(int value)
```
    Returns a saturated (or clamped) value based on value.
    Calling this method is equivalent to calling Math2.saturate(value, 0, 255).
    
    Parameters:
    
    value - the value to saturate (or clamp)
    
    Returns:
    
    a saturated (or clamped) value based on value
  - saturate
```
public static int saturate(int value,
                           int minimum,
                           int maximum)
```
    Returns a saturated (or clamped) value based on value.
    If value is less than minimum, minimum will be returned. If value is greater than maximum, maximum will be returned. Otherwise value will be returned.
    
    Parameters:
    
    value - the value to saturate (or clamp)
    
    minimum - the minimum value
    
    maximum - the maximum value
    
    Returns:
    
    a saturated (or clamped) value based on value

Class MathF

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EPSILON

PI

PI_DIVIDED_BY_FOUR

PI_DIVIDED_BY_TWO

PI_MULTIPLIED_BY_TWO

PI_RECIPROCAL

Method Detail

equals

abs

acos

asin

atan

atan2

cos

exp

floor

max

max

min

min

modulo

nextFloat

pow

saturate

saturate

sin

sqrt

tan

toDegrees

toFloat

toRadians

wrapAround

solveQuadraticSystem

abs

max

min

saturate

saturate