std::linear_congruential_engine

template<
    class UIntType,
    UIntType a,
    UIntType c,
    UIntType m
> class linear_congruential_engine;

linear_congruential_engine is a random number engine based on Linear congruential generator (LCG).

Template parameters

When m is not zero, if a >= m or c >= m is true, the program is ill-formed.

Generator properties

The size of the states of linear_congruential_engine is 1, each of them consists of a single integer.

The actual modulus \(\scriptsize m_0\)m₀ is defined as follows:

• If m is not zero, \(\scriptsize m_0\)m₀ is m.
• If m is zero, \(\scriptsize m_0\)m₀ is the value of std::numeric_limits<result_type>::max() plus 1 (which means \(\scriptsize m_0\)m₀ need not be representable as result_type).

The transition algorithm of linear_congruential_engine is \(\scriptsize TA(x_i) = (a \cdot x_i + c)\mod m_0\)TA(x_i) = (a·x_i+c) mod m₀.

The generation algorithm of linear_congruential_engine is \(\scriptsize GA(x_i) = (a \cdot x_i + c)\mod m_0\)GA(x_i) = (a·x_i+c) mod m₀.

The pseudo-random number generated with the current state is also the successor state.

Predefined specializations

The following specializations define the random number engine with two commonly used parameter sets:

Nested types

Data members

Member functions

Non-member functions

Example