.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation .. .. SPDX-License-Identifier: CC-BY-4.0 .. _onemkl_vm_remainder: remainder ========= .. container:: Performs element by element computation of the remainder function on the elements of vector ``a`` and the corresponding elements of vector ``b``. .. container:: section .. rubric:: Syntax :class: sectiontitle Buffer API: .. code-block:: cpp namespace oneapi::mkl::vm { sycl::event remainder( sycl::queue& exec_queue, std::int64_t n, sycl::buffer& a, sycl::buffer& b, sycl::buffer& y, oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined, oneapi::mkl::vm::error_handler errhandler = {}); } // namespace oneapi::mkl::vm USM API: .. code-block:: cpp namespace oneapi::mkl::vm { sycl::event remainder( sycl::queue& exec_queue, std::int64_t n, const T *a, const T *b, T* y, std::vector const & depends = {}, oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined, oneapi::mkl::vm::error_handler errhandler = {}); } // namespace oneapi::mkl::vm ``remainder`` supports the following precisions. .. list-table:: :header-rows: 1 * - T * - ``float`` * - ``double`` .. container:: section .. rubric:: Description :class: sectiontitle The ``remainder(a)`` function computes the remainder of each element of vector ``a``, with respect to the corresponding elements of vector ``b``: compute the values of ``n`` such that ``n = ai - n*bi`` where ``n`` is the integer nearest to the exact value of ``a``\ :sub:`i`/``b``\ :sub:`i`. If two integers are equally close to ``a``\ :sub:`i`/``b``\ :sub:`i`, ``n`` is the even one. If ``n`` is zero, it has the same sign as ``a``\ :sub:`i`. .. container:: tablenoborder .. list-table:: :header-rows: 1 * - Argument 1 - Argument 2 - Result - VM status code * - ``a`` not NAN - ±0 - NAN - oneapi::mkl::vm::status::errdom * - ±∞ - ``b`` not NAN - NAN -   * - ±0 - ``b``\ ≠ 0, not NAN - ±0 -   * - ``a`` finite - ±∞ - ``a`` -   * - NAN - ``b`` - NAN -   * - ``a`` - NAN - NAN -   .. container:: section .. rubric:: Input Parameters :class: sectiontitle Buffer API: exec_queue The queue where the routine should be executed. n Specifies the number of elements to be calculated. a The buffer ``a`` containing 1st input vector of size ``n``. b The buffer ``b`` containing 2nd input vector of size ``n``. mode Overrides the global VM mode setting for this function call. See :ref:`onemkl_vm_setmode` function for possible values and their description. This is an optional parameter. The default value is ``oneapi::mkl::vm::mode::not_defined``. errhandler Sets local error handling mode for this function call. See the :ref:`onemkl_vm_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 ``a`` to the 1st input vector of size ``n``. b Pointer ``b`` to the 2nd input vector of size ``n``. depends Vector of dependent events (to wait for input data to be ready). mode Overrides the global VM mode setting for this function call. See the :ref:`onemkl_vm_setmode` function for possible values and their description. This is an optional parameter. The default value is ``oneapi::mkl::vm::mode::not_defined``. errhandler Sets local error handling mode for this function call. See the :ref:`onemkl_vm_create_error_handler` function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default. .. container:: section .. rubric:: Output Parameters :class: sectiontitle Buffer API: y The buffer ``y`` containing the output vector of size ``n``. USM API: y Pointer ``y`` to the output vector of size ``n``. return value (event) Event, signifying availability of computed output and status code(s). .. container:: section .. rubric:: Exceptions :class: sectiontitle For list of generated exceptions please refer to  :ref:`onemkl_vm_exceptions` .. container:: familylinks .. container:: parentlink **Parent topic:** :ref:`onemkl_vm_mathematical_functions`