Developer Reference for Intel® oneAPI Math Kernel Library for C
v?Tanh
vsTanh vdTanh vcTanh vzTanh vmsTanh vmdTanh vmcTanh vmzTanh Computes hyperbolic tangent of vector elements.
Syntax
vhTanh ( n , a , y ) ;
vhTanhI(n, a, inca, y, incy);
vmhTanh ( n , a , y , mode ) ;
vmhTanhI(n, a, inca, y, incy, mode);
vsTanh ( n , a , y ) ;
vsTanhI(n, a, inca, y, incy);
vmsTanh ( n , a , y , mode ) ;
vmsTanhI(n, a, inca, y, incy, mode);
vdTanh ( n , a , y ) ;
vdTanhI(n, a, inca, y, incy);
vmdTanh ( n , a , y , mode ) ;
vmdTanhI(n, a, inca, y, incy, mode);
vcTanh ( n , a , y ) ;
vcTanhI(n, a, inca, y, incy);
vmcTanh ( n , a , y , mode ) ;
vmcTanhI(n, a, inca, y, incy, mode);
vzTanh ( n , a , y ) ;
vzTanhI(n, a, inca, y, incy);
vmzTanh ( n , a , y , mode ) ;
vmzTanhI(n, a, inca, y, incy, mode);
Include Files
mkl.h
Input Parameters
Name |
Type |
Description |
|---|---|---|
n |
const MKL_INT |
Specifies the number of elements to be calculated. |
a |
const _Float16* for vhTanh , vmhTanh const float* for vsTanh , vmsTanh const double* for vdTanh , vmdTanh const MKL_Complex8* for vcTanh , vmcTanh const MKL_Complex16* for vzTanh , vmzTanh |
Pointer to an array that contains the input vector a . |
inca , incy |
const MKL_INT |
Specifies increments for the elements of a and y . |
mode |
const MKL_INT64 |
Overrides global VM mode setting for this function call. See vmlSetMode (Sets a new mode for VM functions according to the mode parameter and stores the previous VM mode to oldmode.) for possible values and their description. |
Output Parameters
Name |
Type |
Description |
|---|---|---|
y |
_Float16* for vhTanh , vmhTanh float* for vsTanh , vmsTanh double* for vdTanh , vmdTanh MKL_Complex8* for vcTanh , vmcTanh MKL_Complex16* for vzTanh , vmzTanh |
Pointer to an array that contains the output vector y . |
Description
The v?Tanh function computes hyperbolic tangent of vector elements.
Special Values for Real Function v?Tanh(x)
Argument |
Result |
Exception |
|---|---|---|
+0 |
+0 |
|
-0 |
-0 |
|
|
+1 |
|
|
-1 |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
INVALID |
See Special Value Notations for the conventions used in the table below.
Special Values for Complex Function v?Tanh(z)
RE(z) i · IM(z) |
|
-X |
-0 |
+0 |
+X |
|
NAN |
|---|---|---|---|---|---|---|---|
+i · ∞ |
-1+i · 0 |
QNAN+i · QNAN INVALID |
QNAN+i · QNAN INVALID |
QNAN+i · QNAN INVALID |
QNAN+i · QNAN INVALID |
+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 INVALID |
QNAN+i · QNAN INVALID |
QNAN+i · QNAN INVALID |
QNAN+i · QNAN INVALID |
+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:
raises INVALID exception when real or imaginary part of the argument is SNAN
\(Tanh(CONJ(z))=CONJ(Tanh(z))\)
\(Tanh(-z)=-Tanh(z)\) .