BigInteger::Negate Method (BigInteger)

.NET Framework (current version)

Negates a specified BigInteger value.

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

Syntax

public:
static BigInteger Negate(
	BigInteger value
)

Parameters

value: Type: System.Numerics::BigInteger
The value to negate.

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 Negate method is a useful substitute for the negation operator when instantiating a BigInteger variable, as shown in the following example.

C++

No code example is currently available or this language may not be supported.

Examples

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

C++