std::shuffle_order_engine

C++

Language

Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

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)

Filesystem library (C++17)

Technical Specifications

Numerics library

Common mathematical functions

Special mathematical functions

Floating-point environment (C++11)

Complex numbers

Numeric arrays

Pseudo-random number generation

Compile-time rational arithmetic (C++11)

Numeric algorithms

gcd (C++17)

lcm (C++17)

Generic numeric operations

iota (C++11)

accumulate

inner_product

adjacent_difference

partial_sum

reduce (C++17)

transform_reduce (C++17)

inclusive_scan (C++17)

exclusive_scan (C++17)

transform_inclusive_scan (C++17)

transform_exclusive_scan (C++17)

Bit operations

bit_cast (C++20)

ispow2 (C++20)

ceil2 (C++20)

floor2 (C++20)

log2p1 (C++20)

Pseudo-random number generation

Uniform random bit generators

UniformRandomBitGenerator (C++20)

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)

Non-deterministic generator

random_device (C++11)

Distributions

Uniform distributions

uniform_int_distribution (C++11)

uniform_real_distribution (C++11)

generate_canonical (C++11)

Bernoulli distributions

bernoulli_distribution (C++11)

binomial_distribution (C++11)

negative_binomial_distribution (C++11)

geometric_distribution (C++11)

Poisson distributions

poisson_distribution (C++11)

exponential_distribution (C++11)

gamma_distribution (C++11)

weibull_distribution (C++11)

extreme_value_distribution (C++11)

Normal distributions

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)

Sampling distributions

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

std::shuffle_order_engine

Member functions

shuffle_order_engine::shuffle_order_engine

shuffle_order_engine::seed

shuffle_order_engine::base

Generation

shuffle_order_engine::operator()

shuffle_order_engine::discard

Characteristics

shuffle_order_engine::min

shuffle_order_engine::max

Non-member functions

operator==operator!=

operator<<operator>>

Defined in header <random>
template< class Engine, std::size_t K > class shuffle_order_engine;		(since C++11)

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	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	Engine::result_type

Member functions

(constructor)	constructs the engine adaptor (public member function)
seed	sets the state of the underlying engine (public member function)
base	returns the underlying engine (public member function)
Generation
operator()	advances the state of the underlying engine and returns the generated value (public member function)
discard	advances the adaptor's state by a specified amount (public member function)
Characteristics
min [static]	gets the smallest possible value in the output range of the underlying engine. (public static member function)
max [static]	gets the largest possible value in the output range of the underlying engine. (public static member function)

Non-member functions

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

Member objects

constexpr size_t table_size [static]

the size of the internal table, K (public static member constant)