tanh¶
Computes hyperbolic tangent of vector elements.
Syntax
Buffer API:
-
void
tanh
(queue &exec_queue, int64_t n, buffer<T, 1> &a, buffer<T, 1> &y, uint64_t mode = mode::not_defined)¶
-
sycl::event tanh(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);)
USM API:
-
event tanh(queue& exec_queue, int64_t n, T\* a, T\* y, vector_class<event> const & depends = {}, uint64_t mode = mode::not_defined )
-
sycl::event
tanh
(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);¶
tanh
supports the following precisions and devices:
T |
Devices supported |
---|---|
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host |
|
Host |
Description
The tanh(a) function computes hyperbolic tangent of vector elements.
Argument |
Result |
Erro Code |
---|---|---|
+0 |
+0 |
|
-0 |
-0 |
|
+∞ |
+1 |
|
-∞ |
-1 |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
+i·∞ |
-1+i·0 |
QNAN+i·QNAN |
QNAN+i·QNAN |
QNAN+i·QNAN |
QNAN+i·QNAN |
+1+i·0 |
QNAN+i·QNAN |
+i·Y |
-1+i·0·Tan(Y) |
+1+i·0·Tan(Y) |
QNAN+i·QNAN |
||||
+i·0 |
-1+i·0 |
-0+i·0 |
+0+i·0 |
+1+i·0 |
QNAN+i·0 |
||
-i·0 |
-1-i·0 |
-0-i·0 |
+0-i·0 |
+1-i·0 |
QNAN-i·0 |
||
-i·Y |
-1+i·0·Tan(Y) |
+1+i·0·Tan(Y) |
QNAN+i·QNAN |
||||
-i·∞ |
-1-i·0 |
QNAN+i·QNAN |
QNAN+i·QNAN |
QNAN+i·QNAN |
QNAN+i·QNAN |
+1-i·0 |
QNAN+i·QNAN |
+i·NAN |
-1+i·0 |
QNAN+i·QNAN |
QNAN+i·QNAN |
QNAN+i·QNAN |
QNAN+i·QNAN |
+1+i·0 |
QNAN+i·QNAN |
Notes:
tanh(CONJ(a))=CONJ(tanh(a))
tanh(-a)=-tanh(a)
.
The tanh(a) 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 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
.
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
.
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 tanhcan be found in the Intel® oneMKL installation directory, under:
examples/dpcpp/vml/source/vtanh.cpp