Struct Interp1D 

pub struct Interp1D<C, Z> { /* private fields */ }

• C: Coordinate type.
• Z: Value type.

Implementations

impl<C, Z> Interp1D<C, Z>

pub fn new(x: Vec<C>, z: Vec<Z>) -> Self

where C: PartialOrd,

Create a new interpolation engine.

Interpolates values which are sampled on a rectangular grid.

Parameters

• x: The x-coordinates. Must be monotonic.
• z: The values z(x) for each grid point defined by the x coordinates.

Panics

Panics when

• dimensions of the indices and z-values don’t match.
• one axis is empty.
• x values are not monotonic.

pub fn bounds(&self) -> (C, C)

where C: Copy,

Get the boundaries of the sample range as (x0, x1) tuple.

pub fn is_within_bounds(&self, x: C) -> bool

where C: PartialOrd + Copy,

Check if the x coordinate lies within the defined sample range.

pub fn xs(&self) -> &Vec<C>

Get the x-coordinate values.

pub fn z(&self) -> &Vec<Z>

Get the raw z values.

pub fn map_values<Z2>(&self, f: impl Fn(&Z) -> Z2) -> Interp1D<C, Z2>

where C: PartialOrd + Clone,

Create a new interpolated table by applying a function elementwise to the values.

pub fn map_axis<Xnew>(self, f: impl Fn(C) -> Xnew) -> Interp1D<Xnew, Z>

where Xnew: PartialOrd,

Apply a function to the coordinates values of the axis. Panics if the new coordinates are not monotonically increasing.

impl<C, Z> Interp1D<C, Z>

where C: Copy + Sub<Output = C> + Div + PartialOrd, Z: Copy + Mul<<C as Div>::Output, Output = Z> + Add<Output = Z> + Sub<Output = Z>, <C as Div>::Output: Copy + Add<Output = <C as Div>::Output> + Sub<Output = <C as Div>::Output>,

pub fn eval(&self, x: C) -> Z

Evaluate the sampled function by interpolation at x.

If x lies out of the sampled range then the function is silently extrapolated. The boundaries of the sample range can be queried with bounds().

pub fn eval_no_extrapolation(&self, x: C) -> Option<Z>

Returns the same value as eval() as long as x is within the range of the samples. Otherwise None is returned instead of an extrapolation.

Trait Implementations

impl<C: Clone, Z: Clone> Clone for Interp1D<C, Z>

fn clone(&self) -> Interp1D<C, Z>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug, Z: Debug> Debug for Interp1D<C, Z>

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

Formats the value using the given formatter.