Difference between revisions of "cpp/numeric/random/subtract with carry engine"
From cppreference.com
m (langlinks) |
m (+ todo: the rest of template params to be described) |
||
| Line 22: | Line 22: | ||
{{dsc inc | cpp/numeric/random/dsc ranlux48_base}} | {{dsc inc | cpp/numeric/random/dsc ranlux48_base}} | ||
{{dsc end}} | {{dsc end}} | ||
| + | |||
| + | ===Template parameters=== | ||
| + | {{par begin}} | ||
| + | {{cpp/numeric/random/param_list|UIntType}} | ||
| + | {{todo|other template parameters need to be described }} | ||
| + | {{par | w | }} | ||
| + | {{par | s | }} | ||
| + | {{par | r | }} | ||
| + | {{par end}} | ||
===Member types=== | ===Member types=== | ||
Revision as of 10:40, 20 February 2021
| Defined in header <random>
|
||
| template< class UIntType, |
(since C++11) | |
subtract_with_carry_engine is a random number engine that uses subtract with carry algorithm.
| This section is incomplete |
The following typedefs define the random number engine with two commonly used parameter sets:
| Defined in header
<random> | |
| Type | Definition |
ranlux24_base (C++11)
|
std::subtract_with_carry_engine<std::uint_fast32_t, 24, 10, 24> |
ranlux48_base (C++11)
|
std::subtract_with_carry_engine<std::uint_fast64_t, 48, 5, 12> |
Contents |
Template parameters
| UIntType | - | The result type generated by the generator. The effect is undefined if this is not one of unsigned short, unsigned int, unsigned long, or unsigned long long.
| ||
| w | - | |||
| s | - | |||
| r | - |
Member types
| Member type | Definition |
result_type
|
The integral type generated by the engine. Results are undefined if this is not an unsigned integral type. |
Member functions
Construction and Seeding | |
| constructs the engine (public member function) | |
| sets the current state of the engine (public member function) | |
Generation | |
| advances the engine's state and returns the generated value (public member function) | |
| advances the engine's state by a specified amount (public member function) | |
Characteristics | |
| [static] |
gets the smallest possible value in the output range (public static member function) |
| [static] |
gets the largest possible value in the output range (public static member function) |
Non-member functions
| (C++11)(C++11)(removed in C++20) |
compares the internal states of two pseudo-random number engines (function) |
| (C++11) |
performs stream input and output on pseudo-random number engine (function template) |
Member objects
| constexpr size_t word_size [static] |
(public static member constant) | ||
| constexpr size_t short_lag [static] |
(public static member constant) | ||
| constexpr size_t long_lag [static] |
(public static member constant) | ||
| constexpr UIntType default_seed [static] |
(public static member constant) |
