Struct average::Quantile

pub struct Quantile { /* private fields */ }

Available on crate features std or libm only.

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

The P² algorithm is employed. It uses constant space but the relative error of the quantile estimate is not bounded by a function of the number of samples. For algorithms that use growing space with bounded error, see the quantiles crate.

It is recommended to use a different algorithm for discrete distributions and a small number of samples, or for quantiles close to a singularity in the distribution.

Implementations

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 NaN 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 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 Debug for Quantile

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

Formats the value using the given formatter.

impl Default for Quantile

fn default() -> Quantile

Create a new median estimator.

impl<'de> Deserialize<'de> for Quantile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.

impl Serialize for Quantile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.