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

NAME
std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >

SYNOPSIS

#include <random>

  Public Types
typedef _UIntType result_type

  Public Member Functions
independent_bits_engine ()
Constructs a default independent_bits_engine engine.
independent_bits_engine (_RandomNumberEngine &&__rng)
Move constructs a independent_bits_engine engine.
template<typename _Sseq , typename = _If_seed_seq<_Sseq>> independent_bits_engine (_Sseq &__q)
Generator construct a independent_bits_engine engine.
independent_bits_engine (const _RandomNumberEngine &__rng)
Copy constructs a independent_bits_engine engine.
independent_bits_engine (result_type __s)
Seed constructs a independent_bits_engine engine.
const _RandomNumberEngine & base () const noexcept
Gets a const reference to the underlying generator engine object.
void discard (unsigned long long __z)
Discard a sequence of random numbers.
result_type operator() ()
Gets the next value in the generated random number sequence.
void seed ()
Reseeds the independent_bits_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 independent_bits_engine object with the given seed sequence.
void seed (result_type __s)
Reseeds the independent_bits_engine object with the default seed for the underlying base class generator engine.

  Static Public Member Functions
static constexpr result_type max ()
Gets the maximum value in the generated random number range.
static constexpr result_type min ()
Gets the minimum value in the generated random number range.

  Friends
bool operator== (const independent_bits_engine &__lhs, const independent_bits_engine &__rhs)
Compares two independent_bits_engine random number generator objects of the same type for equality.
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)
Extracts the current state of a % subtract_with_carry_engine random number generator engine __x from the input stream __is.

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

Member Typedef Documentation

  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.

Constructor & Destructor Documentation

  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.

  template<typename _RandomNumberEngine , size_t __w, typename _UIntType > std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::independent_bits_engine (const _RandomNumberEngine & __rng) [inline], [explicit]

Copy constructs a independent_bits_engine engine. Copies an existing base class random number generator.

Parameters
    __rng An existing (base class) engine object.

  template<typename _RandomNumberEngine , size_t __w, typename _UIntType > std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::independent_bits_engine (_RandomNumberEngine && __rng) [inline], [explicit]

Move constructs a independent_bits_engine engine. Copies an existing base class random number generator.

Parameters
    __rng An existing (base class) engine object.

  template<typename _RandomNumberEngine , size_t __w, typename _UIntType > std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::independent_bits_engine (result_type __s) [inline], [explicit]

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.

  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) [inline], [explicit]

Generator construct a independent_bits_engine engine.

Parameters
    __q A seed sequence.

Member Function Documentation

  template<typename _RandomNumberEngine , size_t __w, typename _UIntType > const _RandomNumberEngine & std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::base () const [inline], [noexcept]

Gets a const reference to the underlying generator engine object.

  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.

References std::forward().

  template<typename _RandomNumberEngine , size_t __w, typename _UIntType > static constexpr result_type std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::max () [inline], [static], [constexpr]

Gets the maximum value in the generated random number range.

  template<typename _RandomNumberEngine , size_t __w, typename _UIntType > static constexpr result_type std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::min () [inline], [static], [constexpr]

Gets the minimum value in the generated random number range.

References std::forward().

  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.

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

  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.

  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.

  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.

References std::forward().

Friends And Related Symbol Documentation

  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.

  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.

Author

Generated automatically by Doxygen for libstdc++ from the source code.