# Complex Structure

**Silverlight**

Represents a complex number.

**Namespace:**System.Numerics

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

The Complex type exposes the following members.

Name | Description | |
---|---|---|

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

Acos | Returns the angle that is the arc cosine of the specified complex number. | |

Add | Adds two complex numbers and returns the result. | |

Asin | Returns the angle that is the arc sine of the specified complex number. | |

Atan | Returns the angle that is the arc tangent of the specified complex number. | |

Conjugate | Computes the conjugate of a complex number and returns the result. | |

Cos | Returns the cosine of the specified complex number. | |

Cosh | Returns the hyperbolic cosine of the specified complex number. | |

Divide | Divides one complex number by another and returns the result. | |

Equals(Complex) | Returns a value that indicates whether the current instance and a specified complex number have the same value. | |

Equals(Object) | Returns a value that indicates whether the current instance and a specified object have the same value. (Overrides ValueType.Equals(Object).) | |

Exp | Returns e raised to the power specified by a complex number. | |

Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |

FromPolarCoordinates | Creates a complex number from a point's polar coordinates. | |

GetHashCode | Returns the hash code for the current Complex object. (Overrides ValueType.GetHashCode.) | |

GetType | Gets the Type of the current instance. (Inherited from Object.) | |

Log(Complex) | Returns the natural (base e) logarithm of a specified complex number. | |

Log(Complex, Double) | Returns the logarithm of a specified complex number in a specified base. | |

Log10 | Returns the base-10 logarithm of a specified complex number. | |

MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |

Multiply | Returns the product of two complex numbers. | |

Negate | Returns the additive inverse of a specified complex number. | |

Pow(Complex, Double) | Returns a specified complex number raised to a power specified by a double-precision floating-point number. | |

Pow(Complex, Complex) | Returns a specified complex number raised to a power specified by a complex number. | |

Reciprocal | Returns the multiplicative inverse of a complex number. | |

Sin | Returns the sine of the specified complex number. | |

Sinh | Returns the hyperbolic sine of the specified complex number. | |

Sqrt | Returns the square root of a specified complex number. | |

Subtract | Subtracts one complex number from another and returns the result. | |

Tan | Returns the tangent of the specified complex number. | |

Tanh | Returns the hyperbolic tangent of the specified complex number. | |

ToString | Converts the value of the current complex number to its equivalent string representation in Cartesian form. (Overrides ValueType.ToString.) | |

ToString(IFormatProvider) | Converts the value of the current complex number to its equivalent string representation in Cartesian form by using the specified culture-specific formatting information. | |

ToString(String) | Converts the value of the current complex number to its equivalent string representation in Cartesian form by using the specified format for its real and imaginary parts. | |

ToString(String, IFormatProvider) | Converts the value of the current complex number to its equivalent string representation in Cartesian form by using the specified format and culture-specific format information for its real and imaginary parts. |

Name | Description | |
---|---|---|

Addition | Adds two complex numbers. | |

Division | Divides a specified complex number by another specified complex number. | |

Equality | Returns a value that indicates whether two complex numbers are equal. | |

Narrowing(BigInteger to Complex) | Defines an explicit conversion of a BigInteger value to a complex number. | |

Narrowing(Decimal to Complex) | Defines an explicit conversion of a Decimal value to a complex number. | |

Widening(Byte to Complex) | Defines an implicit conversion of an unsigned byte to a complex number. | |

Widening(Double to Complex) | Defines an implicit conversion of a double-precision floating-point number to a complex number. | |

Widening(Int16 to Complex) | Defines an implicit conversion of a 16-bit signed integer to a complex number. | |

Widening(Int32 to Complex) | Defines an implicit conversion of a 32-bit signed integer to a complex number. | |

Widening(Int64 to Complex) | Defines an implicit conversion of a 64-bit signed integer to a complex number. | |

Widening(SByte to Complex) | Defines an implicit conversion of a signed byte to a complex number. | |

Widening(Single to Complex) | Defines an implicit conversion of a single-precision floating-point number to a complex number. | |

