BSD 4_4 development
[unix-history] / usr / share / man / cat3 / srandom.0
RANDOM(3) BSD Programmer's Manual RANDOM(3)
N\bNA\bAM\bME\bE
r\bra\ban\bnd\bdo\bom\bm, s\bsr\bra\ban\bnd\bdo\bom\bm, i\bin\bni\bit\bts\bst\bta\bat\bte\be, s\bse\bet\bts\bst\bta\bat\bte\be - better random number generator;
routines for changing generators
S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
#\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<s\bst\btd\bdl\bli\bib\bb.\b.h\bh>\b>
_\bl_\bo_\bn_\bg
r\bra\ban\bnd\bdo\bom\bm(_\bv_\bo_\bi_\bd);
_\bv_\bo_\bi_\bd
s\bsr\bra\ban\bnd\bdo\bom\bm(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\bs_\be_\be_\bd);
_\bc_\bh_\ba_\br _\b*
i\bin\bni\bit\bts\bst\bta\bat\bte\be(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\bs_\be_\be_\bd, _\bc_\bh_\ba_\br _\b*_\bs_\bt_\ba_\bt_\be, _\bi_\bn_\bt _\bn);
_\bc_\bh_\ba_\br _\b*
s\bse\bet\bts\bst\bta\bat\bte\be(_\bc_\bh_\ba_\br _\b*_\bs_\bt_\ba_\bt_\be);
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
The r\bra\ban\bnd\bdo\bom\bm() function uses a non-linear additive feedback random number
generator employing a default table of size 31 long integers to return
successive pseudo-random numbers in the range from 0 to (2**31)-1. The
period of this random number generator is very large, approximately
16*((2**31)-1).
The r\bra\ban\bnd\bdo\bom\bm()/ s\bsr\bra\ban\bnd\bdo\bom\bm() have (almost) the same calling sequence and ini-
tialization properties as rand(3)/ srand(3). The difference is that
rand produces a much less random sequence -- in fact, the low dozen bits
generated by rand go through a cyclic pattern. All the bits generated by
r\bra\ban\bnd\bdo\bom\bm() are usable. For example, `random()&01' will produce a random
binary value.
Unlike srand, s\bsr\bra\ban\bnd\bdo\bom\bm() does not return the old seed; the reason for
this is that the amount of state information used is much more than a
single word. (Two other routines are provided to deal with restart-
ing/changing random number generators). Like rand(3), however, r\bra\ban\bnd\bdo\bom\bm()
will by default produce a sequence of numbers that can be duplicated by
calling s\bsr\bra\ban\bnd\bdo\bom\bm() with `1' as the seed.
The i\bin\bni\bit\bts\bst\bta\bat\bte\be() routine allows a state array, passed in as an argument,
to be initialized for future use. The size of the state array (in bytes)
is used by i\bin\bni\bit\bts\bst\bta\bat\bte\be() to decide how sophisticated a random number gener-
ator it should use -- the more state, the better the random numbers will
be. (Current "optimal" values for the amount of state information are 8,
32, 64, 128, and 256 bytes; other amounts will be rounded down to the
nearest known amount. Using less than 8 bytes will cause an error.) The
seed for the initialization (which specifies a starting point for the
random number sequence, and provides for restarting at the same point) is
also an argument. The i\bin\bni\bit\bts\bst\bta\bat\bte\be() function returns a pointer to the pre-
vious state information array.
Once a state has been initialized, the s\bse\bet\bts\bst\bta\bat\bte\be() routine provides for
rapid switching between states. The s\bse\bet\bts\bst\bta\bat\bte\be() function returns a point-
er to the previous state array; its argument state array is used for fur-
ther random number generation until the next call to i\bin\bni\bit\bts\bst\bta\bat\bte\be() or
s\bse\bet\bts\bst\bta\bat\bte\be().
Once a state array has been initialized, it may be restarted at a differ-
ent point either by calling i\bin\bni\bit\bts\bst\bta\bat\bte\be() (with the desired seed, the state
array, and its size) or by calling both s\bse\bet\bts\bst\bta\bat\bte\be() (with the state array)
and s\bsr\bra\ban\bnd\bdo\bom\bm() (with the desired seed). The advantage of calling both
s\bse\bet\bts\bst\bta\bat\bte\be() and s\bsr\bra\ban\bnd\bdo\bom\bm() is that the size of the state array does not
have to be remembered after it is initialized.
With 256 bytes of state information, the period of the random number gen-
erator is greater than 2**69 which should be sufficient for most purpos-
es.
A\bAU\bUT\bTH\bHO\bOR\bR
Earl T. Cohen
D\bDI\bIA\bAG\bGN\bNO\bOS\bST\bTI\bIC\bCS\bS
If i\bin\bni\bit\bts\bst\bta\bat\bte\be() is called with less than 8 bytes of state information, or
if s\bse\bet\bts\bst\bta\bat\bte\be() detects that the state information has been garbled, error
messages are printed on the standard error output.
S\bSE\bEE\bE A\bAL\bLS\bSO\bO
rand(3)
H\bHI\bIS\bST\bTO\bOR\bRY\bY
These functions appeared in 4.2BSD.
B\bBU\bUG\bGS\bS
About 2/3 the speed of rand(3).
4.2 Berkeley Distribution June 4, 1993 2