abs

Computes absolute value of vector elements.

Syntax

Buffer API:

void abs(queue &exec_queue, int64_t n, buffer<T, 1> &a, buffer<T, 1> &y, uint64_t mode = mode::not_defined)

USM API:

event abs(queue &exec_queue, int64_t n, T *a, T *y, vector_class<event> *depends, uint64_t mode = mode::not_defined)

abs supports the following precisions.

T
float
double
std::complex<float>
std::complex<double>

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 size n.

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 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 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 size n.

USM API:

y

Pointer y to the output vector of size n.

return value (event)

Function end event.

Example

An example of how to use abs can be found in the oneMKL installation directory, under:

examples/sycl/vml/vabs.cpp

Parent topic: Arithmetic Functions