BigInteger.Modulus(BigInteger, BigInteger) Operator

Reference

Definition

Namespace:: System.Numerics

Assemblies:: System.Numerics.dll, System.Runtime.Numerics.dll

Assemblies:: netstandard.dll, System.Runtime.Numerics.dll

Assembly:: System.Runtime.Numerics.dll

Assembly:: System.Numerics.dll

Assembly:: netstandard.dll

Source:: BigInteger.cs

Source:: BigInteger.cs

Source:: BigInteger.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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) = System::Numerics::IModulusOperators<System::Numerics::BigInteger, System::Numerics::BigInteger, System::Numerics::BigInteger>::op_Modulus;

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

The value to be divided.

divisor: BigInteger

The value to divide by.

Returns

BigInteger

The remainder that results from the division.

Implements

Modulus(TSelf, TOther)

Exceptions

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:

BigInteger num1 = 100045632194;
BigInteger num2 = 90329434;
BigInteger remainder = num1 % num2;
Console.WriteLine(remainder);           // Displays 50948756

let num1 = 100045632194I
let num2 = 90329434I
let remainder = num1 % num2
printfn $"{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).

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

Share via