.TH "std::shuffle_order_engine< _RandomNumberEngine, __k >" 3cxx "Wed Jul 28 2021" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::shuffle_order_engine< _RandomNumberEngine, __k > \- Produces random numbers by reordering random numbers from some base engine\&.  

.SH SYNOPSIS
.br
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "template<typename _Sseq > using \fB_If_seed_seq\fP = typename \fBenable_if\fP< __detail::__is_seed_seq< _Sseq, \fBshuffle_order_engine\fP, \fBresult_type\fP >::value >::type"
.br
.ti -1c
.RI "typedef _RandomNumberEngine::result_type \fBresult_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBshuffle_order_engine\fP ()"
.br
.RI "Constructs a default shuffle_order_engine engine\&. "
.ti -1c
.RI "\fBshuffle_order_engine\fP (_RandomNumberEngine &&__rng)"
.br
.RI "Move constructs a shuffle_order_engine engine\&. "
.ti -1c
.RI "template<typename _Sseq , typename  = _If_seed_seq<_Sseq>> \fBshuffle_order_engine\fP (_Sseq &__q)"
.br
.RI "Generator construct a shuffle_order_engine engine\&. "
.ti -1c
.RI "\fBshuffle_order_engine\fP (const _RandomNumberEngine &__rng)"
.br
.RI "Copy constructs a shuffle_order_engine engine\&. "
.ti -1c
.RI "\fBshuffle_order_engine\fP (\fBresult_type\fP __s)"
.br
.RI "Seed constructs a shuffle_order_engine engine\&. "
.ti -1c
.RI "const _RandomNumberEngine & \fBbase\fP () const noexcept"
.br
.ti -1c
.RI "void \fBdiscard\fP (unsigned long long __z)"
.br
.ti -1c
.RI "\fBresult_type\fP \fBoperator()\fP ()"
.br
.ti -1c
.RI "void \fBseed\fP ()"
.br
.RI "Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator engine\&. "
.ti -1c
.RI "template<typename _Sseq > _If_seed_seq< _Sseq > \fBseed\fP (_Sseq &__q)"
.br
.RI "Reseeds the shuffle_order_engine object with the given seed sequence\&. "
.ti -1c
.RI "void \fBseed\fP (\fBresult_type\fP __s)"
.br
.RI "Reseeds the shuffle_order_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 "static constexpr \fBresult_type\fP \fBmax\fP ()"
.br
.ti -1c
.RI "static constexpr \fBresult_type\fP \fBmin\fP ()"
.br
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr size_t \fBtable_size\fP"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "template<typename _RandomNumberEngine1 , size_t __k1, typename _CharT , typename _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator<<\fP (\fBstd::basic_ostream\fP< _CharT, _Traits > &__os, const \fBstd::shuffle_order_engine\fP< _RandomNumberEngine1, __k1 > &__x)"
.br
.RI "Inserts the current state of a shuffle_order_engine random number generator engine \fC__x\fP into the output stream \fC__os\fP\&. "
.ti -1c
.RI "bool \fBoperator==\fP (const \fBshuffle_order_engine\fP &__lhs, const \fBshuffle_order_engine\fP &__rhs)"
.br
.ti -1c
.RI "template<typename _RandomNumberEngine1 , size_t __k1, typename _CharT , typename _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator>>\fP (\fBstd::basic_istream\fP< _CharT, _Traits > &__is, \fBstd::shuffle_order_engine\fP< _RandomNumberEngine1, __k1 > &__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<typename _RandomNumberEngine, size_t __k>
.br
class std::shuffle_order_engine< _RandomNumberEngine, __k >"
Produces random numbers by reordering random numbers from some base engine\&. 

The values from the base engine are stored in a sequence of size \fC__k\fP and shuffled by an algorithm that depends on those values\&. 
.PP
Definition at line 1326 of file random\&.h\&.
.SH "Member Typedef Documentation"
.PP 
.SS "template<typename _RandomNumberEngine , size_t __k> typedef _RandomNumberEngine::result_type \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::\fBresult_type\fP"
The type of the generated random value\&. 
.PP
Definition at line 1333 of file random\&.h\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<typename _RandomNumberEngine , size_t __k> \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::\fBshuffle_order_engine\fP ()\fC [inline]\fP"

.PP
Constructs a default shuffle_order_engine engine\&. The underlying engine is default constructed as well\&. 
.PP
Definition at line 1346 of file random\&.h\&.
.SS "template<typename _RandomNumberEngine , size_t __k> \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::\fBshuffle_order_engine\fP (const _RandomNumberEngine & __rng)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Copy constructs a shuffle_order_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

.PP
Definition at line 1357 of file random\&.h\&.
.SS "template<typename _RandomNumberEngine , size_t __k> \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::\fBshuffle_order_engine\fP (_RandomNumberEngine && __rng)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Move constructs a shuffle_order_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

