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

Improve README

Browse Source
This commit is contained in:
Vinzent Steinberg 2017-05-16 18:21:27 +02:00
parent 34a8aadb35
commit 79f449e190
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,9 +1,15 @@
# average
Calculate the average of a sequence and its error iteratively, using constant
memory.
memory and avoiding numerical problems. The calculation can be easily parallelized
by using `Average::merge`.
[Documentation](https://docs.rs/average) |
[crates.io](https://crates.io/crates/average)
[![Build Status](https://travis-ci.org/vks/average.svg?branch=master)](https://travis-ci.org/vks/average)
## Advantages over naive calculation of average and variance
* Avoids loss of precision due to cancellation.
* Only needs a single pass over the samples, at the cost of a division inside the loop.