BigInteger.Negate Method

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

Negates a specified BigInteger value.

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

Syntax

'Declaration
Public Shared Function Negate ( _
    value As BigInteger _
) As BigInteger
public static BigInteger Negate(
    BigInteger value
)

Parameters

Return Value

Type: System.Numerics.BigInteger
The result of the value parameter multiplied by negative one (-1).

Remarks

Negation obtains the additive inverse of a number. The additive inverse of a number is a number that produces a value of zero when it is added to the original number.

The Negate method is implemented for languages that do not support custom operators. Its behavior is identical to negation using the unary negation operator. In addition, the Multiply method is a useful substitute for the negation operator when instantiating a BigInteger variable, as shown in the following example.

' The statement
'    Dim number As BigInteger = -Int64.MinValue
' produces compiler error BC30439: Constant expression not representable in type 'Long'.
' The alternative:
Dim number As BigInteger = BigInteger.Negate(Int64.MinValue)
// The statement
//    BigInteger number = -Int64.MinValue;
// produces compiler error CS0220: The operation overflows at compile time in checked mode.
// The alternative:
BigInteger number = BigInteger.Negate(Int64.MinValue);

Examples

The following example illustrates three ways to negate the value of a BigInteger object.

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.