From 79f449e19024508add1de3398714e207678edb0d Mon Sep 17 00:00:00 2001 From: Vinzent Steinberg Date: Tue, 16 May 2017 18:21:27 +0200 Subject: [PATCH] Improve README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 530e205..5033651 100644 --- a/README.md +++ b/README.md @@ -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.