NAME¶

std::shuffle_order_engine - std::shuffle_order_engine

Synopsis¶

Defined in header <random>
template<

class Engine, (since C++11)
std::size_t K

> class shuffle_order_engine;

shuffle_order_engine is a random number engine adaptor that shuffles the random
numbers generated by the base engine. It maintains a table of size K and delivers a
randomly selected number from that table when requested, replacing it with a number
generated by the base engine.

The following typedef defines the random number engine with one commonly used
parameter set:

Defined in header <random>
Type Definition
knuth_b (C++11) std::shuffle_order_engine<std::minstd_rand0, 256>

Template parameters¶

Engine - the type of the wrapped engine
K - the size of the internal table. Must be greater than 0.

Type requirements¶

-
Engine must meet the requirements of RandomNumberEngine.

Member types¶

Member type Definition
result_type (C++11) Engine::result_type

Member functions¶

constructor constructs the engine adaptor
(C++11) (public member function)
seed sets the state of the underlying engine
(C++11) (public member function)
base returns the underlying engine
(C++11) (public member function)

Generation¶

operator() advances the state of the underlying engine and returns the
(C++11) generated value
(public member function)
discard advances the adaptor's state by a specified amount
(C++11) (public member function)

Characteristics¶

min gets the smallest possible value in the output range of the
[static] (C++11) underlying engine.
(public static member function)
max gets the largest possible value in the output range of the
[static] (C++11) underlying engine.
(public static member function)

Non-member functions¶

operator== compares the internal states of the adaptors and
operator!= underlying engines
(C++11) (function)
(C++11)(removed in C++20)
operator<< performs stream input and output on pseudo-random number
operator>> engine adaptor
(C++11) (function)

Member objects¶

constexpr size_t table_size the size of the internal table, K
[static] (C++11) (public static member constant)

Example¶

This section is incomplete
Reason: no example

Category:¶

* Todo no example