sfmt19937¶

The SIMD-oriented Mersenne Twister pseudorandom number generator.

Description

SIMD-oriented Fast Mersenne Twister pseudorandom number generator SFMT19937 [Saito08] with a period length equal to $2^{19937} - 1$ of the produced sequence. The state of the engine contains the array of 156 128-bit integers.

Generation algorithm

$w_{n} = w_{0} A \oplus w_{M} B \oplus w_{n - 2} C \oplus w_{n - 1} D$

Where $w_{0}, w_{M}, w_{n - 2}, . . .$ are the 128-bit integers, and $w A, w B, w C, w D$ operations are defined as follows:

$w A = (w << 8) \oplus w$ , left shift of 128-bit integer $w$ by $a$ followed by exclusive-or operation

$w B = (w >> 8) & m a s k$ , right shift of each 32-bit integer in quadruple $w$ by and-operator with quadruple of 32-bit masks $m a s k = (0 x B F F F F F F 6, 0 x D F F A F F F F, 0 x D D F E C B 7 F, 0 x D F F F F F E F)$

$w C = (w >> 8) \oplus w$ , right shift of 128-bit integer $w$

$w D = (w << 8)$ , left shift of each 32-bit integer in quadruple $w$

Integer output: $r_{4 n + k} = w_{n} (k)$ , where $w_{n} (k)$ is the k-th 32-bit integer in quadruple $w_{n}, k = 0, 1, 2, 3$

$u_{n} = (i n t) r_{n} / 2^{32} + 1 / 2$

class sfmt19937¶

Syntax

namespace oneapi::mkl::rng {
class sfmt19937 {
public:
    static constexpr std::uint32_t default_seed = 1;

    sfmt19937(sycl::queue queue, std::uint32_t seed = default_seed);

    sfmt19937(sycl::queue queue, std::initializer_list<std::uint32_t> seed);

    sfmt19937(const sfmt19937& other);

    sfmt19937(sfmt19937&& other);

    sfmt19937& operator=(const sfmt19937& other);

    sfmt19937& operator=(sfmt19937&& other);

    ~sfmt19937();
};
}

Class Members

Routine	Description
sfmt19937(sycl::queue queue, std::uint32_t seed = default_seed)	Constructor for common seed initialization of the engine
sfmt19937(sycl::queue queue, std::initializer_list<std::uint32_t> seed)	Constructor for extended seed initialization of the engine
sfmt19937(const sfmt19937& other)	Copy constructor
sfmt19937(sfmt19937&& other)	Move constructor
sfmt19937& operator=(const sfmt19937& other)	Copy assignment operator
sfmt19937& operator=(sfmt19937&& other)	Move assignment operator

Constructors

sfmt19937::sfmt19937(sycl::queue queue, std::uint32_t seed = default_seed)

Input Parameters

queue: Valid sycl::queue object, calls of the oneapi::mkl::rng::generate() routine submits kernels in this queue to obtain random numbers from a given engine.
seed: The initial conditions of the generator state. The initialization algorithm described in [Saito08].

sfmt19937::sfmt19937(sycl::queue queue, std::initializer_list<std::uint32_t> seed)

Input Parameters

queue: Valid sycl::queue object, calls of the oneapi::mkl::rng::generate() routine submits kernels in this queue to obtain random numbers from a given engine.
seed: The initial conditions of the generator state. The initialization algorithm described in [Saito08].

sfmt19937::sfmt19937(const sfmt19937& other)

Input Parameters

other: Valid sfmt19937 object. The queue and state of the other engine is copied and applied to the current engine.

sfmt19937::sfmt19937(sfmt19937&& other)

Input Parameters

other: Valid sfmt19937 object. The queue and state of the other engine is moved to the current engine.

sfmt19937::sfmt19937& operator=(const sfmt19937& other)

Input Parameters

other: Valid sfmt19937 object. The queue and state of the other engine is copied and applied to the current engine.

sfmt19937::sfmt19937& operator=(sfmt19937&& other)

Input Parameters

other: Valid sfmt19937 r-value object. The queue and state of the other engine is moved to the current engine.

Parent topic: Engines (Basic Random Number Generators)

oneAPI Specification 1.1-rev-1 documentation

sfmt19937¶

class sfmt19937¶