std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType > Class Template Reference

#include <random>

Public Types
typedef _UIntType	result_type

Public Member Functions
	independent_bits_engine ()
	independent_bits_engine (_RandomNumberEngine &&__rng)
template<typename _Sseq, typename = _If_seed_seq<_Sseq>>
	independent_bits_engine (_Sseq &__q)
	independent_bits_engine (const _RandomNumberEngine &__rng)
	independent_bits_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 ()

Friends
bool	operator== (const independent_bits_engine &__lhs, const independent_bits_engine &__rhs)
template<typename _CharT, typename _Traits>
std::basic_istream< _CharT, _Traits > &	operator>> (std::basic_istream< _CharT, _Traits > &__is, std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType > &__x)

Detailed Description

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>
class std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >

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

Since

C++11

Definition at line 1236 of file random.h.

Member Typedef Documentation

result_type

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

typedef _UIntType std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::result_type

The type of the generated random value.

Definition at line 1249 of file random.h.

Constructor & Destructor Documentation

independent_bits_engine() [1/5]

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::independent_bits_engine ( )

inline

Constructs a default independent_bits_engine engine.

The underlying engine is default constructed as well.

Definition at line 1256 of file random.h.

Referenced by operator==.

independent_bits_engine() [2/5]

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::independent_bits_engine ( const _RandomNumberEngine & __rng )

inlineexplicit

Copy constructs a independent_bits_engine engine.

Copies an existing base class random number generator.

Parameters

__rng

An existing (base class) engine object.

Definition at line 1266 of file random.h.

independent_bits_engine() [3/5]

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::independent_bits_engine ( _RandomNumberEngine && __rng )

inlineexplicit

Move constructs a independent_bits_engine engine.

Copies an existing base class random number generator.

Parameters

__rng

An existing (base class) engine object.

Definition at line 1276 of file random.h.

References std::move().

independent_bits_engine() [4/5]

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::independent_bits_engine ( result_type __s )

inlineexplicit

Seed constructs a independent_bits_engine engine.

Constructs the underlying generator engine seeded with __s.

Parameters

__s	A seed value for the base class engine.

Definition at line 1286 of file random.h.

independent_bits_engine() [5/5]

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

template<typename _Sseq, typename = _If_seed_seq<_Sseq>>

std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::independent_bits_engine ( _Sseq & __q )

inlineexplicit

Generator construct a independent_bits_engine engine.

Parameters

__q	A seed sequence.

Definition at line 1296 of file random.h.

Member Function Documentation

base()

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

const _RandomNumberEngine & std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::base ( ) const

inlinenoexcept

Gets a const reference to the underlying generator engine object.

Definition at line 1331 of file random.h.

discard()

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

void std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::discard ( unsigned long long __z )

inline

Discard a sequence of random numbers.

Definition at line 1352 of file random.h.

max()

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

static constexpr result_type std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::max ( )

inlinestaticconstexpr

Gets the maximum value in the generated random number range.

Definition at line 1345 of file random.h.

min()

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

static constexpr result_type std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::min ( )

inlinestaticconstexpr

Gets the minimum value in the generated random number range.

Definition at line 1338 of file random.h.

operator()()

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::result_type std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::operator()

(

)

Gets the next value in the generated random number sequence.

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

References std::__lg(), std::__numeric_limits_base::digits, and std::numeric_limits< _Tp >::max().

seed() [1/3]

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

void std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::seed ( )

inline

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

Definition at line 1305 of file random.h.

seed() [2/3]

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

template<typename _Sseq>

_If_seed_seq< _Sseq > std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::seed ( _Sseq & __q )

inline

Reseeds the independent_bits_engine object with the given seed sequence.

Parameters

__q	A seed generator function.

Definition at line 1323 of file random.h.

seed() [3/3]

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

void std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::seed ( result_type __s )

inline

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

Definition at line 1313 of file random.h.

Friends And Related Symbol Documentation

operator==

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

bool operator== ( const independent_bits_engine< _RandomNumberEngine, __w, _UIntType > & __lhs, const independent_bits_engine< _RandomNumberEngine, __w, _UIntType > & __rhs )

friend

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

Parameters

__lhs	A independent_bits_engine random number generator object.
__rhs	Another independent_bits_engine random number generator object.

Returns

true if the infinite sequences of generated values would be equal, false otherwise.

Definition at line 1377 of file random.h.

References independent_bits_engine().

operator>>

template<typename _RandomNumberEngine, size_t __w, typename _UIntType>

template<typename _CharT, typename _Traits>

std::basic_istream< _CharT, _Traits > & operator>> ( std::basic_istream< _CharT, _Traits > & __is, std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType > & __x )

friend

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

Parameters

__is	An input stream.
__x	A independent_bits_engine random number generator engine.

Returns

The input stream with the state of __x extracted or in an error state.

Definition at line 1395 of file random.h.

---

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

• random.h
• bits/random.tcc