xorwow_engine< DefaultSeed > Class Template Reference

xorwow_engine< DefaultSeed > Class Template Reference#

API library: rocrand_cpp::xorwow_engine< DefaultSeed > Class Template Reference

API library

rocrand_cpp
xorwow_engine

Pseudorandom number engine based XORWOW algorithm. More...

#include <rocrand.hpp>

Public Types
typedef unsigned int	result_type

typedef rocrand_ordering	order_type

typedef unsigned long long	offset_type

typedef unsigned long long	seed_type

Public Member Functions
	xorwow_engine (seed_type seed_value=DefaultSeed, offset_type offset_value=0, order_type order_value=ROCRAND_ORDERING_PSEUDO_DEFAULT)
	Constructs the pseudo-random number engine. More...

	xorwow_engine (rocrand_generator &generator)
	Constructs the pseudo-random number engine. More...

	xorwow_engine (const xorwow_engine &)=delete

xorwow_engine &	operator= (const xorwow_engine &)=delete

	xorwow_engine (xorwow_engine &&rhs) noexcept
	Move construct from an other engine, moving the state over. More...

xorwow_engine &	operator= (xorwow_engine &&rhs) noexcept
	Move assign from an other engine, moving the state over. More...

	~xorwow_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	offset (offset_type value)
	Sets the offset 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...

result_type	min () const
	Returns the smallest possible value that can be generated by the engine. More...

result_type	max () const
	Returns the largest possible value that can be generated by the engine. More...

Static Public Member Functions
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 = ROCRAND_XORWOW_DEFAULT_SEED>
class rocrand_cpp::xorwow_engine< DefaultSeed >

Pseudorandom number engine based XORWOW algorithm.

xorwow_engine is a xorshift pseudorandom number engine based on XORWOW algorithm. It produces random numbers of type unsigned int on the interval [0; 2^32 - 1].

Member Typedef Documentation

◆ offset_type

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

typedef unsigned long long rocrand_cpp::xorwow_engine< DefaultSeed >::offset_type

Pseudo-random number engine offset type. Offset represents a number of the random number engine's states that should be skipped before first value is generated.

◆ order_type

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

typedef rocrand_ordering rocrand_cpp::xorwow_engine< DefaultSeed >::order_type

Pseudo-random number engine ordering type. Represents the ordering of the results of a random number engine.

◆ result_type

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

typedef unsigned int rocrand_cpp::xorwow_engine< DefaultSeed >::result_type

Type of values generated by the random number engine.

◆ seed_type

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

typedef unsigned long long rocrand_cpp::xorwow_engine< DefaultSeed >::seed_type

Pseudo-random number engine seed type definition.

Constructor & Destructor Documentation

◆ xorwow_engine() [1/3]

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

rocrand_cpp::xorwow_engine< DefaultSeed >::xorwow_engine	(	seed_type	seed_value = `DefaultSeed`,
		offset_type	offset_value = `0`,
		order_type	order_value = `ROCRAND_ORDERING_PSEUDO_DEFAULT`
	)

inline

Constructs the pseudo-random number engine.

Parameters

seed_value	- seed value to use in the initialization of the internal state, see also seed()
offset_value	- number of internal states that should be skipped, see also offset()
order_value	- ordering of the sequences generated by the engine, see also order()

◆ xorwow_engine() [2/3]

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

rocrand_cpp::xorwow_engine< DefaultSeed >::xorwow_engine ( rocrand_generator & generator )

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

◆ xorwow_engine() [3/3]

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

rocrand_cpp::xorwow_engine< DefaultSeed >::xorwow_engine ( xorwow_engine< DefaultSeed > && rhs )

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.

◆ ~xorwow_engine()

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

rocrand_cpp::xorwow_engine< DefaultSeed >::~xorwow_engine ( )

inlinenoexcept

Destructs the engine.

Member Function Documentation

◆ max()

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

result_type rocrand_cpp::xorwow_engine< DefaultSeed >::max ( ) const

inline

Returns the largest possible value that can be generated by the engine.

◆ min()

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

result_type rocrand_cpp::xorwow_engine< DefaultSeed >::min ( ) const

inline

Returns the smallest possible value that can be generated by the engine.

◆ offset()

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

void rocrand_cpp::xorwow_engine< DefaultSeed >::offset ( offset_type value )

inline

Sets the offset of a random number engine.

Offset represents a number of the random number engine's states that should be skipped before first value is generated.

This operation resets the engine's internal state.
This operation does not change the engine's seed or the number of dimensions.

Parameters

value - New absolute offset

◆ operator()()

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

template<class Generator >

void rocrand_cpp::xorwow_engine< DefaultSeed >::operator()	(	result_type *	output,
		size_t	size
	)

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.

◆ operator=()

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

xorwow_engine& rocrand_cpp::xorwow_engine< DefaultSeed >::operator= ( xorwow_engine< DefaultSeed > && rhs )

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()

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

void rocrand_cpp::xorwow_engine< DefaultSeed >::order ( order_type value )

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

◆ seed()

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

void rocrand_cpp::xorwow_engine< DefaultSeed >::seed ( seed_type value )

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

◆ stream()

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

void rocrand_cpp::xorwow_engine< DefaultSeed >::stream ( hipStream_t value )

inline

Sets the random number engine's hipStream for kernel launches.

Parameters

value - new hipStream to use

◆ type()

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

static constexpr rocrand_rng_type rocrand_cpp::xorwow_engine< DefaultSeed >::type ( )

inlinestaticconstexpr

Returns type of the rocRAND pseudo-random number generator associated with the engine.

Member Data Documentation

◆ default_seed

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>

constexpr seed_type rocrand_cpp::xorwow_engine< DefaultSeed >::default_seed = DefaultSeed

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/docs-6.1.1/library/include/rocrand/rocrand.hpp

xorwow_engine< DefaultSeed > Class Template Reference

xorwow_engine&lt; DefaultSeed &gt; Class Template Reference#

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED> class rocrand_cpp::xorwow_engine< DefaultSeed >

Member Typedef Documentation

◆ offset_type

◆ order_type

◆ result_type

◆ seed_type

Constructor & Destructor Documentation

◆ xorwow_engine() [1/3]

◆ xorwow_engine() [2/3]

◆ xorwow_engine() [3/3]

◆ ~xorwow_engine()

Member Function Documentation

◆ max()

◆ min()

◆ offset()

◆ operator()()

◆ operator=()

◆ order()

◆ seed()

◆ stream()

◆ type()

Member Data Documentation

◆ default_seed

xorwow_engine< DefaultSeed > Class Template Reference#

template<unsigned long long DefaultSeed = ROCRAND_XORWOW_DEFAULT_SEED>
class rocrand_cpp::xorwow_engine< DefaultSeed >