Struct CubicSpline

pub struct CubicSpline<T, D: Dimension> { /* private fields */ }

The CubicSpline 1d interpolation Strategy (Builder)

Example

From Wikipedia

let y = array![ 0.5, 0.0, 3.0];
let x = array![-1.0, 0.0, 3.0];
let query = Array::linspace(-1.0, 3.0, 10);
let interpolator = Interp1DBuilder::new(y)
    .strategy(CubicSpline::new())
    .x(x)
    .build().unwrap();

let result = interpolator.interp_array(&query).unwrap();
let expect = array![
    0.5,
    0.1851851851851852,
    0.01851851851851853,
    -5.551115123125783e-17,
    0.12962962962962965,
    0.40740740740740755,
    0.8333333333333331,
    1.407407407407407,
    2.1296296296296293, 3.0
];

Implementations

impl<T, D> CubicSpline<T, D>

where D: Dimension + RemoveAxis, T: SplineNum,

pub fn new() -> Self

create a cubic-spline interpolation stratgy

pub fn extrapolate(self, extrapolate: bool) -> Self

does the strategy extrapolate? Default is false

pub fn boundary(self, boundary: BoundaryCondition<T, D>) -> Self

set the boundary condition. default is BoundaryCondition::Natural

Trait Implementations

impl<T: Debug, D: Debug + Dimension> Debug for CubicSpline<T, D>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, D> Default for CubicSpline<T, D>

where D: Dimension + RemoveAxis, T: SplineNum,

fn default() -> Self

Returns the “default value” for a type.

impl<Sd, Sx, D> Interp1DStrategyBuilder<Sd, Sx, D> for CubicSpline<Sd::Elem, D>

where Sd: Data, Sd::Elem: SplineNum, Sx: Data<Elem = Sd::Elem>, D: Dimension + RemoveAxis,

const MINIMUM_DATA_LENGHT: usize = 3usize

type FinishedStrat = CubicSplineStrategy<Sd, D>

fn build<Sx2>( self, x: &ArrayBase<Sx2, Ix1>, data: &ArrayBase<Sd, D>, ) -> Result<Self::FinishedStrat, BuilderError>

where Sx2: Data<Elem = Sd::Elem>,

initialize the strategy by validating data and possibly calculating coefficients This method is called in Interp1DBuilder::build