.. _oneapi-mkl-rng-mcg31m1:

oneapi::mkl::rng::mcg31m1
=========================

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

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

The 31-bit multiplicative congruential pseudorandom number generator MCG(1132489760, 2\ :sup:`32`-1) :ref:`[L'Ecuyer99a] <bibliography>`.


API
***


Syntax
------

.. code-block:: cpp

   class mcg31m1 {
   public:
       static constexpr std::uint32_t default_seed = 1;
       mcg31m1(sycl::queue queue, std::uint32_t seed = default_seed);
       mcg31m1(const mcg31m1& other);
       mcg31m1(mcg31m1&& other);
       mcg31m1& operator=(const mcg31m1& other);
       mcg31m1& operator=(mcg31m1&& other);
       ~mcg31m1();
   };


Devices supported: Host, CPU, and GPU.


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


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

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

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




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