basis/random/mersenne-twister/mersenne-twister-docs.factor.bak

   1 USING: help.markup help.syntax math ;
   2 IN: random.mersenne-twister
   3
   4 ARTICLE: "random-numbers" "Generating random integers"
   5 "The " { $vocab-link "random" } " vocabulary implements the ``Mersenne Twister'' pseudo-random number generator algorithm."
   6 ! { $subsection init-random }
   7 { $subsection (random) }
   8 { $subsection random } ;
   9
  10 ABOUT: "random-numbers"
  11
  12 ! HELP: init-random
  13 ! { $values { "seed" integer } }
  14 ! { $description "Initializes the random number generator with the given seed. This word is called on startup to initialize the random number generator with the current time." } ;
  15
  16 HELP: (random)
  17 { $values { "rand" "an integer between 0 and 2^32-1" } }
  18 { $description "Generates a random 32-bit unsigned integer." } ;
  19
  20 HELP: random
  21 { $values { "seq" "a sequence" } { "elt" "a random element" } }
  22 { $description "Outputs a random element of the sequence. If the sequence is empty, always outputs " { $link f } "." }
  23 { $notes "Since integers are sequences, passing an integer " { $snippet "n" } " yields a random integer in the interval " { $snippet "[0,n)" } "." } ;
  24
  25 HELP: big-random
  26 { $values { "n" "an integer" } { "r" "a random integer" } }
  27 { $description "Outputs an integer with n bytes worth of bits." } ;
  28
  29 HELP: random-256
  30 { $values { "r" "a random integer" } }
  31 { $description "Outputs an random integer 256 bits in length." } ;