Widening(UInt16 to Complex) | Defines an implicit conversion of a 16-bit unsigned integer to a complex number. | |

Widening(UInt32 to Complex) | Defines an implicit conversion of a 32-bit unsigned integer to a complex number. | |

Widening(UInt64 to Complex) | Defines an implicit conversion of a 64-bit unsigned integer to a complex number. | |

Inequality | Returns a value that indicates whether two complex numbers are not equal. | |

Multiply | Multiplies two specified complex numbers. | |

Subtraction | Subtracts a complex number from another complex number. | |

UnaryNegation | Returns the additive inverse of a specified complex number. |

Name | Description | |
---|---|---|

ImaginaryOne | Returns a new Complex instance with a real number equal to zero and an imaginary number equal to one. | |

One | Returns a new Complex instance with a real number equal to one and an imaginary number equal to zero. | |

Zero | Returns a new Complex instance with a real number equal to zero and an imaginary number equal to zero. |

A complex number is a number that comprises a real number part and an imaginary number part. A complex number z is usually written in the form z = x + yi, where x and y are real numbers, and i is the imaginary unit that has the property i2 = -1. The real part of the complex number is represented by x, and the imaginary part of the complex number is represented by y.

The Complex type uses the Cartesian coordinate system (real, imaginary) when instantiating and manipulating complex numbers. A complex number can be represented as a point in a two-dimensional coordinate system, which is known as the complex plane. The real part of the complex number is positioned on the x-axis (the horizontal axis), and the imaginary part is positioned on the y-axis (the vertical axis).

Any point in the complex plane can also be expressed based on its absolute value, by using the polar coordinate system., In polar coordinates, a point is characterized by two numbers:

Its magnitude, which is the distance of the point from the origin (that is, 0,0, or the point at which the x-axis and the y-axis intersect).

Its phase, which is the angle between the real axis and the line drawn from the origin to the point.

### Instantiating a Complex Number

You can assign a value to a complex number in one of the following ways:

By passing two Double values to its constructor. The first value represents the real part of the complex number, and the second value represents its imaginary part. These values represent the position of the complex number in the two-dimensional Cartesian coordinate system.

By calling the static (Shared in Visual Basic) Complex.FromPolarCoordinates method to create a complex number from its polar coordinates.

By assigning a Byte, SByte, Int16, UInt16, Int32, UInt32, Int64, UInt64, Single, or Double value to a Complex object. The value becomes the real part of the complex number, and its imaginary part equals 0.

By casting (in C#) or converting (in Visual Basic) a Decimal or BigInteger value to a Complex object. The value becomes the real part of the complex number, and its imaginary part equals 0.

By assigning the complex number that is returned by a method or operator to a Complex object. For example, Complex.Add is a static method that returns a complex number that is the sum of two complex numbers, and the Complex.Addition operator adds two complex numbers and returns the result.

The following example demonstrates each of these five ways of assigning a value to a complex number.

Imports System.Numerics Module Example Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock) ' Create a complex number by calling its class constructor. Dim c1 As New Complex(12, 6) outputBlock.Text &= c1.ToString() & vbCrLf ' Assign a Double to a complex number. Dim c2 As Complex = 3.14 outputBlock.Text &= c2.ToString() & vbCrLf ' Cast a Decimal to a complex number. Dim c3 As Complex = CType(12.3D, Complex) outputBlock.Text &= c3.ToString() & vbCrLf ' Assign the return value of a method to a Complex variable. Dim c4 As Complex = Complex.Pow(Complex.One, -1) outputBlock.Text &= c4.ToString() & vbCrLf ' Assign the value returned by an operator to a Complex variable. Dim c5 As Complex = Complex.One + Complex.One outputBlock.Text &= c5.ToString() & vbCrLf ' Instantiate a complex number from its polar coordinates. Dim c6 As Complex = Complex.FromPolarCoordinates(10, 0.524) outputBlock.Text &= c6.ToString() & vbCrLf End Sub End Module ' The example displays the following output: ' (12, 6) ' (3.14, 0) ' (12.3000001907349, 0) ' (1, 0) ' (2, 0) ' (8.65824721882145, 5.00347430269914)

