atanh(), atanhf(), atanhl()

Updated: April 19, 2023

Compute an inverse hyperbolic tangent

Synopsis:

#include <math.h>

double atanh( double x );

float atanhf( float x );

long double atanhl( long double x );

Arguments:

x
The value for which you want to compute the inverse hyperbolic tangent.

Library:

libm
The general-purpose math library.
libm-sve
(QNX Neutrino 7.1 or later) A library that optimizes the code for ARMv8.2 chips that have Scalable Vector Extension hardware.

Your system requirements will determine how you should work with these libraries:

Note: Compile your program with the -fno-builtin option to prevent the compiler from using a built-in version of the function.

Description:

These functions compute the inverse hyperbolic tangent of x.

To check for error situations, use feclearexcept() and fetestexcept(). For example:

Returns:

The inverse hyperbolic tangent of x.

If x is: These functions return: Errors:
±0.0 x
±1.0 Inf, with the same sign as x FE_DIVBYZERO
Finite and |x| > 1 NaN FE_INVALID
±Inf NaN FE_INVALID
NaN NaN

These functions raise FE_INEXACT if the FPU reports that the result can't be exactly represented as a floating-point number.

Examples:

#include <stdio.h>
#include <math.h>
#include <fenv.h>
#include <stdlib.h>

int main( void )
{
    int except_flags;

    feclearexcept(FE_ALL_EXCEPT);

    printf( "%f\n", atanh( 0.5 ) );

    except_flags = fetestexcept(FE_ALL_EXCEPT);
    if(except_flags) {
        /* An error occurred; handle it appropriately. */
    }

    return EXIT_SUCCESS;
}

produces the output:

0.549306

Classification:

C11, POSIX 1003.1

Safety:  
Cancellation point No
Interrupt handler Yes
Signal handler Yes
Thread Yes