.. _sinpi:

sinpi
=====


Computes the element-wise sine of vector elements multiplied by pi.


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

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

The ``sinpi(a)`` function computes the sine of vector elements multiplied
by :math:`\pi`. For an argument ``a``, the function computes sin(:math:`\pi`\ \*\ ``a``).

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

   * -  Argument
     -  Result
     -  Error Code
   * -  +0
     -  +0
     -   
   * -  -0
     -  -0
     -   
   * -  +\ ``n``, positive integer
     -  +0
     -   
   * -  -``n``, negative integer
     -  -0
     -   
   * -  +\ :math:`\infty`
     -  QNAN
     -  ``status::errdom``
   * -  -\ :math:`\infty`
     -  QNAN
     -  ``status::errdom``
   * -  QNAN
     -  QNAN
     -   
   * -  SNAN
     -  QNAN
     -   




If arguments abs(``a``\ :sub:`i`) ≤ 2\ :sup:`22` for single precision
or abs(``a``\ :sub:`i` ) ≤ 2\ :sup:`51` for double precision, they
belong to the *fast computational path*: arguments for which VM
provides the best possible performance. Avoid arguments which do not
belong to the fast computational path in VM High Accuracy (HA) or Low
Accuracy (LA) functions. For arguments which do not belong to the
fast computational path you can use VM Enhanced Performance (EP)
functions, which are fast on the entire function domain. However,
these functions provide lower accuracy.


API
***


Syntax
------

**Buffer API**


.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event sinpi(sycl::queue & exec_queue,
         std::int64_t n,
         sycl::buffer<T> & a,
         sycl::buffer<T> & y,
         oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
         oneapi::mkl::vm::error_handler<T> errhandler = {});

   }


.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event sinpi(sycl::queue & exec_queue,
         sycl::buffer<T> & a,
         oneapi::mkl::slice sa,
         sycl::buffer<T> & y,
         oneapi::mkl::slice sy,
         oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
         oneapi::mkl::vm::error_handler<T> errhandler = {});

   }

**USM API**

.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event sinpi(sycl::queue & exec_queue,
         std::int64_t n,
         T const * a,
         T * y,
         std::vector<cl::sycl::event> const & depends = {},
         oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
         oneapi::mkl::vm::error_handler<T> errhandler = {});

   }


.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event sinpi(sycl::queue & exec_queue,
         T const * a,
         oneapi::mkl::slice sa,
         T * y,
         oneapi::mkl::slice sy,
         std::vector<cl::sycl::event> const & depends = {},
         oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
         oneapi::mkl::vm::error_handler<T> errhandler = {});

   }





``sinpi`` supports the following precisions and devices:


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

      * -  T
        -  Devices supported
      * -  ``float``
        -  Host, CPU, and GPU
      * -  ``double``
        -  Host, CPU, and GPU


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

**Buffer API**


exec_queue
   The queue where the routine should be executed.


n
   Specifies the number of elements to be calculated.


a
   The buffer containing the input vector.


sa
   Slice selector for ``a``. See :ref:`data-types` for a description of the |O-MKL| slice type.


sy
   Slice selector for ``y``. See :ref:`data-types` for a description of the |O-MKL| slice type.


mode
   Overrides the global VM mode setting for this function call. See :ref:`set_mode` function for possible values and their description. This is an optional parameter. The default value is ``mode::not_defined``.


errhandler
   Sets local error handling mode for this function call. See the :ref:`create_error_handler` function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.


**USM API**


exec_queue
   The queue where the routine should be executed.


n
   Specifies the number of elements to be calculated.


a
   Pointer to the input vector.


sa
   Slice selector for ``a``. See :ref:`data-types` for a description of the |O-MKL| slice type.


sy
   Slice selector for ``y``. See :ref:`data-types` for a description of the |O-MKL| slice type.


depends
   Vector of dependent events (to wait for input data to be ready). This is an optional parameter. The default is an empty vector.


mode
   Overrides the global VM mode setting for this function call. See the :ref:`set_mode` function for possible values and their description. This is an optional parameter. The default value is ``mode::not_defined``.


errhandler
   Sets local error handling mode for this function call. See the :ref:`create_error_handler` function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.


Output Parameters
-----------------

**Buffer API**


y
   The buffer containing the output vector.


return value (event)
   Computation end event


**USM API**


y
   Pointer to the output vector.


return value (event)
   Computation end event


Examples
********

An example of how to use ``sinpi`` can be found in the |O-MKL|
installation directory, under:


.. code-block::


   examples/dpcpp/vml/source/vsinpi.cpp