Skip to main content

VariogramModel

kriging_rs::variogram::models

Enum VariogramModel 

Source 
pub enum VariogramModel {
    Spherical {
        nugget: Real,
        sill: Real,
        range: Real,
    },
    Exponential {
        nugget: Real,
        sill: Real,
        range: Real,
    },
    Gaussian {
        nugget: Real,
        sill: Real,
        range: Real,
    },
    Cubic {
        nugget: Real,
        sill: Real,
        range: Real,
    },
    Stable {
        nugget: Real,
        sill: Real,
        range: Real,
        alpha: Real,
    },
    Matern {
        nugget: Real,
        sill: Real,
        range: Real,
        nu: Real,
    },
    Power {
        nugget: Real,
        slope: Real,
        exponent: Real,
    },
    HoleEffect {
        nugget: Real,
        sill: Real,
        range: Real,
    },
}
Expand description

Parametric variogram (nugget, sill, range, and optional shape).

Build with VariogramModel::new from a VariogramType; use with OrdinaryKrigingModel::new or BinomialKrigingModel::new.

Variants§

§

Spherical

Fields

§nugget: Real
§sill: Real
§range: Real
§

Exponential

Fields

§nugget: Real
§sill: Real
§range: Real
§

Gaussian

Fields

§nugget: Real
§sill: Real
§range: Real
§

Cubic

Fields

§nugget: Real
§sill: Real
§range: Real
§

Stable

Fields

§nugget: Real
§sill: Real
§range: Real
§alpha: Real
§

Matern

Fields

§nugget: Real
§sill: Real
§range: Real
§nu: Real
§

Power

Unbounded power-law model γ(h) = nugget + slope·h^exponent, exponent ∈ (0, 2). sill and range fields carry slope and exponent respectively so that the rest of the library can treat VariogramModel uniformly via params.

Note: for the power model, sill is not a true plateau — it is reused as the slope coefficient. Use new_power for a named constructor.

Fields

§nugget: Real
§slope: Real
§exponent: Real
§

HoleEffect

Hole-effect model with a pseudo-periodic dip; bounded above by sill.

Fields

§nugget: Real
§sill: Real
§range: Real

Implementations§

Source§

impl VariogramModel

Source

pub fn new( nugget: Real, sill: Real, range: Real, model_type: VariogramType, ) -> Result<Self, KrigingError>

Constructs a variogram model with validated parameters: nugget >= 0, sill > nugget, range > 0, all finite.

Source

pub fn new_power( nugget: Real, slope: Real, exponent: Real, ) -> Result<Self, KrigingError>

Construct a power-law variogram γ(h) = nugget + slope·h^exponent. slope > 0, exponent ∈ (0, 2), all values finite.

Source

pub fn new_with_shape( nugget: Real, sill: Real, range: Real, model_type: VariogramType, shape: Real, ) -> Result<Self, KrigingError>

Constructs a variogram model with an explicit shape parameter for Stable (alpha) or Matérn (nu). For other model types, shape is ignored. Stable: alpha in (0, 2]. Matérn: nu > 0.

Source

pub fn variogram_type(&self) -> VariogramType

Source

pub fn params(&self) -> (Real, Real, Real)

Source

pub fn shape(&self) -> Option<Real>

Shape parameter for Stable (alpha), Matérn (nu), or Power (exponent). Returns None for 3-parameter bounded models.

Source

pub fn semivariance(&self, distance: Real) -> Real

Semivariance at distance. Assumes distance >= 0 (e.g. from haversine); clamps negative input to 0.

Source

pub fn covariance(&self, distance: Real) -> Real

Covariance C(h) = C(0) − γ(h). For bounded models C(0) = sill; for the unbounded power model, C(0) is not defined, so this method returns 0 there and kriging should use the semivariance form.

Trait Implementations§

Source§

impl Clone for VariogramModel

Source§

fn clone(&self) -> VariogramModel

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 Debug for VariogramModel

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for VariogramModel

Source§

fn eq(&self, other: &VariogramModel) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for VariogramModel

Source§

impl StructuralPartialEq for VariogramModel

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<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> 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> 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> Scalar for T
where T: 'static + Clone + PartialEq + Debug,