Skip to main content

PolyharmonicSpline

Struct PolyharmonicSpline 

Source
pub struct PolyharmonicSpline { /* private fields */ }
Expand description

A polyharmonic spline interpolator for arbitrary-dimension data.

Given n data points in d dimensions with scalar values, the polyharmonic spline builds an interpolant (or smoothing approximation) using radial basis functions augmented with a polynomial of degree <= order - 1.

§Examples

use scirs2_interpolate::polyharmonic::PolyharmonicSpline;

// 2D scattered data
let points = vec![
    vec![0.0, 0.0],
    vec![1.0, 0.0],
    vec![0.0, 1.0],
    vec![1.0, 1.0],
];
let values = vec![0.0, 1.0, 1.0, 2.0];

let spline = PolyharmonicSpline::fit(&points, &values, 2, 0.0)
    .expect("should fit successfully");

// Evaluate at a query point
let result = spline.evaluate(&[0.5, 0.5]).expect("should evaluate");
assert!((result - 1.0).abs() < 1e-8);

Implementations§

Source§

impl PolyharmonicSpline

Source

pub fn fit( points: &[Vec<f64>], values: &[f64], order: usize, smoothing: f64, ) -> InterpolateResult<Self>

Fit a polyharmonic spline to scattered data.

§Arguments
  • points - Data point coordinates, n points each of dimension d.
  • values - Function values at the data points (length n).
  • order - Order of the polyharmonic kernel (>= 1).
    • order = 1: phi(r) = r
    • order = 2: phi(r) = r^2 log(r) (thin-plate spline)
    • order = 3: phi(r) = r^3
  • smoothing - Regularization parameter (>= 0). When 0, exact interpolation is performed. Larger values produce smoother results.
§Errors

Returns an error if:

  • points is empty
  • points and values have different lengths
  • The linear system is singular
Source

pub fn thin_plate_spline( points: &[Vec<f64>], values: &[f64], smoothing: f64, ) -> InterpolateResult<Self>

Create a thin-plate spline interpolator (order = 2).

This is a convenience method equivalent to fit(points, values, 2, smoothing).

Source

pub fn evaluate(&self, query: &[f64]) -> InterpolateResult<f64>

Evaluate the polyharmonic spline at a single query point.

§Errors

Returns an error if the query point dimension does not match the data point dimension.

Source

pub fn evaluate_batch( &self, queries: &[Vec<f64>], ) -> InterpolateResult<Vec<f64>>

Evaluate the polyharmonic spline at multiple query points.

Returns a vector of interpolated values, one per query point.

Source

pub fn order(&self) -> usize

Return the order of the polyharmonic kernel.

Source

pub fn dim(&self) -> usize

Return the dimension of the data points.

Source

pub fn num_points(&self) -> usize

Return the number of data points.

Source

pub fn weights(&self) -> &[f64]

Return the RBF weights.

Source

pub fn poly_coefficients(&self) -> &[f64]

Return the polynomial coefficients.

Auto Trait Implementations§

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> 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, 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