Skip to main content

Crate spline1d

Crate spline1d 

Source
Expand description

This crate performs cubic spline interpolation and single-interval quadratic interpolation in pure Rust (1-D curves). Currently, the following local interpolation methods are available: akima, makima, pchip, steffen, catmullrom, cardinal, and fritschbutland.

§Feature flags

  • std - enabled by default. Enables CSV-loading helpers and all allocation-backed APIs.
  • alloc - enables allocation-backed spline containers such as Spline<T> without requiring std.
  • --no-default-features - builds the allocation-free, no_std single-interval interpolation API.

§Single-interval APIs

The generic single-interval API takes an InterpolationType and provides cubic cubic_single_left, cubic_single_middle, and cubic_single_right functions, together with their _alpha forms. Cubic normalized form is y(t) = y1 * (1 - t) + y2 * t + (1 - t) * t * (alpha0 + alpha1 * t), so it has two coefficients [alpha0, alpha1].

The parallel quadratic API is quadratic_single_left, quadratic_single_middle, and quadratic_single_right, also with _alpha forms. With t = (x - x1) / (x2 - x1), its normalized form is y(t) = y1 * (1 - t) + y2 * t + alpha * (1 - t) * t: it has one alpha. Direct quadratic coefficients [a, b, c] are local to dx = x - x1 and are evaluated as y = (a * dx + b) * dx + c.

Quadratic left alpha is the corresponding cubic left alpha alpha0. Quadratic right alpha is the corresponding cubic right alpha0 + alpha1. For a middle interval [x1, x2], quadratic alpha is the arithmetic mean of the right alpha from [x0, x1, x2] and the left alpha from [x1, x2, x3]. This is an averaged endpoint-derived construction, not a quadratic fit through all four points.

InterpolationType selects AKIMA, MAKIMA, PCHIP, STEFFEN, CATMULLROM, CARDINAL(tension), or FRITSCHBUTLAND. Method-specific cubic and quadratic functions are public as well, such as pchip_single_middle_quadratic.

use spline1d::{quadratic_single_middle, InterpolationType};

let coeffs: [f64; 3] = quadratic_single_middle(
    InterpolationType::PCHIP,
    0.0, 0.0,
    0.7, 1.0,
    2.1, 1.5,
    4.8, 3.0,
);
let x = 1.2;
let dx = x - 0.7;
let y = (coeffs[0] * dx + coeffs[1]) * dx + coeffs[2];
assert!(y.is_finite());

Cubic interpolation is also available through allocation-backed spline containers that store interval breaks and direct cubic coefficients.

An advanced multivariable 1D interpolation is available with the std feature; interpolation structures for n variables x1, x2, …, xn running along x0 can be calculated simultaneously and used to do any pair-wise lookup xi->xj.

In case of non-monotonous variables, a reverse interpolation search exists with the std feature: a SearchTree is produced to lookup all x values for a given y.

Re-exports§

