numpy.tanh — NumPy v1.15 Manual (original) (raw)
numpy. tanh(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, _subok=True_[, signature, _extobj_]) = <ufunc 'tanh'>¶
Compute hyperbolic tangent element-wise.
Equivalent to np.sinh(x)/np.cosh(x) or -1j * np.tan(1j*x).
| Parameters: | x : array_like Input array. out : ndarray, None, or tuple of ndarray and None, optional A 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, optional Values of True indicate to calculate the ufunc at that position, values of False indicate to leave the value in the output alone. **kwargs For other keyword-only arguments, see theufunc docs. |
|---|---|
| Returns: | y : ndarray The 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)
References
| [1] | M. Abramowitz and I. A. Stegun, Handbook of Mathematical Functions. New York, NY: Dover, 1972, pg. 83.http://www.math.sfu.ca/~cbm/aands/ |
|---|
| [2] | Wikipedia, “Hyperbolic function”,http://en.wikipedia.org/wiki/Hyperbolic_function |
|---|
Examples
np.tanh((0, np.pi1j, np.pi1j/2)) array([ 0. +0.00000000e+00j, 0. -1.22460635e-16j, 0. +1.63317787e+16j])
Example of providing the optional output parameter illustrating
that what is returned is a reference to said parameter
out2 = np.tanh([0.1], out1) out2 is out1 True
Example of ValueError due to provision of shape mis-matched
outnp.tanh(np.zeros((3,3)),np.zeros((2,2))) Traceback (most recent call last): File "", line 1, in ValueError: invalid return array shape