• Article

BigInteger.Decrement Operator

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

Decrements a BigInteger value by 1.

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

Syntax

'Declaration
Public Shared Operator -- ( _
    value As BigInteger _
) As BigInteger

public static BigInteger operator --(
    BigInteger value
)

Parameters

Return Value

Type: System.Numerics.BigInteger
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:

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

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

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.

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.