std::discard_block_engine< _RandomNumberEngine, __p, __r >(3) | Library Functions Manual | std::discard_block_engine< _RandomNumberEngine, __p, __r >(3) |
NAME¶
std::discard_block_engine< _RandomNumberEngine, __p, __r >
SYNOPSIS¶
Public Types¶
template<typename _Sseq > using _If_seed_seq =
typename enable_if< __detail::__is_seed_seq< _Sseq,
discard_block_engine, result_type >::value >::type
typedef _RandomNumberEngine::result_type result_type
Public Member Functions¶
discard_block_engine ()
Constructs a default discard_block_engine engine. discard_block_engine
(_RandomNumberEngine &&__rng)
Move constructs a discard_block_engine engine. template<typename _Sseq ,
typename = _If_seed_seq<_Sseq>> discard_block_engine (_Sseq
&__q)
Generator construct a discard_block_engine engine. discard_block_engine
(const _RandomNumberEngine &__rng)
Copy constructs a discard_block_engine engine. discard_block_engine
(result_type __s)
Seed constructs a discard_block_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 discard_block_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 discard_block_engine object with the given seed sequence. void
seed (result_type __s)
Reseeds the discard_block_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.
Static Public Attributes¶
static constexpr size_t block_size
static constexpr size_t used_block
Friends¶
template<typename _RandomNumberEngine1 , size_t __p1, size_t
__r1, typename _CharT , typename _Traits > std::basic_ostream<
_CharT, _Traits > & operator<<
(std::basic_ostream< _CharT, _Traits > &__os, const
std::discard_block_engine< _RandomNumberEngine1, __p1, __r1 >
&__x)
Inserts the current state of a discard_block_engine random number generator
engine __x into the output stream __os. bool operator== (const
discard_block_engine &__lhs, const discard_block_engine
&__rhs)
Compares two discard_block_engine random number generator objects of the same
type for equality. template<typename _RandomNumberEngine1 , size_t __p1,
size_t __r1, typename _CharT , typename _Traits >
std::basic_istream< _CharT, _Traits > &
operator>> (std::basic_istream< _CharT, _Traits >
&__is, std::discard_block_engine< _RandomNumberEngine1, __p1,
__r1 > &__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 __p, size_t __r>¶
class std::discard_block_engine< _RandomNumberEngine, __p, __r >" Produces random numbers from some base engine by discarding blocks of data.
0 <= __r <= __p
Member Typedef Documentation¶
template<typename _RandomNumberEngine , size_t __p, size_t __r> typedef _RandomNumberEngine::result_type std::discard_block_engine< _RandomNumberEngine, __p, __r >::result_type¶
The type of the generated random value.
Constructor & Destructor Documentation¶
template<typename _RandomNumberEngine , size_t __p, size_t __r> std::discard_block_engine< _RandomNumberEngine, __p, __r >::discard_block_engine () [inline]¶
Constructs a default discard_block_engine engine. The underlying engine is default constructed as well.
template<typename _RandomNumberEngine , size_t __p, size_t __r> std::discard_block_engine< _RandomNumberEngine, __p, __r >::discard_block_engine (const _RandomNumberEngine & __rng) [inline], [explicit]¶
Copy constructs a discard_block_engine engine. Copies an existing base class random number generator.
Parameters
template<typename _RandomNumberEngine , size_t __p, size_t __r> std::discard_block_engine< _RandomNumberEngine, __p, __r >::discard_block_engine (_RandomNumberEngine && __rng) [inline], [explicit]¶
Move constructs a discard_block_engine engine. Copies an existing base class random number generator.
Parameters
template<typename _RandomNumberEngine , size_t __p, size_t __r> std::discard_block_engine< _RandomNumberEngine, __p, __r >::discard_block_engine (result_type __s) [inline], [explicit]¶
Seed constructs a discard_block_engine engine. Constructs the underlying generator engine seeded with __s.
Parameters
template<typename _RandomNumberEngine , size_t __p, size_t __r> template<typename _Sseq , typename = _If_seed_seq<_Sseq>> std::discard_block_engine< _RandomNumberEngine, __p, __r >::discard_block_engine (_Sseq & __q) [inline], [explicit]¶
Generator construct a discard_block_engine engine.
Parameters
Member Function Documentation¶
template<typename _RandomNumberEngine , size_t __p, size_t __r> const _RandomNumberEngine& std::discard_block_engine< _RandomNumberEngine, __p, __r >::base () const [inline], [noexcept]¶
Gets a const reference to the underlying generator engine object.
template<typename _RandomNumberEngine , size_t __p, size_t __r> void std::discard_block_engine< _RandomNumberEngine, __p, __r >::discard (unsigned long long __z) [inline]¶
Discard a sequence of random numbers.
template<typename _RandomNumberEngine , size_t __p, size_t __r> static constexpr result_type std::discard_block_engine< _RandomNumberEngine, __p, __r >::max () [inline], [static], [constexpr]¶
Gets the maximum value in the generated random number range.
References std::max().
template<typename _RandomNumberEngine , size_t __p, size_t __r> static constexpr result_type std::discard_block_engine< _RandomNumberEngine, __p, __r >::min () [inline], [static], [constexpr]¶
Gets the minimum value in the generated random number range.
References std::min().
template<typename _RandomNumberEngine , size_t __p, size_t __r> discard_block_engine< _RandomNumberEngine, __p, __r >::result_type std::discard_block_engine< _RandomNumberEngine, __p, __r >::operator()¶
Gets the next value in the generated random number sequence.
template<typename _RandomNumberEngine , size_t __p, size_t __r> void std::discard_block_engine< _RandomNumberEngine, __p, __r >::seed () [inline]¶
Reseeds the discard_block_engine object with the default seed for the underlying base class generator engine.
template<typename _RandomNumberEngine , size_t __p, size_t __r> template<typename _Sseq > _If_seed_seq<_Sseq> std::discard_block_engine< _RandomNumberEngine, __p, __r >::seed (_Sseq & __q) [inline]¶
Reseeds the discard_block_engine object with the given seed sequence.
Parameters
template<typename _RandomNumberEngine , size_t __p, size_t __r> void std::discard_block_engine< _RandomNumberEngine, __p, __r >::seed (result_type __s) [inline]¶
Reseeds the discard_block_engine object with the default seed for the underlying base class generator engine.
Friends And Related Function Documentation¶
template<typename _RandomNumberEngine , size_t __p, size_t __r> template<typename _RandomNumberEngine1 , size_t __p1, size_t __r1, typename _CharT , typename _Traits > std::basic_ostream<_CharT, _Traits>& operator<< (std::basic_ostream< _CharT, _Traits > & __os, const std::discard_block_engine< _RandomNumberEngine1, __p1, __r1 > & __x) [friend]¶
Inserts the current state of a discard_block_engine random number generator engine __x into the output stream __os.
Parameters
__x A discard_block_engine random number generator engine.
Returns
template<typename _RandomNumberEngine , size_t __p, size_t __r> bool operator== (const discard_block_engine< _RandomNumberEngine, __p, __r > & __lhs, const discard_block_engine< _RandomNumberEngine, __p, __r > & __rhs) [friend]¶
Compares two discard_block_engine random number generator objects of the same type for equality.
Parameters
__rhs Another discard_block_engine random number generator object.
Returns
template<typename _RandomNumberEngine , size_t __p, size_t __r> template<typename _RandomNumberEngine1 , size_t __p1, size_t __r1, typename _CharT , typename _Traits > std::basic_istream<_CharT, _Traits>& operator>> (std::basic_istream< _CharT, _Traits > & __is, std::discard_block_engine< _RandomNumberEngine1, __p1, __r1 > & __x) [friend]¶
Extracts the current state of a % subtract_with_carry_engine random number generator engine __x from the input stream __is.
Parameters
__x A discard_block_engine random number generator engine.
Returns
Author¶
Generated automatically by Doxygen for libstdc++ from the source code.
Mon Dec 18 2023 | libstdc++ |