Struct statrs::distribution::Dirichlet

pub struct Dirichlet { /* private fields */ }

Implements the Dirichlet distribution

Examples

use statrs::distribution::{Dirichlet, Continuous};
use statrs::statistics::Distribution;
use nalgebra::DVector;
use statrs::statistics::MeanN;

let n = Dirichlet::new(vec![1.0, 2.0, 3.0]).unwrap();
assert_eq!(n.mean().unwrap(), DVector::from_vec(vec![1.0 / 6.0, 1.0 / 3.0, 0.5]));
assert_eq!(n.pdf(&DVector::from_vec(vec![0.33333, 0.33333, 0.33333])), 2.222155556222205);

Implementations

impl Dirichlet

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

Constructs a new dirichlet distribution with the given concentration parameters (alpha)

Errors

Returns an error if any element x in alpha exist such that x < = 0.0 or x is NaN, or if the length of alpha is less than 2

Examples

use statrs::distribution::Dirichlet;
use nalgebra::DVector;

let alpha_ok = vec![1.0, 2.0, 3.0];
let mut result = Dirichlet::new(alpha_ok);
assert!(result.is_ok());

let alpha_err = vec![0.0];
result = Dirichlet::new(alpha_err);
assert!(result.is_err());

pub fn new_with_param(alpha: f64, n: usize) -> Result<Dirichlet>

Constructs a new dirichlet distribution with the given concentration parameter (alpha) repeated n times

Errors

Returns an error if alpha < = 0.0 or alpha is NaN, or if n < 2

Examples

use statrs::distribution::Dirichlet;

let mut result = Dirichlet::new_with_param(1.0, 3);
assert!(result.is_ok());

result = Dirichlet::new_with_param(0.0, 1);
assert!(result.is_err());

pub fn alpha(&self) -> &DVector<f64>

Returns the concentration parameters of the dirichlet distribution as a slice

Examples

use statrs::distribution::Dirichlet;
use nalgebra::DVector;

let n = Dirichlet::new(vec![1.0, 2.0, 3.0]).unwrap();
assert_eq!(n.alpha(), &DVector::from_vec(vec![1.0, 2.0, 3.0]));

pub fn entropy(&self) -> Option<f64>

Returns the entropy of the dirichlet distribution

Formula

ln(B(α)) - (K - α_0)ψ(α_0) - Σ((α_i - 1)ψ(α_i))

where

B(α) = Π(Γ(α_i)) / Γ(Σ(α_i))

α_0 is the sum of all concentration parameters, K is the number of concentration parameters, ψ is the digamma function, α_i is the ith concentration parameter, and Σ is the sum from 1 to K

Trait Implementations

impl Clone for Dirichlet

fn clone(&self) -> Dirichlet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Continuous<&'a Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>, f64> for Dirichlet

fn pdf(&self, x: &DVector<f64>) -> f64

Calculates the probabiliy density function for the dirichlet distribution with given x’s corresponding to the concentration parameters for this distribution

Panics

If any element in x is not in (0, 1), the elements in x do not sum to 1 with a tolerance of 1e-4, or if x is not the same length as the vector of concentration parameters for this distribution

Formula

(1 / B(α)) * Π(x_i^(α_i - 1))

where

B(α) = Π(Γ(α_i)) / Γ(Σ(α_i))

α is the vector of concentration parameters, α_i is the ith concentration parameter, x_i is the ith argument corresponding to the ith concentration parameter, Γ is the gamma function, Π is the product from 1 to K, Σ is the sum from 1 to K, and K is the number of concentration parameters

fn ln_pdf(&self, x: &DVector<f64>) -> f64

Calculates the log probabiliy density function for the dirichlet distribution with given x’s corresponding to the concentration parameters for this distribution

Panics

If any element in x is not in (0, 1), the elements in x do not sum to 1 with a tolerance of 1e-4, or if x is not the same length as the vector of concentration parameters for this distribution

Formula

ln((1 / B(α)) * Π(x_i^(α_i - 1)))

where

B(α) = Π(Γ(α_i)) / Γ(Σ(α_i))

α is the vector of concentration parameters, α_i is the ith concentration parameter, x_i is the ith argument corresponding to the ith concentration parameter, Γ is the gamma function, Π is the product from 1 to K, Σ is the sum from 1 to K, and K is the number of concentration parameters

impl Debug for Dirichlet

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

Formats the value using the given formatter.

impl Distribution<Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>> for Dirichlet

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> DVector<f64>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl MeanN<Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>> for Dirichlet

fn mean(&self) -> Option<DVector<f64>>

Returns the means of the dirichlet distribution

Formula

α_i / α_0

for the ith element where α_i is the ith concentration parameter and α_0 is the sum of all concentration parameters

impl PartialEq for Dirichlet

fn eq(&self, other: &Dirichlet) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VarianceN<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>> for Dirichlet

fn variance(&self) -> Option<DMatrix<f64>>

Returns the variances of the dirichlet distribution

Formula

(α_i * (α_0 - α_i)) / (α_0^2 * (α_0 + 1))

for the ith element where α_i is the ith concentration parameter and α_0 is the sum of all concentration parameters

impl StructuralPartialEq for Dirichlet