std::discard_block_engine (3) - Linux Man Pages

std::discard_block_engine: std::discard_block_engine

NAME

std::discard_block_engine - std::discard_block_engine

Synopsis


Defined in header <random>
template<
class Engine, (since C++11)
size_t P, size_t R
> class discard_block_engine;


discard_block_engine is a pseudo-random number generator adaptor that discards a certain amount of data produced by the base engine. From each block of size P generated by the base engine, the adaptor keeps only R numbers, discarding the rest.

Template parameters


Engine - the type of the wrapped engine
P - the size of a block. Must be greater than 0.
R - the number of used numbers per block. Must be greater than 0 and not greater than P

Type requirements


-
Engine must meet the requirements of RandomNumberEngine.

Member types


Member type Definition
result_type Engine::result_type

Member functions


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

Generation


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

Characteristics


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


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

Non-member functions


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

Member objects


constexpr size_t block_size the size of the block, P
                            (public static member constant)
[static]


constexpr size_t used_size the number of used numbers per block, R
                            (public static member constant)
[static]