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

Improve Histogram docs by exporting the Histogram10 special case

Browse Source
This commit is contained in:
Vinzent Steinberg 2018-07-06 13:08:33 +02:00
parent 554d4ca596
commit fcbe51f1dd
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/lib.rs
View File

@ -63,7 +63,9 @@
//! ## Calculating histograms //! ## Calculating histograms
//! //!
//! The [`define_histogram`] macro can be used to define a histogram struct that //! The [`define_histogram`] macro can be used to define a histogram struct that
//! uses constant memory. //! uses constant memory. See [`Histogram10`] (defined using
//! `define_histogram!(Histogram10, 10)`) and the extension trait [`Histogram`]
//! for the methods available to the generated struct.
//! //!
//! //!
//! [`Mean`]: ./struct.Mean.html //! [`Mean`]: ./struct.Mean.html
@ -78,6 +80,8 @@
//! [`Max`]: ./struct.Max.html //! [`Max`]: ./struct.Max.html
//! [`concatenate`]: ./macro.concatenate.html //! [`concatenate`]: ./macro.concatenate.html
//! [`define_histogram`]: ./macro.define_histogram.html //! [`define_histogram`]: ./macro.define_histogram.html
//! [`Histogram10`]: ./struct.Histogram10.html
//! [`Histogram`]: ./trait.Histogram.html
#![cfg_attr(feature = "cargo-clippy", allow(float_cmp))] #![cfg_attr(feature = "cargo-clippy", allow(float_cmp))]
@ -104,3 +108,5 @@ pub use weighted_mean::{WeightedMean, WeightedMeanWithError};
pub use minmax::{Min, Max}; pub use minmax::{Min, Max};
pub use quantile::Quantile; pub use quantile::Quantile;
pub use traits::{Estimate, Merge, Histogram}; pub use traits::{Estimate, Merge, Histogram};
define_histogram!(Histogram10, 10);