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

math.primes.erato doc fixes.

db4
Jon Harper 2010-11-02 17:23:54 +01:00 committed by Samuel Tardieu
parent cd28c7a219
commit f60f13c675
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
basis/math/primes/erato/erato-docs.factor
View File

@ -1,10 +1,14 @@
USING: help.markup help.syntax ;
USING: byte-arrays help.markup help.syntax kernel math ;
IN: math.primes.erato
HELP: sieve
{ $values { "n" "the greatest odd number to consider" } { "arr" "a bit array" } }
{ $description "Apply Eratostene sieve up to " { $snippet "n" } ". Primality can then be tested using " { $link marked-prime? } "." } ;
{ $values { "n" integer } { "arr" byte-array } }
{ $description "Apply Eratostene sieve up to " { $snippet "n" }
". " { $snippet "n" } " must be greater than 1"
". Primality can then be tested using " { $link marked-prime? } "." } ;
HELP: marked-prime?
{ $values { "n" "an integer" } { "arr" "a byte array returned by " { $link sieve } } { "?" "a boolean" } }
{ $description "Check whether an odd integer between 3 and the limit given to " { $link sieve } " has been marked as a prime number."} ;
{ $values { "n" integer } { "arr" byte-array } { "?" boolean } }
{ $description "Checks whether " { $snippet "n" } " has been marked as a prime number. "
{ $snippet "arr" } " must be " { $instance byte-array } " returned by " { $link sieve } ". "
{ $snippet "n" } " must be between 2 and the limit given to " { $link sieve } "." } ;