frac
Computes the element-wise signed fractional part of vector elements.
Description
The frac(a) function computes a signed fractional part for each vector element.
\[\begin{align}\begin{aligned}y_i =\\\begin{cases}\\\begin{split}a_i - \lfloor a_i \rfloor a_i, & \geq 0 \\ a_i - \lceil a_i \rceil, & a < 0\end{split}\\\end{cases}\end{aligned}\end{align}\]
\[\begin{align}\begin{aligned}y_i =\\\begin{cases}\\\begin{split} a_i - \lfloor a_i \rfloor a_i, & \geq 0 \\ a_i - \lceil a_i \rceil, & a < 0\end{split}\\\end{cases}\end{aligned}\end{align}\]
Argument |
Result |
Error Code |
|---|---|---|
+0 |
+0 |
|
-0 |
-0 |
|
+\(\infty\) |
+0 |
|
-\(\infty\) |
-0 |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
The frac function does not generate any errors.
API
Syntax
Buffer API
namespace oneapi::mkl::vm {
sycl::event frac(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);
}namespace oneapi::mkl::vm {
sycl::event frac(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
namespace oneapi::mkl::vm {
sycl::event frac(sycl::queue & exec_queue,
std::int64_t n,
T const * a,
T * y,
std::vector<sycl::event> const & depends = {},
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);
}namespace oneapi::mkl::vm {
sycl::event frac(sycl::queue & exec_queue,
T const * a,
oneapi::mkl::slice sa,
T * y,
oneapi::mkl::slice sy,
std::vector<sycl::event> const & depends = {},
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);
}frac supports the following precisions and devices:
T |
Devices supported |
|---|---|
sycl::half |
GPU |
_Float16 |
CPU |
float |
CPU and GPU |
double |
CPU and GPU |
Input Parameters
Buffer API
- exec_queue
-
The queue where the routine will be executed.
- n
-
Specifies the number of elements to be calculated.
- a
-
The buffer containing the input vector.
- 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.
- 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 will be executed.
- n
-
Specifies the number of elements to be calculated.
- a
-
Pointer to the input vector.
- 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.
- 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 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 frac can be found in the oneMKL installation directory, under:
share/doc/mkl/examples/sycl/vml/source/vfrac.cpp