package ocaml-base-compiler
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=c2d706432f93ba85bd3383fa451d74543c32a4e84a1afaf3e8ace18f7f097b43
doc/stdlib/Stdlib/Random/index.html
Module Stdlib.Random
Source
Pseudo-random number generators (PRNG).
Basic functions
Initialize the generator, using the argument as a seed. The same seed will always yield the same sequence of numbers.
Same as Random.init
but takes more data as seed.
Initialize the generator with a random seed chosen in a system-dependent way. If /dev/urandom
is available on the host machine, it is used to provide a highly random initial seed. Otherwise, a less random seed is computed from system parameters (current time, process IDs).
Return 30 random bits in a nonnegative integer.
Random.int bound
returns a random integer between 0 (inclusive) and bound
(exclusive). bound
must be greater than 0 and less than 230.
Random.full_int bound
returns a random integer between 0 (inclusive) and bound
(exclusive). bound
may be any positive integer.
If bound
is less than 230, Random.full_int bound
is equal to Random.int
bound
. If bound
is greater than 230 (on 64-bit systems or non-standard environments, such as JavaScript), Random.full_int
returns a value, where Random.int
raises Invalid_argument
.
Random.int32 bound
returns a random integer between 0 (inclusive) and bound
(exclusive). bound
must be greater than 0.
Random.nativeint bound
returns a random integer between 0 (inclusive) and bound
(exclusive). bound
must be greater than 0.
Random.int64 bound
returns a random integer between 0 (inclusive) and bound
(exclusive). bound
must be greater than 0.
Random.float bound
returns a random floating-point number between 0 and bound
(inclusive). If bound
is negative, the result is negative or zero. If bound
is 0, the result is 0.
Random.bool ()
returns true
or false
with probability 0.5 each.
Random.bits32 ()
returns 32 random bits as an integer between Int32.min_int
and Int32.max_int
.
Random.bits64 ()
returns 64 random bits as an integer between Int64.min_int
and Int64.max_int
.
Random.nativebits ()
returns 32 or 64 random bits (depending on the bit width of the platform) as an integer between Nativeint.min_int
and Nativeint.max_int
.
Advanced functions
The functions from module State
manipulate the current state of the random generator explicitly. This allows using one or several deterministic PRNGs, even in a multi-threaded program, without interference from other parts of the program.
Return the current state of the generator used by the basic functions.