BigInteger.Decrement(BigInteger) Operator

Definition

Namespace:

System.Numerics

Assemblies:

netstandard.dll, System.Runtime.Numerics.dll

Source:

BigInteger.cs

Decrements a BigInteger value by 1.

C#

public static System.Numerics.BigInteger operator --(System.Numerics.BigInteger value);

Parameters

value

BigInteger

The value to decrement.

Returns

BigInteger

The value of the value parameter decremented by 1.

Implements

Decrement(TSelf)

Remarks

The Decrement method defines the decrement operation for BigInteger values. It enables code such as the following:

C#

BigInteger number = 93843112;
Console.WriteLine(--number);               // Displays 93843111

Languages that do not support custom operators can call the Subtract method instead. For example:

C#

BigInteger number1 = BigInteger.Pow(Int32.MaxValue, 2);
number1 = BigInteger.Subtract(number1, BigInteger.One);

Because BigInteger objects are immutable, the Decrement operator creates a new BigInteger object whose value is one less than the BigInteger object represented by value. This means that repeated calls to Decrement may be expensive.

The equivalent method for this operator is BigInteger.Subtract(BigInteger, BigInteger).

Applies to

See also

• Increment(BigInteger)