Struct rv::data::BernoulliSuffStat

pub struct BernoulliSuffStat { /* fields omitted */ }

Sufficient statistic for the Bernoulli distribution.

Contains the number of trials and the number of successes.

Implementations

impl BernoulliSuffStat

pub fn new() -> Self

Create a new Bernoulli sufficient statistic

pub fn from_parts_unchecked(n: usize, k: usize) -> Self

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

pub fn n(&self) -> usize

Get the total number of trials, n.

Example

let mut stat = BernoulliSuffStat::new();

stat.observe(&true);
stat.observe(&false);

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

pub fn k(&self) -> usize

Get the number of successful trials, k.

Example

let mut stat = BernoulliSuffStat::new();

stat.observe(&true);
stat.observe(&false);

assert_eq!(stat.k(), 1);

Trait Implementations

impl Clone for BernoulliSuffStat

fn clone(&self) -> BernoulliSuffStat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BernoulliSuffStat

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

Formats the value using the given formatter.

impl Default for BernoulliSuffStat

fn default() -> Self

Returns the “default value” for a type.

impl Eq for BernoulliSuffStat

impl<'a, X> From<&'a BernoulliSuffStat> for DataOrSuffStat<'a, X, Bernoulli> where
    X: Booleable, 

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

Performs the conversion.

impl PartialEq<BernoulliSuffStat> for BernoulliSuffStat

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

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

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

This method tests for !=.

impl StructuralEq for BernoulliSuffStat

impl StructuralPartialEq for BernoulliSuffStat

impl<X: Booleable> SuffStat<X> for BernoulliSuffStat

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