You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Calculates an implementation-dependent approximation to the inverse hyperbolic tangent, having domain ``[-1, +1]`` and codomain ``[-infinity, +infinity]``, for each element ``x_i`` of the input array ``x``.
268
+
r"""
269
+
Calculates an implementation-dependent approximation to the inverse hyperbolic tangent for each element ``x_i`` of the input array ``x``.
270
270
271
271
**Special cases**
272
272
273
-
For floating-point operands,
273
+
For real-valued floating-point operands,
274
274
275
275
- If ``x_i`` is ``NaN``, the result is ``NaN``.
276
276
- If ``x_i`` is less than ``-1``, the result is ``NaN``.
For complex floating-point operands, ``atanh(conj(x))`` must equal ``conj(atanh(x))`` and ``atanh(-x)`` must equal ``-atanh(x)``.
310
+
311
+
.. note::
312
+
The inverse hyperbolic tangent is a multi-valued function and requires a branch cut on the complex plane. By convention, a branch cut is placed at the line segments :math:`(-\infty, 1]` and :math:`[1, \infty)` of the real axis.
313
+
314
+
Accordingly, for complex arguments, the function returns the inverse hyperbolic tangent in the range of a half-strip unbounded along the real axis and in the interval :math:`[-\pi j/2, +\pi j/2]` along the imaginary axis.
315
+
316
+
*Note: branch cuts have provisional status* (see :ref:`branch-cuts`).
317
+
283
318
Parameters
284
319
----------
285
320
x: array
286
-
input array whose elements each represent the area of a hyperbolic sector. Should have a real-valued floating-point data type.
321
+
input array whose elements each represent the area of a hyperbolic sector. Should have a floating-point data type.
287
322
288
323
Returns
289
324
-------
290
325
out: array
291
-
an array containing the inverse hyperbolic tangent of each element in ``x``. The returned array must have a real-valued floating-point data type determined by :ref:`type-promotion`.
326
+
an array containing the inverse hyperbolic tangent of each element in ``x``. The returned array must have a floating-point data type determined by :ref:`type-promotion`.
0 commit comments