com.frostphyr.avail

Class FloatingPoint

java.lang.Object

com.frostphyr.avail.FloatingPoint

public final class FloatingPoint
extends Object

Utility class containing methods for floating point types float and double.

Since:

1.4

Field Summary

Fields

Modifier and Type	Field and Description
static double	EPSILON_DEFAULT_DOUBLE The default epsilon used for doubles which has a value of 1E-9.
static float	EPSILON_DEFAULT_FLOAT The default epsilon used for floats which has a value of 1E-5.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(double value1, double value2) Returns whether value1 and value2 are equal using the default epsilon EPSILON_DEFAULT_DOUBLE.
static boolean	equals(double value1, double value2, double epsilon) Returns whether value1 and value2 are equal given the specified epsilon.
static boolean	equals(float value1, float value2) Returns whether value1 and value2 are equal using the default epsilon EPSILON_DEFAULT_FLOAT.
static boolean	equals(float value1, float value2, float epsilon) Returns whether value1 and value2 are equal given the specified epsilon.
static boolean	greaterThan(double value1, double value2) Returns whether value1 is greater than value2.
static boolean	greaterThan(double value1, double value2, double epsilon) Returns whether value1 is greater than value2.
static boolean	greaterThan(float value1, float value2) Returns whether value1 is greater than value2.
static boolean	greaterThan(float value1, float value2, float epsilon) Returns whether value1 is greater than value2.
static boolean	greaterThanOrEqual(double value1, double value2) Returns whether value1 is greater than or equal to value2.
static boolean	greaterThanOrEqual(double value1, double value2, double epsilon) Returns whether value1 is greater than or equal to value2.
static boolean	greaterThanOrEqual(float value1, float value2) Returns whether value1 is greater than or equal to value2.
static boolean	greaterThanOrEqual(float value1, float value2, float epsilon) Returns whether value1 is greater than or equal to value2.
static boolean	lessThan(double value1, double value2) Returns whether value1 is less than value2.
static boolean	lessThan(double value1, double value2, double epsilon) Returns whether value1 is less than value2.
static boolean	lessThan(float value1, float value2) Returns whether value1 is less than value2.
static boolean	lessThan(float value1, float value2, float epsilon) Returns whether value1 is less than value2.
static boolean	lessThanOrEqual(double value1, double value2) Returns whether value1 is less than or equal to value2.
static boolean	lessThanOrEqual(double value1, double value2, double epsilon) Returns whether value1 is less than or equal to value2.
static boolean	lessThanOrEqual(float value1, float value2) Returns whether value1 is less than or equal to value2.
static boolean	lessThanOrEqual(float value1, float value2, float epsilon) Returns whether value1 is less than or equal to value2.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EPSILON_DEFAULT_FLOAT

public static final float EPSILON_DEFAULT_FLOAT

The default epsilon used for floats which has a value of 1E-5.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

See Also:

Constant Field Values

EPSILON_DEFAULT_DOUBLE

public static final double EPSILON_DEFAULT_DOUBLE

The default epsilon used for doubles which has a value of 1E-9.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

See Also:

Constant Field Values

Method Detail

equals

public static boolean equals(float value1,
                             float value2,
                             float epsilon)

Returns whether value1 and value2 are equal given the specified epsilon.

Parameters:

value1 - the first value to compare

value2 - the second value to compare

epsilon - the acceptable margin of error between both values where they will be considered equal

Returns:

true if value1 and value2 are within the specified epsilon of each other; false otherwise

equals

public static boolean equals(float value1,
                             float value2)

Returns whether value1 and value2 are equal using the default epsilon EPSILON_DEFAULT_FLOAT.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

Parameters:

value1 - the first value to compare

value2 - the second value to compare

Returns:

true if value1 and value2 are within the default epsilon of each other; false otherwise

equals

public static boolean equals(double value1,
                             double value2,
                             double epsilon)

Returns whether value1 and value2 are equal given the specified epsilon.

Parameters:

value1 - the first value to compare

value2 - the second value to compare

