steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add more documentation for math.statistics

db4
Benjamin Pollack 2015-01-30 08:20:50 -05:00 committed by John Benediktsson
parent ab5bfd90ef
commit 5e01164a72
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
basis/math/statistics/statistics-docs.factor
View File

@ -15,6 +15,11 @@ HELP: harmonic-mean
{ $examples { $example "USING: math.statistics prettyprint ;" "{ 1 2 3 } harmonic-mean ." "6/11" } }
{ $errors "Throws a " { $link signal-error. } " (divide by zero) if the sequence is empty." } ;
HELP: kth-smallest
{ $values { "seq" sequence } { "k" integer } }
{ $description "Returns the kth smallest element. This is semantically equivalent to " { $snippet "swap natural-sort nth" } ", and is therefore zero-indexed. " { $snippet "k" } " may not be larger than the highest index of " { $snippet "sequence" } "." }
{ $examples { $example "USING: math.statistics ;" "{ 3 1 2 } 1 kth-smallest ." "2" } } ;
HELP: mean
{ $values { "seq" sequence } { "x" "a non-negative real number"} }
{ $description "Computes the arithmetic mean of the elements in " { $snippet "seq" } "." }