pub struct CovGrad { /* private fields */ }
Expand description
Representation of the gradient of the covariance matrix
Implementations§
source§impl CovGrad
impl CovGrad
sourcepub fn new(slices: &[DMatrix<f64>]) -> Result<Self, CovGradError>
pub fn new(slices: &[DMatrix<f64>]) -> Result<Self, CovGradError>
Create a new cov-grad with given slices
sourcepub fn new_unchecked(slices: &[DMatrix<f64>]) -> Self
pub fn new_unchecked(slices: &[DMatrix<f64>]) -> Self
Create a new unchecked CovGrad
sourcepub fn component_mul(&self, other: &DMatrix<f64>) -> Result<Self, CovGradError>
pub fn component_mul(&self, other: &DMatrix<f64>) -> Result<Self, CovGradError>
Component wise multiplication
sourcepub fn left_mul(&self, other: &DMatrix<f64>) -> Result<Self, CovGradError>
pub fn left_mul(&self, other: &DMatrix<f64>) -> Result<Self, CovGradError>
Left multiplication by another matrix
sourcepub fn right_mul(&self, other: &DMatrix<f64>) -> Result<Self, CovGradError>
pub fn right_mul(&self, other: &DMatrix<f64>) -> Result<Self, CovGradError>
Right multiplication by another matrix
sourcepub fn relative_eq(&self, other: &CovGrad, rel: f64, abs: f64) -> bool
pub fn relative_eq(&self, other: &CovGrad, rel: f64, abs: f64) -> bool
Check if this is relatively eq to another matrix
sourcepub fn concat_cols(&self, other: &Self) -> Result<Self, CovGradError>
pub fn concat_cols(&self, other: &Self) -> Result<Self, CovGradError>
Concatenate columns from another matrix
sourcepub fn from_column_slices(
n: usize,
m: usize,
slice: &[f64],
) -> Result<Self, CovGradError>
pub fn from_column_slices( n: usize, m: usize, slice: &[f64], ) -> Result<Self, CovGradError>
Create a new CovMat from a sequence of column slices
sourcepub fn from_row_slices(
n: usize,
m: usize,
slice: &[f64],
) -> Result<Self, CovGradError>
pub fn from_row_slices( n: usize, m: usize, slice: &[f64], ) -> Result<Self, CovGradError>
Create a new CovMat from a sequence of row slices
Trait Implementations§
source§impl<'de> Deserialize<'de> for CovGrad
impl<'de> Deserialize<'de> for CovGrad
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
Auto Trait Implementations§
impl Freeze for CovGrad
impl RefUnwindSafe for CovGrad
impl Send for CovGrad
impl Sync for CovGrad
impl Unpin for CovGrad
impl UnwindSafe for CovGrad
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.