Template:Random number

From PCSAR

Jump to: navigation, search

This is the documentation for the template Template:Random number

Template:Random number/Doc:

The template {{Random number}} generates a pseudo-random integer between 0 and count-1.

Usage:
  • {{Rand|count|seed|prime}}
  • All parameters are optional and have default values. They must be integers.
  • The default count is 100 (so by default, this template generates values between 0 and 99) and must be non-zero.
  • The default seed is {{#time:z}} and can be set to any other integer value (used to generate distinct values on the same page).
  • The default prime is 67 and should be a prime number above 17 (used to generate distinct values on the same page).


Multiple invocations with unchanging parameters, including with no seed, generate the same value.

Multiple invocations with incrementing seed can generate value in sequence. E.g.: 3 2 1 0 3 2 1 0


Examples generating numbers between 0 and 999:
  • {{Random number|1000}} = 372
  • {{Random number|1000|87|67}} = 372 (same as above)
  • {{Random number|1000|87|61}} = 741 (this and others should all be different)
  • {{Random number|1000|6}} = 945
  • {{Random number|1000|5}} = 878
  • {{Random number|1000|4}} = 811
  • {{Random number|1000|3}} = 744
  • {{Random number|1000|2}} = 677
  • {{Random number|1000|1}} = 610
  • {{Random number|1000|0}} = 543
  • {{Random number|1000|1|17}} = 769 (varying the prime number)
  • {{Random number|1000|1|19}} = 798
  • {{Random number|1000|1|23}} = 846
  • {{Random number|1000|1|29}} = 949
  • {{Random number|1000|1|31}} = 976
  • {{Random number|1000|1|37}} = 81
  • {{Random number|1000|1|41}} = 130
  • {{Random number|1000|1|43}} = 179
  • {{Random number|1000|1|47}} = 242
  • {{Random number|1000|1|51}} = 313
  • {{Random number|1000|1|53}} = 325
  • {{Random number|1000|1|59}} = 420
  • {{Random number|1000|1|61}} = 434
  • {{Random number|1000|1|67}} = 543
  • {{Random number|1000|1|71}} = 575
  • {{Random number|1000|1|73}} = 664
  • {{Random number|1000|1|79}} = 718
Note:
  • Varying seed linearly generates numbers that generate a linear sequence on the same page, with equal cyclic steps;
  • Varying prime (provided that they are odd prime numbers) generates pseudo-random that have independent random distribution.
  • Note that when count is even (such as 100 by default, or 1000 in the examples above), the generated numbers (on the same page) are all odd or all even when you are varying the seed or prime, unless half of the calls use an even seed and the others used an odd seed. However, later invocations will still alternate odd and even numbers on output (this problem only occurs on the same page where multiple random numbers are invoked).
  • On the same page, multiple invocations of this template with the same parameters will generate the same output value, so it is possible to create multiple links related to the same article.

Based on http://en.wikipedia.org/wiki/Template:Random_number


To see how this template is implemented, edit this page and examine the portion between <includeonly> and </includeonly>.

Personal tools