Struct Mean 

pub struct Mean { /* private fields */ }

Incremental mean computed with the delta method to minimize floating-point accumulation error.

Examples

use rill_ml::stats::Mean;
use rill_ml::OnlineStatistic;

let mut m = Mean::new();
m.update(1.0).unwrap();
m.update(2.0).unwrap();
m.update(3.0).unwrap();
assert_eq!(m.value(), 2.0);
assert_eq!(m.samples_seen(), 3);

Implementations

impl Mean

pub const fn new() -> Self

Create a new empty mean accumulator.

pub const fn value(&self) -> f64

Current mean, or 0.0 if no observations have been seen.

pub const fn count(&self) -> u64

Number of observations seen so far.

Trait Implementations

impl Clone for Mean

fn clone(&self) -> Mean

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mean

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

Formats the value using the given formatter.

impl Default for Mean

fn default() -> Mean

Returns the “default value” for a type.

impl OnlineStatistic for Mean

fn update(&mut self, value: f64) -> Result<(), RillError>

Update the statistic with a new observation.

fn samples_seen(&self) -> u64

How many observations have been incorporated.

fn reset(&mut self)

Reset the statistic.