nlcpy.tanh
- nlcpy.tanh = <ufunc 'nlcpy_tanh'>
Computes the element-wise hyperbolic tangent.
Equivalent to
vp.sinh(x)/vp.cosh(x)or-1j * vp.tan(1j*x).- Parameters
- xarray_like
Input an array or a scalar.
- outndarray or 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.
- wherearray_like, optional
This 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.- **kwargs
For other keyword-only arguments, see the section Optional Keyword Arguments.
- Returns
- yndarray
The hyperbolic tangent values for each element of x. If x is a scalar, this function returns the result as a 0-dimension ndarray.
See also
Examples
>>> import nlcpy as vp >>> vp.tanh((0, vp.pi*1j, vp.pi*1j/2)) array([0.+0.00000000e+00j, 0.-1.22464680e-16j, 0.+1.63312394e+16j]) >>> # Example of providing the optional output parameter >>> out1 = vp.array([0], dtype='d') >>> out2 = vp.tanh([0.1], out1) >>> out2 is out1 True