![]() |
abLEMON 1.9.0-101-gccb8629
A maintained fork of LEMON
|
Mersenne Twister random number generator. More...
#include <lemon/random.h>
Public Member Functions | |
Initialization | |
| Random () | |
| Default constructor. | |
| template< typename Number > | |
| Random (Number seed) | |
| Constructor with seed. | |
| template< typename Iterator > | |
| Random (Iterator begin, Iterator end) | |
| Constructor with array seeding. | |
| Random (const Random &other) | |
| Copy constructor. | |
| Random & | operator= (const Random &other) |
| Assign operator. | |
| template< typename Number > | |
| void | seed (Number seed) |
| Seeding random sequence. | |
| template< typename Iterator > | |
| void | seed (Iterator begin, Iterator end) |
| Seeding random sequence. | |
| bool | seed () |
| Seeding from the random device or from the time. | |
| bool | seedFromFile (const std::string &file="/dev/urandom", int offset=0) |
| Seeding from file. | |
| bool | seedFromTime () |
| Seeding from the time. | |
Uniform Distributions | |
| template< typename Number > | |
| Number | real () |
| Returns a random real number from the range [0, 1). | |
| double | operator() () |
| Returns a random real number from the range [0, 1). | |
| double | operator() (double b) |
| Returns a random real number from the range [0, b). | |
| double | operator() (double a, double b) |
| Returns a random real number from the range [a, b). | |
| template< typename Number > | |
| Number | integer (Number b) |
| Returns a random integer from a range. | |
| template< typename Number > | |
| Number | integer (Number a, Number b) |
| Returns a random integer from a range. | |
| template< typename Number > | |
| Number | operator[] (Number b) |
| Returns a random integer from a range. | |
| template< typename Number > | |
| Number | uinteger () |
| Returns a random non-negative integer. | |
| template< typename Number > | |
| Number | integer () |
| Returns a random integer. | |
| bool | boolean () |
| Returns a random bool. | |
Non-uniform Distributions | |
| bool | boolean (double p) |
| Returns a random bool with given probability of true result. | |
| double | gauss () |
| Standard normal (Gauss) distribution. | |
| double | gauss (double mean, double std_dev) |
| Normal (Gauss) distribution with given mean and standard deviation. | |
| double | lognormal (double n_mean, double n_std_dev) |
| Lognormal distribution. | |
| double | lognormal (const std::pair< double , double > ¶ms) |
| Lognormal distribution. | |
| std::pair< double , double > | lognormalParamsFromMD (double mean, double std_dev) |
| Compute the lognormal parameters from mean and standard deviation. | |
| double | lognormalMD (double mean, double std_dev) |
| Lognormal distribution with given mean and standard deviation. | |
| double | exponential (double lambda=1.0) |
| Exponential distribution with given mean. | |
| double | gamma (int k) |
| Gamma distribution with given integer shape. | |
| double | gamma (double k, double theta=1.0) |
| Gamma distribution with given shape and scale parameter. | |
| double | weibull (double k, double lambda) |
| Weibull distribution. | |
| double | pareto (double k, double x_min) |
| Pareto distribution. | |
| int | poisson (double lambda) |
| Poisson distribution. | |
Two-Dimensional Distributions | |
| dim2::Point< double > | disc () |
| Uniform distribution on the full unit circle. | |
| dim2::Point< double > | gauss2 () |
| A kind of two-dimensional normal (Gauss) distribution. | |
| dim2::Point< double > | exponential2 () |
| A kind of two-dimensional exponential distribution. | |
The Mersenne Twister is a twisted generalized feedback shift-register generator of Matsumoto and Nishimura. The period of this generator is \( 2^{19937} - 1\) and it is equi-distributed in 623 dimensions for 32-bit numbers. The time performance of this generator is comparable to the commonly used generators.
This is a template implementation of both 32-bit and 64-bit architecture optimized versions. The generators differ slightly in the initialization and generation phase so they produce two completely different sequences.
The generator gives back random numbers of several types. To get a random number from a range of a floating point type, you can use one form of the operator() or the real() member function. If you want to get random number from the {0, 1, ..., n-1} integer range, use the operator[] or the integer() method. And to get random number from the whole range of an integer type, you can use the argumentless integer() or uinteger() functions. Finally, you can get random bool with equal chance of true and false or with given probability of true result using the boolean() member functions.
Various non-uniform distributions are also supported: normal (Gauss), exponential, gamma, Poisson, etc.; and a few two-dimensional distributions, too.
LEMON provides a global instance of the random number generator: rnd. In most cases, it is a good practice to use this global generator to get random numbers.
|
inline |
Constructor with constant seeding.
|
inline |
Constructor with seed. The current number type will be converted to the architecture word type.
|
inline |
Constructor with array seeding. The given range should contain any number type and the numbers will be converted to the architecture word type.
|
inline |
Copy constructor. The generated sequence will be identical to the other sequence. It can be used to save the current state of the generator and later use it to generate the same sequence.
Assign operator. The generated sequence will be identical to the other sequence. It can be used to save the current state of the generator and later use it to generate the same sequence.
|
inline |
Seeding the random sequence. The current number type will be converted to the architecture word type.
|
inline |
Seeding the random sequence. The given range should contain any number type and the numbers will be converted to the architecture word type.
|
inline |
By default, this function seeds the generator with words of std::random_device. If it does not succeed (e.g., the device throws), it uses the seedFromTime().
true.
|
inline |
Seeding the random sequence from file. The linux kernel has two devices, /dev/random and /dev/urandom which could give good seed values for pseudo random generators (The difference between two devices is that the random may block the reading operation while the kernel can give good source of randomness, while the urandom does not block the input, but it could give back bytes with worse entropy).
| file | The source file |
| offset | The offset, from the file read. |
true when the seeding successes.
|
inline |
Seeding from the time. This function uses the current time of std::chrono::system_clock and of std::chrono::steady_clock for initialize the random sequence.
true.
|
inline |
It returns a random real number from the range [0, 1). The default Number type is double.
|
inline |
It returns a random double from the range [0, 1).
|
inline |
It returns a random real number from the range [0, b).
|
inline |
It returns a random real number from the range [a, b).
|
inline |
It returns a random integer from the range {0, 1, ..., b - 1}.
|
inline |
It returns a random integer from the range {a, a + 1, ..., b - 1}.
|
inline |
It returns a random integer from the range {0, 1, ..., b - 1}.
|
inline |
It returns a random non-negative integer uniformly from the whole range of the current Number type. The default result type of this function is unsigned int.
|
inline |
It returns a random integer uniformly from the whole range of the current Number type. The default result type of this function is int.
|
inline |
It returns a random bool. The generator holds a buffer for random bits. Every time when it become empty the generator makes a new random word and fill the buffer up.
|
inline |
It returns a random bool with given probability of true result.
|
inline |
Standard normal (Gauss) distribution.
|
inline |
Normal (Gauss) distribution with given mean and standard deviation.
|
inline |
Lognormal distribution. The parameters are the mean and the standard deviation of exp(X).
|
inline |
Lognormal distribution. The parameter is an std::pair of the mean and the standard deviation of exp(X).
|
inline |
This function computes the lognormal parameters from mean and standard deviation. The return value can direcly be passed to lognormal().
|
inline |
Lognormal distribution with given mean and standard deviation.
|
inline |
This function generates an exponential distribution random number with mean 1/lambda.
|
inline |
This function generates a gamma distribution random number.
| k | shape parameter (k>0 integer) |
|
inline |
This function generates a gamma distribution random number.
| k | shape parameter (k>0) |
| theta | scale parameter |
|
inline |
This function generates a Weibull distribution random number.
| k | shape parameter (k>0) |
| lambda | scale parameter (lambda>0) |
|
inline |
This function generates a Pareto distribution random number.
| k | shape parameter (k>0) |
| x_min | location parameter (x_min>0) |
|
inline |
This function generates a Poisson distribution random number with parameter lambda.
The probability mass function of this distribusion is
\[ \frac{e^{-\lambda}\lambda^k}{k!} \]
|
inline |
Uniform distribution on the full unit circle.
|
inline |
This function provides a turning symmetric two-dimensional distribution. The two coordinates are independent and of standard normal distribution.
|
inline |
This function provides a turning symmetric two-dimensional distribution. For \((V_1, V_2)\) uniform in the unit disc and \(S = V_1^2 + V_2^2\), it returns \(-\ln(S)/S \cdot (V_1, V_2)\): its direction is uniform, and its distance from the origin is \(-\ln(S)/\sqrt{S}\) with \(S\) uniform in \((0, 1)\), which exceeds \(r\) with the probability \(u\) such that \(-\ln(u)/\sqrt{u} = r\) (not an exponential distribution).