Struct rv::data::CategoricalSuffStat

pub struct CategoricalSuffStat { /* fields omitted */ }

Categorical distribution sufficient statistic.

Store the number of observations and the count of observations of each instance.

Implementations

impl CategoricalSuffStat

pub fn new(k: usize) -> Self

pub fn from_parts_unchecked(n: usize, counts: Vec<f64>) -> Self

Create a sufficient statistic from components without checking whether they are valid.

pub fn n(&self) -> usize

Get the total number of trials

Example

let mut stat = CategoricalSuffStat::new(3);

stat.observe(&0_u8);
stat.observe(&1_u8);
stat.observe(&1_u8);

assert_eq!(stat.n(), 3);

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

Get the number of occurrences of each class, counts

Example

let mut stat = CategoricalSuffStat::new(3);

stat.observe(&0_u8);
stat.observe(&1_u8);
stat.observe(&1_u8);

assert_eq!(*stat.counts(), vec![1.0, 2.0, 0.0]);

Trait Implementations

impl Clone for CategoricalSuffStat

fn clone(&self) -> CategoricalSuffStat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CategoricalSuffStat

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

Formats the value using the given formatter.

impl<'a, X> From<&'a CategoricalSuffStat> for DataOrSuffStat<'a, X, Categorical> where
    X: CategoricalDatum, 

fn from(stat: &'a CategoricalSuffStat) -> Self

Performs the conversion.

impl PartialEq<CategoricalSuffStat> for CategoricalSuffStat

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

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

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

This method tests for !=.

impl StructuralPartialEq for CategoricalSuffStat

impl<X: CategoricalDatum> SuffStat<X> for CategoricalSuffStat

fn n(&self) -> usize

Returns the number of observations

fn observe(&mut self, x: &X)

Assimilate the datum x into the statistic

fn forget(&mut self, x: &X)

Remove the datum x from the statistic

fn observe_many(&mut self, xs: &[X])

Assimilate several observations

fn forget_many(&mut self, xs: &[X])

Forget several observations