edu.stanford.rsl.conrad.utils.interpolation

Class NumberInterpolatingTreeMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<java.lang.Number,java.lang.Number>

edu.stanford.rsl.conrad.utils.interpolation.NumberInterpolatingTreeMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Number,java.lang.Number>, java.util.NavigableMap<java.lang.Number,java.lang.Number>, java.util.SortedMap<java.lang.Number,java.lang.Number>

public class NumberInterpolatingTreeMap
extends java.util.TreeMap<java.lang.Number,java.lang.Number>

This is a generic implementation of LinearInterpolatingDoubleArray used in modeling an interpolated table.

In this implementation:

Keys represent Input and Values represent the Output.

Entries added to this data structure are automatically sorted by key value.

The default interpolation scheme used is this class is linear, however developers can create custom interpolation schemes.

Author:

Rotimi X Ojo *

See Also:

LinearInterpolatingDoubleArray, Interpolator, TreeMap, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
NumberInterpolatingTreeMap()

Method Summary

Methods

Modifier and Type	Method and Description
Interpolator	getInterpolator() Retrieve the intepolator used by the class
java.lang.Number	interpolateValue(java.lang.Number key) Returns the intepolated value of key
void	put(double[] keys, double[] values) Insert a array of input and corresponding output to data structure.
void	put(java.lang.Number[] keys, java.lang.Number[] values) Insert a array of input and corresponding output to data structure.
void	setInterpolator(Interpolator interpolator) Set the interpolating scheme used by the class.

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty

Constructor Detail

NumberInterpolatingTreeMap

public NumberInterpolatingTreeMap()

Method Detail

interpolateValue

public java.lang.Number interpolateValue(java.lang.Number key)

Returns the intepolated value of key

Parameters:

key - is the input to the intepolating function

Returns:

throws RuntimeException if provided key is out of bounds

setInterpolator

public void setInterpolator(Interpolator interpolator)

Set the interpolating scheme used by the class. A linear interpolator is used by default

Parameters:

interpolator - is interpolator used by the class

getInterpolator

public Interpolator getInterpolator()

Retrieve the intepolator used by the class

Returns:

the interpolator used by the class

put

public void put(java.lang.Number[] keys,
       java.lang.Number[] values)

Insert a array of input and corresponding output to data structure. input-output pairs are automatially sorted by key value

Parameters:

keys - is an array of input values.

values - is corresponding array of output values.

put

public void put(double[] keys,
       double[] values)

Insert a array of input and corresponding output to data structure. input-output pairs are automatially sorted by key value

Parameters:

keys - is an array of input values.

values - is corresponding array of output values.