Template Class mt19937_engine
Defined in File rocrand.hpp
Class Documentation
-
template<unsigned long long DefaultSeed = 0ULL>
class mt19937_engine 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].Public Types
-
typedef unsigned int result_type
Type of values generated by the random number engine.
Public Functions
-
inline mt19937_engine(seed_type seed_value = DefaultSeed)
Constructs the pseudo-random number engine.
- Parameters:
seed_value – - seed value to use in the initialization of the internal state, see also seed()
-
inline mt19937_engine(rocrand_generator &generator)
Constructs the pseudo-random number engine.
The pseudo-random number engine will be created using
generator
. The constructed engine take ownership overgenerator
, and sets passed reference toNULL
. The lifetime ofgenerator
is now bound to the lifetime of the engine.- Parameters:
generator – - rocRAND generator
-
mt19937_engine(const mt19937_engine&) = delete
-
mt19937_engine(mt19937_engine&&) = delete
-
mt19937_engine &operator=(const mt19937_engine&) = delete
-
mt19937_engine &operator=(mt19937_engine&&) = delete
-
inline ~mt19937_engine() noexcept(false)
Destructs the engine.
See also: rocrand_destroy_generator()
-
inline void stream(hipStream_t value)
Sets the random number engine’s
hipStream
for kernel launches.- Parameters:
value – - new
hipStream
to use
-
inline void seed(seed_type value)
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.
See also: rocrand_set_seed()
- Parameters:
value – - New seed value
-
template<class Generator>
inline void operator()(result_type *output, size_t size) 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 byoutput
pointer.The device memory pointed by
output
must have been previously allocated and be large enough to store at leastsize
values ofIntType
type.See also: rocrand_generate()
- Parameters:
output – - Pointer to device memory to store results
size – - Number of values to generate
-
inline result_type min() const
Returns the smallest possible value that can be generated by the engine.
-
inline result_type max() const
Returns the largest possible value that can be generated by the engine.
Public Static Functions
-
static inline constexpr rocrand_rng_type type()
Returns type of the rocRAND pseudo-random number generator associated with the engine.
Public Static Attributes
-
static constexpr seed_type default_seed = DefaultSeed
The default seed equal to
DefaultSeed
.
-
typedef unsigned int result_type