basis/math/primes/primes-docs.factor

   1 USING: help.markup help.syntax math sequences ;
   2 IN: math.primes
   3
   4 { next-prime prime? } related-words
   5
   6 HELP: next-prime
   7 { $values { "n" 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 { primes-upto primes-between } related-words
  15
  16 HELP: primes-upto
  17 { $values { "n" "an integer" } { "seq" "a sequence" } }
  18 { $description "Return a sequence containing all the prime numbers smaller or equal to " { $snippet "n" } "." } ;
  19
  20 HELP: primes-between
  21 { $values { "low" "an integer" } { "high" "an integer" } { "seq" "a sequence" } }
  22 { $description "Return a sequence containing all the prime numbers between " { $snippet "low" } " and " { $snippet "high" } "." } ;
  23
  24 HELP: find-relative-prime
  25 { $values
  26     { "n" integer }
  27     { "p" integer }
  28 }
  29 { $description "Returns a number that is relatively prime to " { $snippet "n" } "." } ;
  30
  31 HELP: find-relative-prime*
  32 { $values
  33     { "n" integer } { "guess" integer }
  34     { "p" integer }
  35 }
  36 { $description "Returns a number that is relatively prime to " { $snippet "n" } ", starting by trying " { $snippet "guess" } "." } ;
  37
  38 HELP: random-prime
  39 { $values
  40     { "numbits" integer }
  41     { "p" integer }
  42 }
  43 { $description "Returns a prime number exactly " { $snippet "numbits" } " bits in length, with the topmost bit set to one." } ;
  44
  45 HELP: unique-primes
  46 { $values
  47     { "numbits" integer } { "n" integer }
  48     { "seq" sequence }
  49 }
  50 { $description "Generates a sequence of " { $snippet "n" } " unique prime numbers with exactly " { $snippet "numbits" } " bits." } ;
  51
  52 ARTICLE: "math.primes" "Prime numbers"
  53 "The " { $vocab-link "math.primes" } " vocabulary implements words related to prime numbers. Serveral useful vocabularies exist for testing primality. The Sieve of Eratosthenes in " { $vocab-link "math.primes.erato" } " is useful for testing primality below five million. For larger integers, " { $vocab-link "math.primes.miller-rabin" } " is a fast probabilstic primality test. The " { $vocab-link "math.primes.lucas-lehmer" } " vocabulary implements an algorithm for finding huge Mersenne prime numbers." $nl
  54 "Testing if a number is prime:"
  55 { $subsections prime? }
  56 "Generating prime numbers:"
  57 { $subsections
  58     next-prime
  59     primes-upto
  60     primes-between
  61     random-prime
  62 }
  63 "Generating relative prime numbers:"
  64 { $subsections
  65     find-relative-prime
  66     find-relative-prime*
  67 }
  68 "Make a sequence of random prime numbers:"
  69 { $subsections unique-primes } ;
  70
  71 ABOUT: "math.primes"