Export (0) Print
Expand All

Complex.Abs Method

Gets the absolute value (or magnitude) of a complex number.

Namespace:  System.Numerics
Assembly:  System.Numerics (in System.Numerics.dll)

public static double Abs(
	Complex value
)

Parameters

value
Type: System.Numerics.Complex

A complex number.

Return Value

Type: System.Double
The absolute value of value.

The absolute value of a complex number is equivalent to its Magnitude property. The absolute value of a real number a + bi is calculated as follows:

  • If b = 0, the result is 0.

  • If a > b, the result is a * Math.Sqrt(1 + b2/a2).

  • If b > a, the result is b * Math.Sqrt(1 + a2/b2).

If the calculation of the absolute value results in an overflow, the method returns either Double.PositiveInfinity or Double.NegativeInfinity. If either the Real or Imaginary property is Double.NaN and the other property is neither Double.PositiveInfinity nor Double.NegativeInfinity, the method returns Double.NaN.

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.60555127546399 
//       Equal to Magnitude: True

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Windows Phone 8.1, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft