Complex.Magnitude Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the magnitude (or absolute value) of a complex number.
public:
property double Magnitude { double get(); };
public double Magnitude { get; }
member this.Magnitude : double
Public ReadOnly Property Magnitude As Double
Property Value
The magnitude of the current instance.
Examples
The following example calculates the absolute value of a complex number and demonstrates that it is equivalent to the value of the Magnitude property.
using System;
using System.Numerics;
public class Example
{
public static void Main()
{
Complex complex1 = new Complex(2.0, 3.0);
Console.WriteLine("|{0}| = {1:N2}", complex1, Complex.Abs(complex1));
Console.WriteLine("Equal to Magnitude: {0}",
Complex.Abs(complex1).Equals(complex1.Magnitude));
}
}
// The example displays the following output:
// |(2, 3)| = 3.61
// Equal to Magnitude: True
open System.Numerics
let complex1 = Complex(2., 3.)
printfn $"|{complex1}| = {Complex.Abs complex1:N2}"
printfn $"Equal to Magnitude: {Complex.Abs(complex1).Equals complex1.Magnitude}"
// The example displays the following output:
// |(2, 3)| = 3.61
// Equal to Magnitude: True
Remarks
The Magnitude property is equivalent to the absolute value of a complex number. It specifies the distance from the origin (the intersection of the x-axis and the y-axis in the Cartesian coordinate system) to the two-dimensional point represented by a complex number. The absolute value is calculated as follows:
$| a + bi | = \sqrt{a \times a + b \times b}$
If the calculation of the absolute value results in an overflow, this property returns either Double.PositiveInfinity or Double.NegativeInfinity.
The Magnitude and the Phase properties define the position of a point that represents a complex number in the polar coordinate system.
You can instantiate a complex number based on its polar coordinates instead of its Cartesian coordinates by calling the FromPolarCoordinates method.