epsilon - the acceptable margin of error between both values where they will be considered equal

Returns:

true if value1 and value2 are within the specified epsilon of each other; false otherwise

equals

public static boolean equals(double value1,
                             double value2)

Returns whether value1 and value2 are equal using the default epsilon EPSILON_DEFAULT_DOUBLE.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

Parameters:

value1 - the first value to compare

value2 - the second value to compare

Returns:

true if value1 and value2 are within the default epsilon of each other; false otherwise

lessThan

public static boolean lessThan(float value1,
                               float value2,
                               float epsilon)

Returns whether value1 is less than value2. The epsilon is used to determine if the values are equal, in which case it will return false.

Parameters:

value1 - the value to check if it is less than value2

value2 - the value to check if value1 is less than

epsilon - the acceptable margin of error between both values where they will be considered equal

Returns:

true if value1 is less than value2; false otherwise

See Also:

equals(float, float, float)

lessThan

public static boolean lessThan(float value1,
                               float value2)

Returns whether value1 is less than value2. The default epsilon EPSILON_DEFAULT_FLOAT is used to determine if the values are equal, in which case it will return false.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

Parameters:

value1 - the value to check if it is less than value2

value2 - the value to check if value1 is less than

Returns:

true if value1 is less than value2; false otherwise

See Also:

equals(float, float)

lessThan

public static boolean lessThan(double value1,
                               double value2,
                               double epsilon)

Returns whether value1 is less than value2. The epsilon is used to determine if the values are equal, in which case it will return false.

Parameters:

value1 - the value to check if it is less than value2

value2 - the value to check if value1 is less than

epsilon - the acceptable margin of error between both values where they will be considered equal

Returns:

true if value1 is less than value2; false otherwise

See Also:

equals(double, double, double)

lessThan

public static boolean lessThan(double value1,
                               double value2)

Returns whether value1 is less than value2. The default epsilon EPSILON_DEFAULT_DOUBLE is used to determine if the values are equal, in which case it will return false.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

Parameters:

value1 - the value to check if it is less than value2

value2 - the value to check if value1 is less than

Returns:

true if value1 is less than value2; false otherwise

See Also:

equals(double, double)

greaterThan

public static boolean greaterThan(float value1,
                                  float value2,
                                  float epsilon)

Returns whether value1 is greater than value2. The epsilon is used to determine if the values are equal, in which case it will return false.

Parameters:

value1 - the value to check if it is greater than value2

value2 - the value to check if value1 is greater than

epsilon - the acceptable margin of error between both values where they will be considered equal

Returns:

true if value1 is greater than value2; false otherwise

See Also:

equals(float, float, float)

greaterThan

public static boolean greaterThan(float value1,
                                  float value2)

Returns whether value1 is greater than value2. The default epsilon EPSILON_DEFAULT_FLOAT is used to determine if the values are equal, in which case it will return false.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

Parameters:

value1 - the value to check if it is greater than value2

value2 - the value to check if value1 is greater than

Returns:

true if value1 is greater than value2; false otherwise

See Also:

equals(float, float)

greaterThan

public static boolean greaterThan(double value1,
                                  double value2,
                                  double epsilon)

Returns whether value1 is greater than value2. The epsilon is used to determine if the values are equal, in which case it will return false.

Parameters:

value1 - the value to check if it is greater than value2

value2 - the value to check if value1 is greater than

epsilon - the acceptable margin of error between both values where they will be considered equal

Returns:

true if value1 is greater than value2; false otherwise

See Also:

equals(double, double, double)

greaterThan

public static boolean greaterThan(double value1,
                                  double value2)

Returns whether value1 is greater than value2. The default epsilon EPSILON_DEFAULT_DOUBLE is used to determine if the values are equal, in which case it will return false.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

Parameters:

value1 - the value to check if it is greater than value2

value2 - the value to check if value1 is greater than

Returns:

true if value1 is greater than value2; false otherwise

See Also:

equals(double, double)

lessThanOrEqual

public static boolean lessThanOrEqual(float value1,
                                      float value2,
                                      float epsilon)

