.. _oneapi-mkl-rng-sfmt19937:

oneapi::mkl::rng::sfmt19937
===========================

.. contents::
    :local:
    :depth: 1

Description
***********

SIMD-oriented Fast Mersenne Twister pseudorandom number generator SFMT19937 :ref:`[Saito08] <bibliography>` with a period length equal to 2\ :sup:`19937`-1 of the produced sequence.


API
***


Syntax
------

.. code-block:: cpp

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


Devices supported: Host and CPU.


Include Files
-------------

- ``oneapi/mkl/rng.hpp``


Input Parameters
----------------

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Description
   * - queue
     - ``sycl::queue``
     - Valid ``sycl queue``, calls of ``oneapi::mkl::rng::generate()`` routine submit kernels in this queue.
   * - seed
     - ``std::uint32_t``
       ``std::initializer_list<std::uint32_t>``
     - Initial conditions of the engine.


See :ref:`VS Notes <bibliography>` for the detailed descriptions.