Struct WeightedMean

pub struct WeightedMean { /* private fields */ }

Estimate the weighted and unweighted arithmetic mean of a sequence of numbers (“population”).

Example

use average::WeightedMean;

let a: WeightedMean = (1..6).zip(1..6)
    .map(|(x, w)| (f64::from(x), f64::from(w))).collect();
println!("The weighted mean is {}.", a.mean());

Implementations

impl WeightedMean

pub fn new() -> WeightedMean

Create a new weighted and unweighted mean estimator.

pub fn add(&mut self, sample: f64, weight: f64)

Add an observation sampled from the population.

pub fn is_empty(&self) -> bool

Determine whether the sample is empty.

Might be a false positive if the sum of weights is zero.

pub fn sum_weights(&self) -> f64

Return the sum of the weights.

Returns 0 for an empty sample.

pub fn mean(&self) -> f64

Estimate the weighted mean of the population.

Returns NaN for an empty sample, or if the sum of weights is zero.

Trait Implementations

impl Clone for WeightedMean

fn clone(&self) -> WeightedMean

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WeightedMean

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

Formats the value using the given formatter.

impl Default for WeightedMean

fn default() -> WeightedMean

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WeightedMean

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Extend<&'a (f64, f64)> for WeightedMean

fn extend<T: IntoIterator<Item = &'a (f64, f64)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<(f64, f64)> for WeightedMean

fn extend<T: IntoIterator<Item = (f64, f64)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> FromIterator<&'a (f64, f64)> for WeightedMean

fn from_iter<T>(iter: T) -> WeightedMean

where T: IntoIterator<Item = &'a (f64, f64)>,

Creates a value from an iterator.

impl FromIterator<(f64, f64)> for WeightedMean

fn from_iter<T>(iter: T) -> WeightedMean

where T: IntoIterator<Item = (f64, f64)>,

Creates a value from an iterator.

impl Merge for WeightedMean

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

Merge another sample into this one.

Example

use average::{WeightedMean, Merge};

let weighted_sequence: &[(f64, f64)] = &[
    (1., 0.1), (2., 0.2), (3., 0.3), (4., 0.4), (5., 0.5),
    (6., 0.6), (7., 0.7), (8., 0.8), (9., 0.9)];
let (left, right) = weighted_sequence.split_at(3);
let avg_total: WeightedMean = weighted_sequence.iter().collect();
let mut avg_left: WeightedMean = left.iter().collect();
let avg_right: WeightedMean = right.iter().collect();
avg_left.merge(&avg_right);
assert!((avg_total.mean() - avg_left.mean()).abs() < 1e-15);

impl Serialize for WeightedMean

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

where __S: Serializer,

Serialize this value into the given Serde serializer.