Export (0) Print
Expand All

BigInteger.Modulus Operator

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

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

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.

ExceptionCondition
DivideByZeroException

divisor is 0 (zero).

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

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.

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Windows Phone 8.1, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft