BigInteger::Modulus Operator (BigInteger, BigInteger)

.NET Framework (current version)

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

Returns the remainder that results from division with two specified BigInteger values.

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

Syntax

public:
static BigInteger operator %(
	BigInteger dividend,
	BigInteger divisor
)

Parameters

dividend: Type: System.Numerics::BigInteger
The value to be divided.

divisor: Type: System.Numerics::BigInteger
The value to divide by.

Return Value

Type: System.Numerics::BigInteger

The remainder that results from the division.

Exceptions

Exception	Condition
DivideByZeroException	divisor is 0 (zero).

Remarks

The Modulus method defines the operation of the modulus operator for BigInteger values. It enables code such as the following:

C++

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

Languages that do not support custom operators can call the BigInteger::Remainder method instead.

The sign of the value returned by the modulus operation depends on the sign of dividend: If dividend is positive, the modulus operation returns a positive result; if it is negative, the modulus operation returns a negative result. The behavior of the modulus operation with BigInteger values is identical to the modulus operation with other integral types.

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