com.first.team2052.lib.interpolables

Class InterpolatingTreeMap<K extends InverseInterpolable<K> & java.lang.Comparable<K>,V extends Interpolable<V>>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<K,V>

com.first.team2052.lib.interpolables.InterpolatingTreeMap<K,V>

Type Parameters:

K - The type of the key (must implement InverseInterpolable)

V - The type of the value (must implement Interpolable)

All Implemented Interfaces:

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

public class InterpolatingTreeMap<K extends InverseInterpolable<K> & java.lang.Comparable<K>,V extends Interpolable<V>>
extends java.util.TreeMap<K,V>

Interpolating Tree Maps are used to get values at points that are not defined by making a guess from points that are defined. This uses linear interpolation.

See Also:

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
InterpolatingTreeMap()
InterpolatingTreeMap(int maximumSize)

Method Summary

Modifier and Type	Method and Description
V	getInterpolated(K key)
V	put(K key, V value) Inserts a key value pair, and trims the tree if a max size is specified
void	putAll(java.util.Map<? extends K,? extends V> map)

Methods inherited from class java.util.TreeMap

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

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Constructor Detail

InterpolatingTreeMap

public InterpolatingTreeMap(int maximumSize)

InterpolatingTreeMap

public InterpolatingTreeMap()

Method Detail

put

public V put(K key,
             V value)

Inserts a key value pair, and trims the tree if a max size is specified

Specified by:

put in interface java.util.Map<K extends InverseInterpolable<K> & java.lang.Comparable<K>,V extends Interpolable<V>>

Overrides:

put in class java.util.TreeMap<K extends InverseInterpolable<K> & java.lang.Comparable<K>,V extends Interpolable<V>>

Parameters:

key - Key for inserted data

value - Value for inserted data

Returns:

the value

putAll

public void putAll(java.util.Map<? extends K,? extends V> map)

Specified by:

putAll in interface java.util.Map<K extends InverseInterpolable<K> & java.lang.Comparable<K>,V extends Interpolable<V>>

Overrides:

putAll in class java.util.TreeMap<K extends InverseInterpolable<K> & java.lang.Comparable<K>,V extends Interpolable<V>>

getInterpolated

public V getInterpolated(K key)

Parameters:

key - Lookup for a value (does not have to exist)

Returns:

V or null; V if it is Interpolable or exists, null if it is at a bound and cannot average