Struct average::Max

pub struct Max { /* fields omitted */ }

Estimate the maximum of a sequence of numbers ("population").

Example

use average::Max;

let a: Max = (1..6).map(f64::from).collect();
assert_eq!(a.max(), 5.);

Implementations

impl Max

pub fn from_value(x: f64) -> Max

Create a new maxium estimator from a given value.

pub fn new() -> Max

Create a new maximum estimator.

pub fn max(&self) -> f64

Estimate the maxium of the population.

Trait Implementations

impl Clone for Max

fn clone(&self) -> Max

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Max

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

Formats the value using the given formatter.

impl Default for Max

fn default() -> Max

Returns the "default value" for a type.

impl Estimate for Max

fn add(&mut self, x: f64)

Add an observation sampled from the population.

fn estimate(&self) -> f64

Estimate the statistic of the population.

impl<'a> FromIterator<&'a f64> for Max

fn from_iter<T>(iter: T) -> Max where
    T: IntoIterator<Item = &'a f64>, 

Creates a value from an iterator.

impl FromIterator<f64> for Max

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

Creates a value from an iterator.

impl Merge for Max

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

Merge another sample into this one.

Example

use average::{Max, Merge};

let sequence: &[f64] = &[1., 2., 3., 4., 5., 6., 7., 8., 9.];
let (left, right) = sequence.split_at(3);
let max_total: Max = sequence.iter().collect();
let mut max_left: Max = left.iter().collect();
let max_right: Max = right.iter().collect();
max_left.merge(&max_right);
assert_eq!(max_total.max(), max_left.max());