pub struct WhiteKernel { /* private fields */ }
Expand description
White Noise Kernel
Implementations§
source§impl WhiteKernel
impl WhiteKernel
sourcepub fn new(noise_level: f64) -> Result<Self, KernelError>
pub fn new(noise_level: f64) -> Result<Self, KernelError>
Create a new WhiteKernel with the given level of noise
sourcepub fn new_unchecked(noise_level: f64) -> Self
pub fn new_unchecked(noise_level: f64) -> Self
Create a new WhiteKernel without check the parameters
Trait Implementations§
source§impl<B> Add<B> for WhiteKernelwhere
B: Kernel,
impl<B> Add<B> for WhiteKernelwhere
B: Kernel,
source§impl Clone for WhiteKernel
impl Clone for WhiteKernel
source§fn clone(&self) -> WhiteKernel
fn clone(&self) -> WhiteKernel
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 WhiteKernel
impl Debug for WhiteKernel
source§impl<'de> Deserialize<'de> for WhiteKernel
impl<'de> Deserialize<'de> for WhiteKernel
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 WhiteKernel
impl Kernel for WhiteKernel
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, param_vec: &[f64]) -> Result<Self, KernelError>
fn reparameterize(&self, param_vec: &[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 n_parameters(&self) -> usize
fn n_parameters(&self) -> usize
Return the number of parameters used in this
Kernel
.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 WhiteKernelwhere
B: Kernel,
impl<B> Mul<B> for WhiteKernelwhere
B: Kernel,
§type Output = ProductKernel<WhiteKernel, B>
type Output = ProductKernel<WhiteKernel, B>
The resulting type after applying the
*
operator.source§impl PartialEq for WhiteKernel
impl PartialEq for WhiteKernel
source§fn eq(&self, other: &WhiteKernel) -> bool
fn eq(&self, other: &WhiteKernel) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Serialize for WhiteKernel
impl Serialize for WhiteKernel
impl StructuralPartialEq for WhiteKernel
Auto Trait Implementations§
impl Freeze for WhiteKernel
impl RefUnwindSafe for WhiteKernel
impl Send for WhiteKernel
impl Sync for WhiteKernel
impl Unpin for WhiteKernel
impl UnwindSafe for WhiteKernel
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.