0.3.4

core/gay.zharel.hermes.math/InterpolatingMap

InterpolatingMap

class InterpolatingMap<T> : NavigableMap<Double, T>

A navigable map that supports interpolation between values.

InterpolatingMap is a wrapper around a TreeMap<Double, T> that, when queried with a key, returns the exact value if the key exists, or interpolates between the two nearest values otherwise. The interpolation logic is provided by the user via the interpolate function.

Parameters

T

The type of values stored in the map.

Throws

IllegalArgumentException

if the number of keys and values do not match.

Constructors

InterpolatingMap

constructor(interpolator: (T, T, Double) -> T)

constructor(interpolator: (T, T, Double) -> T, keys: List<Double>, values: List<T>)

Properties

open override val entries: MutableSet<MutableMap.MutableEntry<Double, T>>

val interpolate: (T, T, Double) -> T

A function that takes two values and an interpolation factor in 0.0, 1.0, and returns an interpolated value.

open override val keys: MutableSet<Double>

open override val size: Int

val tree: TreeMap<Double, T>

The underlying TreeMap storing the data.

open override val values: MutableCollection<T>

Functions

open override fun ceilingEntry(p0: Double): MutableMap.MutableEntry<Double, T>

open override fun ceilingKey(p0: Double): Double

open override fun clear()

open override fun comparator(): Comparator<in Double>

open override fun containsKey(key: Double): Boolean

open override fun containsValue(value: T): Boolean

descendingKeySet

open override fun descendingKeySet(): NavigableSet<Double>

open override fun descendingMap(): NavigableMap<Double, T>

open override fun firstEntry(): MutableMap.MutableEntry<Double, T>

open override fun firstKey(): Double

open override fun floorEntry(p0: Double): MutableMap.MutableEntry<Double, T>

open override fun floorKey(p0: Double): Double

open operator override fun get(key: Double): T

Gets the value associated with the given key. If the key does not exist, the value is interpolated between the two nearest values.

open override fun headMap(p0: Double): SortedMap<Double, T>

open override fun headMap(p0: Double, p1: Boolean): NavigableMap<Double, T>

open override fun higherEntry(p0: Double): MutableMap.MutableEntry<Double, T>

open override fun higherKey(p0: Double): Double

open override fun isEmpty(): Boolean

open override fun lastEntry(): MutableMap.MutableEntry<Double, T>

open override fun lastKey(): Double

open override fun lowerEntry(p0: Double): MutableMap.MutableEntry<Double, T>

open override fun lowerKey(p0: Double): Double

navigableKeySet

open override fun navigableKeySet(): NavigableSet<Double>

open override fun pollFirstEntry(): MutableMap.MutableEntry<Double, T>

open override fun pollLastEntry(): MutableMap.MutableEntry<Double, T>

open override fun put(key: Double, value: T): T?

open override fun putAll(from: Map<out Double, T>)

open override fun subMap(p0: Double, p1: Double): SortedMap<Double, T>

open override fun subMap(p0: Double, p1: Boolean, p2: Double, p3: Boolean): NavigableMap<Double, T>

open override fun tailMap(p0: Double): SortedMap<Double, T>

open override fun tailMap(p0: Double, p1: Boolean): NavigableMap<Double, T>