Struct inc_stats::Percentiles

pub struct Percentiles { /* fields omitted */ }

Data percentile struct

This struct stores data to allow efficient computation of percentiles. This struct takes linear space. It implements FromIterator to allow collection.

Examples

let nums = [2.0, 4.0, 8.0];
let mut percs = inc_stats::Percentiles::new();
for num in nums.iter() {
    percs.add(num.clone());
}
assert_eq!(3, percs.count());

let nums = [2.0, 4.0, 8.0];
let percs: inc_stats::Percentiles = nums.iter().cloned().collect();
assert_eq!(3, percs.count());

Methods

impl Percentiles

pub fn new() -> Self

Create a new Percentiles object with no data

pub fn add(&mut self, val: f64)

Add a data point

pub fn count(&self) -> i64

Get the number of data points

pub fn percentiles<I>(&mut self, percentiles: I) -> Option<Vec<f64>> where
    I: Iterator<Item = f64>, 

Get a number of percentiles

This takes linear time in the number of added data points, and log linear in the number of percentiles. This will be marginally more efficient than calling percentile repeatedly in a bad order.

Examples:

let nums = [1.0, 3.0, 7.0];
let mut percs: inc_stats::Percentiles = nums.iter().cloned().collect();
let quarts = percs.percentiles([0.75, 0.25, 0.5].iter().cloned()).unwrap();
assert!((5.0 - quarts[0]).abs() < 1.0e-6);
assert!((2.0 - quarts[1]).abs() < 1.0e-6);
assert!((3.0 - quarts[2]).abs() < 1.0e-6);

pub fn percentile(&mut self, percentile: &f64) -> Option<f64>

Get a percentile

Linear time.

Examples:

let nums = [1.0, 5.0];
let mut percs: inc_stats::Percentiles = nums.iter().cloned().collect();
let quart = percs.percentile(&0.25).unwrap();
assert!((2.0 - quart).abs() < 1.0e-6);

pub fn median(&mut self) -> Option<f64>

Get the median

Linear time.

Examples:

let nums = [1.0, 5.0, 100.0];
let mut percs: inc_stats::Percentiles = nums.iter().cloned().collect();
let med = percs.median().unwrap();
assert!((5.0 - med).abs() < 1.0e-6);

Trait Implementations

impl Debug for Percentiles

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

Formats the value using the given formatter.

impl FromIterator<f64> for Percentiles

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = f64>, 

Creates a value from an iterator.