de.javagl.common.collections

Class DoubleMaps

java.lang.Object

de.javagl.common.collections.DoubleMaps

public class DoubleMaps
extends Object

Utility methods related to maps containing Double keys and values

Method Summary

Modifier and Type	Method and Description
static double	getInterpolated(NavigableMap<Double,? extends Number> map, double key) Returns a linearly interpolated value from the given map.

Methods inherited from class java.lang.Object

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

Method Detail

getInterpolated

public static double getInterpolated(NavigableMap<Double,? extends Number> map,
                                     double key)

Returns a linearly interpolated value from the given map.

For the given key, the next larger and next smaller key will be determined. The values associated with these keys will be interpolated, based on the location of the given key between the next larger and smaller key.

If the given key is larger than the largest key in the given map, then the value of the largest key will be returned.

If the given key is smaller than the smallest key in the given map, then the value of the smallest key will be returned.

Parameters:

map - The map

key - The key

Returns:

The interpolated value

Throws:

IllegalArgumentException - If the given map is empty