Display the source code in std/complex.d from which thispage was generated on github.

If you spot a problem with this page, click here to create aBugzilla 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 usinglocal clone.

Function `std.complex.abs`

Calculates the absolute value (or modulus) of a complex number.


						
				T abs(T)(
				
  Complex!T z
				

				) pure nothrow @nogc @safe;

normal case

Special Values
z	abs(z)	Notes
(0, 0)	0
(NaN, any) or (any, NaN)	NaN
(Inf, any) or (any, Inf)	Inf
(a, b)	hypot(a, b)	Uses algorithm to prevent overflow/underflow

Parameters

Name	Description
z	A complex number of type Complex!T

Returns

The absolute value (modulus) of z

Example

static import core.math;
writeln(abs(complex(1.0))); // 1.0
writeln(abs(complex(0.0, 1.0))); // 1.0
writeln(abs(complex(1.0L, -2.0L))); // core.math.sqrt(5.0L)

Authors

Lars Tandle Kyllingstad, Don Clugston

License

Boost License 1.0