Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/numeric/random/shuffle order engine"

From cppreference.com
< cpp‎ | numeric‎ | random
m (Text replace - "{{tdcl" to "{{dcl")
m ({{c}})
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{cpp/title|shuffle_order_engine}}
 
{{cpp/title|shuffle_order_engine}}
−
{{cpp/numeric/random/shuffle_order_engine/sidebar}}
+
{{cpp/numeric/random/shuffle_order_engine/navbar}}
−
{{ddcl | header=random | notes={{mark since c++11}} | 1=
+
{{dcl begin}}
 +
{{dcl header|random}}
 +
{{dcl|since=c++11|
 
template<
 
template<
−
     class Engine,  
+
     class Engine,
−
     size_t p, size_t r
+
     std::size_t K
 
> class shuffle_order_engine;
 
> class shuffle_order_engine;
 
}}
 
}}
 +
{{dcl end}}
  
−
{{todo}}
+
{{tt|shuffle_order_engine}} is a random number engine adaptor that shuffles the random numbers generated by the base engine. It maintains a table of size {{c|K}} and delivers a randomly selected number from that table when requested, replacing it with a number generated by the base engine.
  
−
===Member types===
+
The following typedef defines the random number engine with one commonly used parameter set:
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list hitem | Member type | Definition}}
+
{{dsc header|random}}
−
{{dcl list item | {{tt|result_type}} | {{c|typename Engine::result_type}} }}
+
{{dsc hitem|Type|Definition}}
−
{{dcl list end}}
+
{{dsc inc|cpp/numeric/random/dsc knuth_b}}
 +
{{dsc end}}
  
−
===Member variables===
+
===Template parameters===
−
{{dcl list begin}}
+
{{par begin}}
−
{{dcl list mem sconst | nolink=true | {{dcl small|constexpr size_t}} table_size | {{todo}} }}
+
{{par|Engine|the type of the wrapped engine}}
−
{{dcl list end}}
+
{{par|K|the size of the internal table. Must be greater than {{math|0}}.}}
 +
{{par hreq}}
 +
{{par req named|Engine|RandomNumberEngine}}
 +
{{par end}}
 +
 
 +
===Member types===
 +
{{dsc begin}}
 +
{{dsc hitem|Member type|Definition}}
 +
{{dsc|{{tt|result_type}} {{mark c++11}}|{{tt|Engine::result_type}}}}
 +
{{dsc end}}
  
 
===Member functions===
 
===Member functions===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list template | cpp/numeric/random/engine/dcl list constructor |shuffle_order_engine}}
+
{{dsc inc|cpp/numeric/random/adaptor/dsc constructor|shuffle_order_engine}}
−
{{dcl list template | cpp/numeric/random/engine/dcl list seed |shuffle_order_engine}}
+
{{dsc inc|cpp/numeric/random/adaptor/dsc seed|shuffle_order_engine}}
−
{{dcl list template | cpp/numeric/random/engine/dcl list base |shuffle_order_engine}}
+
{{dsc inc|cpp/numeric/random/adaptor/dsc base|shuffle_order_engine}}
  
−
{{dcl list h2 | Generation}}
+
{{dsc h2|Generation}}
−
{{dcl list template | cpp/numeric/random/engine/dcl list operator() |shuffle_order_engine}}
+
{{dsc inc|cpp/numeric/random/adaptor/dsc operator()|shuffle_order_engine}}
−
{{dcl list template | cpp/numeric/random/engine/dcl list discard |shuffle_order_engine}}
+
{{dsc inc|cpp/numeric/random/adaptor/dsc discard|shuffle_order_engine}}
  
−
{{dcl list h2 | Characteristics}}
+
{{dsc h2|Characteristics}}
−
{{dcl list template | cpp/numeric/random/engine/dcl list min |shuffle_order_engine}}
+
{{dsc inc|cpp/numeric/random/adaptor/dsc min|shuffle_order_engine}}
−
{{dcl list template | cpp/numeric/random/engine/dcl list max |shuffle_order_engine}}
+
{{dsc inc|cpp/numeric/random/adaptor/dsc max|shuffle_order_engine}}
−
{{dcl list end}}
+
{{dsc end}}
  
 
===Non-member functions===
 
===Non-member functions===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list template | cpp/numeric/random/engine/dcl list operator_cmp |shuffle_order_engine}}
+
{{dsc inc|cpp/numeric/random/adaptor/dsc operator_cmp|shuffle_order_engine}}
−
{{dcl list template | cpp/numeric/random/engine/dcl list operator_ltltgtgt |shuffle_order_engine}}
+
{{dsc inc|cpp/numeric/random/adaptor/dsc operator_ltltgtgt|shuffle_order_engine}}
−
{{dcl list end}}
+
{{dsc end}}
 +
 
 +
===Member objects===
 +
{{dsc begin}}
 +
{{dsc mem sconst|nolink=true|{{dsc small|constexpr size_t}} table_size|the size of the internal table, {{tt|K}}|notes={{mark c++11}}}}
 +
{{dsc end}}
 +
 
 +
===Example===
 +
{{example}}
 +
 
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 23:27, 5 May 2023

 
C++
 
Numerics library
Common mathematical functions
Mathematical special functions (C++17)
Mathematical constants (C++20)
Basic linear algebra algorithms (C++26)
Floating-point environment (C++11)
Complex numbers
Numeric array (valarray)
Pseudo-random number generation
Factor operations
(C++17)
(C++17)
Interpolations
(C++20)
(C++20)
Saturation arithmetic
(C++26)
(C++26)
(C++26)
(C++26)
(C++26)

Generic numeric operations
Bit operations
(C++20)    
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++23)
(C++20)
 
Pseudo-random number generation
 
std::shuffle_order_engine
 
Defined in header <random>
template<

    class Engine,
    std::size_t K

> class shuffle_order_engine;
 (since C++11)

shuffle_order_engine is a random number engine adaptor that shuffles the random numbers generated by the base engine. It maintains a table of size K and delivers a randomly selected number from that table when requested, replacing it with a number generated by the base engine.

The following typedef defines the random number engine with one commonly used parameter set:

Defined in header <random>
Type Definition
knuth_b (C++11) std::shuffle_order_engine<std::minstd_rand0, 256>[edit]

Contents

[edit] Template parameters

Engine - the type of the wrapped engine
K - the size of the internal table. Must be greater than 0.
Type requirements
-
Engine must meet the requirements of RandomNumberEngine.

[edit] Member types

Member type Definition
result_type (C++11) Engine::result_type

[edit] Member functions

(C++11)
 constructs the engine adaptor
(public member function) [edit]
(C++11)
 sets the state of the underlying engine
(public member function) [edit]
(C++11)
 returns the underlying engine
(public member function) [edit]
Generation
(C++11)
 advances the state of the underlying engine and returns the generated value
(public member function) [edit]
(C++11)
 advances the adaptor's state by a specified amount
(public member function) [edit]
Characteristics
[static] (C++11)
 gets the smallest possible value in the output range of the underlying engine.
(public static member function) [edit]
[static] (C++11)
 gets the largest possible value in the output range of the underlying engine.
(public static member function) [edit]

[edit] Non-member functions

(C++11)(C++11)(removed in C++20)
 compares the internal states of the adaptors and underlying engines
(function) [edit]
(C++11)
 performs stream input and output on pseudo-random number engine adaptor
(function) [edit]

[edit] Member objects

constexpr size_t table_size
[static] (C++11)
 the size of the internal table, K
(public static member constant)

[edit] Example

This section is incomplete
Reason: no example
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/numeric/random/shuffle_order_engine&oldid=151414"