com.tomtom.speedtools.utils

Class MathUtils

java.lang.Object

com.tomtom.speedtools.utils.MathUtils

public final class MathUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static double	EPSILON Precision for floating point numbers; used to decide equality.

Method Summary

Modifier and Type	Method and Description
static double	findMax(double[] a) Find the maximum in a double array.
static double	findMin(double[] a) Find the minimum in a double array.
static boolean	isAlmostEqual(double x, double y) Are two doubles equal?
static boolean	isAlmostZero(double x) Is a double zero?
static boolean	isBetween(double value, double min, double max) Is a value between two limits?
static boolean	isBetween(int value, int min, int max) Is a value between two limits?
static double	limitTo(double value, double min, double max) Limit a value to 2 boundaries.
static int	limitTo(int value, int min, int max) Limit a value to 2 boundaries.
static int	random(int min, int max) Produce a random number between [min..max] (inclusive).
static void	setRandomSeed(long seed) Set the randomizer seed.
static double	wrapValueToWithinLimits(double value, int limit) Map a value to [-limit, limit).

Methods inherited from class java.lang.Object

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

Field Detail

EPSILON

public static final double EPSILON

Precision for floating point numbers; used to decide equality.

See Also:

Constant Field Values

Method Detail

findMin

public static double findMin(@Nonnull
                             double[] a)

Find the minimum in a double array.

Parameters:

a - An array of doubles.

Returns:

The minimum value in a.

findMax

public static double findMax(@Nonnull
                             double[] a)

Find the maximum in a double array.

Parameters:

a - An array of doubles.

Returns:

The maximum value in a.

isAlmostZero

public static boolean isAlmostZero(double x)

Is a double zero?

Parameters:

x - The double to be tested.

Returns:

true iff x is within EPS of 0.0.

isAlmostEqual

public static boolean isAlmostEqual(double x,
                                    double y)

Are two doubles equal?

Parameters:

x - One double.

y - The other double.

Returns:

true iff x and y are within EPS of each other.

isBetween

public static boolean isBetween(int value,
                                int min,
                                int max)

Is a value between two limits?

Parameters:

value - Value to check.

min - Minimum. Must be <= max.

max - Maximum.

Returns:

True if min <= value <= max.

isBetween

public static boolean isBetween(double value,
                                double min,
                                double max)

Is a value between two limits?

Parameters:

value - Value to check.

min - Minimum. Must be <= max.

max - Maximum.

Returns:

True if min <= value <= max.

limitTo

public static int limitTo(int value,
                          int min,
                          int max)

Limit a value to 2 boundaries.

Parameters:

value - Value to limit.

min - Minimum (inclusive). Must be <= max.

max - Maximum (inclusive).

Returns:

Closest value min <= value <= max.

limitTo

public static double limitTo(double value,
                             double min,
                             double max)

Limit a value to 2 boundaries.

Parameters:

value - Value to limit.

min - Minimum (inclusive). Must be <= max.

max - Maximum (inclusive).

Returns:

Closest value min <= value <= max.

random

public static int random(int min,
                         int max)

Produce a random number between [min..max] (inclusive).

Parameters:

min - Minimum (inclusive). Must be <= max.

max - Maximum (inclusive).

Returns:

Random number in [min, max].

setRandomSeed

public static void setRandomSeed(long seed)

Set the randomizer seed.

Parameters:

seed - Seed.

wrapValueToWithinLimits

public static double wrapValueToWithinLimits(double value,
                                             int limit)

Map a value to [-limit, limit). Values outside this range are wrapped to this range.

Parameters:

value - Any value.

Returns:

Wrapped to [-limit, limit).