ctanh(), ctanhf(), ctanhl()
QNX SDP8.0C Library ReferenceAPIDeveloper
Compute the complex hyperbolic tangent
Synopsis:
#include <complex.h>
double complex ctanh( double complex z );
float complex ctanhf( float complex z );
long double complex ctanhl( long double complex z );
Arguments:
- z
- The value that you want to get the complex hyperbolic tangent of.
Library:
- libm
- The general-purpose math library.
- libm-sve
- 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.
Description:
These functions compute the complex hyperbolic tangent of the number specified by z.
To check for error situations, use feclearexcept() and fetestexcept(). For example:
- Call
feclearexcept(FE_ALL_EXCEPT)before calling ctanh(), ctanhf(), or ctanhl(). - On return, if
fetestexcept(FE_ALL_EXCEPT)is nonzero, then an error has occurred.
Returns:
The complex hyperbolic tangent of z.
| If z is: | These functions return: | Errors: |
|---|---|---|
| 0 + 0i | 0 + 0i | — |
| 0 + Infi | 0 + NaNi | FE_INVALID |
| x + Infi, for any nonzero, finite x | NaN + NaNi | FE_INVALID |
| 0 + NaNi | 0 + NaNi | — |
| x + NaNi, for any nonzero finite x | NaN + NaNi | — |
| Inf + yi, for any finite positive y | 1 + 0i | — |
| Inf + Infi | 1 ± 0i, where the sign of the imaginary part is unspecified | — |
| Inf + NaNi | 1 ± 0i, where the sign of the imaginary part is unspecified | — |
| NaN + 0i | NaN + 0i | — |
| NaN + yi, for any nonzero y | NaN + NaNi | — |
| 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.
Classification:
| Safety: | |
|---|---|
| Cancellation point | No |
| Signal handler | Yes |
| Thread | Yes |
Page updated: