Complex.Negate(Complex) Method

Reference

Definition

Namespace:: System.Numerics

Assemblies:: System.Numerics.dll, System.Runtime.Numerics.dll

Assemblies:: netstandard.dll, System.Runtime.Numerics.dll

Assembly:: System.Runtime.Numerics.dll

Assembly:: System.Numerics.dll

Assembly:: netstandard.dll

Source:: Complex.cs

Source:: Complex.cs

Source:: Complex.cs

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.

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)

open System.Numerics

let values =
    [ Complex.One; Complex(-7.1, 2.5); Complex(1.3, -4.2); Complex(-3.3, -1.8) ]

for c1 in values do
    printfn $"{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 don't support custom operators. Its behavior is identical to negation using the unary negation operator, UnaryNegation.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

Share via