.TH "std::discard_block_engine< _RandomNumberEngine, __p, __r >" 3cxx "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME std::discard_block_engine< _RandomNumberEngine, __p, __r > .SH SYNOPSIS .br .PP .PP \fC#include \fP .SS "Public Types" .in +1c .ti -1c .RI "template<\fBtypename\fP \fB_Sseq\fP > \fBusing\fP \fB_If_seed_seq\fP = \fBtypename\fP \fBenable_if\fP< __detail::__is_seed_seq< \fB_Sseq\fP, \fBdiscard_block_engine\fP, \fBresult_type\fP >::value >::type" .br .ti -1c .RI "\fBtypedef\fP _RandomNumberEngine::result_type \fBresult_type\fP" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBdiscard_block_engine\fP ()" .br .RI "Constructs a default discard_block_engine engine\&. " .ti -1c .RI "\fBdiscard_block_engine\fP (_RandomNumberEngine &&\fB__rng\fP)" .br .RI "Move constructs a discard_block_engine engine\&. " .ti -1c .RI "template<\fBtypename\fP \fB_Sseq\fP , \fBtypename\fP = _If_seed_seq<_Sseq>> \fBdiscard_block_engine\fP (\fB_Sseq\fP &__q)" .br .RI "Generator construct a discard_block_engine engine\&. " .ti -1c .RI "\fBdiscard_block_engine\fP (\fBconst\fP _RandomNumberEngine &\fB__rng\fP)" .br .RI "Copy constructs a discard_block_engine engine\&. " .ti -1c .RI "\fBdiscard_block_engine\fP (\fBresult_type\fP \fB__s\fP)" .br .RI "Seed constructs a discard_block_engine engine\&. " .ti -1c .RI "\fBconst\fP _RandomNumberEngine & \fBbase\fP () \fBconst\fP \fBnoexcept\fP" .br .RI "Gets a const reference to the underlying generator engine object\&. " .ti -1c .RI "\fBvoid\fP \fBdiscard\fP (unsigned long long \fB__z\fP)" .br .RI "Discard a sequence of random numbers\&. " .ti -1c .RI "\fBresult_type\fP \fBoperator()\fP ()" .br .RI "Gets the next value in the generated random number sequence\&. " .ti -1c .RI "\fBvoid\fP \fBseed\fP ()" .br .RI "Reseeds the discard_block_engine object with the default seed for the underlying base class generator engine\&. " .ti -1c .RI "template<\fBtypename\fP \fB_Sseq\fP > _If_seed_seq< \fB_Sseq\fP > \fBseed\fP (\fB_Sseq\fP &__q)" .br .RI "Reseeds the discard_block_engine object with the given seed sequence\&. " .ti -1c .RI "\fBvoid\fP \fBseed\fP (\fBresult_type\fP \fB__s\fP)" .br .RI "Reseeds the discard_block_engine object with the default seed for the underlying base class generator engine\&. " .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "\fBstatic\fP \fBconstexpr\fP \fBresult_type\fP \fBmax\fP ()" .br .RI "Gets the maximum value in the generated random number range\&. " .ti -1c .RI "\fBstatic\fP \fBconstexpr\fP \fBresult_type\fP \fBmin\fP ()" .br .RI "Gets the minimum value in the generated random number range\&. " .in -1c .SS "Static Public Attributes" .in +1c .ti -1c .RI "\fBstatic\fP \fBconstexpr\fP size_t \fBblock_size\fP" .br .ti -1c .RI "\fBstatic\fP \fBconstexpr\fP size_t \fBused_block\fP" .br .in -1c .SS "Friends" .in +1c .ti -1c .RI "template<\fBtypename\fP \fB_RandomNumberEngine1\fP , size_t __p1, size_t __r1, \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator<<\fP (\fBstd::basic_ostream\fP< _CharT, _Traits > &\fB__os\fP, \fBconst\fP \fBstd::discard_block_engine\fP< \fB_RandomNumberEngine1\fP, \fB__p1\fP, \fB__r1\fP > &__x)" .br .RI "Inserts the current state of a discard_block_engine random number generator engine \fC__x\fP into the output stream \fC__os\fP\&. " .ti -1c .RI "bool \fBoperator==\fP (\fBconst\fP \fBdiscard_block_engine\fP &\fB__lhs\fP, \fBconst\fP \fBdiscard_block_engine\fP &\fB__rhs\fP)" .br .RI "Compares two discard_block_engine random number generator objects of the same type for equality\&. " .ti -1c .RI "template<\fBtypename\fP \fB_RandomNumberEngine1\fP , size_t __p1, size_t __r1, \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator>>\fP (\fBstd::basic_istream\fP< _CharT, _Traits > &\fB__is\fP, \fBstd::discard_block_engine\fP< \fB_RandomNumberEngine1\fP, \fB__p1\fP, \fB__r1\fP > &__x)" .br .RI "Extracts the current state of a % subtract_with_carry_engine random number generator engine \fC__x\fP from the input stream \fC__is\fP\&. " .in -1c .SH "Detailed Description" .PP .SS "template<\fBtypename\fP _RandomNumberEngine, size_t __p, size_t __r> .br class std::discard_block_engine< _RandomNumberEngine, __p, __r >"Produces random numbers from some base engine by discarding blocks of data\&. .PP 0 <= \fC__r\fP <= \fC__p\fP .SH "Member Typedef Documentation" .PP .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBtypedef\fP _RandomNumberEngine::result_type \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::result_type" The type of the generated random value\&. .SH "Constructor & Destructor Documentation" .PP .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::discard_block_engine ()\fC [inline]\fP" .PP Constructs a default discard_block_engine engine\&. The underlying engine is default constructed as well\&. .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::discard_block_engine (\fBconst\fP _RandomNumberEngine & __rng)\fC [inline]\fP, \fC [explicit]\fP" .PP Copy constructs a discard_block_engine engine\&. Copies an existing base class random number generator\&. .PP \fBParameters\fP .RS 4 \fI__rng\fP An existing (base class) engine object\&. .RE .PP .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::discard_block_engine (_RandomNumberEngine && __rng)\fC [inline]\fP, \fC [explicit]\fP" .PP Move constructs a discard_block_engine engine\&. Copies an existing base class random number generator\&. .PP \fBParameters\fP .RS 4 \fI__rng\fP An existing (base class) engine object\&. .RE .PP .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::discard_block_engine (\fBresult_type\fP __s)\fC [inline]\fP, \fC [explicit]\fP" .PP Seed constructs a discard_block_engine engine\&. Constructs the underlying generator engine seeded with \fC__s\fP\&. .PP \fBParameters\fP .RS 4 \fI__s\fP A seed value for the base class engine\&. .RE .PP .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> template<\fBtypename\fP \fB_Sseq\fP , \fBtypename\fP = _If_seed_seq<_Sseq>> \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::discard_block_engine (\fB_Sseq\fP & __q)\fC [inline]\fP, \fC [explicit]\fP" .PP Generator construct a discard_block_engine engine\&. .PP \fBParameters\fP .RS 4 \fI__q\fP A seed sequence\&. .RE .PP .SH "Member Function Documentation" .PP .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBconst\fP _RandomNumberEngine & \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::base () const\fC [inline]\fP, \fC [noexcept]\fP" .PP Gets a const reference to the underlying generator engine object\&. .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBvoid\fP \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::discard (unsigned long long __z)\fC [inline]\fP" .PP Discard a sequence of random numbers\&. .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBstatic\fP \fBconstexpr\fP \fBresult_type\fP \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::max ()\fC [inline]\fP, \fC [static]\fP, \fC [constexpr]\fP" .PP Gets the maximum value in the generated random number range\&. .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBstatic\fP \fBconstexpr\fP \fBresult_type\fP \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::min ()\fC [inline]\fP, \fC [static]\fP, \fC [constexpr]\fP" .PP Gets the minimum value in the generated random number range\&. .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBdiscard_block_engine\fP< _RandomNumberEngine, __p, __r >\fB::result_type\fP \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::operator() ()" .PP Gets the next value in the generated random number sequence\&. .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBvoid\fP \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::seed ()\fC [inline]\fP" .PP Reseeds the discard_block_engine object with the default seed for the underlying base class generator engine\&. .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> template<\fBtypename\fP \fB_Sseq\fP > _If_seed_seq< \fB_Sseq\fP > \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::seed (\fB_Sseq\fP & __q)\fC [inline]\fP" .PP Reseeds the discard_block_engine object with the given seed sequence\&. .PP \fBParameters\fP .RS 4 \fI__q\fP A seed generator function\&. .RE .PP .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> \fBvoid\fP \fBstd::discard_block_engine\fP< _RandomNumberEngine, __p, __r >::seed (\fBresult_type\fP __s)\fC [inline]\fP" .PP Reseeds the discard_block_engine object with the default seed for the underlying base class generator engine\&. .SH "Friends And Related Symbol Documentation" .PP .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> template<\fBtypename\fP \fB_RandomNumberEngine1\fP , size_t __p1, size_t __r1, \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator\fP<< (\fBstd::basic_ostream\fP< _CharT, _Traits > & __os, \fBconst\fP \fBstd::discard_block_engine\fP< \fB_RandomNumberEngine1\fP, \fB__p1\fP, \fB__r1\fP > & __x)\fC [friend]\fP" .PP Inserts the current state of a discard_block_engine random number generator engine \fC__x\fP into the output stream \fC__os\fP\&. .PP \fBParameters\fP .RS 4 \fI__os\fP An output stream\&. .br \fI__x\fP A discard_block_engine random number generator engine\&. .RE .PP \fBReturns\fP .RS 4 The output stream with the state of \fC__x\fP inserted or in an error state\&. .RE .PP .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> bool \fBoperator\fP== (\fBconst\fP \fBdiscard_block_engine\fP< _RandomNumberEngine, __p, __r > & __lhs, \fBconst\fP \fBdiscard_block_engine\fP< _RandomNumberEngine, __p, __r > & __rhs)\fC [friend]\fP" .PP Compares two discard_block_engine random number generator objects of the same type for equality\&. .PP \fBParameters\fP .RS 4 \fI__lhs\fP A discard_block_engine random number generator object\&. .br \fI__rhs\fP Another discard_block_engine random number generator object\&. .RE .PP \fBReturns\fP .RS 4 true if the infinite sequences of generated values would be equal, false otherwise\&. .RE .PP .SS "template<\fBtypename\fP _RandomNumberEngine , size_t __p, size_t __r> template<\fBtypename\fP \fB_RandomNumberEngine1\fP , size_t __p1, size_t __r1, \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator\fP>> (\fBstd::basic_istream\fP< _CharT, _Traits > & __is, \fBstd::discard_block_engine\fP< \fB_RandomNumberEngine1\fP, \fB__p1\fP, \fB__r1\fP > & __x)\fC [friend]\fP" .PP Extracts the current state of a % subtract_with_carry_engine random number generator engine \fC__x\fP from the input stream \fC__is\fP\&. .PP \fBParameters\fP .RS 4 \fI__is\fP An input stream\&. .br \fI__x\fP A discard_block_engine random number generator engine\&. .RE .PP \fBReturns\fP .RS 4 The input stream with the state of \fC__x\fP extracted or in an error state\&. .RE .PP .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.