abs¶
Computes absolute value of vector elements.
Syntax
Buffer API:
namespace oneapi::mkl::vm {
void abs(queue& exec_queue,
int64_t n,
buffer<T, 1>& a,
buffer<T, 1>& y,
uint64_t mode = mode::not_defined)
}
namespace oneapi::mkl::vm {
sycl::event abs(
sycl::queue & exec_queue,
sycl::buffer<T> & a,
oneapi::mkl::slice sa,
sycl::buffer<T> & y,
oneapi::mkl::slice sy, oneapi::mkl::vm::mode lib_mode =
oneapi::mkl::vm::mode::not_defined);
}
USM API:
namespace oneapi::mkl::vm {
event abs(
queue& exec_queue,
int64_t n, T* a, T* y,
vector_class<event> const & depends = {}, uint64_t mode = mode::not_defined )
}
namespace oneapi::mkl::vm {
sycl::event abs(
sycl::queue & exec_queue, T const * a,
oneapi::mkl::slice sa, 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);
}
abs
supports the following precisions and devices:
T |
Devices supported |
---|---|
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
Description
The abs(a) function computes an absolute value of vector elements.
Argument |
Result |
Error Code |
---|---|---|
+0 |
+0 |
|
-0 |
+0 |
|
+∞ |
+∞ |
|
-∞ |
+∞ |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
Specifications for special values of the complex functions are defined according to the following formula
abs(a) = hypot(RE(a),IM(a))
.
The abs 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.- 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.- 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
.
USM API:
- y
Pointer
y
to the output vector of sizen
.- return value (event)
Function end event.
Example
An example of how to use abscan be found in the Intel® oneMKL installation directory, under:
examples/dpcpp/vml/source/vabs.cpp