Display the source code in std/math.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Function `std.math.atanh`

Calculates the inverse hyperbolic tangent of x, returning a value from ranging from -1 to 1.


						
				real atanh
				(
				

				  real x
				

				) pure nothrow @nogc @safe;
				

				

				double atanh
				(
				

				  double x
				

				) pure nothrow @nogc @safe;
				

				

				float atanh
				(
				

				  float x
				

				) pure nothrow @nogc @safe;

Mathematically, atanh(x) = log( (1+x)/(1-x) ) / 2

Domain X	Range Y
-∞..∞	-1 .. 1

Special Values
x	acosh(x)
NAN	NAN
±0	±0
-∞	-0

Example

assert(isIdentical(atanh(0.0), 0.0));
assert(isIdentical(atanh(-0.0),-0.0));
assert(isNaN(atanh(real.nan)));
assert(isNaN(atanh(-real.infinity)));
writeln(atanh(0.0)); // 0

Authors

Walter Bright, Don Clugston, Conversion of CEPHES math library to D by Iain Buclaw and David Nadlinger

License

Boost License 1.0.