### Operations with Complex Numbers

The Complex structure in the .NET Framework includes members that provide the following functionality:

Methods to compare two complex numbers to determine whether they are equal.

Operators to perform arithmetic operations on complex numbers. Complex operators enable you to perform addition, subtraction, multiplication, division, and unary negation with complex numbers.

Methods to perform other numerical operations on complex numbers. In addition to the four basic arithmetic operations, you can raise a complex number to a specified power, find the square root of a complex number, and get the absolute value of a complex number.

Methods to perform trigonometric operations on complex numbers. For example, you can calculate the tangent of an angle represented by a complex number.

### Precision and Complex Numbers

The real and imaginary parts of a complex number are represented by two double-precision floating-point values. This means that Complex values, like double-precision floating-point values, can lose precision as a result of numerical operations. This means that strict comparisons for equality of two Complex values may fail, even if the difference between the two values is due to a loss of precision. For more information, see Double.

For example, performing exponentiation on the logarithm of a number should return the original number. However, in some cases, the loss of precision of floating-point values can cause slight differences between the two values, as the following example illustrates.

Dim value As New Complex(Double.MinValue/2, Double.MinValue/2) Dim value2 As Complex = Complex.Exp(Complex.Log(value)) outputBlock.Text += String.Format("{0} {3}{1} {3}Equal: {2}{3}", value, value2, value = value2, vbCrLf) ' The example displays the following output: ' (-8.98846567431158E+307, -8.98846567431158E+307) ' (-8.98846567431161E+307, -8.98846567431161E+307) ' Equal: False

### Complex Numbers, Infinity, and NaN

The real and imaginary parts of a complex number are represented by Double values. In addition to ranging from Double.MinValue to Double.MaxValue, the real or imaginary part of a complex number can have a value of Double.PositiveInfinity, Double.NegativeInfinity, or Double.NaN. Double.PositiveInfinity, Double.NegativeInfinity, and Double.NaN all propagate in any arithmetic or trigonometric operation.

In the following example, division by Zero produces a complex number whose real and imaginary parts are both Double.NaN. As a result, performing multiplication with this value also produces a complex number whose real and imaginary parts are Double.NaN. Similarly, performing a multiplication that overflows the range of the Double type produces a complex number whose real part is Double.NaN and whose imaginary part is Double.PositiveInfinity. Subsequently performing division with this complex number returns a complex number whose real part is Double.NaN and whose imaginary part is Double.PositiveInfinity.

Imports System.Numerics Module Example Public Sub Demo(outputBlock As System.Windows.Controls.TextBlock) Dim c1 As Complex = New Complex(Double.MaxValue / 2, Double.MaxValue /2) Dim c2 As Complex = c1 / Complex.Zero outputBlock.Text += c2.ToString() + vbCrLf c2 = c2 * New Complex(1.5, 1.5) outputBlock.Text += c2.ToString() + vbCrLf + vbCrLf Dim c3 As Complex = c1 * New Complex(2.5, 3.5) outputBlock.Text += c3.ToString() + vbCrLf c3 = c3 + New Complex(Double.MinValue / 2, Double.MaxValue / 2) outputBlock.Text += c3.ToString() End Sub End Module ' The example displays the following output: ' (NaN, NaN) ' (NaN, NaN) ' ' (NaN, Infinity) ' (NaN, Infinity)

Mathematical operations with complex numbers that are invalid or that overflow the range of the Double data type do not throw an exception. Instead, they return a Double.PositiveInfinity, Double.NegativeInfinity, or Double.NaN under the following conditions:

The division of a positive number by zero returns Double.PositiveInfinity.

Any operation that overflows the upper bound of the Double data type returns Double.PositiveInfinity.

The division of a negative number by zero returns Double.NegativeInfinity.

Any operation that overflows the lower bound of the Double data type returns Double.NegativeInfinity.

The division of a zero by zero returns Double.NaN.

