Share via

  • Article

Complex.Negate Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns the additive inverse of a specified complex number.

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

Syntax

'Declaration
Public Shared Function Negate ( _
    value As Complex _
) As Complex

public static Complex Negate(
    Complex value
)

Parameters

Return Value

Type: System.Numerics.Complex
The result of the Real and Imaginary components of the value parameter multiplied by -1.

Remarks

The additive inverse of a complex number is a complex number that produces a value of Zero when it is added to the original complex number. This method returns a complex number in which the real and imaginary components of the original complex number are multiplied by -1.

The Negate method is implemented for languages that do not support custom operators. Its behavior is identical to negation using the unary negation operator, UnaryNegation.

Examples

The following example obtains the additive inverse of each element in an array of complex numbers.

Imports System.Numerics

Module Example
   Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim values() As Complex = { Complex.One, 
                                  New Complex(-7.1, 2.5), 
                                  New Complex(1.3, -4.2), 
                                  New Complex(-3.3, -1.8) }
      For Each c1 In values
         outputBlock.Text += String.Format("{0} --> {1}", c1, Complex.Negate(c1)) & vbCrLf
      Next
   End Sub
End Module
' The example displays the following output:
'       (1, 0) --> (-1, 0)
'       (-7.1, 2.5) --> (7.1, -2.5)
'       (1.3, -4.2) --> (-1.3, 4.2)
'       (-3.3, -1.8) --> (3.3, 1.8)

using System;
using System.Numerics;

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      Complex[] values = { Complex.One, 
                          new Complex(-7.1, 2.5), 
                          new Complex(1.3, -4.2), 
                          new Complex(-3.3, -1.8) };
      foreach (Complex c1 in values)
         outputBlock.Text += String.Format("{0} --> {1}", c1, Complex.Negate(c1)) + "\n";
   }
}
// The example displays the following output:
//       (1, 0) --> (-1, 0)
//       (-7.1, 2.5) --> (7.1, -2.5)
//       (1.3, -4.2) --> (-1.3, 4.2)
//       (-3.3, -1.8) --> (3.3, 1.8)

Version Information

Silverlight

Supported in: 5, 4

Platforms

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