CODEWITHSUNDEEP
javabigdecimal
Adamski
Adamski

Reputation: 54705

Check if BigDecimal is an integer in Java

What is an efficient way of determining whether a BigDecimal is an integer value in the mathematical sense?

At present I have the following code:

private boolean isIntegerValue(BigDecimal bd) {
    boolean ret;
    
    try {
        bd.toBigIntegerExact();
        ret = true;
    } catch (ArithmeticException ex) {
        ret = false;
    }

    return ret;
}

... but would like to avoid the object creation overhead if possible.

Previously I was using bd.longValueExact() which would avoid creating an object if the BigDecimal was using its compact representation internally, but obviously would fail if the value was too big to fit into a long.

Upvotes: 71

Views: 64405

Answers (7)

Scott Armstrong
Scott Armstrong

Reputation: 51

This can be done the same way that someone would check if a double is an integer, performing % 1 == 0. This is how it would look for a BigDecimal value.

public static boolean isIntegerValue(BigDecimal bd){
  return bd.remainder(BigDecimal.ONE).compareTo(BigDecimal.ZERO) == 0;
}

Upvotes: 5

Tobias Wichtrey
Tobias Wichtrey

Reputation: 1218

EDIT: As of Java 8, stripTrailingZeroes() now accounts for zero

BigDecimal stripTrailingZeros doesn't work for zero

So

private boolean isIntegerValue(BigDecimal bd) {
  return bd.stripTrailingZeros().scale() <= 0;
}

Is perfectly fine now.

If you use the scale() and stripTrailingZeros() solution mentioned in some of the answers you should pay attention to zero. Zero always is an integer no matter what scale it has, and stripTrailingZeros() does not alter the scale of a zero BigDecimal.

So you could do something like this:

private boolean isIntegerValue(BigDecimal bd) {
  return bd.signum() == 0 || bd.scale() <= 0 || bd.stripTrailingZeros().scale() <= 0;
}

Upvotes: 107

StPatrick
StPatrick

Reputation: 210

Divide the number by 1 and check for a remainder. Any whole number should always have a remainder of 0 when divided by 1.

public boolean isWholeNumber(BigDecimal number) {
    return number.remainder(BigDecimal.ONE).compareTo(BigDecimal.ZERO) == 0;
}

Upvotes: 9

Ian
Ian

Reputation: 11

This is the cleanest I've come up with.

public static boolean isWhole(BigDecimal bigDecimal) {
    return bigDecimal.setScale(0, RoundingMode.HALF_UP).compareTo(bigDecimal) == 0;
}

Upvotes: 1

emisch
emisch

Reputation: 95

You can use this (just summarizing from other answers):

private boolean isIntegerValue(BigDecimal bd) {
  return bd.stripTrailingZeros().scale() <= 0;
}

Upvotes: 7

Kosi2801
Kosi2801

Reputation: 23095

One possiblity should be to check if scale() is zero or negative. In that case the BigDecimal should have no digits after the decimal point and the number should be a mathematical integer if I understand your question correctly.

Update: If positive, it could still be an integer, but you cannot spare extra object creations for further in-depth checks in that case. An example for such a case is given at the stripTrailingZeros() method javadoc (thanks Joachim for the hint in his answer).

Upvotes: 4

Joachim Sauer
Joachim Sauer

Reputation: 308031

Depending on the source/usage of your BigDecimal values it might be faster to check if the scale <= 0 first. If it is, then it's definitely an integer value in the mathematical sense. If it is >0, then it could still be an integer value and the more expensive test would be needed.

Upvotes: 19

Related Questions