Skip to main content

CubicSpline

Struct CubicSpline 

Source
pub struct CubicSpline<T: Float> { /* private fields */ }
Expand description

Cubic spline 1-D interpolator.

Precomputes polynomial coefficients for each segment at construction time. Each evaluation is O(log n) via binary search.

Implementations§

Source§

impl<T: Float> CubicSpline<T>

Source

pub fn new( xs: &[T], ys: &[T], boundary: SplineBoundary<T>, extrap: Extrapolate, ) -> Result<Self>

Construct a cubic spline interpolator.

§Errors
  • xs and ys must have the same length (>= 3).
  • xs must be strictly increasing.
  • All values must be finite.
§Examples
let xs = [0.0_f64, 1.0, 2.0, 3.0];
let ys = [0.0, 1.0, 4.0, 9.0]; // roughly x²
let spline = CubicSpline::new(&xs, &ys, SplineBoundary::Natural, Extrapolate::Error).unwrap();
let y = spline.eval(1.5).unwrap();
assert!((y - 2.25).abs() < 0.5); // close to 1.5²
Source

pub fn eval(&self, x: T) -> Result<T>

Evaluate the spline at a single point.

§Examples
let spline = CubicSpline::new(
    &[0.0_f64, 1.0, 2.0, 3.0], &[0.0, 1.0, 4.0, 9.0],
    SplineBoundary::Natural, Extrapolate::Error,
).unwrap();
let y = spline.eval(1.5).unwrap();
assert!((y - 2.25).abs() < 0.5);
Source

pub fn eval_many(&self, xs: &[T]) -> Result<Vec<T>>

Evaluate at many points.

§Examples
let spline = CubicSpline::new(
    &[0.0_f64, 1.0, 2.0, 3.0], &[0.0, 1.0, 4.0, 9.0],
    SplineBoundary::Natural, Extrapolate::Error,
).unwrap();
let ys = spline.eval_many(&[0.5, 1.5, 2.5]).unwrap();
assert_eq!(ys.len(), 3);
Source

pub fn derivative(&self, x: T) -> Result<T>

Evaluate the first derivative at a single point.

§Examples
let spline = CubicSpline::new(
    &[0.0_f64, 1.0, 2.0, 3.0], &[0.0, 1.0, 4.0, 9.0],
    SplineBoundary::Natural, Extrapolate::Error,
).unwrap();
let dy = spline.derivative(1.0).unwrap();
assert!(dy > 0.0); // increasing function
Source

pub fn second_derivative(&self, x: T) -> Result<T>

Evaluate the second derivative at a single point.

§Examples
let spline = CubicSpline::new(
    &[0.0_f64, 1.0, 2.0, 3.0], &[0.0, 1.0, 4.0, 9.0],
    SplineBoundary::Natural, Extrapolate::Error,
).unwrap();
let d2y = spline.second_derivative(0.0).unwrap();
// Natural boundary: second derivative = 0 at endpoints
assert!(d2y.abs() < 1e-10);

Trait Implementations§

Source§

impl<T: Clone + Float> Clone for CubicSpline<T>

Source§

fn clone(&self) -> CubicSpline<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Float> Debug for CubicSpline<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for CubicSpline<T>

§

impl<T> RefUnwindSafe for CubicSpline<T>
where T: RefUnwindSafe,

§

impl<T> Send for CubicSpline<T>

§

impl<T> Sync for CubicSpline<T>

§

impl<T> Unpin for CubicSpline<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for CubicSpline<T>

§

impl<T> UnwindSafe for CubicSpline<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.