atan
atan#
Computes inverse tangent of vector elements.
Syntax
Buffer API:
namespace oneapi::mkl::vm {
sycl::event atan(
sycl::queue& exec_queue,
std::int64_t n,
sycl::buffer<T,1>& a,
sycl::buffer<T,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 atan(
sycl::queue& exec_queue,
std::int64_t n,
const T *a,
T* y,
std::vector<sycl::event> const & depends = {},
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);
} // namespace oneapi::mkl::vm
atan
supports the following precisions.
T |
---|
|
|
|
|
Description
The atan(a) function computes inverse tangent of vector elements.
Argument |
Result |
Status code |
---|---|---|
+0 |
+0 |
|
-0 |
-0 |
|
+∞ |
+ |
|
-∞ |
- |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
The atan function does not generate any errors.
Specifications for special values of the complex functions are defined according to the following formula
atan(a) = -i*atanh(i*a)
.
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
.- 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 sizen
.- 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 sizen
.
USM API:
- y
Pointer
y
to the output vector of sizen
.- 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