Struct stats_ci::quantile::Stats

pub struct Stats { /* private fields */ }

Running statistics for quantiles

Implementations

impl Stats

pub fn new(population: usize) -> Self

Create a new instance with an initial population

pub fn ci( &self, confidence: Confidence, quantile: f64 ) -> CIResult<Interval<usize>>

Return the confidence interval on the indices for a given quantile.

Arguments

• confidence - the confidence level
• quantile - the quantile (must be in the range [0, 1])

Returns

A confidence interval containing indices on the corresponding data.

Errors

• TooFewSamples - if the number of samples is too small to compute a confidence interval
• InvalidQuantile - if the quantile is not in the range [0, 1]
• IndexError - if the confidence interval falls outside the range of the data

Examples

let data = [1, 2, 3, 4, 5, 6, 7, 8, 9];
let confidence = Confidence::new_two_sided(0.8);
let quantile = 0.5; // median
let stats = quantile::Stats::new(data.len());
let interval = stats.ci(confidence, quantile)?;
assert_eq!(interval, Interval::new(3, 6)?);

pub fn index(&self, quantile: f64) -> CIResult<usize>

Return the index for a given quantile.

Arguments

• quantile - the quantile (must be in the range [0, 1])

Returns

The index corresponding to the quantile.

Errors

• TooFewSamples - if the number of samples is too small to compute a confidence interval
• InvalidQuantile - if the quantile is not in (0, 1)

Examples

let data = ['a', 'b', 'c', 'd', 'e'];
let stats = quantile::Stats::new(data.len());
assert_eq!(stats.index(0.).unwrap(), 0);
assert_eq!(stats.index(0.5).unwrap(), 2);
assert_eq!(stats.index(1.).unwrap(), 4);
assert_eq!(data[stats.index(0.25).unwrap()], 'b');
assert_eq!(data[stats.index(0.75).unwrap()], 'd');

Trait Implementations

impl Add<Stats> for Stats

type Output = Stats

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<Stats> for Stats

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Stats

fn clone(&self) -> Stats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stats

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

Formats the value using the given formatter.

impl Default for Stats

fn default() -> Stats

Returns the “default value” for a type.

impl Ord for Stats

fn cmp(&self, other: &Stats) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Stats> for Stats

fn eq(&self, other: &Stats) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Stats> for Stats

fn partial_cmp(&self, other: &Stats) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Stats

impl Eq for Stats

impl StructuralEq for Stats

impl StructuralPartialEq for Stats