arg

arg#

Computes argument of vector elements.

Syntax

Buffer API:

namespace oneapi::mkl::vm {

sycl::event arg(
        sycl::queue& exec_queue,
        std::int64_t n,
        sycl::buffer<T,1>& a,
        sycl::buffer<R,1>& y,
        oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);

} // namespace oneapi::mkl::vm

USM API:

namespace oneapi::mkl::vm {

sycl::event arg(
        sycl::queue& exec_queue,
        std::int64_t n,
        const T *a,
        R* y,
        std::vector<sycl::event> const & depends = {},
        oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);

} // namespace oneapi::mkl::vm

arg supports the following precisions.

T	R
`std::complex<float>`	`float`
`std::complex<double>`	`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 oneapi::mkl::vm::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 oneapi::mkl::vm::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): Event, signifying availability of computed output and status code(s).

Exceptions

For list of generated exceptions please refer to Exceptions

Parent topic: VM Mathematical Functions