std::shuffle_order_engine< _RandomNumberEngine, __k > - Produces random numbers by reordering random
Contents
Constructor & Destructor Documentation
template<typename_RandomNumberEngine,size_t__k>std::shuffle_order_engine<_RandomNumberEngine,__k>::shuffle_order_engine()[inline]
Constructs a default shuffle_order_engine engine. The underlying engine is default constructed as well.
template<typename_RandomNumberEngine,size_t__k>std::shuffle_order_engine<_RandomNumberEngine,__k>::shuffle_order_engine(const_RandomNumberEngine&__rng)[inline],[explicit]
Copy constructs a shuffle_order_engine engine. Copies an existing base class random number generator.
Parameters__rng An existing (base class) engine object.
template<typename_RandomNumberEngine,size_t__k>std::shuffle_order_engine<_RandomNumberEngine,__k>::shuffle_order_engine(_RandomNumberEngine&&__rng)[inline],[explicit]
Move constructs a shuffle_order_engine engine. Copies an existing base class random number generator.
Parameters__rng An existing (base class) engine object.
template<typename_RandomNumberEngine,size_t__k>std::shuffle_order_engine<_RandomNumberEngine,__k>::shuffle_order_engine(result_type__s)[inline],[explicit]
Seed constructs a shuffle_order_engine engine. Constructs the underlying generator engine seeded with
__s.
Parameters__s A seed value for the base class engine.
template<typename_RandomNumberEngine,size_t__k>template<typename_Sseq,typename=_If_seed_seq<_Sseq>>std::shuffle_order_engine<_RandomNumberEngine,__k>::shuffle_order_engine(_Sseq&__q)[inline],[explicit]
Generator construct a shuffle_order_engine engine.
Parameters__q A seed sequence.
Detailed Description
template<typename_RandomNumberEngine,size_t__k>
class std::shuffle_order_engine< _RandomNumberEngine, __k >"Produces random numbers by reordering random
numbers from some base engine.
The values from the base engine are stored in a sequence of size __k and shuffled by an algorithm that
depends on those values.
Since
C++11
Member Function Documentation
template<typename_RandomNumberEngine,size_t__k>const_RandomNumberEngine&std::shuffle_order_engine<_RandomNumberEngine,__k>::base()const[inline],[noexcept]
Gets a const reference to the underlying generator engine object.
template<typename_RandomNumberEngine,size_t__k>voidstd::shuffle_order_engine<_RandomNumberEngine,__k>::discard(unsignedlonglong__z)[inline]
Discard a sequence of random numbers.
template<typename_RandomNumberEngine,size_t__k>staticconstexprresult_typestd::shuffle_order_engine<_RandomNumberEngine,__k>::max()[inline],[static],[constexpr]
Gets the maximum value in the generated random number range.
template<typename_RandomNumberEngine,size_t__k>staticconstexprresult_typestd::shuffle_order_engine<_RandomNumberEngine,__k>::min()[inline],[static],[constexpr]
Gets the minimum value in the generated random number range.
template<typename_RandomNumberEngine,size_t__k>shuffle_order_engine<_RandomNumberEngine,__k>::result_typestd::shuffle_order_engine<_RandomNumberEngine,__k>::operator()()
Gets the next value in the generated random number sequence.
References std::max(), and std::min().
template<typename_RandomNumberEngine,size_t__k>voidstd::shuffle_order_engine<_RandomNumberEngine,__k>::seed()[inline]
Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator
engine.
template<typename_RandomNumberEngine,size_t__k>template<typename_Sseq>_If_seed_seq<_Sseq>std::shuffle_order_engine<_RandomNumberEngine,__k>::seed(_Sseq&__q)[inline]
Reseeds the shuffle_order_engine object with the given seed sequence.
Parameters__q A seed generator function.
template<typename_RandomNumberEngine,size_t__k>voidstd::shuffle_order_engine<_RandomNumberEngine,__k>::seed(result_type__s)[inline]
Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator
engine.
Member Typedef Documentation
template<typename_RandomNumberEngine,size_t__k>typedef_RandomNumberEngine::result_typestd::shuffle_order_engine<_RandomNumberEngine,__k>::result_type
The type of the generated random value.
Name
std::shuffle_order_engine< _RandomNumberEngine, __k > - Produces random numbers by reordering random
numbers from some base engine.
Synopsis
#include <random>
PublicTypes
template<typename_Sseq > using_If_seed_seq = __detail::_If_seed_seq_for< _Sseq, shuffle_order_engine,
result_type >
typedef _RandomNumberEngine::result_type result_typePublicMemberFunctionsshuffle_order_engine ()
Constructs a default shuffle_order_engine engine.
shuffle_order_engine (_RandomNumberEngine &&__rng)
Move constructs a shuffle_order_engine engine.
template<typename_Sseq , typename = _If_seed_seq<_Sseq>> shuffle_order_engine (_Sseq &__q)
Generator construct a shuffle_order_engine engine.
shuffle_order_engine (const _RandomNumberEngine &__rng)
Copy constructs a shuffle_order_engine engine.
shuffle_order_engine (result_type__s)
Seed constructs a shuffle_order_engine engine.
const _RandomNumberEngine & base () const noexcept
voiddiscard (unsigned long long __z)
result_typeoperator() ()
voidseed ()
Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator
engine.
template<typename_Sseq > _If_seed_seq< _Sseq > seed (_Sseq &__q)
Reseeds the shuffle_order_engine object with the given seed sequence.
voidseed (result_type__s)
Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator
engine.
StaticPublicMemberFunctionsstatic constexpr result_typemax ()
static constexpr result_typemin ()
StaticPublicAttributesstatic constexpr size_t table_sizeFriends
template<typename_RandomNumberEngine1 , size_t __k1, typename _CharT , typename _Traits >
std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os,
const std::shuffle_order_engine< _RandomNumberEngine1, __k1 > &__x)
Inserts the current state of a shuffle_order_engine random number generator engine __x into the
output stream __os.
bool operator== (const shuffle_order_engine &__lhs, const shuffle_order_engine &__rhs)
template<typename_RandomNumberEngine1 , size_t __k1, typename _CharT , typename _Traits >
std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is,
std::shuffle_order_engine< _RandomNumberEngine1, __k1 > &__x)
Extracts the current state of a % subtract_with_carry_engine random number generator engine __x from
the input stream __is.
