Skip to main content

Dirichlet

Struct Dirichlet 

Source
pub struct Dirichlet { /* private fields */ }
Expand description

Dirichlet distribution, conjugate prior for multinomial likelihood.

After observing counts c₁, ..., cₖ, the posterior is Dirichlet(α₁ + c₁, ..., αₖ + cₖ).

Implementations§

Source§

impl Dirichlet

Source

pub fn new(alpha: Vec<f64>) -> Result<Self>

Create a Dirichlet distribution with concentration parameters alpha.

All elements must be positive and the vector must have at least 2 elements.

Source

pub fn symmetric(k: usize, alpha: f64) -> Result<Self>

Create a symmetric Dirichlet with k categories, each with concentration alpha.

Source

pub fn alpha(&self) -> &[f64]

Concentration parameters.

Source

pub fn update_multinomial(&self, counts: &[u64]) -> Self

Posterior after observing multinomial counts.

§Panics

Panics if counts.len() != self.alpha.len().

Source

pub fn mean(&self) -> Vec<f64>

Expected value (mean) of the Dirichlet: E[Xᵢ] = αᵢ / Σα.

Source

pub fn variance(&self) -> Vec<f64>

Variance of each component: Var[Xᵢ] = αᵢ(Σα − αᵢ) / (Σα² (Σα + 1)).

Source

pub fn ln_pdf(&self, x: &[f64]) -> Result<f64>

Log-PDF of the Dirichlet at point x.

§Errors

Returns an error if x.len() != alpha.len() or if values don’t sum to approximately 1.

Trait Implementations§

Source§

impl Clone for Dirichlet

Source§

fn clone(&self) -> Dirichlet

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Dirichlet

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.