.. _oneapi-mkl-rng-mcg59:

oneapi::mkl::rng::mcg59
=======================

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

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

The 59-bit multiplicative congruential pseudorandom number generator MCG(13\ :sup:`13`, 2\ :sup:`59`) from NAG Numerical Libraries :ref:`[NAG] <bibliography>`.


API
***


Syntax
------

.. code-block:: cpp

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

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 ``oneapi::mkl::rng::generate()`` routine submit kernels in this queue.
   * -     seed
     -     ``std::uint64_t``
     -     Initial conditions of the engine.


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