Returns whether value1 is less than or equal to value2. The epsilon is used to determine if the values are equal, in which case it will return true.

Parameters:

value1 - the value to check if it is less than or equal to value2

value2 - the value to check if value1 is less than or equal to

epsilon - the acceptable margin of error between both values where they will be considered equal

Returns:

true if value1 is less than or equal to value2; false otherwise

See Also:

equals(float, float, float)

lessThanOrEqual

public static boolean lessThanOrEqual(float value1,
                                      float value2)

Returns whether value1 is less than or equal to value2. The default epsilon EPSILON_DEFAULT_FLOAT is used to determine if the values are equal, in which case it will return true.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

Parameters:

value1 - the value to check if it is less than or equal to value2

value2 - the value to check if value1 is less than or equal to

Returns:

true if value1 is less than or equal to value2; false otherwise

See Also:

equals(float, float)

lessThanOrEqual

public static boolean lessThanOrEqual(double value1,
                                      double value2,
                                      double epsilon)

Returns whether value1 is less than or equal to value2. The epsilon is used to determine if the values are equal, in which case it will return true.

Parameters:

value1 - the value to check if it is less than or equal to value2

value2 - the value to check if value1 is less than or equal to

epsilon - the acceptable margin of error between both values where they will be considered equal

Returns:

true if value1 is less than or equal to value2; false otherwise

See Also:

equals(double, double, double)

lessThanOrEqual

public static boolean lessThanOrEqual(double value1,
                                      double value2)

Returns whether value1 is less than or equal to value2. The default epsilon EPSILON_DEFAULT_DOUBLE is used to determine if the values are equal, in which case it will return true.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

Parameters:

value1 - the value to check if it is less than or equal to value2

value2 - the value to check if value1 is less than or equal to

Returns:

true if value1 is less than or equal to value2; false otherwise

See Also:

equals(double, double)

greaterThanOrEqual

public static boolean greaterThanOrEqual(float value1,
                                         float value2,
                                         float epsilon)

Returns whether value1 is greater than or equal to value2. The epsilon is used to determine if the values are equal, in which case it will return true.

Parameters:

value1 - the value to check if it is greater than or equal to value2

value2 - the value to check if value1 is greater than or equal to

epsilon - the acceptable margin of error between both values where they will be considered equal

Returns:

true if value1 is greater than or equal to value2; false otherwise

See Also:

equals(float, float, float)

greaterThanOrEqual

public static boolean greaterThanOrEqual(float value1,
                                         float value2)

Returns whether value1 is greater than or equal to value2. The default epsilon EPSILON_DEFAULT_FLOAT is used to determine if the values are equal, in which case it will return true.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

Parameters:

value1 - the value to check if it is greater than or equal to value2

value2 - the value to check if value1 is greater than or equal to

Returns:

true if value1 is greater than or equal to value2; false otherwise

See Also:

equals(float, float)

greaterThanOrEqual

public static boolean greaterThanOrEqual(double value1,
                                         double value2,
                                         double epsilon)

Returns whether value1 is greater than or equal to value2. The epsilon is used to determine if the values are equal, in which case it will return true.

Parameters:

value1 - the value to check if it is greater than or equal to value2

value2 - the value to check if value1 is greater than or equal to

epsilon - the acceptable margin of error between both values where they will be considered equal

Returns:

true if value1 is greater than or equal to value2; false otherwise

See Also:

equals(double, double, double)

greaterThanOrEqual

public static boolean greaterThanOrEqual(double value1,
                                         double value2)

Returns whether value1 is greater than or equal to value2. The default epsilon EPSILON_DEFAULT_DOUBLE is used to determine if the values are equal, in which case it will return true.

Care should be taken when using default epsilons as it may produce unexpected results depending on the values used.

Parameters:

value1 - the value to check if it is greater than or equal to value2

value2 - the value to check if value1 is greater than or equal to

Returns:

true if value1 is greater than or equal to value2; false otherwise

See Also:

equals(double, double)