Java.math.BigInteger.mod() Method

Advertisements


Description

The java.math.BigInteger.mod(BigInteger m) returns a BigInteger whose value is (this mod m). This method differs from remainder in that it always returns a non-negative BigInteger.

Declaration

Following is the declaration for java.math.BigInteger.mod() method

public BigInteger mod(BigInteger m)

Parameters

  • m - the modulus

Return Value

This method returns a BigInteger object whose value is this mod m.

Exception

  • ArithmeticException - if m ≤ 0

Example

The following example shows the usage of math.BigInteger.mod() method

package com.tutorialspoint;

import java.math.*;

public class BigIntegerDemo {

public static void main(String[] args) {

        // create 3 BigInteger objects
        BigInteger bi1, bi2, bi3;

        bi1 = new BigInteger("-100");
        bi2 = new BigInteger("3");

        // perform mod operation on bi1 using bi2
	bi3 = bi1.mod(bi2);

        String str = bi1 + " mod " + bi2 + " is " +bi3;

	// print bi3 value
	System.out.println( str );
    }
}

Let us compile and run the above program, this will produce the following result:

-100 mod 3 is 2



Advertisements
Advertisements