std::atanh, std::atanhf, std::atanhl

Defined in header `<cmath>`
	(1)
float atanh ( float num ); double atanh ( double num ); long double atanh ( long double num );			(until C++23)
/* floating-point-type / atanh ( / floating-point-type */ num );			(since C++23) (constexpr since C++26)
float atanhf( float num );		(2)	(since C++11) (constexpr since C++26)
long double atanhl( long double num );		(3)	(since C++11) (constexpr since C++26)
Additional overloads (since C++11)
Defined in header `<cmath>`
template< class Integer > double atanh ( Integer num );		(A)	(constexpr since C++26)

1-3) 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. (since C++23)

A) Additional overloads are provided for all integer types, which are treated as double.

(since C++11)

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 (A). 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)).

Example

Run this code

#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 output:

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

External links

Weisstein, Eric W. "Inverse Hyperbolic Tangent." From MathWorld — A Wolfram Web Resource.

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Metaprogramming library (C++11)
Diagnostics library
General utilities library
Strings library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Numerics library
Localizations library
Input/output library
Filesystem library (C++17)
Regular expressions library (C++11)
Concurrency support library (C++11)
Technical specifications
Symbols index
External libraries

Common mathematical functions
Mathematical special functions (C++17)
Mathematical constants (C++20)
Floating-point environment (C++11)
Complex numbers
Numeric arrays
Pseudo-random number generation
Factor operations
gcd (C++17)
lcm (C++17)
Interpolations
midpoint (C++20)
lerp (C++20)
Generic numeric operations
iota (C++11)
ranges::iota (C++23)
accumulate
inner_product
adjacent_difference
partial_sum
reduce (C++17)
transform_reduce (C++17)
inclusive_scan (C++17)
exclusive_scan (C++17)
transform_inclusive_scan (C++17)
transform_exclusive_scan (C++17)
Bit operations
bit_cast (C++20)
byteswap (C++23)
has_single_bit (C++20)
bit_ceil (C++20)
bit_floor (C++20)
bit_width (C++20)
rotl (C++20)
rotr (C++20)
countl_zero (C++20)
countl_one (C++20)
countr_zero (C++20)
countr_one (C++20)
popcount (C++20)
endian (C++20)

asinhasinhfasinhl (C++11)(C++11)(C++11)	computes the inverse hyperbolic sine (\({\small\operatorname{arsinh}{x} }\) $arsinh(x)$ ) (function)
acoshacoshfacoshl (C++11)(C++11)(C++11)	computes the inverse hyperbolic cosine (\({\small\operatorname{arcosh}{x} }\) $arcosh(x)$ ) (function)
tanhtanhftanhl (C++11)(C++11)	computes hyperbolic tangent (\({\small\tanh{x} }\) $tanh(x)$ ) (function)
atanh(std::complex) (C++11)	computes area hyperbolic tangent of a complex number (\({\small\operatorname{artanh}{z} }\) $artanh(z)$ ) (function template)