fmod¶
The fmod function performs element by element computation of the modulus function of vector a
with respect to vector b
.
Syntax
Buffer API:
namespace oneapi::mkl::vm { void fmod(queue& exec_queue, int64_t n, buffer<T,1>& a, buffer<T,1>& b, buffer<T,1>& y, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {} ) }namespace oneapi::mkl::vm { sycl::event fmod(sycl::queue & exec_queue, sycl::buffer<T> & a, oneapi::mkl::slice sa, sycl::buffer<T> & b, oneapi::mkl::slice sb, sycl::buffer<T> & y, oneapi::mkl::slice sy, oneapi::mkl::vm::mode lib_mode = oneapi::mkl::vm::mode::not_defined, oneapi::mkl::vm::error_handler<T> eh = {}); }USM API:
namespace oneapi::mkl::vm { event fmod( queue& exec_queue, int64_t n, T* a, T* b, T* y, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {} ) }namespace oneapi::mkl::vm { sycl::event fmod(sycl::queue & exec_queue, T const * a, oneapi::mkl::slice sa, T const * b, oneapi::mkl::slice sb, T * y, oneapi::mkl::slice sy, sycl::vector_class<cl::sycl::event> const & depends = {}, oneapi::mkl::vm::mode lib_mode = oneapi::mkl::vm::mode::not_defined, oneapi::mkl::vm::error_handler<T> eh = {}); }
fmod
supports the following precisions and devices:
T
Devices supported
float
Host, CPU, and GPU
double
Host, CPU, and GPU
Description
The fmod (a,b) function computes the modulus function of each element of vector
a
, with respect to the corresponding elements of vectorb
:
ai - bi*trunc(ai/bi)
In general, the modulus function
fmod (ai, bi)
returns the valueai - n*bi
for some integern
such that ifb
i is nonzero, the result has the same sign asa
i and a magnitude less than the magnitude ofb
i.
Argument 1
Argument 2
Result
Error Code
a
not NAN±0
NAN
status::sing
±∞
b
not NANNAN
status::sing
±0
b
≠ 0, not NAN±0
a
finite±∞
a
NAN
b
a
NAN
NAN
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
a
containing 1st input vector of sizen
.- sa
Slice selector for
a
. See Data Types for a description of the oneMKL slice type.- b
The buffer
b
containing 2nd input vector of sizen
.- sb
Slice selector for
b
. See Data Types for a description of the oneMKL slice type.- sy
Slice selector for
y
. See Data Types for a description of the oneMKL slice type.- mode
Overrides the global VM mode setting for this function call. See 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 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 sizen
.- sa
Slice selector for
a
. See Data Types for a description of the oneMKL slice type.- b
Pointer
b
to the 2nd input vector of sizen
.- sb
Slice selector for
b
. See Data Types for a description of the oneMKL slice type.- sy
Slice selector for
y
. See Data Types for a description of the oneMKL slice type.- 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 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 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
y
containing the output vector of sizen
.USM API:
- y
Pointer
y
to the output vector of sizen
.- return value (event)
Function end event.
Example
An example of how to use fmodcan be found in the Intel® oneMKL installation directory, under:
examples/dpcpp/vml/source/vfmod.cpp