.. _oneapi-mkl-rng-device-skip_ahead:

oneapi::mkl::rng::device::skip_ahead
====================================


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

Description
***********
Proceed state of engine by the skip-ahead method.

The ``oneapi::mkl::rng::device::skip_ahead`` function supports the following interfaces to apply the skip-ahead method:

- Common interface
- Interface with a partitioned number of skipped elements


API
***


Syntax
------


**Common Interface**


.. code-block:: cpp

   template<typename_Engine>
     void skip_ahead (Engine& engine, std::uint64_t      num_to_skip)


**Interface with a partitioned number of skipped elements**

.. code-block:: cpp

   template<typename_Engine>
     void skip_ahead (Engine& engine,      std::initializer_list<std::uint64_t> num_to_skip)


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

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


Template Parameters
-------------------

**Common Interface**


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

   * - Name
     - Type
     - Description
   * - ``engine``
     - ``Engine&``
     - Object of ``engine`` class, which supports the block-splitting method.
   * - ``num_to_skip``
     - ``std::uint64_t``
     - Number of skipped elements.




**Interface with a Partitioned Number of Skipped Elements**


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

   * - Name
     - Type
     - Description
   * - ``engine``
     - ``Engine&``
     -  Object of ``engine`` class, which supports the block-splitting method.
   * - ``num_to_skip``
     - ``std::initializer_list<std::uint64_t>``
     - Partitioned number of skipped elements.