Struct probability::distribution::Categorical

pub struct Categorical { /* fields omitted */ }

A categorical distribution.

Methods

impl Categorical

pub fn new(p: &[f64]) -> Self

Create a categorical distribution with success probability p.

It should hold that p[i] >= 0, p[i] <= 1, and sum(p) == 1.

pub fn k(&self) -> usize

Return the number of categories.

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

Return the event probabilities.

Trait Implementations

impl Discrete for Categorical

fn mass(&self, x: usize) -> f64

Compute the probability mass function.

impl Distribution for Categorical

type Value = usize

The type of outcomes.

fn distribution(&self, x: f64) -> f64

Compute the cumulative distribution function.

impl Entropy for Categorical

fn entropy(&self) -> f64

Compute the differential entropy.

impl Inverse for Categorical

fn inverse(&self, p: f64) -> usize

Compute the inverse of the cumulative distribution function.

impl Kurtosis for Categorical

fn kurtosis(&self) -> f64

Compute the excess kurtosis.

impl Mean for Categorical

fn mean(&self) -> f64

Compute the expected value.

impl Median for Categorical

fn median(&self) -> f64

Compute the median.

impl Modes for Categorical

fn modes(&self) -> Vec<usize>

Compute the modes.

impl Sample for Categorical

fn sample<S>(&self, source: &mut S) -> usize where
    S: Source, 

Draw a sample.

impl Skewness for Categorical

fn skewness(&self) -> f64

Compute the skewness.

impl Variance for Categorical

fn variance(&self) -> f64

Compute the variance.

fn deviation(&self) -> f64

Compute the standard deviation.

impl Clone for Categorical

fn clone(&self) -> Categorical

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Categorical

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

Formats the value using the given formatter.