Java.math.BigInteger.remainder() Method

Description

The java.math.BigInteger.remainder(BigInteger val) returns a BigInteger whose value is (this % val).

Declaration

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

public BigInteger remainder(BigInteger val)

Parameters

val − Value by which this BigInteger is to be divided, and the remainder computed.

Return Value

This method returns a BigInteger object whose value is this % val.

Exception

ArithmeticException − If val is zero.

Example

The following example shows the usage of math.BigInteger.remainder() 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 remainder operation on bi1 using bi2
      bi3 = bi1.remainder(bi2);

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

      // print bi3 value
      System.out.println("Remainder result for " +str);
   }
}

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

Remainder result for -100 % 3 is -1