com.first.team2052.lib.interpolables

Class InterpolatingDouble

java.lang.Object

com.first.team2052.lib.interpolables.InterpolatingDouble

All Implemented Interfaces:

Interpolable<InterpolatingDouble>, InverseInterpolable<InterpolatingDouble>, java.lang.Comparable<InterpolatingDouble>

public class InterpolatingDouble
extends java.lang.Object
implements Interpolable<InterpolatingDouble>, InverseInterpolable<InterpolatingDouble>, java.lang.Comparable<InterpolatingDouble>

A Double that can be interpolated using the InterpolatingTreeMap.

See Also:

InterpolatingTreeMap

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Double	value

Constructor Summary

Constructors

Constructor and Description
InterpolatingDouble(java.lang.Double val)

Method Summary

Modifier and Type	Method and Description
int	compareTo(InterpolatingDouble other)
InterpolatingDouble	interpolate(InterpolatingDouble other, double x) Interpolates between this value and an other value according to a given parameter.
double	inverseInterpolate(InterpolatingDouble upper, InterpolatingDouble query) Given this point (lower), a query point (query), and an upper point (upper), estimate how far (on [0, 1]) between 'lower' and 'upper' the query point lies.

Methods inherited from class java.lang.Object

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

Field Detail

value

public java.lang.Double value

Constructor Detail

InterpolatingDouble

public InterpolatingDouble(java.lang.Double val)

Method Detail

interpolate

public InterpolatingDouble interpolate(InterpolatingDouble other,
                                       double x)

Description copied from interface: Interpolable

Interpolates between this value and an other value according to a given parameter. If x is 0, the method should return this value. If x is 1, the method should return the other value. If 0 < x < 1, the return value should be interpolated proportionally between the two.

Specified by:

interpolate in interface Interpolable<InterpolatingDouble>

Parameters:

other - The value of the upper bound

x - The requested value. Should be between 0 and 1.

Returns:

The estimated average between the surrounding data

inverseInterpolate

public double inverseInterpolate(InterpolatingDouble upper,
                                 InterpolatingDouble query)

Description copied from interface: InverseInterpolable

Given this point (lower), a query point (query), and an upper point (upper), estimate how far (on [0, 1]) between 'lower' and 'upper' the query point lies.

Specified by:

inverseInterpolate in interface InverseInterpolable<InterpolatingDouble>

Returns:

The interpolation parameter on [0, 1] representing how far between this point and the upper point the query point lies.

compareTo

public int compareTo(InterpolatingDouble other)

Specified by:

compareTo in interface java.lang.Comparable<InterpolatingDouble>