Struct rv::dist::SymmetricDirichlet
source · pub struct SymmetricDirichlet { /* private fields */ }
Expand description
Symmetric Dirichlet distribution where all alphas are the same.
SymmetricDirichlet { alpha, k }
is mathematicall equivalent to
Dirichlet { alphas: vec![alpha; k] }
. This version has some extra
optimizations to seep up computing the PDF and drawing random vectors.
Implementations§
source§impl SymmetricDirichlet
impl SymmetricDirichlet
sourcepub fn new(alpha: f64, k: usize) -> Result<Self, SymmetricDirichletError>
pub fn new(alpha: f64, k: usize) -> Result<Self, SymmetricDirichletError>
Create a new symmetric Dirichlet distributon
Arguments
- alpha: The Dirichlet weight.
- k : The number of weights.
alpha
will be replicatedk
times.
sourcepub fn new_unchecked(alpha: f64, k: usize) -> Self
pub fn new_unchecked(alpha: f64, k: usize) -> Self
Create a new SymmetricDirichlet without checking whether the parmaeters are valid.
sourcepub fn jeffreys(k: usize) -> Result<Self, SymmetricDirichletError>
pub fn jeffreys(k: usize) -> Result<Self, SymmetricDirichletError>
The Jeffrey’s Dirichlet prior for Categorical distributions
Example
let symdir = SymmetricDirichlet::jeffreys(4).unwrap();
assert_eq!(symdir, SymmetricDirichlet::new(0.5, 4).unwrap());
sourcepub fn alpha(&self) -> f64
pub fn alpha(&self) -> f64
Get the alpha unfiorm weight parameter
Example
let symdir = SymmetricDirichlet::new(1.2, 5).unwrap();
assert_eq!(symdir.alpha(), 1.2);
sourcepub fn set_alpha(&mut self, alpha: f64) -> Result<(), SymmetricDirichletError>
pub fn set_alpha(&mut self, alpha: f64) -> Result<(), SymmetricDirichletError>
Set the value of alpha
Example
let mut symdir = SymmetricDirichlet::new(1.1, 5).unwrap();
assert_eq!(symdir.alpha(), 1.1);
symdir.set_alpha(2.3).unwrap();
assert_eq!(symdir.alpha(), 2.3);
Will error for invalid parameters
assert!(symdir.set_alpha(0.5).is_ok());
assert!(symdir.set_alpha(0.0).is_err());
assert!(symdir.set_alpha(-1.0).is_err());
assert!(symdir.set_alpha(std::f64::INFINITY).is_err());
assert!(symdir.set_alpha(std::f64::NEG_INFINITY).is_err());
assert!(symdir.set_alpha(std::f64::NAN).is_err());
sourcepub fn set_alpha_unchecked(&mut self, alpha: f64)
pub fn set_alpha_unchecked(&mut self, alpha: f64)
Set the value of alpha without input validation
Trait Implementations§
source§impl Clone for SymmetricDirichlet
impl Clone for SymmetricDirichlet
source§fn clone(&self) -> SymmetricDirichlet
fn clone(&self) -> SymmetricDirichlet
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<X: CategoricalDatum> ConjugatePrior<X, Categorical> for SymmetricDirichlet
impl<X: CategoricalDatum> ConjugatePrior<X, Categorical> for SymmetricDirichlet
source§fn posterior(&self, x: &CategoricalData<'_, X>) -> Self::Posterior
fn posterior(&self, x: &CategoricalData<'_, X>) -> Self::Posterior
Computes the posterior distribution from the data
source§fn ln_m_cache(&self) -> Self::LnMCache
fn ln_m_cache(&self) -> Self::LnMCache
Compute the cache for the log marginal likelihood.
source§fn ln_m_with_cache(
&self,
cache: &Self::LnMCache,
x: &CategoricalData<'_, X>
) -> f64
fn ln_m_with_cache( &self, cache: &Self::LnMCache, x: &CategoricalData<'_, X> ) -> f64
Log marginal likelihood with supplied cache.
source§fn ln_pp_cache(&self, x: &CategoricalData<'_, X>) -> Self::LnPpCache
fn ln_pp_cache(&self, x: &CategoricalData<'_, X>) -> Self::LnPpCache
Compute the cache for the Log posterior predictive of y given x. Read more
source§fn ln_pp_with_cache(&self, cache: &Self::LnPpCache, y: &X) -> f64
fn ln_pp_with_cache(&self, cache: &Self::LnPpCache, y: &X) -> f64
Log posterior predictive of y given x with supplied ln(norm)
source§fn ln_m(&self, x: &DataOrSuffStat<'_, X, Fx>) -> f64
fn ln_m(&self, x: &DataOrSuffStat<'_, X, Fx>) -> f64
The log marginal likelihood
source§fn ln_pp(&self, y: &X, x: &DataOrSuffStat<'_, X, Fx>) -> f64
fn ln_pp(&self, y: &X, x: &DataOrSuffStat<'_, X, Fx>) -> f64
Log posterior predictive of y given x
source§fn m(&self, x: &DataOrSuffStat<'_, X, Fx>) -> f64
fn m(&self, x: &DataOrSuffStat<'_, X, Fx>) -> f64
Marginal likelihood of x
source§impl ContinuousDistr<Vec<f64, Global>> for SymmetricDirichlet
impl ContinuousDistr<Vec<f64, Global>> for SymmetricDirichlet
source§impl Debug for SymmetricDirichlet
impl Debug for SymmetricDirichlet
source§impl<'de> Deserialize<'de> for SymmetricDirichlet
impl<'de> Deserialize<'de> for SymmetricDirichlet
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 Display for SymmetricDirichlet
impl Display for SymmetricDirichlet
source§impl From<&SymmetricDirichlet> for Dirichlet
impl From<&SymmetricDirichlet> for Dirichlet
source§fn from(symdir: &SymmetricDirichlet) -> Self
fn from(symdir: &SymmetricDirichlet) -> Self
Converts to this type from the input type.
source§impl From<&SymmetricDirichlet> for String
impl From<&SymmetricDirichlet> for String
source§fn from(symdir: &SymmetricDirichlet) -> String
fn from(symdir: &SymmetricDirichlet) -> String
Converts to this type from the input type.
source§impl From<SymmetricDirichlet> for Dirichlet
impl From<SymmetricDirichlet> for Dirichlet
source§fn from(symdir: SymmetricDirichlet) -> Self
fn from(symdir: SymmetricDirichlet) -> Self
Converts to this type from the input type.
source§impl PartialEq<SymmetricDirichlet> for SymmetricDirichlet
impl PartialEq<SymmetricDirichlet> for SymmetricDirichlet
source§impl Rv<Categorical> for SymmetricDirichlet
impl Rv<Categorical> for SymmetricDirichlet
source§impl Serialize for SymmetricDirichlet
impl Serialize for SymmetricDirichlet
Auto Trait Implementations§
impl RefUnwindSafe for SymmetricDirichlet
impl Send for SymmetricDirichlet
impl Sync for SymmetricDirichlet
impl Unpin for SymmetricDirichlet
impl UnwindSafe for SymmetricDirichlet
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,
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§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 more§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).§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.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.