mt19937_engine< DefaultSeed > Class Template Reference#
|
API library
|
Random number engine based on the Mersenne Twister algorithm. More...
#include <rocrand.hpp>
Public Types | |
| typedef unsigned int | result_type |
| typedef rocrand_ordering | order_type |
| typedef unsigned long long | seed_type |
Public Member Functions | |
| mt19937_engine (seed_type seed_value=DefaultSeed, order_type order_value=ROCRAND_ORDERING_PSEUDO_DEFAULT) | |
| Constructs the pseudo-random number engine. More... | |
| mt19937_engine (rocrand_generator &generator) | |
| Constructs the pseudo-random number engine. More... | |
| mt19937_engine (const mt19937_engine &)=delete | |
| mt19937_engine & | operator= (const mt19937_engine &)=delete |
| mt19937_engine (mt19937_engine &&rhs) noexcept | |
| Move construct from an other engine, moving the state over. More... | |
| mt19937_engine & | operator= (mt19937_engine &&rhs) noexcept |
| Move assign from an other engine, moving the state over. More... | |
| ~mt19937_engine () noexcept(false) | |
| void | stream (hipStream_t value) |
Sets the random number engine's hipStream for kernel launches. More... | |
| void | order (order_type value) |
| Sets the order of a random number engine. More... | |
| void | seed (seed_type value) |
| Sets the seed of the pseudo-random number engine. More... | |
| template<class Generator > | |
| void | operator() (result_type *output, size_t size) |
Fills output with uniformly distributed random integer values. More... | |
Static Public Member Functions | |
| static constexpr result_type | min () |
| Returns the smallest possible value that can be generated by the engine. More... | |
| static constexpr result_type | max () |
| Returns the largest possible value that can be generated by the engine. More... | |
| static constexpr rocrand_rng_type | type () |
| Returns type of the rocRAND pseudo-random number generator associated with the engine. More... | |
Static Public Attributes | |
| static constexpr seed_type | default_seed = DefaultSeed |
The default seed equal to DefaultSeed. More... | |
Detailed Description
template<unsigned long long DefaultSeed = 0ULL>
class rocrand_cpp::mt19937_engine< DefaultSeed >
Random number engine based on the Mersenne Twister algorithm.
mt19937 is a random number engine based on the Mersenne Twister algorithm as proposed in "Mersenne Twister: A 623-Dimensionally Equidistributed Uniform
Pseudo-Random Number Generator". It produces high quality random numbers of type unsigned int on the interval [0; 2^32 - 1].
Member Typedef Documentation
◆ order_type
| typedef rocrand_ordering rocrand_cpp::mt19937_engine< DefaultSeed >::order_type |
Pseudo-random number engine ordering type. Represents the ordering of the results of a random number engine.
See also: order()
◆ result_type
| typedef unsigned int rocrand_cpp::mt19937_engine< DefaultSeed >::result_type |
Type of values generated by the random number engine.
◆ seed_type
| typedef unsigned long long rocrand_cpp::mt19937_engine< DefaultSeed >::seed_type |
Pseudo-random number engine seed type definition.
See also: seed()
Constructor & Destructor Documentation
◆ mt19937_engine() [1/3]
|
inline |
Constructs the pseudo-random number engine.
MT19937 does not accept offset.
- Parameters
-
seed_value - seed value to use in the initialization of the internal state, see also seed() order_value - ordering of the sequences generated by the engine, see also order()
See also: rocrand_create_generator()
◆ mt19937_engine() [2/3]
|
inlineexplicit |
Constructs the pseudo-random number engine.
The pseudo-random number engine will be created using generator. The constructed engine take ownership over generator, and sets passed reference to NULL. The lifetime of generator is now bound to the lifetime of the engine.
- Parameters
-
generator - rocRAND generator
◆ mt19937_engine() [3/3]
|
inlinenoexcept |
Move construct from an other engine, moving the state over.
- Parameters
-
rhs the engine to move-from
- The moved-from engine is safe to assign to or destroy, but otherwise cannot be used.
- This engine will continue the sequence generated by
rhs.
◆ ~mt19937_engine()
|
inlinenoexcept |
Destructs the engine.
See also: rocrand_destroy_generator()
Member Function Documentation
◆ max()
|
inlinestaticconstexpr |
Returns the largest possible value that can be generated by the engine.
◆ min()
|
inlinestaticconstexpr |
Returns the smallest possible value that can be generated by the engine.
◆ operator()()
|
inline |
Fills output with uniformly distributed random integer values.
Generates size random integer values uniformly distributed on the interval [0, 2^32 - 1], and stores them into the device memory referenced by output pointer.
- Parameters
-
output - Pointer to device memory to store results size - Number of values to generate
The device memory pointed by output must have been previously allocated and be large enough to store at least size values of IntType type.
See also: rocrand_generate()
◆ operator=()
|
inlinenoexcept |
Move assign from an other engine, moving the state over.
- Parameters
-
rhs the engine to move-from
- The moved-from engine is safe to assign to or destroy, but otherwise cannot be used.
- This engine will continue the sequence generated by
rhs.
◆ order()
|
inline |
Sets the order of a random number engine.
The order refers to the ordering of the sequences generated by the engine.
- This operation resets the engine's internal state.
- This operation does not change the engine's seed.
- Parameters
-
value - New ordering
See also: rocrand_set_ordering()
◆ seed()
|
inline |
Sets the seed of the pseudo-random number engine.
The seed is used to construct the initial state of an engine.
- This operation resets the engine's internal state.
- This operation does not change the engine's offset.
- Parameters
-
value - New seed value
See also: rocrand_set_seed()
◆ stream()
|
inline |
Sets the random number engine's hipStream for kernel launches.
- Parameters
-
value - new hipStreamto use
◆ type()
|
inlinestaticconstexpr |
Returns type of the rocRAND pseudo-random number generator associated with the engine.
Member Data Documentation
◆ default_seed
|
staticconstexpr |
The default seed equal to DefaultSeed.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocrand/checkouts/latest/library/include/rocrand/rocrand.hpp
Generated by
1.9.1