eu.printingin3d.javascad.utils

Class DoubleUtils

java.lang.Object

eu.printingin3d.javascad.utils.DoubleUtils

public final class DoubleUtils
extends Object

Miscellaneous helper methods regarding doubles.

Author:

ivivan

Method Summary

Modifier and Type	Method and Description
static boolean	between(double value, double value1, double value2) Returns true if and only if the given value is between value1 and value2.
static int	compareEps(double a, double b) Compare two doubles and returns with an integer similar to Double.compare(double, double), but with regards to a predefined epsilon value.
static boolean	equalsEps(double a, double b) Checks the the given doubles if they are equals - which means they are closer than a predefined epsilon value, because comparing two doubles directly is a bad practice.
static String	formatDouble(double value) Format the given double with four digits precision, but leave it without a decimal point.
static int	hashCodeEps(double value) Create a hash value of the given double.
static boolean	isZero(double a) Checks if the given double value is zero using a stricter epsilon value than equalsEps(double, double).

Methods inherited from class java.lang.Object

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

Method Detail

equalsEps

public static boolean equalsEps(double a,
                                double b)

Checks the the given doubles if they are equals - which means they are closer than a predefined epsilon value, because comparing two doubles directly is a bad practice.

Parameters:

a - one of the values to be checked

b - the other value to be checked

Returns:

true if the two values are close enough to call them equals

compareEps

public static int compareEps(double a,
                             double b)

Compare two doubles and returns with an integer similar to Double.compare(double, double), but with regards to a predefined epsilon value. The epsilon value is the same as equalsEps(double, double) method. If the equalsEps returns with true this method will return with zero and vice versa.

Parameters:

a - the first value to compare

b - the second value to compare

Returns:

an integer similar to Double.compare(double, double), but with regards to a predefined epsilon value

hashCodeEps

public static int hashCodeEps(double value)

Create a hash value of the given double. It will satisfy the basic rule of equals and hashCode methods that if two values are equals they have to have to same hash code value.

So this class's equalsEps(double, double) method and this method satisfies this rule: if two double value gives back true with equalEps than this method will generate the same hash code for them.

Parameters:

value - the double value to be used to generate the hash code

Returns:

the calculated hash code

isZero

public static boolean isZero(double a)

Checks if the given double value is zero using a stricter epsilon value than equalsEps(double, double).

Parameters:

a - the double value to be checked

Returns:

true if and only if the value is closed than a predefined epsilon value

formatDouble

public static String formatDouble(double value)

Format the given double with four digits precision, but leave it without a decimal point. if it is a round value

Parameters:

value - the value to be formatted

Returns:

the formatted string

between

public static boolean between(double value,
                              double value1,
                              double value2)

Returns true if and only if the given value is between value1 and value2. It doesn't matter if value1 is bigger than value2 or vica-versa.

Parameters:

value - the value to be checked

value1 - the border of the interval

value2 - the border of the interval.

Returns:

true if and only if the given value is between value1 and value2