# atanh

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           atanh, atanhf, atanhl — inverse hyperbolic tangent functions
    


## SYNOPSIS



           #include <math.h>
    
           double atanh(double _x_);
           float atanhf(float _x_);
           long double atanhl(long double _x_);
    


## DESCRIPTION



           The functionality described on this reference page is aligned with
           the ISO C standard. Any conflict between the requirements
           described here and the ISO C standard is unintentional. This
           volume of POSIX.1‐2017 defers to the ISO C standard.
    
           These functions shall compute the inverse hyperbolic tangent of
           their argument _x_.
    
           An application wishing to check for error situations should set
           _errno_ to zero and call _feclearexcept_(FE_ALL_EXCEPT) before calling
           these functions. On return, if _errno_ is non-zero or
           _fetestexcept_(FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW |
           FE_UNDERFLOW) is non-zero, an error has occurred.
    


## RETURN VALUE



           Upon successful completion, these functions shall return the
           inverse hyperbolic tangent of their argument.
    
           If _x_ is ±1, a pole error shall occur, and _atanh_(), _atanhf_(), and
           _atanhl_() shall return the value of the macro HUGE_VAL, HUGE_VALF,
           and HUGE_VALL, respectively, with the same sign as the correct
           value of the function.
    
           For finite |_x_ |>1, a domain error shall occur, and either a NaN (if
           supported), or an implementation-defined value shall be returned.
    
           If _x_ is NaN, a NaN shall be returned.
    
           If _x_ is ±0, _x_ shall be returned.
    
           If _x_ is ±Inf, a domain error shall occur, and a NaN shall be
           returned.
    
           If _x_ is subnormal, a range error may occur
           and _x_ should be returned.
    
           If _x_ is not returned, _atanh_(), _atanhf_(), and _atanhl_() shall return
           an implementation-defined value no greater in magnitude than
           DBL_MIN, FLT_MIN, and LDBL_MIN, respectively.
    


## ERRORS



           These functions shall fail if:
    
           Domain Error
                       The _x_ argument is finite and not in the range [-1,1],
                       or is ±Inf.
    
                       If the integer expression (_math_errhandling_ &
                       MATH_ERRNO) is non-zero, then _errno_ shall be set to
                       **[EDOM]**.  If the integer expression (_math_errhandling_ &
                       MATH_ERREXCEPT) is non-zero, then the invalid
                       floating-point exception shall be raised.
    
           Pole Error  The _x_ argument is ±1.
    
                       If the integer expression (_math_errhandling_ &
                       MATH_ERRNO) is non-zero, then _errno_ shall be set to
                       **[ERANGE]**.  If the integer expression (_math_errhandling_
                       & MATH_ERREXCEPT) is non-zero, then the divide-by-zero
                       floating-point exception shall be raised.
    
           These functions may fail if:
    
           Range Error The value of _x_ is subnormal.
    
                       If the integer expression (_math_errhandling_ &
                       MATH_ERRNO) is non-zero, then _errno_ shall be set to
                       **[ERANGE]**.  If the integer expression (_math_errhandling_
                       & MATH_ERREXCEPT) is non-zero, then the underflow
                       floating-point exception shall be raised.
    
           _The following sections are informative._
    


## EXAMPLES



           None.
    


## APPLICATION USAGE



           On error, the expressions (_math_errhandling_ & MATH_ERRNO) and
           (_math_errhandling_ & MATH_ERREXCEPT) are independent of each other,
           but at least one of them must be non-zero.
    


## RATIONALE



           None.
    


## FUTURE DIRECTIONS



           None.
    


* * *