scipp.atanh

scipp.atanh(x, *, out=None)

Element-wise inverse hyperbolic tangent.

The input unit must be dimensionless and values must be in (-1, 1).

Parameters:

• x (scipp.typing.VariableLike) – Input data.

• out (Optional[TypeVar(VariableLikeType, Variable, DataArray, Dataset, DataGroup[Any])], default: None) – Optional output buffer.

Returns:

Same type as input – The inverse hyperbolic tangent values of the input.

Examples

Compute the inverse hyperbolic tangent:

>>> import scipp as sc
>>> x = sc.array(dims=['x'], values=[-0.5, 0.0, 0.5])
>>> sc.atanh(x)
<scipp.Variable> (x: 3)    float64  [dimensionless]  [-0.549306, 0, 0.549306]

The domain is (-1, 1), and atanh(0) = 0.