Complex.Negate(Complex) Method

Definition

Returns the additive inverse of a specified complex number.

public:
 static System::Numerics::Complex Negate(System::Numerics::Complex value);
public static System.Numerics.Complex Negate (System.Numerics.Complex value);
static member Negate : System.Numerics.Complex -> System.Numerics.Complex
Public Shared Function Negate (value As Complex) As Complex

Parameters

value
Complex

A complex number.

Returns

Complex

The result of the Real and Imaginary components of the value parameter multiplied by -1.

Examples

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

using System;
using System.Numerics;

public class Example
{
   public static void Main()
   {
      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)
         Console.WriteLine("{0} --> {1}", c1, Complex.Negate(c1));
   }
}
// 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)
Imports System.Numerics

Module Example
   Public Sub Main()
      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
         Console.WriteLine("{0} --> {1}", c1, Complex.Negate(c1))
      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)

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.

Applies to

See also