Updated: October 26, 2022 |

*Compute the complex inverse hyperbolic tangent*

#include <complex.h> double complex catanh( double complexz); float complex catanhf( float complexz); long double complex catanhl( long double complexz);

`z`- The value that you want to get the complex inverse hyperbolic tangent of.

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

- If you want only selected processes to run with the SVE version, you can include both libraries in your OS image and use the -l m or -l m-sve option to qcc to link explicitly against the appropriate one.
- If you want all processes to use the SVE version, include libm-sve.so in your OS image and set up a symbolic link from libm.so to libm-sve.so. Use the -l m option to qcc to link against the library.

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

These functions compute the complex inverse hyperbolic tangent of `z`,
with branch cuts outside the interval [−1; +1] along the real axis.

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

- Call
`feclearexcept(FE_ALL_EXCEPT)`before calling catanh(), catanhf(), or catanhl(). - On return, if
`fetestexcept(FE_ALL_EXCEPT)`is nonzero, then an error has occurred.

The complex inverse hyperbolic tangent of `z`,
in the range of a half-strip mathematically unbounded along the real axis
and in the interval [−i`π`/2; +i`π`/2] along the imaginary axis.

If z is: |
These functions return: | Errors: |
---|---|---|

0 + 0i |
0 + 0i |
— |

0 + NaNi |
0 + NaNi |
— |

1 + 0i |
Inf + 0i |
FE_DIVBYZERO |

x + Infi, for any finite positive x |
0 + (π/2)i |
— |

x + NaNi, for any finite nonzero x |
NaN + NaNi |
— |

Inf + yi, for any finite positive y |
0 + (π/2)i |
— |

Inf + Infi |
0 + (π/2)i |
— |

Inf + NaNi |
0 + NaNi |
— |

NaN + yi, for any finite y |
NaN + NaNi |
— |

NaN + Infi |
±0 + (π/2)i, where the sign of the real part is unspecified |
— |

NaN + NaNi |
NaN + NaNi |
— |

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

Safety: | |
---|---|

Cancellation point | No |

Interrupt handler | Yes |

Signal handler | Yes |

Thread | Yes |