Struct InvGaussianSuffStat 

pub struct InvGaussianSuffStat { /* private fields */ }

Gaussian sufficient statistic.

Holds the number of observations, their sum, and the sum of their squared values.

Implementations

impl InvGaussianSuffStat

pub fn new() -> Self

pub fn from_parts_unchecked( n: usize, sum_x: f64, sum_inv_x: f64, sum_ln_x: f64, ) -> Self

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

Example

use rv::data::InvGaussianSuffStat;
use rv::prelude::SuffStat;

let data: Vec<f64> = vec![0.1, 0.2, 0.3];

let mut stat_b = InvGaussianSuffStat::new();
stat_b.observe_many(&data);

let n = data.len();
let sum_x = data.iter().sum();
let sum_inv_x = data.iter().map(|x: &f64| x.recip()).sum();
let sum_ln_x = data.iter().map(|x: &f64| x.ln()).sum();

let stat_a = InvGaussianSuffStat::from_parts_unchecked(n, sum_x, sum_inv_x, sum_ln_x);

assert_eq!(stat_a.n(), stat_b.n());
assert::close(stat_a.sum_x(), stat_b.sum_x(), 1e-10);
assert::close(stat_a.sum_inv_x(), stat_b.sum_inv_x(), 1e-10);
assert::close(stat_a.sum_ln_x(), stat_b.sum_ln_x(), 1e-10);

pub fn n(&self) -> usize

Get the number of observations

pub fn mean(&self) -> f64

Get the sample mean

pub fn sum_x(&self) -> f64

Sum of x

pub fn sum_inv_x(&self) -> f64

Sum of 1/x

pub fn sum_ln_x(&self) -> f64

Trait Implementations

impl Clone for InvGaussianSuffStat

fn clone(&self) -> InvGaussianSuffStat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InvGaussianSuffStat

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

Formats the value using the given formatter.

impl Default for InvGaussianSuffStat

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InvGaussianSuffStat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&[f32]> for InvGaussianSuffStat

fn from(xs: &[f32]) -> Self

Converts to this type from the input type.

impl From<&[f64]> for InvGaussianSuffStat

fn from(xs: &[f64]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a InvGaussianSuffStat> for DataOrSuffStat<'a, f32, InvGaussian>

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

Converts to this type from the input type.

impl<'a> From<&'a InvGaussianSuffStat> for DataOrSuffStat<'a, f64, InvGaussian>

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

Converts to this type from the input type.

impl From<&Vec<f32>> for InvGaussianSuffStat

fn from(xs: &Vec<f32>) -> Self

Converts to this type from the input type.

impl From<&Vec<f64>> for InvGaussianSuffStat

fn from(xs: &Vec<f64>) -> Self

Converts to this type from the input type.

impl PartialEq for InvGaussianSuffStat

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InvGaussianSuffStat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SuffStat<f32> for InvGaussianSuffStat

fn n(&self) -> usize

Returns the number of observations

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

Assimilate the datum x into the statistic

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

Remove the datum x from the statistic

fn merge(&mut self, other: Self)

Combine sufficient statistics

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

Assimilate several observations

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

Forget several observations

impl SuffStat<f64> for InvGaussianSuffStat

fn n(&self) -> usize

Returns the number of observations

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

Assimilate the datum x into the statistic

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

Remove the datum x from the statistic

fn merge(&mut self, other: Self)

Combine sufficient statistics

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

Assimilate several observations

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

Forget several observations

impl StructuralPartialEq for InvGaussianSuffStat