.PP
Definition at line 1368 of file random\&.h\&.
.SS "template<typename _RandomNumberEngine , size_t __k> \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::\fBshuffle_order_engine\fP (\fBresult_type\fP __s)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Seed constructs a shuffle_order_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

.PP
Definition at line 1379 of file random\&.h\&.
.SS "template<typename _RandomNumberEngine , size_t __k> template<typename _Sseq , typename  = _If_seed_seq<_Sseq>> \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::\fBshuffle_order_engine\fP (_Sseq & __q)\fC [inline]\fP, \fC [explicit]\fP"

.PP
Generator construct a shuffle_order_engine engine\&. 
.PP
\fBParameters\fP
.RS 4
\fI__q\fP A seed sequence\&. 
.RE
.PP

.PP
Definition at line 1390 of file random\&.h\&.
.SH "Member Function Documentation"
.PP 
.SS "template<typename _RandomNumberEngine , size_t __k> const _RandomNumberEngine& \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::base () const\fC [inline]\fP, \fC [noexcept]\fP"
Gets a const reference to the underlying generator engine object\&. 
.PP
Definition at line 1433 of file random\&.h\&.
.SS "template<typename _RandomNumberEngine , size_t __k> void \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::discard (unsigned long long __z)\fC [inline]\fP"
Discard a sequence of random numbers\&. 
.PP
Definition at line 1454 of file random\&.h\&.
.SS "template<typename _RandomNumberEngine , size_t __k> static constexpr \fBresult_type\fP \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::max ()\fC [inline]\fP, \fC [static]\fP, \fC [constexpr]\fP"
Gets the maximum value in the generated random number range\&. 
.PP
Definition at line 1447 of file random\&.h\&.
.PP
References std::max()\&.
.SS "template<typename _RandomNumberEngine , size_t __k> static constexpr \fBresult_type\fP \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::min ()\fC [inline]\fP, \fC [static]\fP, \fC [constexpr]\fP"
Gets the minimum value in the generated random number range\&. 
.PP
Definition at line 1440 of file random\&.h\&.
.PP
References std::min()\&.
.SS "template<typename _RandomNumberEngine , size_t __k> \fBshuffle_order_engine\fP< _RandomNumberEngine, __k >::\fBresult_type\fP \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::operator()"
Gets the next value in the generated random number sequence\&. 
.PP
Definition at line 837 of file bits/random\&.tcc\&.
.PP
References std::max(), and std::min()\&.
.SS "template<typename _RandomNumberEngine , size_t __k> void \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::seed ()\fC [inline]\fP"

.PP
Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator engine\&. 
.PP
Definition at line 1399 of file random\&.h\&.
.SS "template<typename _RandomNumberEngine , size_t __k> template<typename _Sseq > _If_seed_seq<_Sseq> \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::seed (_Sseq & __q)\fC [inline]\fP"

.PP
Reseeds the shuffle_order_engine object with the given seed sequence\&. 
.PP
\fBParameters\fP
.RS 4
\fI__q\fP A seed generator function\&. 
.RE
.PP

.PP
Definition at line 1423 of file random\&.h\&.
.SS "template<typename _RandomNumberEngine , size_t __k> void \fBstd::shuffle_order_engine\fP< _RandomNumberEngine, __k >::seed (\fBresult_type\fP __s)\fC [inline]\fP"

.PP
Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator engine\&. 
.PP
Definition at line 1410 of file random\&.h\&.
.SH "Friends And Related Function Documentation"
.PP 
.SS "template<typename _RandomNumberEngine , size_t __k> template<typename _RandomNumberEngine1 , size_t __k1, typename _CharT , typename _Traits > \fBstd::basic_ostream\fP<_CharT, _Traits>& operator<< (\fBstd::basic_ostream\fP< _CharT, _Traits > & __os, const \fBstd::shuffle_order_engine\fP< _RandomNumberEngine1, __k1 > & __x)\fC [friend]\fP"

.PP
Inserts the current state of a shuffle_order_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 shuffle_order_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<typename _RandomNumberEngine , size_t __k> bool operator== (const \fBshuffle_order_engine\fP< _RandomNumberEngine, __k > & __lhs, const \fBshuffle_order_engine\fP< _RandomNumberEngine, __k > & __rhs)\fC [friend]\fP"
Compares two shuffle_order_engine random number generator objects of the same type for equality\&.
.PP
\fBParameters\fP
.RS 4
\fI__lhs\fP A shuffle_order_engine random number generator object\&. 
.br
\fI__rhs\fP Another shuffle_order_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

.PP
Definition at line 1478 of file random\&.h\&.
.SS "template<typename _RandomNumberEngine , size_t __k> template<typename _RandomNumberEngine1 , size_t __k1, typename _CharT , typename _Traits > \fBstd::basic_istream\fP<_CharT, _Traits>& operator>> (\fBstd::basic_istream\fP< _CharT, _Traits > & __is, \fBstd::shuffle_order_engine\fP< _RandomNumberEngine1, __k1 > & __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 shuffle_order_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\&.