.. _rint:

rint
====

Computes the element-wise rounding of vector elements to the nearest integer, according to the current rounding mode.


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

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

The ``rint(a)`` function computes a rounded floating-point integer value
using the current rounding mode for each vector element.

The rounding mode affects the results computed for inputs that fall
between consecutive integers. For example:

-  ``f(0.5) = 0``, for rounding modes set to round to nearest round toward zero or to minus infinity.

-  ``f(0.5) = 1``, for rounding modes set to plus infinity.

-  ``f(-1.5) = -2``, for rounding modes set to round to nearest or to minus infinity.

-  ``f(-1.5) = -1``, for rounding modes set to round toward zero or to plus infinity.


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

   * -  Argument
     -  Result
     -  Error Code
   * -  +0
     -  +0
     -   
   * -  -0
     -  -0
     -   
   * -  +\ :math:`\infty`
     -  +\ :math:`\infty`
     -   
   * -  -\ :math:`\infty`
     -  -\ :math:`\infty`
     -   
   * -  QNAN
     -  QNAN
     -   
   * -  SNAN
     -  QNAN
     -   

The ``rint`` function does not generate any errors.


API
***


Syntax
------

**Buffer API**

.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event rint(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);

   }

.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event rint(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);

   }

**USM API**

.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event rint(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);

   }

.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event rint(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);

   }



``rint`` 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``.


**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``.


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 ``rint`` can be found in the |O-MKL|
installation directory, under:

.. code-block::

   examples/dpcpp/vml/source/vrint.cpp