pub struct ConstantKernel { /* private fields */ }Implementations§
Source§impl ConstantKernel
impl ConstantKernel
Sourcepub fn new(value: f64) -> Result<ConstantKernel, KernelError>
pub fn new(value: f64) -> Result<ConstantKernel, KernelError>
Create a new kernel with the given constant value
Sourcepub fn new_unchecked(scale: f64) -> ConstantKernel
pub fn new_unchecked(scale: f64) -> ConstantKernel
Create a new constant function kernel without checking the parameters
Trait Implementations§
Source§impl<B> Add<B> for ConstantKernelwhere
B: Kernel,
impl<B> Add<B> for ConstantKernelwhere
B: Kernel,
Source§impl Clone for ConstantKernel
impl Clone for ConstantKernel
Source§fn clone(&self) -> ConstantKernel
fn clone(&self) -> ConstantKernel
Returns a duplicate 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 ConstantKernel
impl Debug for ConstantKernel
Source§impl Default for ConstantKernel
impl Default for ConstantKernel
Source§fn default() -> ConstantKernel
fn default() -> ConstantKernel
Returns the “default value” for a type. Read more
Source§impl Kernel for ConstantKernel
impl Kernel for ConstantKernel
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>,
) -> Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>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>,
) -> Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>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>,
) -> Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>
fn diag<R, C, S>( &self, x: &Matrix<f64, R, C, S>, ) -> Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>
Returns the diagonal of the kernel(x, x)
Source§fn parameters(
&self,
) -> Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>
fn parameters( &self, ) -> Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>
Return the corresponding parameter vector
The parameters here are in a log-scale
Source§fn reparameterize(
&self,
param_vec: &[f64],
) -> Result<ConstantKernel, KernelError>
fn reparameterize( &self, param_vec: &[f64], ) -> Result<ConstantKernel, 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<(Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>, CovGrad), CovGradError>
fn covariance_with_gradient<R, C, S>( &self, x: &Matrix<f64, R, C, S>, ) -> Result<(Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>, CovGrad), CovGradError>
Covariance and Gradient with the log-scaled hyper-parameters
Source§fn consume_parameters<I>(
&self,
params: I,
) -> Result<(Self, <I as IntoIterator>::IntoIter), KernelError>where
I: IntoIterator<Item = f64>,
fn consume_parameters<I>(
&self,
params: I,
) -> Result<(Self, <I as IntoIterator>::IntoIter), KernelError>where
I: IntoIterator<Item = f64>,
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>(self, other: B) -> AddKernel<Self, B>where
B: Kernel,
fn mul<B>(self, other: B) -> ProductKernel<Self, B>where
B: Kernel,
Source§impl<B> Mul<B> for ConstantKernelwhere
B: Kernel,
impl<B> Mul<B> for ConstantKernelwhere
B: Kernel,
Source§type Output = ProductKernel<ConstantKernel, B>
type Output = ProductKernel<ConstantKernel, B>
The resulting type after applying the
* operator.Source§impl PartialEq for ConstantKernel
impl PartialEq for ConstantKernel
Source§impl TryFrom<f64> for ConstantKernel
impl TryFrom<f64> for ConstantKernel
Source§type Error = KernelError
type Error = KernelError
The type returned in the event of a conversion error.
Source§fn try_from(
value: f64,
) -> Result<ConstantKernel, <ConstantKernel as TryFrom<f64>>::Error>
fn try_from( value: f64, ) -> Result<ConstantKernel, <ConstantKernel as TryFrom<f64>>::Error>
Performs the conversion.
impl StructuralPartialEq for ConstantKernel
Auto Trait Implementations§
impl Freeze for ConstantKernel
impl RefUnwindSafe for ConstantKernel
impl Send for ConstantKernel
impl Sync for ConstantKernel
impl Unpin for ConstantKernel
impl UnsafeUnpin for ConstantKernel
impl UnwindSafe for ConstantKernel
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§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.