[wpimath] Add InterpolatedTreeMap (#4073)

- Add InterpolatedTreeMap for Java from team 254's 2016 MIT licensed code
- Add InterpolatedMap for C++ from team 3512's code with @calcmogul (original author) permission

Co-authored-by: Tyler Veness <calcmogul@gmail.com>
This commit is contained in:
Ashray._.g
2022-03-19 20:46:42 -07:00
committed by GitHub
parent 765efa325e
commit 0d70884dce
4 changed files with 369 additions and 0 deletions

View File

@@ -0,0 +1,96 @@
// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
package edu.wpi.first.util;
import java.util.TreeMap;
/**
* 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.
*/
public class InterpolatingTreeMap<K extends Number, V extends Number> {
private final TreeMap<K, V> m_map = new TreeMap<>();
/**
* Inserts a key-value pair.
*
* @param key The key.
* @param value The value.
*/
public void put(K key, V value) {
m_map.put(key, value);
}
/**
* Returns the value associated with a given key.
*
* <p>If there's no matching key, the value returned will be a linear interpolation between the
* keys before and after the provided one.
*
* @param key The key.
* @return The value associated with the given key.
*/
public Double get(K key) {
V val = m_map.get(key);
if (val == null) {
K ceilingKey = m_map.ceilingKey(key);
K floorKey = m_map.floorKey(key);
if (ceilingKey == null && floorKey == null) {
return null;
}
if (ceilingKey == null) {
return m_map.get(floorKey).doubleValue();
}
if (floorKey == null) {
return m_map.get(ceilingKey).doubleValue();
}
V floor = m_map.get(floorKey);
V ceiling = m_map.get(ceilingKey);
return interpolate(floor, ceiling, inverseInterpolate(ceilingKey, key, floorKey));
} else {
return val.doubleValue();
}
}
/** Clears the contents. */
public void clear() {
m_map.clear();
}
/**
* Return the value interpolated between val1 and val2 by the interpolant d.
*
* @param val1 The lower part of the interpolation range.
* @param val2 The upper part of the interpolation range.
* @param d The interpolant in the range [0, 1].
* @return The interpolated value.
*/
private double interpolate(V val1, V val2, double d) {
double dydx = val2.doubleValue() - val1.doubleValue();
return dydx * d + val1.doubleValue();
}
/**
* Return where within interpolation range [0, 1] q is between down and up.
*
* @param up Upper part of interpolation range.
* @param q Query.
* @param down Lower part of interpolation range.
* @return Interpolant in range [0, 1].
*/
private double inverseInterpolate(K up, K q, K down) {
double upperToLower = up.doubleValue() - down.doubleValue();
if (upperToLower <= 0) {
return 0.0;
}
double queryToLower = q.doubleValue() - down.doubleValue();
if (queryToLower <= 0) {
return 0.0;
}
return queryToLower / upperToLower;
}
}