io.github.thunderbots.lightning.utility

Class MathUtil

java.lang.Object

io.github.thunderbots.lightning.utility.MathUtil

public final class MathUtil
extends java.lang.Object

The MathUtil class contains static methods for common calculations and mathematical utilities.

Author:

Zach Ohara

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MathUtil() MathUtil should not be instantiable.

Method Summary

Modifier and Type	Method and Description
static double	scaleToRange(double num, double[] inputRange, double[] outputRange) Scales a number within some range to a corresponding position relative to another range.
static double	truncateToRange(double num, double min, double max) Truncates the number to be only within a given range.

Methods inherited from class java.lang.Object

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

Constructor Detail

MathUtil

private MathUtil()

MathUtil should not be instantiable.

Method Detail

scaleToRange

public static double scaleToRange(double num,
                                  double[] inputRange,
                                  double[] outputRange)

Scales a number within some range to a corresponding position relative to another range. If the absolute value of the number is below the input range, 0 will be returned. If the absolute value of the number is above the input range, the maximum value of the output range, but with the same polarity as the number, will be returned.

Parameters:

num - the number to be scaled

inputRange - a two-element array representing the lowest and and highest values, respectively, of the range to be scaled from

outputRange - a two-element array representing the lowest and and highest values, respectively, of the range to be scaled to

Returns:

the number, scaled to the same relative position within the output range

truncateToRange

public static double truncateToRange(double num,
                                     double min,
                                     double max)

Truncates the number to be only within a given range. If the number is already within the given range, the number is returned unchanged. If the number is less than the minimum, then the minimum is returned, and if the number is greater than the maximum, then the maximum is returned.

Parameters:

num - the number to scale.

min - the minimum of the range.

max - the maximum range.

Returns:

the closest approximation of num such that min <= num <= max .