bundles / numpy 2.4.3 / numpy / ma / core / tanh
_MaskedUnaryOperation
numpy.ma.core:tanh
source: /numpy/ma/core.py
Summary
Compute hyperbolic tangent element-wise.
Extended Summary
Equivalent to np.sinh(x)/np.cosh(x) or -1j * np.tan(1j*x).
Parameters
x: array_likeInput array.
out: ndarray, None, or tuple of ndarray and None, optionalA location into which the result is stored. If provided, it must have a shape that the inputs broadcast to. If not provided or None, a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs.
where: array_like, optionalThis condition is broadcast over the input. At locations where the condition is True, the out array will be set to the ufunc result. Elsewhere, the out array will retain its original value. Note that if an uninitialized out array is created via the default
out=None, locations within it where the condition is False will remain uninitialized.**kwargsFor other keyword-only arguments, see the
ufunc docs <ufuncs.kwargs>.
Returns
y: ndarrayThe corresponding hyperbolic tangent values. This is a scalar if x is a scalar.
Notes
If out is provided, the function writes the result into it, and returns a reference to out. (See Examples)
Examples
import numpy as np np.tanh((0, np.pi*1j, np.pi*1j/2))
out1 = np.array([0], dtype='d') out2 = np.tanh([0.1], out1) out2 is out1
np.tanh(np.zeros((3,3)),np.zeros((2,2)))
Aliases
-
numpy.ma.tanh