Any operation that is performed on operands whose values are Double.PositiveInfinity, Double.NegativeInfinity, or Double.NaN returns Double.PositiveInfinity, Double.NegativeInfinity, or Double.NaN, depending on the specific operation.

Note that this applies to any intermediate calculations performed by a method. For example, the multiplication of new Complex(9e308, 9e308) and new Complex(2.5, 3.5) uses the formula (ac - bd) + (ad + bc)i. The calculation of the real component that results from the multiplication evaluates the expression 9e308 * 2.5 - 9e308 * 3.5. Each intermediate multiplication in this expression returns Double.PositiveInfinity, and the attempt to subtract Double.PositiveInfinity from Double.PositiveInfinity returns Double.NaN.

### Formatting a Complex Number

By default, the string representation of a complex number takes the form (real, imaginary), where real and imaginary are the string representations of the Double values that form the complex number's real and imaginary components. Some overloads of the ToString method allow customization of the string representations of these Double values to reflect the formatting conventions of a particular culture or to appear in a particular format defined by a standard or custom numeric format string. (For more information, see Standard Numeric Format Strings and Custom Numeric Format Strings.)

One of the more common ways of expressing the string representation of a complex number takes the form a + bi, where a is the complex number's real component, and b is the complex number's imaginary component. In electrical engineering, a complex number is most commonly expressed as a + bj. You can return the string representation of a complex number in either of these two forms. To do this, define a custom format provider by implementing the ICustomFormatter and IFormatProvider interfaces, and then call the String.Format(IFormatProvider, String, Object()) method.

The following example defines a ComplexFormatter class that represents a complex number as a string in the form of either a + bi or a + bj.

Imports System.Numerics Public Class ComplexFormatter Implements IFormatProvider, ICustomFormatter Public Function GetFormat(formatType As Type) As Object _ Implements IFormatProvider.GetFormat If formatType Is GetType(ICustomFormatter) Then Return Me Else Return Nothing End If End Function Public Function Format(fmt As String, arg As Object, provider As IFormatProvider) As String _ Implements ICustomFormatter.Format If TypeOf arg Is Complex Then Dim c1 As Complex = DirectCast(arg, Complex) ' Check if the format string has a precision specifier. Dim precision As Integer Dim fmtString As String = String.Empty If fmt.Length > 1 Then Try precision = Int32.Parse(fmt.Substring(1)) Catch e As FormatException precision = 0 End Try fmtString = "N" + precision.ToString() End If If fmt.Substring(0, 1).Equals("I", StringComparison.OrdinalIgnoreCase) Then Return c1.Real.ToString(fmtString) + " + " + c1.Imaginary.ToString(fmtString) + "i" ElseIf fmt.Substring(0, 1).Equals("J", StringComparison.OrdinalIgnoreCase) Then Return c1.Real.ToString(fmtString) + " + " + c1.Imaginary.ToString(fmtString) + "j" Else Return c1.ToString(fmt, provider) End If Else If Typeof arg Is IFormattable Then Return DirectCast(arg, IFormattable).ToString(fmt, provider) ElseIf arg IsNot Nothing Then Return arg.ToString() Else Return String.Empty End If End If End Function End Class

The following example then uses this custom formatter to display the string representation of a complex number.

Module Example Public Sub Demo(outputBlock As System.Windows.Controls.TextBlock) Dim c1 As Complex = New Complex(12.1, 15.4) outputBlock.Text += "Formatting with ToString(): " + c1.ToString() + vbCrLf outputBlock.Text += "Formatting with ToString(format): " + c1.ToString("N2") + vbCrLf outputBlock.Text += "Custom formatting with I0: " + String.Format(New ComplexFormatter(), "{0:I0}", c1) + vbCrLf outputBlock.Text += "Custom formatting with J3: " + String.Format(New ComplexFormatter(), "{0:J3}", c1) + vbCrLf End Sub End Module ' The example displays the following output: ' Formatting with ToString(): (12.1, 15.4) ' Formatting with ToString(format): (12.10, 15.40) ' Custom formatting with I0: 12 + 15i ' Custom formatting with J3: 12.100 + 15.400j

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.