Struct average::Min

pub struct Min { /* private fields */ }

Estimate the minimum of a sequence of numbers (“population”).

Example

use average::Min;

let a: Min = (1..6).map(f64::from).collect();
println!("The minimum is {}.", a.min());

Implementations

impl Min

pub fn from_value(x: f64) -> Min

Create a new minimum estimator from a given value.

pub fn new() -> Min

Create a new minimum estimator.

pub fn min(&self) -> f64

Estimate the minimum of the population.

Returns f64::INFINITY for an empty sample.

Trait Implementations

impl Clone for Min

fn clone(&self) -> Min

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Min

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

Formats the value using the given formatter.

impl Default for Min

fn default() -> Min

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Min

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Estimate for Min

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> Extend<&'a f64> for Min

fn extend<T>(&mut self, iter: T)

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

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> for Min

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = f64>,

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> for Min

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

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

Creates a value from an iterator.

impl FromIterator<f64> for Min

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

where T: IntoIterator<Item = f64>,

Creates a value from an iterator.

impl<'a> FromParallelIterator<&'a f64> for Min

Available on crate feature rayon only.

fn from_par_iter<I>(par_iter: I) -> Min

where I: IntoParallelIterator<Item = &'a f64>, Self: Merge,

Creates an instance of the collection from the parallel iterator par_iter.

impl FromParallelIterator<f64> for Min

Available on crate feature rayon only.

fn from_par_iter<I>(par_iter: I) -> Min

where I: IntoParallelIterator<Item = f64>, Self: Merge,

Creates an instance of the collection from the parallel iterator par_iter.

impl Merge for Min

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

Merge another sample into this one.

Example

use average::{Min, Merge};

let sequence: &[f64] = &[1., 2., 3., 4., 5., 6., 7., 8., 9.];
let (left, right) = sequence.split_at(3);
let min_total: Min = sequence.iter().collect();
let mut min_left: Min = left.iter().collect();
let min_right: Min = right.iter().collect();
min_left.merge(&min_right);
assert_eq!(min_total.min(), min_left.min());

impl Serialize for Min

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

where __S: Serializer,

Serialize this value into the given Serde serializer.