tanh

tanh#

Computes hyperbolic tangent of vector elements.

Syntax

Buffer API:

namespace oneapi::mkl::vm {

sycl::event tanh(
        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 tanh(
        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

tanh supports the following precisions.

T
`float`
`double`
`std::complex<float>`
`std::complex<double>`

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 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