Skip to main content

Interp2d

Struct Interp2d 

Source
pub struct Interp2d<F> { /* private fields */ }
Expand description

2D interpolator for data on regular grids

This struct provides functionality similar to SciPy’s interp2d for interpolating 2D data defined on regular grids.

Implementations§

Source§

impl<F> Interp2d<F>

Source

pub fn new( x: &ArrayView1<'_, F>, y: &ArrayView1<'_, F>, z: &ArrayView2<'_, F>, kind: Interp2dKind, ) -> InterpolateResult<Self>

Create a new 2D interpolator

§Arguments
  • x - X coordinates (must be sorted), length n_x
  • y - Y coordinates (must be sorted), length n_y
  • z - Z values with shape (n_y, n_x)
  • kind - Interpolation method
§Returns

New 2D interpolator

§Errors
  • ShapeMismatch - If z.shape() != (y.len(), x.len())
  • InvalidInput - If x or y are not sorted
§Examples
use scirs2_core::ndarray::{array, Array2};
use scirs2_interpolate::interp2d::{Interp2d, Interp2dKind};

// Define grid
let x = array![0.0, 1.0, 2.0];
let y = array![0.0, 1.0];

// Define function z = x + y on the grid
let z = Array2::from_shape_fn((2, 3), |(i, j)| {
    y[i] + x[j]
});

let interp = Interp2d::new(&x.view(), &y.view(), &z.view(),
                          Interp2dKind::Linear)?;

// Interpolate at a point
let result = interp.evaluate(0.5, 0.5)?;
Source

pub fn evaluate(&self, x_new: F, ynew: F) -> InterpolateResult<F>

Evaluate the interpolator at a single point

§Arguments
  • x_new - X coordinate for evaluation
  • ynew - Y coordinate for evaluation
§Returns

Interpolated value at (x_new, ynew)

§Examples
use scirs2_core::ndarray::{array, Array2};
use scirs2_interpolate::interp2d::{Interp2d, Interp2dKind};

let x = array![0.0, 1.0, 2.0];
let y = array![0.0, 1.0];
let z = Array2::from_shape_fn((2, 3), |(i, j)| {
    y[i] + x[j] // z = x + y
});

let interp = Interp2d::new(&x.view(), &y.view(), &z.view(),
                          Interp2dKind::Linear)?;

let result = interp.evaluate(0.5, 0.5)?;
// Should be approximately 1.0 (0.5 + 0.5)
Source

pub fn evaluate_array( &self, x_new: &ArrayView1<'_, F>, ynew: &ArrayView1<'_, F>, ) -> InterpolateResult<Array1<F>>

Evaluate at multiple points

§Arguments
  • x_new - X coordinates for evaluation
  • ynew - Y coordinates for evaluation (must have same length as x_new)
§Returns

Array of interpolated values

Source

pub fn evaluate_grid( &self, x_new: &ArrayView1<'_, F>, ynew: &ArrayView1<'_, F>, ) -> InterpolateResult<Array2<F>>

Evaluate on a regular grid

§Arguments
  • x_new - X coordinates for output grid
  • ynew - Y coordinates for output grid
§Returns

2D array with shape (len(ynew), len(x_new))

Trait Implementations§

Source§

impl<F: Clone> Clone for Interp2d<F>

Source§

fn clone(&self) -> Interp2d<F>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F: Debug> Debug for Interp2d<F>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> Freeze for Interp2d<F>

§

impl<F> RefUnwindSafe for Interp2d<F>
where F: RefUnwindSafe,

§

impl<F> Send for Interp2d<F>
where F: Send,

§

impl<F> Sync for Interp2d<F>
where F: Sync,

§

impl<F> Unpin for Interp2d<F>

§

impl<F> UnsafeUnpin for Interp2d<F>

§

impl<F> UnwindSafe for Interp2d<F>
where F: RefUnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more