std::independent_bits_engine(3)

NAME
std::independent_bits_engine -

SYNOPSIS

  Public Types
typedef _UIntType result_type

  Public Member Functions
const _RandomNumberEngine & base () const
void discard (unsigned long long __z)
independent_bits_engine (seed_seq &__q)
independent_bits_engine (result_type __s)
independent_bits_engine (_RandomNumberEngine &&__rne)
independent_bits_engine (const _RandomNumberEngine &__rne)
independent_bits_engine ()
result_type max () const
result_type min () const
result_type operator() ()
void seed (seed_seq &__q)
void seed (result_type __s)
void seed ()

  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 specifies number of bits __w.

Definition at line 969 of file bits/random.h.

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.

Definition at line 979 of file bits/random.h.

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.

Definition at line 986 of file bits/random.h.

  template<typename _RandomNumberEngine, size_t __w, typename _UIntType> std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::independent_bits_engine (const _RandomNumberEngine & __rne) [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.

Definition at line 996 of file bits/random.h.

  template<typename _RandomNumberEngine, size_t __w, typename _UIntType> std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::independent_bits_engine (_RandomNumberEngine && __rne) [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.

Definition at line 1006 of file bits/random.h.

  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.

Definition at line 1016 of file bits/random.h.

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

Generator construct a independent_bits_engine engine.

Parameters:
    __q A seed sequence.

Definition at line 1025 of file bits/random.h.

Member Function Documentation

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

Gets a const reference to the underlying generator engine object.

Definition at line 1059 of file bits/random.h.

  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.

Todo
    Look for a faster way to do discard.

Definition at line 1086 of file bits/random.h.

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

Gets the maximum value in the generated random number range.

Todo
    This should be constexpr.

Definition at line 1077 of file bits/random.h.

Referenced by std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::operator()().

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

Gets the minimum value in the generated random number range.

Todo
    This should be constexpr.

Definition at line 1068 of file bits/random.h.

Referenced by std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::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() () [inline]

Gets the next value in the generated random number sequence.

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

References std::log10(), std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::max(), and std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::min().

  template<typename _RandomNumberEngine, size_t __w, typename _UIntType> void std::independent_bits_engine< _RandomNumberEngine, __w, _UIntType >::seed (seed_seq & __q) [inline]

Reseeds the independent_bits_engine object with the given seed sequence.

Parameters:
    __q A seed generator function.

Definition at line 1051 of file bits/random.h.

  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 1042 of file bits/random.h.

  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 1034 of file bits/random.h.

Friends And Related Function 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 two objects are equal, false otherwise.

Definition at line 1110 of file bits/random.h.

  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 1128 of file bits/random.h.

Author

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