.. _oneapi-mkl-rng-philox4x32x10:

oneapi::mkl::rng::philox4x32x10
===============================

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

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

A Philox4x32-10 counter-based pseudorandom number generator :ref:`[Salmon11] <bibliography>`.


API
***


Syntax
------

.. code-block:: cpp

   class philox4x32x10 {
   public:
       static constexpr std::uint64_t default_seed = 0;
       philox4x32x10(sycl::queue queue, std::uint64_t seed = default_seed);
       philox4x32x10(sycl::queue queue, std::initializer_list<std::uint64_t> seed);
       philox4x32x10(const philox4x32x10& other);
       philox4x32x10(philox4x32x10&& other);
       philox4x32x10& operator=(const philox4x32x10& other);
       philox4x32x10& operator=(philox4x32x10&& other);
       ~philox4x32x10();
   };


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::uint64_t``
       ``std::initializer_list<std::uint64_t>``
     - Initial conditions of the generator state or engine state.

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