Struct makima_spline::Spline

pub struct Spline { /* fields omitted */ }

Contains all the necessary information to sample a given point

Implementations

impl Spline

pub fn from_vec(points: Vec<(f64, f64)>) -> Spline

Returns a Spline struct from a dataset

Arguments

• points - A vec that holds each point (f64, f64) to be interpolated
  The first element in the tuple being the key that will be used for finding the right segment during sampling

Example

let spline = makima_spline::Spline::from_vec(vec![(1., 3.), (2., 5.), (3., 2.)]);

Panics

panic! when there is only one point in the vector. Make sure your vector contains at least 2 points to interpolate between

pub fn sample(&self, pos: f64) -> f64

samples a point at a given position

Example

let spline = makima_spline::Spline::from_vec(vec![(1., 3.), (2., 5.), (3., 2.)]);
let sample: f64 = spline.sample(1.5);
//This even works outside the given data (extrapolation)
let sample2: f64 = spline.sample(-3.0);

pub fn derivative_1(&self, pos: f64) -> f64

returns the 1. order derivative at sampled point

pub fn derivative_2(&self, pos: f64) -> f64

returns the 2. order derivative at sampled point

note, this doesn't have to be continous

pub fn derivative_3(&self, pos: f64) -> f64

returns the 3. order derivative at sampled point

note, this doesn't have to be continous