• Article

BigInteger.Modulus Operator

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

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

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

Syntax

'Declaration
Public Shared Operator Mod ( _
    dividend As BigInteger, _
    divisor As BigInteger _
) As BigInteger

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

Parameters

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:

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

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.