atanh() [6/10]

template<typename T , require_complex_bt< std::is_arithmetic, T > * = nullptr>

auto stan::math::atanh ( T &&  x )

inline

Return the inverse hyperbolic tangent of the specified value.

Return the elementwise application of atanh() to specified argument container.

An argument of -1 returns negative infinity and an argument of 1 returns infinity. Returns nan for nan argument.

Parameters

[in]

x

complex<Arithmetic> Argument.

Returns

Inverse hyperbolic tangent of the argument.

Exceptions

std::domain_error

If argument is not in [-1, 1].

The return type promotes the underlying scalar argument type to double if it is an integer, and otherwise is the argument type.

Template Parameters

T	type of container

Parameters

x

container

Returns

Elementwise atanh of members of container.

Definition at line 48 of file atanh.hpp.