andreacavalli
/
rust-average
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve docs on calculation of arbitrary moments

This commit is contained in:
Vinzent Steinberg 2018-07-27 16:50:02 +02:00
parent f13be77348
commit bb994f0f22
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/lib.rs
View File

@ -1,7 +1,8 @@
//! This crate provides estimators for statistics on a sequence of numbers. The //! This crate provides estimators for statistics on a sequence of numbers. The
//! typical workflow looks like this: //! typical workflow looks like this:
//! //!
//! 1. If necessary, build your custom estimator using [`concatenate`]. //! 1. If necessary, build your custom estimator using [`concatenate`] or
//! [`define_moments`].
//! 2. Initialize the estimator of your choice with `new()`. //! 2. Initialize the estimator of your choice with `new()`.
//! 3. Add some subset (called "sample") of the sequence of numbers (called //! 3. Add some subset (called "sample") of the sequence of numbers (called
//! "population") for which you want to estimate the statistic, using `add()` //! "population") for which you want to estimate the statistic, using `add()`
@ -42,6 +43,7 @@
//! ([`WeightedMeanWithError`]). //! ([`WeightedMeanWithError`]).
//! * Variance ([`Variance`]), skewness ([`Skewness`]) and kurtosis //! * Variance ([`Variance`]), skewness ([`Skewness`]) and kurtosis
//! ([`Kurtosis`]). //! ([`Kurtosis`]).
//! * Arbitrary higher moments ([`define_moments`]).
//! * Quantiles ([`Quantile`]). //! * Quantiles ([`Quantile`]).
//! * Minimum ([`Min`]) and maximum ([`Max`]). //! * Minimum ([`Min`]) and maximum ([`Max`]).
//! //!
@ -79,6 +81,7 @@
//! [`Min`]: ./struct.Min.html //! [`Min`]: ./struct.Min.html
//! [`Max`]: ./struct.Max.html //! [`Max`]: ./struct.Max.html
//! [`concatenate`]: ./macro.concatenate.html //! [`concatenate`]: ./macro.concatenate.html
//! [`define_moments`]: ./macro.define_moments.html
//! [`define_histogram`]: ./macro.define_histogram.html //! [`define_histogram`]: ./macro.define_histogram.html
//! [`Histogram10`]: ./struct.Histogram10.html //! [`Histogram10`]: ./struct.Histogram10.html
//! [`Histogram`]: ./trait.Histogram.html //! [`Histogram`]: ./trait.Histogram.html