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

Add a couple minor extra docs for math.extras

db4
Benjamin Pollack 2015-05-08 17:09:46 -04:00 committed by John Benediktsson
parent 2aa6ce7e8c
commit e1e29b7647
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
extra/math/extras/extras-docs.factor
View File

@ -1,7 +1,7 @@
! Copyright (C) 2012 John Benediktsson
! See http://factorcode.org/license.txt for BSD license
USING: help.markup help.syntax kernel math sequences ;
USING: help.markup help.syntax kernel math math.functions sequences ;
IN: math.extras
@ -78,6 +78,18 @@ HELP: majority
{ $values { "seq" sequence } { "elt/f" object } }
{ $description "Returns the element of " { $snippet "seq" } " that is in the majority, provided there is such an element, using a linear-time majority vote algorithm." } ;
HELP: nonzero
{ $values { "seq" sequence } { "seq'" sequence } }
{ $description "Outputs a new sequence of the same type as " { $snippet "seq" } " with all non-zero elements removed." } ;
HELP: round-away-from-zero
{ $values { "x" number } { "y" number } }
{ $description "Rounds " { $snippet "x" } " via " { $link ceiling } " if " { $snippet "x" } " is greater than zero, and " { $link floor } " if x is less than zero." }
{ $examples
{ $example "USING: math.extras prettyprint ;" "0.5 round-away-from-zero ." "1.0" }
{ $example "USING: math.extras prettyprint ;" "-0.5 round-away-from-zero ." "-1.0" } }
{ $see-also ceiling floor } ;
HELP: round-to-decimal
{ $values { "x" real } { "n" integer } { "y" real } }
{ $description "Outputs the number closest to " { $snippet "x" } ", rounded to " { $snippet "n" } " decimal places." }
@ -87,6 +99,13 @@ HELP: round-to-decimal
{ $example "USING: math.extras prettyprint ;" "12345.6789 -3 round-to-decimal ." "12000.0" }
} ;
HELP: round-to-even
{ $values { "x" real } { "y" real } }
{ $description "Rounds " { $snippet "x" } " towards the nearest even number. This is also known as banker's rounding or unbiased rounding." }
{ $examples
{ $example "USING: math.extras prettyprint ;" "0.5 round-to-even ." "0.0" }
{ $example "USING: math.extras prettyprint ;" "1.5 round-to-even ." "2.0" } } ;
HELP: kahan-sum
{ $values { "seq" sequence } { "n" float } }
{ $description "Calculates the summation of the sequence using the Kahan summation algorithm." } ;