libstdc++
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
std::shuffle_order_engine< _RandomNumberEngine, __k > Class Template Reference
Numerics » Random Number Generation » Random Number Generators

#include <random.h>

Public Types

template<typename _Sseq >
using _If_seed_seq = typename enable_if< __detail::__is_seed_seq< _Sseq, shuffle_order_engine, result_type >::value >::type
 
typedef _RandomNumberEngine::result_type result_type
 

Public Member Functions

 shuffle_order_engine ()
 
 shuffle_order_engine (_RandomNumberEngine &&__rng)
 
template<typename _Sseq , typename = _If_seed_seq<_Sseq>>
 shuffle_order_engine (_Sseq &__q)
 
 shuffle_order_engine (const _RandomNumberEngine &__rng)
 
 shuffle_order_engine (result_type __s)
 
const _RandomNumberEngine & base () const noexcept
 
void discard (unsigned long long __z)
 
result_type operator() ()
 
void seed ()
 
template<typename _Sseq >
_If_seed_seq< _Sseq > seed (_Sseq &__q)
 
void seed (result_type __s)
 

Static Public Member Functions

static constexpr result_type max ()
 
static constexpr result_type min ()
 

Static Public Attributes

static constexpr size_t table_size
 

Friends

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)
 
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)
 

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.

Definition at line 1329 of file random.h.

Member Typedef Documentation

◆ _If_seed_seq

template<typename _RandomNumberEngine , size_t __k>
template<typename _Sseq >
using std::shuffle_order_engine< _RandomNumberEngine, __k >::_If_seed_seq = typename enable_if<__detail::__is_seed_seq< _Sseq, shuffle_order_engine, result_type>::value>::type

Definition at line 1339 of file random.h.

◆ result_type

template<typename _RandomNumberEngine , size_t __k>
typedef _RandomNumberEngine::result_type std::shuffle_order_engine< _RandomNumberEngine, __k >::result_type

The type of the generated random value.

Definition at line 1336 of file random.h.

Constructor & Destructor Documentation

◆ shuffle_order_engine() [1/5]

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.

Definition at line 1349 of file random.h.

◆ shuffle_order_engine() [2/5]

template<typename _RandomNumberEngine , size_t __k>
std::shuffle_order_engine< _RandomNumberEngine, __k >::shuffle_order_engine ( const _RandomNumberEngine &  __rng)
inlineexplicit

Copy constructs a shuffle_order_engine engine.

Copies an existing base class random number generator.

Parameters
__rngAn existing (base class) engine object.

Definition at line 1360 of file random.h.

◆ shuffle_order_engine() [3/5]

template<typename _RandomNumberEngine , size_t __k>
std::shuffle_order_engine< _RandomNumberEngine, __k >::shuffle_order_engine ( _RandomNumberEngine &&  __rng)
inlineexplicit

Move constructs a shuffle_order_engine engine.

Copies an existing base class random number generator.

Parameters
__rngAn existing (base class) engine object.

Definition at line 1371 of file random.h.

◆ shuffle_order_engine() [4/5]

template<typename _RandomNumberEngine , size_t __k>
std::shuffle_order_engine< _RandomNumberEngine, __k >::shuffle_order_engine ( result_type  __s)
inlineexplicit

Seed constructs a shuffle_order_engine engine.

Constructs the underlying generator engine seeded with __s.

Parameters
__sA seed value for the base class engine.

Definition at line 1382 of file random.h.

◆ shuffle_order_engine() [5/5]

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)
inlineexplicit

Generator construct a shuffle_order_engine engine.

Parameters
__qA seed sequence.

Definition at line 1393 of file random.h.

Member Function Documentation

◆ base()

template<typename _RandomNumberEngine , size_t __k>
const _RandomNumberEngine & std::shuffle_order_engine< _RandomNumberEngine, __k >::base ( ) const
inlinenoexcept

Gets a const reference to the underlying generator engine object.

Definition at line 1436 of file random.h.

◆ discard()

template<typename _RandomNumberEngine , size_t __k>
void std::shuffle_order_engine< _RandomNumberEngine, __k >::discard ( unsigned long long  __z)
inline

Discard a sequence of random numbers.

Definition at line 1457 of file random.h.

◆ max()

template<typename _RandomNumberEngine , size_t __k>
static constexpr result_type std::shuffle_order_engine< _RandomNumberEngine, __k >::max ( )
inlinestaticconstexpr

Gets the maximum value in the generated random number range.

Definition at line 1450 of file random.h.

◆ min()

template<typename _RandomNumberEngine , size_t __k>
static constexpr result_type std::shuffle_order_engine< _RandomNumberEngine, __k >::min ( )
inlinestaticconstexpr

Gets the minimum value in the generated random number range.

Definition at line 1443 of file random.h.

◆ operator()()

template<typename _RandomNumberEngine , size_t __k>
shuffle_order_engine< _RandomNumberEngine, __k >::result_type std::shuffle_order_engine< _RandomNumberEngine, __k >::operator()

Gets the next value in the generated random number sequence.

Definition at line 843 of file bits/random.tcc.

References std::max(), and std::min().

◆ seed() [1/3]

template<typename _RandomNumberEngine , size_t __k>
void std::shuffle_order_engine< _RandomNumberEngine, __k >::seed ( )
inline

Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator engine.

Definition at line 1402 of file random.h.

◆ seed() [2/3]

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
__qA seed generator function.

Definition at line 1426 of file random.h.

◆ seed() [3/3]

template<typename _RandomNumberEngine , size_t __k>
void std::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.

Definition at line 1413 of file random.h.

Friends And Related Symbol Documentation

◆ operator<<

template<typename _RandomNumberEngine , size_t __k>
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 
)
friend

Inserts the current state of a shuffle_order_engine random number generator engine __x into the output stream __os.

Parameters
__osAn output stream.
__xA shuffle_order_engine random number generator engine.
Returns
The output stream with the state of __x inserted or in an error state.

◆ operator==

template<typename _RandomNumberEngine , size_t __k>
bool operator== ( const shuffle_order_engine< _RandomNumberEngine, __k > &  __lhs,
const shuffle_order_engine< _RandomNumberEngine, __k > &  __rhs 
)
friend

Compares two shuffle_order_engine random number generator objects of the same type for equality.

Parameters
__lhsA shuffle_order_engine random number generator object.
__rhsAnother shuffle_order_engine random number generator object.
Returns
true if the infinite sequences of generated values would be equal, false otherwise.

Definition at line 1481 of file random.h.

◆ operator>>

template<typename _RandomNumberEngine , size_t __k>
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 
)
friend

Extracts the current state of a % subtract_with_carry_engine random number generator engine __x from the input stream __is.

Parameters
__isAn input stream.
__xA shuffle_order_engine random number generator engine.
Returns
The input stream with the state of __x extracted or in an error state.

Member Data Documentation

◆ table_size

template<typename _RandomNumberEngine , size_t __k>
constexpr size_t std::shuffle_order_engine< _RandomNumberEngine, __k >::table_size
staticconstexpr

Definition at line 1342 of file random.h.

The documentation for this class was generated from the following files: