catanh, catanhf, catanhl

Article
12/18/2017

The latest version of this topic can be found at catanh, catanhf, catanhl.

Retrieves the inverse hyperbolic tangent of a complex number, with branch cuts outside the interval [−1; +1] along the real axis.

Syntax

_Dcomplex catanh(   
   _Dcomplex z   
);  
_Fcomplex catanh(   
   _Fcomplex z   
);  // C++ only  
_Lcomplex catanh(   
   _Lcomplex z   
);  //  C++ only  
_Fcomplex catanhf(   
   _Fcomplex z   
);  
_Lcomplex catanhl(   
   _Lcomplex z   
);

Parameters

z
A complex number that represents an angle, in radians.

Return Value

The inverse hyperbolic tangent of z, in radians. The result is unbounded along the real axis, and in the interval [−iπ/2; +iπ/2] along the imaginary axis. A domain error will occur if z is outside the interval [-1, +1]. A pole error will occur if z is -1 or +1.

Remarks

Because C++ allows overloading, you can call overloads of catanh that take and return _Fcomplex and _Lcomplex values. In a C program, catanh always takes and returns a _Dcomplex value.

Requirements

Routine	C header	C++ header
`catanh`, `catanhf`, `catanhl`	<complex.h>	<ccomplex>

For more compatibility information, see Compatibility in the Introduction.

Share via