Atanh

Defined in header <cmath>.

Description

Computes the inverse hyperbolic tangent of num. The library provides overloads of std::atanh for all cv-unqualified floating-point types as the type of the parameter num (since C++23).

​Additional Overloads are provided for all integer types, which are treated as double.

Declarations

C++23

// 1)
/* floating-point-type */ atanh( /* floating-point-type */ num );
// 2)
float atanhf( float num );
// 3)
long double atanhl( long double num );

Additional Overloads

// 4)
template< class Integer >
double atanh ( Integer num );

C++11

//1 )
float atanh ( float num );
// 2)
double atanh ( double num );
// 3)
long double atanh ( long double num );
// 4)
float atanhf( float num );
// 5)
long double atanhl( long double num );

Additional Overloads

// 6)
template< class Integer >
double atanh ( Integer num );

Parameters

​num - floating-point or integer value

Return value

If no errors occur, the inverse hyperbolic tangent of num (tanh^-1(num), or artanh(num)), is returned.

If a domain error occurs, an implementation-defined value is returned (NaN where supported).

If a pole error occurs, ±HUGE_VAL, ±HUGE_VALF, or ±HUGE_VALL is returned (with the correct sign).

If a range error occurs due to underflow, the correct result (after rounding) is returned.

Error handling

Errors are reported as specified in math_errhandling.

If the argument is not on the interval [-1, +1], a range error occurs.

If the argument is ±1, a pole error occurs.

If the implementation supports IEEE floating-point arithmetic (IEC 60559):

if the argument is ±0, it is returned unmodified
if the argument is ±1, ±∞ is returned and FE_DIVBYZERO is raised
if |num|>1, NaN is returned and FE_INVALID is raised
if the argument is NaN, NaN is returned

Notes

Although the C standard (to which C++ refers for this function) names this function "arc hyperbolic tangent", the inverse functions of the hyperbolic functions are the area functions. Their argument is the area of a hyperbolic sector, not an arc. The correct name is "inverse hyperbolic tangent" (used by POSIX) or "area hyperbolic tangent".

POSIX specifies that in case of underflow, num is returned unmodified, and if that is not supported, an implementation-defined value no greater than DBL_MIN, FLT_MIN, and LDBL_MIN is returned.

The additional overloads are not required to be provided exactly as Additional Overloads. They only need to be sufficient to ensure that for their argument num of integer type,
std::atanh(num) has the same effect as std::atanh(static_cast<double>(num)).

Examples

#include <cerrno>
#include <cfenv>
#include <cfloat>
#include <cmath>
#include <cstring>
#include <iostream>
 
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout 
        << "atanh(0) = " 
        << std::atanh(0) << '\n'
        << "atanh(-0) = " 
        << std::atanh(-0.0) << '\n'
        << "atanh(0.9) = " 
        << std::atanh(0.9) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout 
        << "atanh(-1) = " 
        << std::atanh(-1) << '\n';
 
    if (errno == ERANGE)
        std::cout 
            << "errno == ERANGE: " 
            << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_DIVBYZERO))
        std::cout 
            << "FE_DIVBYZERO raised\n";
}

Possible Result

atanh(0) = 0
atanh(-0) = -0
atanh(0.9) = 1.47222
atanh(-1) = -inf
errno == ERANGE: Numerical result out of range
FE_DIVBYZERO raised