std::linear_congruential_engine

From Cppreference

C++ Standard Library
Language Utilities library Strings library Containers library Algorithms library Iterators library Numerics library Input/output library Localizations library Regular expressions library (C++11) Atomic operations library (C++11) Thread support library (C++11)
Numerics library
Common mathematical functions Floating-point environment Complex numbers Numeric arrays Pseudo-random number generation Generic numeric operations iota (C++11) accumulate inner_product adjacent_difference partial_sum
Pseudo-random number generation
Engines and engine adaptors linear_congruential_engine (C++11) mersenne_twister_engine (C++11) subtract_with_carry_engine (C++11) discard_block_engine (C++11) independent_bits_engine (C++11) shuffle_order_engine (C++11) Generators minstd_rand0 minstd_rand mt19937 mt19937_64 ranlux24_base ranlux48_base ranlux24 ranlux48 knuth_b default_random_engine random_device (C++11) Distributions uniform_int_distribution (C++11) uniform_real_distribution (C++11) generate_canonical (C++11) bernoulli_distribution (C++11) binomial_distribution (C++11) negative_binomial_distribution (C++11) geometric_distribution (C++11) poisson_distribution (C++11) exponential_distribution (C++11) gamma_distribution (C++11) weibull_distribution (C++11) extreme_value_distribution (C++11) normal_distribution (C++11) lognormal_distribution (C++11) chi_squared_distribution (C++11) cauchy_distribution (C++11) fisher_f_distribution (C++11) student_t_distribution (C++11) discrete_distribution (C++11) piecewise_constant_distribution (C++11) piecewise_linear_distribution (C++11) Seed Sequences seed_seq (C++11) C library rand srand RAND_MAX

Defined in header <random>
template<class UIntType, UIntType a, UIntType c, UIntType m>   class linear_congruential_engine;		(C++11 feature)

A linear_congruential_engine produces unsigned integer pseudorandom numbers. The state of a LCG is of size 1 and consists of a single integer.

The transition algorithm of the LCG function is <math>x_{i+1}\leftarrow(ax_{i} + c) \bmod m</math>.

Contents 1 Member types 2 Member variables 3 Member functions 3.1 Construction and Seeding 3.2 Generation 3.3 Characteristics 4 Non-member functions

[edit] Member types

Member type	Definition
result_type	The integral type generated by the engine. Results are undefined if this is not an unsigned integral type.

[edit] Member variables

multiplier	The multiplier term (a). (public static member constant)
increment	The increment term (c). (public static member constant)
modulus	The modulus term (m). (public static member constant)
default_seed	The default seed (1). (public static member constant)

[edit] Member functions

Construction and Seeding
(constructor)	Constructs the engine. (public member function)
seed	Sets the current state of the engine. (public member function)
Generation
operator()	Advances the engine's state and returns the generated value. (public member function)
discard	Advances the engine's state by a specified amount. (public member function)
Characteristics
min	Gets the smallest possible value in the output range. (public member function)
max	Gets the largest possible value in the output range. (public member function)

[edit] Non-member functions

operator==	Compare two LCGs for equality. (function)
operator<<	Marshalls the engine state to an output stream. (function)
operator>>	Unmarshalls the engine state from an input stream. (function)