BigInteger::Decrement Operator (BigInteger)

.NET Framework (current version)

equivalentCodeEntityM:System.Numerics.BigInteger.Subtract(System.Numerics.BigInteger,System.Numerics.BigInteger)

Decrements a BigInteger value by 1.

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

Syntax

public:
static BigInteger operator --(
	BigInteger value
)

Parameters

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

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:

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

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

C++

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

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 4.0
Windows Phone
Available since 8.1