Clarify limitations of quantile algorithm

Refs #10.
This commit is contained in:
Vinzent Steinberg 2018-03-01 01:33:39 +01:00
parent e4345f5046
commit 8b5fb44500

View File

@ -7,6 +7,11 @@ use quickersort::sort_floats;
use super::Estimate; use super::Estimate;
/// Estimate the p-quantile of a sequence of numbers ("population"). /// 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 variable space with bounded error, see
/// the [`quantiles`](https://crates.io/crates/quantiles) crate. They are
/// recommended over this algorithm for small samples.
// This uses the P² algorithm introduced here: // This uses the P² algorithm introduced here:
// http://www.cs.wustl.edu/~jain/papers/ftp/psqr.pdf // http://www.cs.wustl.edu/~jain/papers/ftp/psqr.pdf
#[derive(Debug, Clone)] #[derive(Debug, Clone)]