Enum rv::data::DataOrSuffStat

pub enum DataOrSuffStat<'a, X, Fx> where
    X: 'a + ApiReady,
    Fx: 'a + HasSuffStat<X> + ApiReady,
    Fx::Stat: ApiReady,  {
    Data(&'a Vec<X>),
    SuffStat(&'a Fx::Stat),
    None,
}

Holds either a sufficient statistic of a vector of data.

Variants

Data(&'a Vec<X>)

A Vec of raw data

SuffStat(&'a Fx::Stat)

A sufficient statistic

None

No data

Methods

impl<'a, X, Fx> DataOrSuffStat<'a, X, Fx> where
    X: 'a + ApiReady,
    Fx: 'a + HasSuffStat<X> + ApiReady,
    Fx::Stat: ApiReady, 

pub fn n(&self) -> usize

Get the number of observations

pub fn is_data(&self) -> bool

Determine whether the object contains data

Example

use rv::dist::Gaussian;
use rv::data::GaussianSuffStat;

let xs = vec![1.0_f64];
let data: DataOrSuffStat<f64, Gaussian> = DataOrSuffStat::Data(&xs);

assert!(data.is_data());

let gauss_stats = GaussianSuffStat::new();
let suffstat: DataOrSuffStat<f64, Gaussian> = DataOrSuffStat::SuffStat(&gauss_stats);

assert!(!suffstat.is_data());

pub fn is_suffstat(&self) -> bool

Determine whether the object contains sufficient statistics

Example

use rv::dist::Gaussian;
use rv::data::GaussianSuffStat;

let xs = vec![1.0_f64];
let data: DataOrSuffStat<f64, Gaussian> = DataOrSuffStat::Data(&xs);

assert!(!data.is_suffstat());

let gauss_stats = GaussianSuffStat::new();
let suffstat: DataOrSuffStat<f64, Gaussian> = DataOrSuffStat::SuffStat(&gauss_stats);

assert!(suffstat.is_suffstat());

pub fn is_none(&self) -> bool

Determine whether the object is empty

Example

use rv::dist::Gaussian;
use rv::data::GaussianSuffStat;

let xs = vec![1.0_f64];
let data: DataOrSuffStat<f64, Gaussian> = DataOrSuffStat::Data(&xs);

assert!(!data.is_none());

let gauss_stats = GaussianSuffStat::new();
let suffstat: DataOrSuffStat<f64, Gaussian> = DataOrSuffStat::SuffStat(&gauss_stats);

assert!(!suffstat.is_none());

let none: DataOrSuffStat<f64, Gaussian> = DataOrSuffStat::None;

assert!(none.is_none());

Trait Implementations

impl<'a, X: PartialOrd, Fx: PartialOrd> PartialOrd<DataOrSuffStat<'a, X, Fx>> for DataOrSuffStat<'a, X, Fx> where
    X: 'a + ApiReady,
    Fx: 'a + HasSuffStat<X> + ApiReady,
    Fx::Stat: ApiReady,
    Fx::Stat: PartialOrd, 

fn partial_cmp(&self, other: &DataOrSuffStat<'a, X, Fx>) -> Option<Ordering>

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

fn lt(&self, other: &DataOrSuffStat<'a, X, Fx>) -> bool

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

fn le(&self, other: &DataOrSuffStat<'a, X, Fx>) -> bool

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

fn gt(&self, other: &DataOrSuffStat<'a, X, Fx>) -> bool

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

fn ge(&self, other: &DataOrSuffStat<'a, X, Fx>) -> bool

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

impl<'a, X: PartialEq, Fx: PartialEq> PartialEq<DataOrSuffStat<'a, X, Fx>> for DataOrSuffStat<'a, X, Fx> where
    X: 'a + ApiReady,
    Fx: 'a + HasSuffStat<X> + ApiReady,
    Fx::Stat: ApiReady,
    Fx::Stat: PartialEq, 

fn eq(&self, other: &DataOrSuffStat<'a, X, Fx>) -> bool

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

fn ne(&self, other: &DataOrSuffStat<'a, X, Fx>) -> bool

This method tests for !=.

impl<'a, X: Clone, Fx: Clone> Clone for DataOrSuffStat<'a, X, Fx> where
    X: 'a + ApiReady,
    Fx: 'a + HasSuffStat<X> + ApiReady,
    Fx::Stat: ApiReady,
    Fx::Stat: Clone, 

fn clone(&self) -> DataOrSuffStat<'a, X, Fx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, X: Debug, Fx: Debug> Debug for DataOrSuffStat<'a, X, Fx> where
    X: 'a + ApiReady,
    Fx: 'a + HasSuffStat<X> + ApiReady,
    Fx::Stat: ApiReady,
    Fx::Stat: Debug, 

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

Formats the value using the given formatter.