BigInteger.Modulus(BigInteger, BigInteger)BigInteger.Modulus(BigInteger, BigInteger)BigInteger.Modulus(BigInteger, BigInteger)BigInteger.Modulus(BigInteger, BigInteger) Operator

Definition

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

``````public:
static System::Numerics::BigInteger operator %(System::Numerics::BigInteger dividend, System::Numerics::BigInteger divisor);``````
``public static System.Numerics.BigInteger operator % (System.Numerics.BigInteger dividend, System.Numerics.BigInteger divisor);``
``static member ( % ) : System.Numerics.BigInteger * System.Numerics.BigInteger -> System.Numerics.BigInteger``
``Public Shared Operator Mod (dividend As BigInteger, divisor As BigInteger) As BigInteger``

Parameters

dividend
BigInteger BigInteger BigInteger BigInteger

The value to be divided.

divisor
BigInteger BigInteger BigInteger BigInteger

The value to divide by.

Returns

The remainder that results from the division.

Exceptions

`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:

``````BigInteger num1 = 100045632194;
BigInteger num2 = 90329434;
BigInteger remainder = num1 % num2;
Console.WriteLine(remainder);           // Displays 50948756
``````
``````Dim num1 As BigInteger = 100045632194
Dim num2 As BigInteger = 90329434
Dim remainder As BigInteger = num1 Mod num2
Console.WriteLine(remainder)                 ' Displays  50948756
``````

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.

The equivalent method for this operator is BigInteger.Remainder(BigInteger, BigInteger).