setstate(3STDC)

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | DIAGNOSTICS | NOTE | ATTRIBUTES | SEE ALSO | RESTRICTIONS

NAME

random, srandom, initstate, setstate- better random number generator

SYNOPSIS

$(NUCLEUS_DIR)/lib/classix/libsys.s.a
#include <stdlib.h>

long random(void);
void srandom(unsigned seed);
char *initstate(unsigned seed, char * state, int n);
char *setstate(char * state);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

DESCRIPTION

The random() 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 ³¹ -1 . The period of this random number generator is very large, approximately 16x(2 ³¹ -1) .

The random() / srandom() functions have (almost) the same calling sequence and initialization properties as rand / srand (3STDC) 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 random() are usable. For example, random() &01 will produce a random binary value.

Unlike srand() , srandom() does not return the old seed; the reason being that the amount of state information used is much more than a single word (two other routines are provided to deal with restarting/changing random number generators). Like rand() , however, random() will by default produce a sequence of numbers that can be duplicated by calling srandom() with 1 as the seed.

The initstate() routine allows a state array, passed as an argument, to be initialized for future use. The size of the state array (in bytes) is used by initstate() to decide how sophisticated a random number generator it should use -- the bigger the 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 initstate() function returns a pointer to the previous state information array.

Once a state has been initialized, the setstate() routine provides for rapid switching between states. The setstate() function returns a pointer to the previous state array; its argument state array is used for further random number generation until the next call to initstate() or setstate() .

Once a state array has been initialized, it may be restarted at a different point either by calling initstate() (with the desired seed, the state array, and its size) or by calling both setstate() (with the state array) and srandom() (with the desired seed). The advantage of calling both setstate() and srandom() 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 generator is greater than 2 ⁶⁹⁰ , which should be sufficient for most purposes.

If initstate() has not been called, then random() behaves as though initstate() had been called with seed=1 and size=128 .

If initstate() is called with size<8 , it returns NULL and random() uses a simple linear congruential random number generator.

DIAGNOSTICS

If initstate() is called with less than 8 bytes of state information, or if setstate() detects that the state information has been garbled, error messages are printed to the standard error output.

NOTE

Though these functions are reentrant, the state information is global to the actor. Therefore, repeatability of a given suite of numbers will not be experienced by several threads in parallel. For a reentrent repeatability of suites, see rand_r (3STDC).

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

rand(3STDC) , rand_r(3STDC)

RESTRICTIONS

random() operates at about 2/3 the speed of rand_r (3STDC).

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | DIAGNOSTICS | NOTE | ATTRIBUTES | SEE ALSO | RESTRICTIONS