extra/math/primes/primes-docs.factor

   1 USING: help.markup help.syntax ;
   2 IN: math.primes
   3
   4 { next-prime prime? } related-words
   5
   6 HELP: next-prime
   7 { $values { "n" "a positive integer" } { "p" "a prime number" } }
   8 { $description "Return the next prime number greater than " { $snippet "n" } "." } ;
   9
  10 HELP: prime?
  11 { $values { "n" "an integer" } { "?" "a boolean" } }
  12 { $description "Test if an integer is a prime number." } ;
  13
  14 { lprimes lprimes-from primes-upto primes-between } related-words
  15
  16 HELP: lprimes
  17 { $values { "list" "a lazy list" } }
  18 { $description "Return a sorted list containing all the prime numbers." } ;
  19
  20 HELP: lprimes-from
  21 { $values { "n" "an integer" } { "list" "a lazy list" } }
  22 { $description "Return a sorted list containing all the prime numbers greater or equal to " { $snippet "n" } "." } ;
  23
  24 HELP: primes-upto
  25 { $values { "n" "an integer" } { "seq" "a sequence" } }
  26 { $description "Return a sequence containing all the prime numbers smaller or equal to " { $snippet "n" } "." } ;
  27
  28 HELP: primes-between
  29 { $values { "low" "an integer" } { "high" "an integer" } { "seq" "a sequence" } }
  30 { $description "Return a sequence containing all the prime numbers between " { $snippet "low" } " and " { $snippet "high" } "." } ;