Home » Java » Java Reference » Java BigInteger Class

Java BigInteger Class | mod() Method with Example

BigInteger Class mod() method: Here, we are going to learn about the mod() method of BigInteger Class with its syntax and example.
Submitted by Preeti Jain, on May 11, 2020

BigInteger Class mod() method

• mod() method is available in java.math package.
• mod() method is used to calculate the mod by using (this BigInteger % BigInteger val).
• mod() method is a non-static method, it is accessible with the class object only and if we try to access the method with the class name then we will get an error.
• mod() method may throw an exception at the time of returning mod.
  ArithmeticException: This exception may throw when the given parameter holds value 0 or negative.

Syntax:

    public BigInteger mod(BigInteger val);

Parameter(s):

• BigInteger val – represents the object by which to calculate mod.

Return value:

The return type of this method is BigInteger, it returns the mod by using (this BigInteger) % (BigInteger val).

Example:

// Java program to demonstrate the example 
// of BigInteger mod(BigInteger val) method of BigInteger

import java.math.*;

public class ModOfBI {
    public static void main(String args[]) {
        // Initialize three variables str1, str2 and str3
        String str1 = "101";
        String str2 = "-80";
        String str3 = "2";

        // Initialize three BigInteger objects  
        BigInteger b_int1 = new BigInteger(str1);
        BigInteger b_int2 = new BigInteger(str2);
        BigInteger b_int3 = new BigInteger(str3);

        // Display b_int1 , b_int2 and b_int3
        System.out.println("b_int1: " + b_int1);
        System.out.println("b_int2: " + b_int2);
        System.out.println("b_int3: " + b_int3);

        System.out.println();

        // calculating mod between two BigInteger values 
        // [(this BigInteger b_int1) mod (BigInteger b_int3) ] 
        // by using mod(BigInteger) method
        BigInteger mod_val = b_int1.mod(b_int3);
        System.out.println("b_int1.mod(b_int3): " + mod_val);


        // calculating mod between two BigInteger values 
        // [(this BigInteger b_int2) mod (BigInteger b_int3) ] 
        // by using mod(BigInteger) method
        mod_val = b_int2.mod(b_int3);
        System.out.println("b_int2.mod(b_int3): " + mod_val);
    }
}

Output

b_int1: 101
b_int2: -80
b_int3: 2

b_int1.mod(b_int3): 1
b_int2.mod(b_int3): 0