libstdc++
std::shuffle_order_engine< _RandomNumberEngine, __k > Class Template Reference

List of all members.

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends


Detailed Description

template<typename _RandomNumberEngine, size_t __k>
class std::shuffle_order_engine< _RandomNumberEngine, __k >

Produces random numbers by combining random numbers from some base engine to produce random numbers with a specifies number of bits __w.

Definition at line 1228 of file random.h.


Member Typedef Documentation

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 1235 of file random.h.


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.

Definition at line 1244 of file random.h.

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:
__rngAn existing (base class) engine object.

Definition at line 1255 of file random.h.

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:
__rngAn existing (base class) engine object.

Definition at line 1266 of file random.h.

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:
__sA seed value for the base class engine.

Definition at line 1277 of file random.h.

template<typename _RandomNumberEngine, size_t __k>
template<typename _Sseq , typename = typename std::enable_if<!std::is_same<_Sseq, shuffle_order_engine>::value && !std::is_same<_Sseq, _RandomNumberEngine>::value> ::type>
std::shuffle_order_engine< _RandomNumberEngine, __k >::shuffle_order_engine ( _Sseq &  __q) [inline, explicit]

Generator construct a shuffle_order_engine engine.

Parameters:
__qA seed sequence.

Definition at line 1291 of file random.h.


Member Function Documentation

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

Gets a const reference to the underlying generator engine object.

Definition at line 1334 of file random.h.

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 1355 of file random.h.

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

Gets the maximum value in the generated random number range.

Definition at line 1348 of file random.h.

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

Gets the minimum value in the generated random number range.

Definition at line 1341 of file random.h.

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 779 of file random.tcc.

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 1300 of file random.h.

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 1311 of file random.h.

template<typename _RandomNumberEngine, size_t __k>
template<typename _Sseq >
void 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 1324 of file random.h.


Friends And Related Function Documentation

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.
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 1379 of file random.h.

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.

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