Complex<T>.Magnitude Property

Gets the modulus or absolute value of a complex number.

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.0
C#
public T Magnitude { get; }

Property Value

T
The modulus of the complex number.

Remarks

The modulus of a complex number is the square root of the sum of the squares of its real and imaginary elements.

If you set the modulus of complex Zero, the result is a real number. Setting the modulus to a negative number results in an exception.

This property requires that the operand type support real arithmetic.

Exceptions

ArgumentOutOfRangeException

The value provided for the modulus is negative.

See Also