spline1d 0.1.1

One-dimensional cubic splines, quadratic single-interval interpolation, and inverse lookup primitives.
Documentation
// lib.rs (splines library)

#![cfg_attr(not(feature = "std"), no_std)]

//! 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.

#[cfg(feature = "alloc")]
extern crate alloc;

pub mod alpha;
pub mod binsearch;
pub mod methods;

#[cfg(feature = "std")]
pub mod multispline;
#[cfg(feature = "std")]
pub mod searchtree;
#[cfg(feature = "alloc")]
pub mod solve;
#[cfg(feature = "alloc")]
pub mod spline;

pub use crate::methods::InterpolationType;

pub use crate::methods::{
    cubic_single_left, cubic_single_left_alpha, cubic_single_middle, cubic_single_middle_alpha,
    cubic_single_right, cubic_single_right_alpha, quadratic_single_left,
    quadratic_single_left_alpha, quadratic_single_middle, quadratic_single_middle_alpha,
    quadratic_single_right, quadratic_single_right_alpha,
};

pub use crate::methods::{
    akima_single_left_quadratic, akima_single_left_quadratic_alpha, akima_single_middle_quadratic,
    akima_single_middle_quadratic_alpha, akima_single_right_quadratic,
    akima_single_right_quadratic_alpha, cardinal_single_left_quadratic,
    cardinal_single_left_quadratic_alpha, cardinal_single_middle_quadratic,
    cardinal_single_middle_quadratic_alpha, cardinal_single_right_quadratic,
    cardinal_single_right_quadratic_alpha, catmullrom_single_left_quadratic,
    catmullrom_single_left_quadratic_alpha, catmullrom_single_middle_quadratic,
    catmullrom_single_middle_quadratic_alpha, catmullrom_single_right_quadratic,
    catmullrom_single_right_quadratic_alpha, fritschbutland_single_left_quadratic,
    fritschbutland_single_left_quadratic_alpha, fritschbutland_single_middle_quadratic,
    fritschbutland_single_middle_quadratic_alpha, fritschbutland_single_right_quadratic,
    fritschbutland_single_right_quadratic_alpha, makima_single_left_quadratic,
    makima_single_left_quadratic_alpha, makima_single_middle_quadratic,
    makima_single_middle_quadratic_alpha, makima_single_right_quadratic,
    makima_single_right_quadratic_alpha, pchip_single_left_quadratic,
    pchip_single_left_quadratic_alpha, pchip_single_middle_quadratic,
    pchip_single_middle_quadratic_alpha, pchip_single_right_quadratic,
    pchip_single_right_quadratic_alpha, steffen_single_left_quadratic,
    steffen_single_left_quadratic_alpha, steffen_single_middle_quadratic,
    steffen_single_middle_quadratic_alpha, steffen_single_right_quadratic,
    steffen_single_right_quadratic_alpha,
};

#[cfg(feature = "alloc")]
pub use crate::methods::akima::{akima, slopes_akima};
pub use crate::methods::akima::{
    akima_single_left, akima_single_left_alpha, akima_single_middle, akima_single_middle_alpha,
    akima_single_right, akima_single_right_alpha,
};

#[cfg(feature = "alloc")]
pub use crate::methods::makima::{makima, slopes_makima};
pub use crate::methods::makima::{
    makima_single_left, makima_single_left_alpha, makima_single_middle, makima_single_middle_alpha,
    makima_single_right, makima_single_right_alpha,
};

#[cfg(feature = "alloc")]
pub use crate::methods::pchip::{pchip, slopes_pchip};
pub use crate::methods::pchip::{
    pchip_single_left, pchip_single_left_alpha, pchip_single_middle, pchip_single_middle_alpha,
    pchip_single_right, pchip_single_right_alpha,
};

#[cfg(feature = "alloc")]
pub use crate::methods::steffen::{slopes_steffen, steffen};
pub use crate::methods::steffen::{
    steffen_single_left, steffen_single_left_alpha, steffen_single_middle,
    steffen_single_middle_alpha, steffen_single_right, steffen_single_right_alpha,
};

#[cfg(feature = "alloc")]
pub use crate::methods::catmullrom::{catmullrom, slopes_catmullrom};
pub use crate::methods::catmullrom::{
    catmullrom_single_left, catmullrom_single_left_alpha, catmullrom_single_middle,
    catmullrom_single_middle_alpha, catmullrom_single_right, catmullrom_single_right_alpha,
};

#[cfg(feature = "alloc")]
pub use crate::methods::cardinal::{cardinal, slopes_cardinal};
pub use crate::methods::cardinal::{
    cardinal_single_left, cardinal_single_left_alpha, cardinal_single_middle,
    cardinal_single_middle_alpha, cardinal_single_right, cardinal_single_right_alpha,
};

#[cfg(feature = "alloc")]
pub use crate::methods::fritschbutland::{fritschbutland, slopes_fritschbutland};
pub use crate::methods::fritschbutland::{
    fritschbutland_single_left, fritschbutland_single_left_alpha, fritschbutland_single_middle,
    fritschbutland_single_middle_alpha, fritschbutland_single_right,
    fritschbutland_single_right_alpha,
};

pub use crate::alpha::{
    alpha_to_cubic_coeffs, alpha_to_quadratic_coeffs, alpha_to_standard_cubic_coeffs,
    cubic_coeffs_to_alpha, cubic_coeffs_to_alpha_unit, quadratic_coeffs_to_alpha,
    quadratic_coeffs_to_alpha_unit,
};
pub use crate::binsearch::binary_search_interval;

#[cfg(feature = "std")]
pub use crate::multispline::{load_multispline_from_csv, MultiSpline};
#[cfg(feature = "std")]
pub use crate::searchtree::{SearchNode, SearchTree};
#[cfg(feature = "alloc")]
pub use crate::spline::Spline;

/*****************************************************************************************************************************************************************************/
/*****************************************************************************************************************************************************************************/