Struct stats::MinMax

pub struct MinMax<T> { /* private fields */ }

A commutative data structure for tracking minimum and maximum values.

This also stores the number of samples.

Implementations

impl<T: PartialOrd + Clone> MinMax<T>

pub fn new() -> MinMax<T>

Create an empty state where min and max values do not exist.

Examples found in repository

src/minmax.rs (line 109)

    fn from_iter<I: IntoIterator<Item = T>>(it: I) -> MinMax<T> {
        let mut v = MinMax::new();
        v.extend(it);
        v
    }

pub fn add(&mut self, sample: T)

Add a sample to the data.

Examples found in repository

src/minmax.rs (line 119)

    fn extend<I: IntoIterator<Item = T>>(&mut self, it: I) {
        for sample in it {
            self.add(sample);
        }
    }

pub const fn min(&self) -> Option<&T>

Returns the minimum of the data set.

None is returned if and only if the number of samples is 0.

pub const fn max(&self) -> Option<&T>

Returns the maximum of the data set.

None is returned if and only if the number of samples is 0.

pub const fn len(&self) -> usize

Returns the number of data points.

pub const fn is_empty(&self) -> bool

Returns true if there are no data points.

Trait Implementations

impl<T: Clone> Clone for MinMax<T>

fn clone(&self) -> MinMax<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialOrd> Commute for MinMax<T>

fn merge(&mut self, v: MinMax<T>)

Merges the value other into self.

fn consume<I: Iterator<Item = Self>>(&mut self, other: I)

Merges the values in the iterator into self.

impl<T: Debug> Debug for MinMax<T>

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

Formats the value using the given formatter.

impl<T: PartialOrd> Default for MinMax<T>

fn default() -> MinMax<T>

Returns the “default value” for a type.

impl<T: PartialOrd + Clone> Extend<T> for MinMax<T>

fn extend<I: IntoIterator<Item = T>>(&mut self, it: I)

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<T: PartialOrd + Clone> FromIterator<T> for MinMax<T>

fn from_iter<I: IntoIterator<Item = T>>(it: I) -> MinMax<T>

Creates a value from an iterator.