Command:

ATANH(3P) POSIX Programmer's Manual ATANH(3P)PROLOGThis manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may dif- fer (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.NAMEatanh, atanhf, atanhl - inverse hyperbolic tangent functionsSYNOPSIS#include<math.h>doubleatanh(doublex);floatatanhf(floatx);longdoubleatanhl(longdoublex);DESCRIPTIONThese functions shall compute the inverse hyperbolic tangent of their argumentx. An application wishing to check for error situations should seterrnoto zero and callfeclearex-cept(FE_ALL_EXCEPT) before calling these functions. On return, iferrnois non-zero orfetestexcept(FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an error has occurred.RETURNVALUEUpon successful completion, these functions shall return the inverse hyperbolic tangent of their argument. Ifxis ?1, a pole error shall occur, andatanh(),atanhf(), andatanhl() 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. Ifxis NaN, a NaN shall be returned. Ifxis ?0,xshall be returned. Ifxis ?Inf, a domain error shall occur, and either a NaN (if supported), or an implementation-defined value shall be returned. Ifxis subnormal, a range error may occur andxshould be returned.ERRORSThese functions shall fail if: Domain Error Thexargument is finite and not in the range [-1,1], or is ?Inf. If the integer expression (math_errhandling & MATH_ERRNO) is non-zero, thenerrnoshall be set to [EDOM]. If the integer expression (math_errhandling & MATH_ERREXCEPT) is non-zero, then the invalid floating-point excep- tion shall be raised. Pole Error Thexargument is ?1. If the integer expression (math_errhandling & MATH_ERRNO) is non-zero, thenerrnoshall 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 ofxis subnormal. If the integer expression (math_errhandling & MATH_ERRNO) is non-zero, thenerrnoshall be set to [ERANGE]. If the integer expression (math_errhandling & MATH_ERREXCEPT) is non-zero, then the underflow floating-point exception shall be raised.Thefollowingsectionsareinformative.EXAMPLESNone.APPLICATIONUSAGEOn error, the expressions (math_errhandling & MATH_ERRNO) and (math_errhandling & MATH_ERREXCEPT) are indepen- dent of each other, but at least one of them must be non-zero.RATIONALENone.FUTUREDIRECTIONSNone.SEEALSOfeclearexcept(),fetestexcept(),tanh(), the Base Definitions volume of IEEE Std 1003.1-2001, Section 4.18, Treatment of Error Conditions for Mathematical Functions,<math.h>COPYRIGHTPortions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Stan- dard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifica- tions Issue 6, Copyright (C) 2001-2003 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 Stan- dard, 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 . IEEE/The Open Group 2003 ATANH(3P)