pub struct Dirichlet { /* private fields */ }
Expand description
Dirichlet distribution over points on the k-simplex.
Implementations§
source§impl Dirichlet
impl Dirichlet
sourcepub fn new(alphas: Vec<f64>) -> Result<Self, DirichletError>
pub fn new(alphas: Vec<f64>) -> Result<Self, DirichletError>
Creates a Dirichlet
with a given alphas
vector
sourcepub fn new_unchecked(alphas: Vec<f64>) -> Self
pub fn new_unchecked(alphas: Vec<f64>) -> Self
Creates a new Dirichlet without checking whether the parameters are valid.
sourcepub fn symmetric(alpha: f64, k: usize) -> Result<Self, DirichletError>
pub fn symmetric(alpha: f64, k: usize) -> Result<Self, DirichletError>
Creates a Dirichlet
where all alphas are identical.
§Notes
SymmetricDirichlet
if faster and more compact, and is the preferred
way to represent a Dirichlet symmetric weights.
§Examples
let dir = Dirichlet::symmetric(1.0, 4).unwrap();
assert_eq!(*dir.alphas(), vec![1.0, 1.0, 1.0, 1.0]);
// Equivalent to SymmetricDirichlet
let symdir = SymmetricDirichlet::new(1.0, 4).unwrap();
let x: Vec<f64> = vec![0.1, 0.4, 0.3, 0.2];
assert::close(dir.ln_f(&x), symdir.ln_f(&x), 1E-12);
sourcepub fn jeffreys(k: usize) -> Result<Self, DirichletError>
pub fn jeffreys(k: usize) -> Result<Self, DirichletError>
Creates a Dirichlet
with all alphas = 0.5 (Jeffreys prior)
§Notes
SymmetricDirichlet
if faster and more compact, and is the preferred
way to represent a Dirichlet symmetric weights.
§Examples
let dir = Dirichlet::jeffreys(3).unwrap();
assert_eq!(*dir.alphas(), vec![0.5, 0.5, 0.5]);
// Equivalent to SymmetricDirichlet::jeffreys
let symdir = SymmetricDirichlet::jeffreys(3).unwrap();
let x: Vec<f64> = vec![0.1, 0.4, 0.5];
assert::close(dir.ln_f(&x), symdir.ln_f(&x), 1E-12);
Trait Implementations§
source§impl<X: CategoricalDatum> ConjugatePrior<X, Categorical> for Dirichlet
impl<X: CategoricalDatum> ConjugatePrior<X, Categorical> for Dirichlet
fn posterior(&self, x: &CategoricalData<'_, X>) -> Self::Posterior
source§fn ln_m_cache(&self) -> Self::MCache
fn ln_m_cache(&self) -> Self::MCache
Compute the cache for the log marginal likelihood.
source§fn ln_m_with_cache(
&self,
cache: &Self::MCache,
x: &CategoricalData<'_, X>,
) -> f64
fn ln_m_with_cache( &self, cache: &Self::MCache, x: &CategoricalData<'_, X>, ) -> f64
Log marginal likelihood with supplied cache.
source§fn ln_pp_cache(&self, x: &CategoricalData<'_, X>) -> Self::PpCache
fn ln_pp_cache(&self, x: &CategoricalData<'_, X>) -> Self::PpCache
Compute the cache for the Log posterior predictive of y given x. Read more
source§fn ln_pp_with_cache(&self, cache: &Self::PpCache, y: &X) -> f64
fn ln_pp_with_cache(&self, cache: &Self::PpCache, y: &X) -> f64
Log posterior predictive of y given x with supplied ln(norm)
source§fn posterior_from_suffstat(&self, stat: &Fx::Stat) -> Self::Posterior
fn posterior_from_suffstat(&self, stat: &Fx::Stat) -> Self::Posterior
Computes the posterior distribution from the data
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
fn pp_with_cache(&self, cache: &Self::PpCache, y: &X) -> f64
source§impl<'de> Deserialize<'de> for Dirichlet
impl<'de> Deserialize<'de> for Dirichlet
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 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 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 HasDensity<Categorical> for Dirichlet
impl HasDensity<Categorical> for Dirichlet
source§impl Parameterized for Dirichlet
impl Parameterized for Dirichlet
type Parameters = DirichletParameters
fn emit_params(&self) -> Self::Parameters
fn from_params(params: Self::Parameters) -> Self
source§impl PartialEq for Dirichlet
impl PartialEq for Dirichlet
source§impl Sampleable<Categorical> for Dirichlet
impl Sampleable<Categorical> for Dirichlet
impl StructuralPartialEq for Dirichlet
Auto Trait Implementations§
impl Freeze for Dirichlet
impl RefUnwindSafe for Dirichlet
impl Send for Dirichlet
impl Sync for Dirichlet
impl Unpin for Dirichlet
impl UnwindSafe for Dirichlet
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.