Struct average::Mean

pub struct Mean { /* fields omitted */ }

Estimate the arithmetic mean of a sequence of numbers ("population").

Example

use average::Mean;

let a: Mean = (1..6).map(Into::into).collect();
println!("The mean is {}.", a.mean());

Methods

impl Mean

fn new() -> Mean

Create a new mean estimator.

fn add(&mut self, sample: f64)

Add an observation sampled from the population.

fn is_empty(&self) -> bool

Determine whether the sample is empty.

fn mean(&self) -> f64

Estimate the mean of the population.

Returns 0 for an empty sample.

fn len(&self) -> u64

Return the sample size.

fn merge(&mut self, other: &Mean)

Merge another sample into this one.

Example

use average::Mean;

let sequence: &[f64] = &[1., 2., 3., 4., 5., 6., 7., 8., 9.];
let (left, right) = sequence.split_at(3);
let avg_total: Mean = sequence.iter().map(|x| *x).collect();
let mut avg_left: Mean = left.iter().map(|x| *x).collect();
let avg_right: Mean = right.iter().map(|x| *x).collect();
avg_left.merge(&avg_right);
assert_eq!(avg_total.mean(), avg_left.mean());

Trait Implementations

impl Debug for Mean

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

Formats the value using the given formatter.

impl Clone for Mean

fn clone(&self) -> Mean

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Mean

fn default() -> Mean

Returns the "default value" for a type.

impl FromIterator<f64> for Mean

fn from_iter<T>(iter: T) -> Mean where
    T: IntoIterator<Item = f64>, 

Creates a value from an iterator.