Struct cont_arith_code::distribution::categorical::Categorical

pub struct Categorical<T> {
    pub count: usize,
    pub map: Map<T, (usize, f64)>,
}

Fields

count: usize

Number of observations

map: Map<T, (usize, f64)>

Symbol -> (count, log-probability)

Implementations

impl<T> Categorical<T>

pub fn singleton(k: T) -> Categorical<T>

pub fn from_data<I>(data: I) -> Self

where T: Ord, I: IntoIterator<Item = T>,

Fit a cateogrical distribution to the given dataset

pub fn len(&self) -> usize

pub fn lookup(&self, key: &T) -> Option<f64>

where T: Clone + Ord,

Looks up a key using binary search

pub fn index_of(&self, key: &T) -> Option<usize>

where T: Clone + Ord,

pub fn get_key(&self, i: usize) -> &T

pub fn log_pmf(&self, key: &T) -> f64

where T: Clone + Ord,

Log-probability mass function

pub fn entropy(&self) -> f64

Entropy of the categorical in nats

pub fn kld(&self, q: &Self) -> f64

where T: Clone + Ord,

Kullback-Leibler divergence D(P||Q) of self (P) from a second Categorical (Q) (nats). Panics if some entry of self is absent in Q.

pub fn log_probability(&self, val: &T) -> f64

where T: Clone + Ord,

Trait Implementations

impl<T: Clone> Clone for Categorical<T>

fn clone(&self) -> Categorical<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Categorical<T>

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

Formats the value using the given formatter.

impl<T: Clone + Ord + Debug + 'static> Model<T> for Categorical<T>

fn push(&mut self, s: i64) -> Option<T>

Push a value into the model and updates its state. Returns a values once it’s been fully described by a series of indexes.

fn next_distr(&mut self) -> Box<dyn UnivariateDistribution>

Get the distribution for the next symbol from the model.

impl<T: PartialEq> PartialEq for Categorical<T>

fn eq(&self, other: &Categorical<T>) -> 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<T: PartialOrd> PartialOrd for Categorical<T>

fn partial_cmp(&self, other: &Categorical<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Debug> UnivariateDistribution for Categorical<T>

fn truncated(&self) -> Box<dyn TruncatedDistribution>

impl<T> StructuralPartialEq for Categorical<T>