modf¶
Computes a truncated integer value and the remaining fraction part for each vector element.
Syntax
Buffer API:
void modf(queue& exec_queue, int64_t n, buffer<T,1>& a, buffer<T,1>& y, buffer<T,1>& z, uint64_t mode = mode::not_defined )
sycl::event modf(sycl::queue & exec_queue, sycl::buffer<T> & a, oneapi::mkl::slice sa, sycl::buffer<T> & y, oneapi::mkl::slice sy, sycl::buffer<T> & z, oneapi::mkl::slice sz, oneapi::mkl::vm::mode lib_mode = oneapi::mkl::vm::mode::not_defined);
USM API:
event modf(queue& exec_queue, int64_t n, T* a, T* y, T* z, vector_class<event> const & depends = {}, uint64_t mode = mode::not_defined )
sycl::event modf(sycl::queue & exec_queue, T const * a, oneapi::mkl::slice sa, T * y, oneapi::mkl::slice sy, T * z, oneapi::mkl::slice sz, sycl::vector_class<cl::sycl::event> const & depends = {}, oneapi::mkl::vm::mode lib_mode = oneapi::mkl::vm::mode::not_defined);
modf
supports the following precisions and devices:
T |
Devices supported |
---|---|
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
Description
The modf(a) functioncomputes a truncated integer value and the remaining fraction part for each vector element.
a_i \geq 0, \begin{cases} y_i = \lfloor a_i \rfloor \\ z_i = a_i - \lfloor a_i \rfloor \end{cases}
a_i < 0, \begin{cases} y_i = \lceil a_i \rceil \\ z_i = a_i - \lceil a_i \rceil \end{cases}
Argument |
Result 1 |
Result 2 |
Error Code |
---|---|---|---|
+0 |
+0 |
+0 |
|
-0 |
-0 |
-0 |
|
+∞ |
+∞ |
+0 |
|
-∞ |
-∞ |
-0 |
|
SNAN |
QNAN |
QNAN |
|
QNAN |
QNAN |
QNAN |
The modf function does not generate any errors.
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 input vector of sizen
.- sa
Slice selector for
a
. 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.- sz
Slice selector for
z
. 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
.
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 input vector of sizen
.- sa
Slice selector for
a
. 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.- sz
Slice selector for
z
. 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
.
Output Parameters
Buffer API:
- y
The buffer
y
containing the output vector of sizen
for truncated integer values.- z
The buffer
z
containing the output vector of sizen
for remaining fraction parts.
USM API:
- y
Pointer
y
to the output vector of sizen
for truncated integer values.- z
Pointer
z
to the output vector of sizen
for remaining fraction parts.- return value (event)
Function end event.
Example
An example of how to use modfcan be found in the Intel® oneMKL installation directory, under:
examples/dpcpp/vml/source/vmodf.cpp