arg¶

Computes argument of vector elements.

Syntax

Buffer API:

void arg(queue &exec_queue, int64_t n, buffer<A, 1> &a, buffer<R, 1> &y, uint64_t mode = mode::not_defined)¶

USM API:

event arg(queue &exec_queue, int64_t n, A *a, R *y, vector_class<event> *depends, uint64_t mode = mode::not_defined)¶

arg supports the following precisions.

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

Description

The arg(a) function computes argument of vector elements.

See Special Value Notations for the conventions used in the table below.

RE(a) i·IM(a)	-∞	-X	-0	+0	+X	+∞	NAN
+i·∞	+3·π/4	+π/2	+π/2	+π/2	+π/2	+π/4	NAN
+i·Y	+π		+π/2	+π/2		+0	NAN
+i·0	+π	+π	+π	+0	+0	+0	NAN
-i·0	-π	-π	-π	-0	-0	-0	NAN
-i·Y	-π		-π/2	-π/2		-0	NAN
-i·∞	-3·π/4	-π/2	-π/2	-π/2	-π/2	-π/4	NAN
+i·NAN	NAN	NAN	NAN	NAN	NAN	NAN	NAN

Note

arg(a)=atan2(IM(a),RE(a))

The arg 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:

USM API:

Example

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

examples/sycl/vml/varg.cpp

Parent topic: Arithmetic Functions