org.monospark.geometrix.util

Class RoundingHelper

java.lang.Object

org.monospark.geometrix.util.RoundingHelper

public final class RoundingHelper
extends java.lang.Object

A class which has the sole purpose of checking the equality of values. This is required since floating-point operations are always inaccurate.

Field Summary

Fields

Modifier and Type	Field and Description
static double	ABSOLUTE_MARGIN_VALUE The absolute margin value which is used to check if two values are almost equal to each other.
static double	RELATIVE_MARGIN_VALUE The relative margin value which is used to check if two values are almost equal to each other.

Method Summary

Modifier and Type	Method and Description
static boolean	areValuesAlmostEqual(double d1, double d2) Checks if two values are almost equal by using an absolute margin value for small differences and a relative margin value for bigger differences.

Methods inherited from class java.lang.Object

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

Field Detail

ABSOLUTE_MARGIN_VALUE

public static final double ABSOLUTE_MARGIN_VALUE

The absolute margin value which is used to check if two values are almost equal to each other.

RELATIVE_MARGIN_VALUE

public static final double RELATIVE_MARGIN_VALUE

The relative margin value which is used to check if two values are almost equal to each other.

Method Detail

areValuesAlmostEqual

public static boolean areValuesAlmostEqual(double d1,
                                           double d2)

Checks if two values are almost equal by using an absolute margin value for small differences and a relative margin value for bigger differences.

Parameters:

d1 - the first value

d2 - the second value

Returns:

true if both values are almost equal, false if not

Throws:

java.lang.IllegalArgumentException - if d1 or d2 is equal to (+/-)Infinity or NaN