Home » Java » Java Reference » Java BigDecimal Class

Java BigDecimal ulp() Method with Example

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

BigDecimal Class ulp() method

• ulp() method is available in java.math package.
• ulp() method is used to get the size of an ulp of this BigDecimal when this BigDecimal holds non-zero value then an ulp is the positive distance between this value and the BigDecimal value next greater in magnitude and when this BigDecimal holds zero then, in that case, an ulp of zero value is equal to the value "1".
• ulp() 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.
• ulp() method does not throw an exception at the time of calculating ulp.

Syntax:

    public BigDecimal ulp();

Parameter(s):

• It does not accept any parameter.

Return value:

The return type of this method is BigDecimal, it returns the size of an ulp of this BigDecimal.

Example:

// Java program to demonstrate the example 
// of BigDecimal ulp() method of BigDecimal

import java.math.*;

public class UlpOfBD {
    public static void main(String args[]) {
        // Initialize three variables - int and
        // String
        int val1 = 2245;
        int val2 = 0;
        String str = "2.346";

        // Initialize three BigDecimal objects  
        BigDecimal b_dec1 = new BigDecimal(val1);
        BigDecimal b_dec2 = new BigDecimal(val2);
        BigDecimal b_dec3 = new BigDecimal(str);

        // returns the BigDecimal that holds 
        // the size of an ulp of this BigDecimal
        // b_dec1 
        BigDecimal ulp = b_dec1.ulp();
        System.out.println("b_dec1.ulp(): " + ulp);

        // returns the BigDecimal that holds 
        // the size of an ulp of this BigDecimal
        // b_dec2 i.e. it returns 1 when this 
        // Bigdecimal holds value 0
        ulp = b_dec2.ulp();
        System.out.println("b_dec2.ulp(): " + ulp);

        // returns the BigDecimal that holds 
        // the size of an ulp of this BigDecimal
        // b_dec3 
        ulp = b_dec3.ulp();
        System.out.println("b_dec3.ulp(): " + ulp);
    }
}

Output

b_dec1.ulp(): 1
b_dec2.ulp(): 1
b_dec3.ulp(): 0.001