pub use crate::methods::InterpolationType;
pub use crate::methods::cubic_single_left;
pub use crate::methods::cubic_single_left_alpha;
pub use crate::methods::cubic_single_middle;
pub use crate::methods::cubic_single_middle_alpha;
pub use crate::methods::cubic_single_right;
pub use crate::methods::cubic_single_right_alpha;
pub use crate::methods::quadratic_single_left;
pub use crate::methods::quadratic_single_left_alpha;
pub use crate::methods::quadratic_single_middle;
pub use crate::methods::quadratic_single_middle_alpha;
pub use crate::methods::quadratic_single_right;
pub use crate::methods::quadratic_single_right_alpha;
pub use crate::methods::akima_single_left_quadratic;
pub use crate::methods::akima_single_left_quadratic_alpha;
pub use crate::methods::akima_single_middle_quadratic;
pub use crate::methods::akima_single_middle_quadratic_alpha;
pub use crate::methods::akima_single_right_quadratic;
pub use crate::methods::akima_single_right_quadratic_alpha;
pub use crate::methods::cardinal_single_left_quadratic;
pub use crate::methods::cardinal_single_left_quadratic_alpha;
pub use crate::methods::cardinal_single_middle_quadratic;
pub use crate::methods::cardinal_single_middle_quadratic_alpha;
pub use crate::methods::cardinal_single_right_quadratic;
pub use crate::methods::cardinal_single_right_quadratic_alpha;
pub use crate::methods::catmullrom_single_left_quadratic;
pub use crate::methods::catmullrom_single_left_quadratic_alpha;
pub use crate::methods::catmullrom_single_middle_quadratic;
pub use crate::methods::catmullrom_single_middle_quadratic_alpha;
pub use crate::methods::catmullrom_single_right_quadratic;
pub use crate::methods::catmullrom_single_right_quadratic_alpha;
pub use crate::methods::fritschbutland_single_left_quadratic;
pub use crate::methods::fritschbutland_single_left_quadratic_alpha;
pub use crate::methods::fritschbutland_single_middle_quadratic;
pub use crate::methods::fritschbutland_single_middle_quadratic_alpha;
pub use crate::methods::fritschbutland_single_right_quadratic;
pub use crate::methods::fritschbutland_single_right_quadratic_alpha;
pub use crate::methods::makima_single_left_quadratic;
pub use crate::methods::makima_single_left_quadratic_alpha;
pub use crate::methods::makima_single_middle_quadratic;
pub use crate::methods::makima_single_middle_quadratic_alpha;
pub use crate::methods::makima_single_right_quadratic;
pub use crate::methods::makima_single_right_quadratic_alpha;
pub use crate::methods::pchip_single_left_quadratic;
pub use crate::methods::pchip_single_left_quadratic_alpha;
pub use crate::methods::pchip_single_middle_quadratic;
pub use crate::methods::pchip_single_middle_quadratic_alpha;
pub use crate::methods::pchip_single_right_quadratic;
pub use crate::methods::pchip_single_right_quadratic_alpha;
pub use crate::methods::steffen_single_left_quadratic;
pub use crate::methods::steffen_single_left_quadratic_alpha;
pub use crate::methods::steffen_single_middle_quadratic;
pub use crate::methods::steffen_single_middle_quadratic_alpha;
pub use crate::methods::steffen_single_right_quadratic;
pub use crate::methods::steffen_single_right_quadratic_alpha;
pub use crate::methods::akima::akima;
pub use crate::methods::akima::slopes_akima;
pub use crate::methods::akima::akima_single_left;
pub use crate::methods::akima::akima_single_left_alpha;
pub use crate::methods::akima::akima_single_middle;
pub use crate::methods::akima::akima_single_middle_alpha;
pub use crate::methods::akima::akima_single_right;
pub use crate::methods::akima::akima_single_right_alpha;
pub use crate::methods::makima::makima;
pub use crate::methods::makima::slopes_makima;
pub use crate::methods::makima::makima_single_left;
pub use crate::methods::makima::makima_single_left_alpha;
pub use crate::methods::makima::makima_single_middle;
pub use crate::methods::makima::makima_single_middle_alpha;
pub use crate::methods::makima::makima_single_right;
pub use crate::methods::makima::makima_single_right_alpha;
pub use crate::methods::pchip::pchip;
pub use crate::methods::pchip::slopes_pchip;
pub use crate::methods::pchip::pchip_single_left;
pub use crate::methods::pchip::pchip_single_left_alpha;
pub use crate::methods::pchip::pchip_single_middle;
pub use crate::methods::pchip::pchip_single_middle_alpha;
pub use crate::methods::pchip::pchip_single_right;
pub use crate::methods::pchip::pchip_single_right_alpha;
pub use crate::methods::steffen::slopes_steffen;
pub use crate::methods::steffen::steffen;
pub use crate::methods::steffen::steffen_single_left;
pub use crate::methods::steffen::steffen_single_left_alpha;
pub use crate::methods::steffen::steffen_single_middle;
pub use crate::methods::steffen::steffen_single_middle_alpha;
pub use crate::methods::steffen::steffen_single_right;
pub use crate::methods::steffen::steffen_single_right_alpha;
pub use crate::methods::catmullrom::catmullrom;
pub use crate::methods::catmullrom::slopes_catmullrom;
pub use crate::methods::catmullrom::catmullrom_single_left;
pub use crate::methods::catmullrom::catmullrom_single_left_alpha;
pub use crate::methods::catmullrom::catmullrom_single_middle;
pub use crate::methods::catmullrom::catmullrom_single_middle_alpha;
pub use crate::methods::catmullrom::catmullrom_single_right;
pub use crate::methods::catmullrom::catmullrom_single_right_alpha;
pub use crate::methods::cardinal::cardinal;
pub use crate::methods::cardinal::slopes_cardinal;
pub use crate::methods::cardinal::cardinal_single_left;
pub use crate::methods::cardinal::cardinal_single_left_alpha;
pub use crate::methods::cardinal::cardinal_single_middle;
pub use crate::methods::cardinal::cardinal_single_middle_alpha;
pub use crate::methods::cardinal::cardinal_single_right;
pub use crate::methods::cardinal::cardinal_single_right_alpha;
pub use crate::methods::fritschbutland::fritschbutland;
pub use crate::methods::fritschbutland::slopes_fritschbutland;
pub use crate::methods::fritschbutland::fritschbutland_single_left;
pub use crate::methods::fritschbutland::fritschbutland_single_left_alpha;
pub use crate::methods::fritschbutland::fritschbutland_single_middle;
pub use crate::methods::fritschbutland::fritschbutland_single_middle_alpha;
pub use crate::methods::fritschbutland::fritschbutland_single_right;
pub use crate::methods::fritschbutland::fritschbutland_single_right_alpha;
pub use crate::alpha::alpha_to_cubic_coeffs;
pub use crate::alpha::alpha_to_quadratic_coeffs;
pub use crate::alpha::alpha_to_standard_cubic_coeffs;
pub use crate::alpha::cubic_coeffs_to_alpha;
pub use crate::alpha::cubic_coeffs_to_alpha_unit;
pub use crate::alpha::quadratic_coeffs_to_alpha;
pub use crate::alpha::quadratic_coeffs_to_alpha_unit;
pub use crate::binsearch::binary_search_interval;
pub use crate::multispline::load_multispline_from_csv;
pub use crate::multispline::MultiSpline;
pub use crate::searchtree::SearchNode;
pub use crate::searchtree::SearchTree;
pub use crate::spline::Spline;

Modules§

alpha
Conversion utilities for normalized cubic and quadratic interval forms.
binsearch
binary search algorithm to find the interval containing a search value; assumes monotonicity.
methods
All single-interval cubic and quadratic interpolation methods are grouped here.
multispline
searchtree
This module handles inverse cubic interpolation (finding all xs corresponding to a given value of y). Since in general case, there might be multiple values, the standard bincode which works for monotonous functions, will not work. Instread, a search tree is constructed which map monotonous regions of y->x mapping and root search happens in the tree subdivisions.
solve
Finding the cubic root (y = 0 intersection) analytically.
spline
The main structure in this module, Spline, encapsulates the calculated cubic spline coefficients and automatically handles interval location and interpolation using the appropriate set of cubic coefficients.