added readme

This commit is contained in:
Stephen McQuay 2013-12-29 01:03:07 -08:00
parent ae4319c560
commit 30b1e6ec56
1 changed files with 12 additions and 0 deletions

12
readme.md Normal file
View File

@ -0,0 +1,12 @@
ostat
=====
ostat is a go package that implements the efficient, accurate, and stable
calculation of [online](http://en.wikipedia.org/wiki/Online_algorithm)
statistical quantities. More info on what is being implemented here can be
found on
[wikipedia](http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Online_algorithm)
The algorithm comes from [*The Art of Computer Programing*, vol 2 by Knuth](http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#cite_note-5).
For documentation please refer to `ostat_test.go`.