pub struct MaternKernel { /* private fields */ }
Expand description
Matérn Kernel The Matérn kernel is given by
K(\mathbf{x}, \mathbf{x'}) = \frac{2^{1-\nu}}{\Gamma(\nu)} {\left( \sqrt{2 \nu} \frac{d}{l} \right)}^\nu K_\nu (\sqrt{2\nu} \frac{d}{l})
where $\Gamma$ is the gamma function and $K_\nu$ is the Bessel funciton of the second kind.
§Parameters
nu
-length_scale
-
Implementations§
source§impl MaternKernel
impl MaternKernel
sourcepub fn new(nu: f64, length_scale: f64) -> Result<Self, KernelError>
pub fn new(nu: f64, length_scale: f64) -> Result<Self, KernelError>
Create a new MaternKernel
with nu
and length_scale
.
sourcepub fn new_unchecked(nu: f64, length_scale: f64) -> Self
pub fn new_unchecked(nu: f64, length_scale: f64) -> Self
Create a new MaternKernel
with nu
and length_scale
without checking inputs.
Trait Implementations§
source§impl<B> Add<B> for MaternKernelwhere
B: Kernel,
impl<B> Add<B> for MaternKernelwhere
B: Kernel,
source§impl Clone for MaternKernel
impl Clone for MaternKernel
source§fn clone(&self) -> MaternKernel
fn clone(&self) -> MaternKernel
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for MaternKernel
impl Debug for MaternKernel
source§impl Default for MaternKernel
impl Default for MaternKernel
source§impl<'de> Deserialize<'de> for MaternKernel
impl<'de> Deserialize<'de> for MaternKernel
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl Kernel for MaternKernel
impl Kernel for MaternKernel
source§fn n_parameters(&self) -> usize
fn n_parameters(&self) -> usize
Return the number of parameters used in this
Kernel
.source§fn covariance<R1, R2, C1, C2, S1, S2>(
&self,
x1: &Matrix<f64, R1, C1, S1>,
x2: &Matrix<f64, R2, C2, S2>,
) -> DMatrix<f64>where
R1: Dim,
R2: Dim,
C1: Dim,
C2: Dim,
S1: Storage<f64, R1, C1>,
S2: Storage<f64, R2, C2>,
ShapeConstraint: SameNumberOfColumns<C1, C2>,
fn covariance<R1, R2, C1, C2, S1, S2>(
&self,
x1: &Matrix<f64, R1, C1, S1>,
x2: &Matrix<f64, R2, C2, S2>,
) -> DMatrix<f64>where
R1: Dim,
R2: Dim,
C1: Dim,
C2: Dim,
S1: Storage<f64, R1, C1>,
S2: Storage<f64, R2, C2>,
ShapeConstraint: SameNumberOfColumns<C1, C2>,
Returns the covariance matrix for two equal sized vectors
source§fn is_stationary(&self) -> bool
fn is_stationary(&self) -> bool
Reports if the given kernel function is stationary.
source§fn diag<R, C, S>(&self, x: &Matrix<f64, R, C, S>) -> DVector<f64>
fn diag<R, C, S>(&self, x: &Matrix<f64, R, C, S>) -> DVector<f64>
Returns the diagonal of the kernel(x, x)
source§fn parameters(&self) -> DVector<f64>
fn parameters(&self) -> DVector<f64>
Return the corresponding parameter vector
The parameters here are in a log-scale
source§fn reparameterize(&self, params: &[f64]) -> Result<Self, KernelError>
fn reparameterize(&self, params: &[f64]) -> Result<Self, KernelError>
Create a new kernel of the given type from the provided parameters.
The parameters here are in a log-scale
source§fn covariance_with_gradient<R, C, S>(
&self,
x: &Matrix<f64, R, C, S>,
) -> Result<(DMatrix<f64>, CovGrad), CovGradError>
fn covariance_with_gradient<R, C, S>( &self, x: &Matrix<f64, R, C, S>, ) -> Result<(DMatrix<f64>, CovGrad), CovGradError>
Covariance and Gradient with the log-scaled hyper-parameters
source§fn consume_parameters<I: IntoIterator<Item = f64>>(
&self,
params: I,
) -> Result<(Self, I::IntoIter), KernelError>
fn consume_parameters<I: IntoIterator<Item = f64>>( &self, params: I, ) -> Result<(Self, I::IntoIter), KernelError>
Takes a sequence of parameters and consumes only the ones it needs
to create itself.
The parameters here are in a log-scale
fn add<B: Kernel>(self, other: B) -> AddKernel<Self, B>
fn mul<B: Kernel>(self, other: B) -> ProductKernel<Self, B>
source§impl<B> Mul<B> for MaternKernelwhere
B: Kernel,
impl<B> Mul<B> for MaternKernelwhere
B: Kernel,
§type Output = ProductKernel<MaternKernel, B>
type Output = ProductKernel<MaternKernel, B>
The resulting type after applying the
*
operator.source§impl PartialEq for MaternKernel
impl PartialEq for MaternKernel
source§fn eq(&self, other: &MaternKernel) -> bool
fn eq(&self, other: &MaternKernel) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Serialize for MaternKernel
impl Serialize for MaternKernel
impl StructuralPartialEq for MaternKernel
Auto Trait Implementations§
impl Freeze for MaternKernel
impl RefUnwindSafe for MaternKernel
impl Send for MaternKernel
impl Sync for MaternKernel
impl Unpin for MaternKernel
impl UnwindSafe for MaternKernel
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.