Struct rv::dist::InvWishart
source · pub struct InvWishart { /* private fields */ }
Expand description
Inverse Wishart distribution, W-1(Ψ,ν) over positive definite matrices.
Implementations§
source§impl InvWishart
impl InvWishart
sourcepub fn new(inv_scale: DMatrix<f64>, df: usize) -> Result<Self, InvWishartError>
pub fn new(inv_scale: DMatrix<f64>, df: usize) -> Result<Self, InvWishartError>
Create an Inverse Wishart distribution, W-1(Ψ,ν) with p-by-p inverse scale matrix, Ψ, and degrees of freedom, ν > p - 1.
§Arguments
- inv_scale: p-dimensional inverse scale matrix, Ψ
- df: Degrees of freedom, ν > p - 1
sourcepub fn new_unchecked(inv_scale: DMatrix<f64>, df: usize) -> Self
pub fn new_unchecked(inv_scale: DMatrix<f64>, df: usize) -> Self
Creates a new InvWishart without checking whether the parameters are valid.
pub fn ndims(&self) -> usize
sourcepub fn set_df_unchecked(&mut self, df: usize)
pub fn set_df_unchecked(&mut self, df: usize)
Set the value of df without input validation
sourcepub fn set_inv_scale(
&mut self,
inv_scale: DMatrix<f64>
) -> Result<(), InvWishartError>
pub fn set_inv_scale( &mut self, inv_scale: DMatrix<f64> ) -> Result<(), InvWishartError>
Set inverse scale parameter
pub fn set_inv_scale_unchecked(&mut self, inv_scale: DMatrix<f64>)
Trait Implementations§
source§impl Clone for InvWishart
impl Clone for InvWishart
source§fn clone(&self) -> InvWishart
fn clone(&self) -> InvWishart
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 ContinuousDistr<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>> for InvWishart
impl ContinuousDistr<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>> for InvWishart
source§impl Debug for InvWishart
impl Debug for InvWishart
source§impl<'de> Deserialize<'de> for InvWishart
impl<'de> Deserialize<'de> for InvWishart
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 PartialEq for InvWishart
impl PartialEq for InvWishart
source§fn eq(&self, other: &InvWishart) -> bool
fn eq(&self, other: &InvWishart) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Rv<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>> for InvWishart
impl Rv<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>> for InvWishart
source§impl Serialize for InvWishart
impl Serialize for InvWishart
impl StructuralPartialEq for InvWishart
Auto Trait Implementations§
impl Freeze for InvWishart
impl RefUnwindSafe for InvWishart
impl Send for InvWishart
impl Sync for InvWishart
impl Unpin for InvWishart
impl UnwindSafe for InvWishart
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<Fx> Rv<Datum> for Fxwhere
Fx: RvDatum,
impl<Fx> Rv<Datum> for Fxwhere
Fx: RvDatum,
source§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.