BigInteger.Decrement(BigInteger) BigInteger.Decrement(BigInteger) BigInteger.Decrement(BigInteger) BigInteger.Decrement(BigInteger) Operator

Definition

Decrements a BigInteger value by 1.

public:
 static System::Numerics::BigInteger operator --(System::Numerics::BigInteger value);
public static System.Numerics.BigInteger operator -- (System.Numerics.BigInteger value);
static member op_Decrement : System.Numerics.BigInteger -> System.Numerics.BigInteger
Public Shared op_Decrement (value As BigInteger) As BigInteger

Parameters

value
BigInteger BigInteger BigInteger BigInteger

The value to decrement.

Returns

The value of the value parameter decremented by 1.

Remarks

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

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

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

BigInteger number1 = BigInteger.Pow(Int32.MaxValue, 2);
number1 = BigInteger.Subtract(number1, BigInteger.One);
Dim number1 As BigInteger = 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