dpnp.tanh

dpnp.tanh(x, out=None, where=True, order='K', dtype=None, subok=True, **kwargs)

Computes the hyperbolic tangent for each element \(x_i\) for input array x.

The mathematical definition of the hyperbolic tangent is

\[\operatorname{tanh}(x) = \frac{\operatorname{sinh}(x)}{\operatorname{cosh}(x)}\]

For full documentation refer to numpy.tanh.

Parameters:

  • x ({dpnp.ndarray, usm_ndarray}) -- Input array, expected to have a floating-point data type.

  • out ({None, dpnp.ndarray, usm_ndarray}, optional) --

    Output array to populate. Array must have the correct shape and the expected data type.

    Default: None.

  • order ({None, "C", "F", "A", "K"}, optional) --

    Memory layout of the newly output array, if parameter out is None.

    Default: "K".

Returns:

out -- An array containing the element-wise hyperbolic tangent. The data type of the returned array is determined by the Type Promotion Rules.

Return type:

dpnp.ndarray

Limitations

Parameters where and subok are supported with their default values. Keyword argument kwargs is currently unsupported. Otherwise NotImplementedError exception will be raised.

See also

dpnp.atanh

Hyperbolic inverse tangent, element-wise.

dpnp.sinh

Hyperbolic sine, element-wise.

dpnp.cosh

Hyperbolic cosine, element-wise.

dpnp.tan

Trigonometric tangent, element-wise.

Examples

>>> import dpnp as np
>>> x = np.array([0, -np.pi, np.pi/2, np.pi])
>>> np.tanh(x)
array([0.0, -0.996272, 0.917152, 0.996272])