rust-average/README.md

47 lines
1.1 KiB
Markdown
Raw Normal View History

2017-05-05 16:52:54 +02:00
# average
2017-05-29 00:39:33 +02:00
Calculate statistics of a sequence iteratively in a single pass, using
2018-03-01 01:54:41 +01:00
constant space and avoiding numerical problems. The calculations can be
2017-05-24 19:45:58 +02:00
easily parallelized by using `merge`.
2017-05-05 16:52:54 +02:00
2018-07-11 12:58:17 +02:00
This crate works without `std`.
2017-06-09 10:55:42 +02:00
[![Documentation Status]][docs.rs]
[![Latest Version]][crates.io]
[![Build Status]][travis]
2017-05-05 17:01:59 +02:00
2017-06-09 10:55:42 +02:00
[Documentation Status]: https://docs.rs/average/badge.svg
[docs.rs]: https://docs.rs/average
[Build Status]: https://travis-ci.org/vks/average.svg?branch=master
[travis]: https://travis-ci.org/vks/average
[Latest Version]: https://img.shields.io/crates/v/average.svg
[crates.io]: https://crates.io/crates/average
2017-05-16 18:21:27 +02:00
2017-05-29 00:39:33 +02:00
## Implemented statistics
2017-05-16 18:21:27 +02:00
2017-05-29 00:39:33 +02:00
* Mean and its error.
* Variance, skewness, kurtosis.
2018-07-06 13:11:40 +02:00
* Arbitrary moments.
2017-06-09 10:42:33 +02:00
* Minimum and maximum.
2017-05-29 00:39:33 +02:00
* Quantile.
2018-07-06 13:11:40 +02:00
* Histogram.
2018-03-01 01:40:02 +01:00
## Crate features
The following optional feature is available:
* `serde1` enables serialization, via Serde version 1.
2019-01-22 14:36:53 +01:00
## Rust version requirements
Rustc version 1.22 or greater is supported.
2018-03-01 01:40:02 +01:00
## Related Projects
* [`quantiles`](https://crates.io/crates/quantiles):
2018-03-01 01:54:41 +01:00
Provides quantile estimates with bounded error but using growing space.