Struct criterion_stats::univariate::Sample

pub struct Sample<A>(_);

A collection of data points drawn from a population

Invariants:

• The sample contains at least 2 data points
• The sample contains no NaNs

Implementations

impl<A> Sample<A> where
    A: Float, 

pub fn new(slice: &[A]) -> &Sample<A>

Creates a new sample from an existing slice

Panics

Panics if slice contains any NaN or if slice has less than two elements

pub fn max(&self) -> A

Returns the biggest element in the sample

• Time: O(length)

pub fn mean(&self) -> A

Returns the arithmetic average of the sample

• Time: O(length)

pub fn median_abs_dev(&self, median: Option<A>) -> A where
    usize: From<A, Output = Result<usize, Error>>, 

Returns the median absolute deviation

The median can be optionally passed along to speed up (2X) the computation

• Time: O(length)
• Memory: O(length)

pub fn median_abs_dev_pct(&self) -> A where
    usize: From<A, Output = Result<usize, Error>>, 

Returns the median absolute deviation as a percentage of the median

• Time: O(length)
• Memory: O(length)

pub fn min(&self) -> A

Returns the smallest element in the sample

• Time: O(length)

pub fn percentiles(&self) -> Percentiles<A> where
    usize: From<A, Output = Result<usize, Error>>, 

Returns a “view” into the percentiles of the sample

This “view” makes consecutive computations of percentiles much faster (O(1))

• Time: O(N log N) where N = length
• Memory: O(length)

pub fn std_dev(&self, mean: Option<A>) -> A

Returns the standard deviation of the sample

The mean can be optionally passed along to speed up (2X) the computation

• Time: O(length)

pub fn std_dev_pct(&self) -> A

Returns the standard deviation as a percentage of the mean

• Time: O(length)

pub fn sum(&self) -> A

Returns the sum of all the elements of the sample

• Time: O(length)

pub fn t(&self, other: &Sample<A>) -> A

Returns the t score between these two samples

• Time: O(length)

pub fn var(&self, mean: Option<A>) -> A

Returns the variance of the sample

The mean can be optionally passed along to speed up (2X) the computation

• Time: O(length)

pub fn bootstrap<T, S>(
    &self,
    nresamples: usize,
    statistic: S
) -> T::Distributions where
    S: Fn(&Sample<A>) -> T,
    S: Sync,
    T: Tuple,
    T: Send,
    T::Distributions: Send,
    T::Builder: Send, 

Returns the bootstrap distributions of the parameters estimated by the 1-sample statistic

• Multi-threaded
• Time: O(nresamples)
• Memory: O(nresamples)

Trait Implementations

impl<A> Deref for Sample<A>

type Target = [A]

The resulting type after dereferencing.

fn deref(&self) -> &[A]

Dereferences the value.