NAME

       std::shuffle_order_engine< _RandomNumberEngine, __k > - Produces random numbers by reordering random
       numbers from some base engine.

SYNOPSIS

       #include <random.h>

   Public Types
       template<typename _Sseq > using _If_seed_seq = typename enable_if< __detail::__is_seed_seq< _Sseq,
           shuffle_order_engine, result_type >::value >::type
       typedef _RandomNumberEngine::result_type result_type

   Public Member Functions
       shuffle_order_engine ()
           Constructs a default shuffle_order_engine engine.
       shuffle_order_engine (_RandomNumberEngine &&__rng)
           Move constructs a shuffle_order_engine engine.
       template<typename _Sseq , typename  = _If_seed_seq<_Sseq>> shuffle_order_engine (_Sseq &__q)
           Generator construct a shuffle_order_engine engine.
       shuffle_order_engine (const _RandomNumberEngine &__rng)
           Copy constructs a shuffle_order_engine engine.
       shuffle_order_engine (result_type __s)
           Seed constructs a shuffle_order_engine engine.
       const _RandomNumberEngine & base () const noexcept
       void discard (unsigned long long __z)
       result_type operator() ()
       void seed ()
           Reseeds the shuffle_order_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 shuffle_order_engine object with the given seed sequence.
       void seed (result_type __s)
           Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator
           engine.

   Static Public Member Functions
       static constexpr result_type max ()
       static constexpr result_type min ()

   Static Public Attributes
       static constexpr size_t table_size

   Friends
       template<typename _RandomNumberEngine1 , size_t __k1, typename _CharT , typename _Traits >
           std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os,
           const std::shuffle_order_engine< _RandomNumberEngine1, __k1 > &__x)
           Inserts the current state of a shuffle_order_engine random number generator engine __x into the
           output stream __os.
       bool operator== (const shuffle_order_engine &__lhs, const shuffle_order_engine &__rhs)
       template<typename _RandomNumberEngine1 , size_t __k1, typename _CharT , typename _Traits >
           std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is,
           std::shuffle_order_engine< _RandomNumberEngine1, __k1 > &__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 __k>
       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 __k and shuffled by an algorithm that
       depends on those values.

Member Typedef Documentation

   template<typename _RandomNumberEngine , size_t __k> typedef _RandomNumberEngine::result_type
       std::shuffle_order_engine< _RandomNumberEngine, __k >::result_type
       The type of the generated random value.

Constructor & Destructor Documentation

   template<typename _RandomNumberEngine , size_t __k> std::shuffle_order_engine< _RandomNumberEngine, __k
       >::shuffle_order_engine () [inline]
       Constructs a default shuffle_order_engine engine. The underlying engine is default constructed as well.

   template<typename _RandomNumberEngine , size_t __k> std::shuffle_order_engine< _RandomNumberEngine, __k
       >::shuffle_order_engine (const _RandomNumberEngine & __rng) [inline],  [explicit]
       Copy constructs a shuffle_order_engine engine. Copies an existing base class random number generator.

       Parameters
           __rng An existing (base class) engine object.

   template<typename _RandomNumberEngine , size_t __k> std::shuffle_order_engine< _RandomNumberEngine, __k
       >::shuffle_order_engine (_RandomNumberEngine && __rng) [inline],  [explicit]
       Move constructs a shuffle_order_engine engine. Copies an existing base class random number generator.

       Parameters
           __rng An existing (base class) engine object.

   template<typename _RandomNumberEngine , size_t __k> std::shuffle_order_engine< _RandomNumberEngine, __k
       >::shuffle_order_engine (result_type __s) [inline],  [explicit]
       Seed constructs a shuffle_order_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 __k> template<typename _Sseq , typename  =
       _If_seed_seq<_Sseq>> std::shuffle_order_engine< _RandomNumberEngine, __k >::shuffle_order_engine (_Sseq &
       __q) [inline],  [explicit]
       Generator construct a shuffle_order_engine engine.

       Parameters
           __q A seed sequence.

Member Function Documentation

   template<typename _RandomNumberEngine , size_t __k> const _RandomNumberEngine & std::shuffle_order_engine<
       _RandomNumberEngine, __k >::base () const [inline],  [noexcept]
       Gets a const reference to the underlying generator engine object.

   template<typename _RandomNumberEngine , size_t __k> void std::shuffle_order_engine< _RandomNumberEngine, __k
       >::discard (unsigned long long __z) [inline]
       Discard a sequence of random numbers.

   template<typename _RandomNumberEngine , size_t __k> static constexpr result_type std::shuffle_order_engine<
       _RandomNumberEngine, __k >::max () [inline],  [static],  [constexpr]
       Gets the maximum value in the generated random number range.

   template<typename _RandomNumberEngine , size_t __k> static constexpr result_type std::shuffle_order_engine<
       _RandomNumberEngine, __k >::min () [inline],  [static],  [constexpr]
       Gets the minimum value in the generated random number range.

   template<typename _RandomNumberEngine , size_t __k> shuffle_order_engine< _RandomNumberEngine, __k
       >::result_type std::shuffle_order_engine< _RandomNumberEngine, __k >::operator() ()
       Gets the next value in the generated random number sequence.

       References std::max(), and std::min().

   template<typename _RandomNumberEngine , size_t __k> void std::shuffle_order_engine< _RandomNumberEngine, __k
       >::seed () [inline]
       Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator
       engine.

   template<typename _RandomNumberEngine , size_t __k> template<typename _Sseq > _If_seed_seq< _Sseq >
       std::shuffle_order_engine< _RandomNumberEngine, __k >::seed (_Sseq & __q) [inline]
       Reseeds the shuffle_order_engine object with the given seed sequence.

       Parameters
           __q A seed generator function.

   template<typename _RandomNumberEngine , size_t __k> void std::shuffle_order_engine< _RandomNumberEngine, __k
       >::seed (result_type __s) [inline]
       Reseeds the shuffle_order_engine object with the default seed for the underlying base class generator
       engine.

Friends And Related Symbol Documentation

   template<typename _RandomNumberEngine , size_t __k> template<typename _RandomNumberEngine1 , size_t __k1,
       typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits > & operator<<
       (std::basic_ostream< _CharT, _Traits > & __os, const std::shuffle_order_engine< _RandomNumberEngine1,
       __k1 > & __x) [friend]
       Inserts the current state of a shuffle_order_engine random number generator engine __x into the output
       stream __os.

       Parameters
           __os An output stream.
           __x A shuffle_order_engine random number generator engine.

       Returns
           The output stream with the state of __x inserted or in an error state.

   template<typename _RandomNumberEngine , size_t __k> bool operator== (const shuffle_order_engine<
       _RandomNumberEngine, __k > & __lhs, const shuffle_order_engine< _RandomNumberEngine, __k > & __rhs)
       [friend]
       Compares two shuffle_order_engine random number generator objects of the same type for equality.

       Parameters
           __lhs A shuffle_order_engine random number generator object.
           __rhs Another shuffle_order_engine random number generator object.

       Returns
           true if the infinite sequences of generated values would be equal, false otherwise.

   template<typename _RandomNumberEngine , size_t __k> template<typename _RandomNumberEngine1 , size_t __k1,
       typename _CharT , typename _Traits > std::basic_istream< _CharT, _Traits > & operator>>
       (std::basic_istream< _CharT, _Traits > & __is, std::shuffle_order_engine< _RandomNumberEngine1, __k1 > &
       __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 shuffle_order_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.

                                                    libstdstd::shuffle_order_eng...ndomNumberEngine, __k >(3cxx)