atanh¶
Computes inverse hyperbolic tangent of vector elements.
Syntax
Buffer API:
namespace oneapi::mkl::vm {
void atanh(queue& exec_queue,
int64_t n,
buffer<T,1>& a,
buffer<T,1>& y,
uint64_t mode = mode::not_defined,
error_handler<T> errhandler = {});
}
namespace oneapi::mkl::vm {
sycl::event atanh(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, oneapi::mkl::vm::error_handler<T> eh = {});
}
USM API:
namespace oneapi::mkl::vm {
event atanh(queue& exec_queue,
int64_t n, T* a, T* y,
vector_class<event> const & depends = {},
uint64_t mode = mode::not_defined, error_handler<T> errhandler = {});
}
namespace oneapi::mkl::vm {
sycl::event atanh(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, oneapi::mkl::vm::error_handler<T> eh = {});
}
atanh
supports the following precisions and devices:
T |
Devices supported |
---|---|
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host |
|
Host |
Description
The atanh(a) function computes inverse hyperbolic tangent of vector elements.
Argument |
Result |
Error Code |
---|---|---|
+1 |
+∞ |
|
-1 |
-∞ |
|
|a| > 1 |
QNAN |
|
-∞ |
QNAN |
|
+∞ |
+∞ |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
RE(a) i·IM(a) |
-∞ |
-X |
-0 |
+0 |
+X |
+∞ |
NAN |
---|---|---|---|---|---|---|---|
+i·∞ |
-0+i· |
-0+i· |
-0+i· |
+0+i· |
+0+i· |
+0+i· |
+0+i· |
+i·Y |
-0+i· |
+0+i· |
QNAN+i·QNAN |
||||
+i·0 |
-0+i· |
-0+i·0 |
+0+i·0 |
+0+i· |
QNAN+i·QNAN |
||
-i·0 |
-0-i· |
-0-i·0 |
+0-i·0 |
+0-i· |
QNAN-i·QNAN |
||
-i·Y |
-0-i· |
+0-i· |
QNAN+i·QNAN |
||||
-i·∞ |
-0-i· |
-0-i· |
-0-i· |
+0-i· |
+0-i· |
+0-i· |
+0-i· |
+i·NAN |
-0+i·QNAN |
QNAN+i·QNAN |
-0+i·QNAN |
+0+i·QNAN |
QNAN+i·QNAN |
+0+i·QNAN |
QNAN+i·QNAN |
Notes:
atanh(±1±i*0)=±∞±i*0
, and status::sing error is generatedatanh(CONJ(a))=CONJ(atanh(a))
atanh(-a)=-atanh(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
.- 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
.- errhandler
Sets local error handling mode for this function call. See the create_error_handler function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.
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
.- errhandler
Sets local error handling mode for this function call. See the create_error_handler function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.
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 atanhcan be found in the Intel® oneMKL installation directory, under:
examples/dpcpp/vml/source/vatanh.cpp