Enum CorrelationFunction

Source

pub enum CorrelationFunction {
    Exponential {
        length_scale: f64,
    },
    Gaussian {
        length_scale: f64,
    },
    Matern {
        nu: f64,
        length_scale: f64,
    },
    Powered {
        exponent: f64,
        length_scale: f64,
    },
}

Expand description

Covariance/correlation function parameterisation for random fields.

Variants§

§

Exponential

C(r) = exp(-r / ℓ)

Fields

§length_scale: f64

§

Gaussian

C(r) = exp(-r² / (2ℓ²))

Fields

§length_scale: f64

§

Matern

Matérn covariance with smoothness ν. ν = 0.5 → Exponential; ν = ∞ → Squared-Exponential.

Fields

§nu: f64

§length_scale: f64

§

Powered

C(r) = exp(-(r/ℓ)^α)

Fields

§exponent: f64

§length_scale: f64

Implementations§

Source §

impl CorrelationFunction

Source

pub fn evaluate(&self, r: f64) -> f64

Evaluate the correlation at (scalar) distance r ≥ 0.

Source

pub fn spectral_density_1d(&self, omega: f64) -> f64

Return the 1-D spectral density S(ω) (Fourier transform of the covariance).

Trait Implementations§

Source §

impl Clone for CorrelationFunction

Source §

fn clone(&self) -> CorrelationFunction

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

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for CorrelationFunction

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