Struct average::Quantile

pub struct Quantile { /* fields omitted */ }

Estimate the p-quantile of a sequence of numbers ("population").

The algorithm uses constant space but does not provide any upper bound on the error. For algorithms that use growing space with bounded error, see the quantiles crate. They are recommended over this algorithm for small samples.

Methods

impl Quantile

pub fn new(p: f64) -> Quantile

Create a new p-quantile estimator.

Panics if p is not between 0 and 1.

pub fn p(&self) -> f64

Return the value of p for this p-quantile.

pub fn quantile(&self) -> f64

Estimate the p-quantile of the population.

Returns 0 for an empty sample.

pub fn len(&self) -> u64

Return the sample size.

pub fn is_empty(&self) -> bool

Determine whether the sample is empty.

Trait Implementations

impl Debug for Quantile

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

Formats the value using the given formatter.

impl Clone for Quantile

fn clone(&self) -> Quantile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Quantile

fn default() -> Quantile

Create a new median estimator.

impl Estimate for Quantile

fn add(&mut self, x: f64)

Add an observation sampled from the population.

fn estimate(&self) -> f64

Estimate the statistic of the population.