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

math.statistics: Fix docs for help-lint.

db4
Doug Coleman 2012-04-10 08:52:12 -07:00
parent 236dd2cc97
commit 021e0f2ce6
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -50,15 +50,14 @@ HELP: std
{ $values { "seq" sequence } { "x" "a non-negative real number"} }
{ $description "Computes the standard deviation of " { $snippet "seq" } ", which is the square root of the variance. It measures how widely spread the values in a sequence are about the mean." }
{ $examples
{ $example "USING: math.statistics prettyprint ;" "{ 1 2 3 } std ." "1.0" }
{ $example "USING: math.statistics prettyprint ;" "{ 1 2 3 4 } std ." "1.290994448735806" } } ;
{ $example "USING: math.statistics prettyprint ;" "{ 4 6 8 10 12 14 16 } std ." "4.0" } } ;
HELP: ste
{ $values { "seq" sequence } { "x" "a non-negative real number"} }
{ $description "Computes the standard error of the mean for " { $snippet "seq" } ". It's defined as the standard deviation divided by the square root of the length of the sequence, and measures uncertainty associated with the estimate of the mean." }
{ $examples
{ $example "USING: math.statistics prettyprint ;" "{ -2 2 } ste ." "2.0" }
{ $example "USING: math.statistics prettyprint ;" "{ -2 2 2 } ste ." "1.333333333333333" } } ;
{ $example "USING: math.statistics prettyprint ;" "{ 4 6 6 8 10 12 14 14 16 } ste ." "1.333333333333333" }
} ;
HELP: var
{ $values { "seq" sequence } { "x" "a non-negative real number"} }
@ -66,15 +65,15 @@ HELP: var
{ $notes "If the number of elements in " { $snippet "seq" } " is 1 or less, it outputs 0." }
{ $examples
{ $example "USING: math.statistics prettyprint ;" "{ 1 } var ." "0" }
{ $example "USING: math.statistics prettyprint ;" "{ 1 2 3 } var ." "1" }
{ $example "USING: math.statistics prettyprint ;" "{ 1 2 3 4 } var ." "1+2/3" } } ;
{ $example "USING: math.statistics prettyprint ;" "{ 1 2 3 } var ." "2/3" }
{ $example "USING: math.statistics prettyprint ;" "{ 1 2 3 4 5 } var ." "2" } } ;
HELP: cov
{ $values { "{x}" sequence } { "{y}" sequence } { "x" "a real number" } }
{ $values { "{x}" sequence } { "{y}" sequence } { "cov" "a real number" } }
{ $description "Computes the covariance of two sequences, " { $snippet "{x}" } " and " { $snippet "{y}" } "." } ;
HELP: corr
{ $values { "{x}" sequence } { "{y}" sequence } { "x" "a real number" } }
{ $values { "{x}" sequence } { "{y}" sequence } { "corr" "a real number" } }
{ $description "Computes the correlation of two sequences, " { $snippet "{x}" } " and " { $snippet "{y}" } "." } ;
HELP: histogram