PROLOG  NAME  SYNOPSIS  DESCRIPTION  RETURN VALUE  ERRORS  EXAMPLES  APPLICATION USAGE  RATIONALE  FUTURE DIRECTIONS  SEE ALSO  COPYRIGHT 


ATANH(3P) POSIX Programmer's Manual ATANH(3P)
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.
atanh, atanhf, atanhl — inverse hyperbolic tangent functions
#include <math.h> double atanh(double x); float atanhf(float x); long double atanhl(long double x);
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 nonzero or fetestexcept(FE_INVALID  FE_DIVBYZERO  FE_OVERFLOW  FE_UNDERFLOW) is nonzero, an error has occurred.
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 implementationdefined 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 implementationdefined value no greater in magnitude than DBL_MIN, FLT_MIN, and LDBL_MIN, respectively.
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 nonzero, then errno shall be set to [EDOM]. If the integer expression (math_errhandling & MATH_ERREXCEPT) is nonzero, then the invalid floatingpoint exception shall be raised. Pole Error The x argument is ±1. If the integer expression (math_errhandling & MATH_ERRNO) is nonzero, then errno shall be set to [ERANGE]. If the integer expression (math_errhandling & MATH_ERREXCEPT) is nonzero, then the dividebyzero floatingpoint 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 nonzero, then errno shall be set to [ERANGE]. If the integer expression (math_errhandling & MATH_ERREXCEPT) is nonzero, then the underflow floatingpoint exception shall be raised. The following sections are informative.
None.
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 nonzero.
None.
None.
feclearexcept(3p), fetestexcept(3p), tanh(3p) The Base Definitions volume of POSIX.1‐2017, Section 4.20, Treatment of Error Conditions for Mathematical Functions, math.h(0p)
Portions of this text are reprinted and reproduced in electronic
form from IEEE Std 1003.12017, Standard for Information
Technology  Portable Operating System Interface (POSIX), The
Open Group Base Specifications Issue 7, 2018 Edition, Copyright
(C) 2018 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any
discrepancy between this version and the original IEEE and The
Open Group Standard, the original IEEE and The Open Group
Standard is the referee document. The original Standard can be
obtained online at http://www.opengroup.org/unix/online.html .
Any typographical or formatting errors that appear in this page
are most likely to have been introduced during the conversion of
the source files to man page format. To report such errors, see
https://www.kernel.org/doc/manpages/reporting_bugs.html .
IEEE/The Open Group 2017 ATANH(3P)
Pages that refer to this page: math.h(0p), tanh(3p)