View source code
Display the source code in std/complex.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
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.sqAbs

T sqAbs(T) (
  Complex!T z
) pure nothrow @nogc @safe;

T sqAbs(T) (
  const T x
) pure nothrow @nogc @safe
if (isFloatingPoint!T);

Parameters

NameDescription
z A complex number.
x A real number.

Returns

The squared modulus of z. For genericity, if called on a real number, returns its square.

Example

import std.math.operations : isClose;
writeln(sqAbs(complex(0.0))); // 0.0
writeln(sqAbs(complex(1.0))); // 1.0
writeln(sqAbs(complex(0.0, 1.0))); // 1.0
assert(isClose(sqAbs(complex(1.0L, -2.0L)), 5.0L));
assert(isClose(sqAbs(complex(-3.0L, 1.0L)), 10.0L));
assert(isClose(sqAbs(complex(1.0f,-1.0f)), 2.0f));

Authors

Lars Tandle Kyllingstad, Don Clugston

License

Boost License 1.0