Display the source code in std/complex.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.complex.norm`

Extracts the norm of a complex number.


						
				T norm(T)
				(
				

				  Complex!T z
				

				) pure nothrow @nogc @safe;

Parameters

Name	Description
z	A complex number

Returns

The squared magnitude of z.

Example

import std.math : isClose, PI;
writeln(norm(complex(3.0, 4.0))); // 25.0
writeln(norm(fromPolar(5.0, 0.0))); // 25.0
assert(isClose(norm(fromPolar(5.0L, PI / 6)), 25.0L));
assert(isClose(norm(fromPolar(5.0L, 13 * PI / 6)), 25.0L));

Authors

Lars Tandle Kyllingstad, Don Clugston

License

Boost License 1.0