Struct Interp2D 

pub struct Interp2D<C1, C2, Z, S>
where
    S: Data<Elem = Z>,
{ /* private fields */ }

Two dimensional bilinear interpolator for data on an irregular grid.

• C1: Coordinate type of first axis.
• C2: Coordinate type of second axis.
• Z: Value type.
• S: Array representation of Z values.

Implementations

impl<C1, C2, Z, S> Interp2D<C1, C2, Z, S>

where S: Data<Elem = Z>,

pub fn new(x: Vec<C1>, y: Vec<C2>, z: ArrayBase<S, Ix2>) -> Self

where C1: PartialOrd, C2: PartialOrd,

Create a new interpolation engine.

Interpolates values which are sampled on a rectangular grid.

Parameters

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

Panics

Panics when

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

pub fn bounds(&self) -> ((C1, C1), (C2, C2))

where C1: Copy, C2: Copy,

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

pub fn is_within_bounds(&self, (x, y): (C1, C2)) -> bool

where C1: PartialOrd + Copy, C2: PartialOrd + Copy,

Check if the (x, y) coordinate lies within the defined sample range.

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

Get the x-coordinate values.

pub fn ys(&self) -> &Vec<C2>

Get the y-coordinate values.

pub fn z(&self) -> &ArrayBase<S, Ix2>

Get the raw z values.

pub fn map_values<Z2>( &self, f: impl Fn(&Z) -> Z2, ) -> Interp2D<C1, C2, Z2, OwnedRepr<Z2>>

where C1: PartialOrd + Clone, C2: PartialOrd + Clone,

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

pub fn map_x_axis<Xnew>( self, f: impl Fn(C1) -> Xnew, ) -> Interp2D<Xnew, C2, Z, S>

where Xnew: PartialOrd,

Apply the function f to each x coordinate. Panics if the ordering of the coordinates is not monotonic after applyint f.

pub fn map_y_axis<Ynew>( self, f: impl Fn(C2) -> Ynew, ) -> Interp2D<C1, Ynew, Z, S>

where Ynew: PartialOrd,

Apply the function f to each y coordinate. Panics if the ordering of the coordinates is not monotonic after applyint f.

impl<C1, C2, Z, S> Interp2D<C1, C2, Z, S>

where C1: Copy + Sub<Output = C1> + Div + PartialOrd, C2: Copy + Sub<Output = C2> + Div<Output = <C1 as Div>::Output> + PartialOrd, Z: Copy + Mul<<C1 as Div>::Output, Output = Z> + Add<Output = Z> + Sub<Output = Z>, <C1 as Div>::Output: Copy + Add<Output = <C1 as Div>::Output> + Sub<Output = <C1 as Div>::Output>, S: Data<Elem = Z> + Clone,

pub fn eval(&self, (x, y): (C1, C2)) -> Z

Evaluate the sampled function by interpolation at (x, y).

If (x, y) 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, xy: (C1, C2)) -> Option<Z>

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

impl<C1, C2, Z, S> Interp2D<C1, C2, Z, S>

where Z: Clone, S: Data<Elem = Z> + Clone, OwnedRepr<Z>: Data<Elem = Z>,

pub fn swap_variables(self) -> Interp2D<C2, C1, Z, OwnedRepr<Z>>

Swap the input variables.

Trait Implementations

impl<C1, C2, Z, S> Clone for Interp2D<C1, C2, Z, S>

where C1: Clone, C2: Clone, S: Data<Elem = Z>, ArrayBase<S, Ix2>: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C1: Debug, C2: Debug, Z: Debug, S> Debug for Interp2D<C1, C2, Z, S>

where S: Data<Elem = Z> + Debug,

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

Formats the value using the given formatter.