/* * @(#)RoundingMode.java 1.3 04/06/18 * * Copyright 2004 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ /* * @(#)RoundingMode.java 1.x 01/xx/xx * * Copyright 2001 Sun Microsystems, Inc. All Rights Reserved. * Portions Copyright IBM Corporation, 2001. All Rights Reserved. * * This software is the proprietary information of Sun Microsystems, Inc. * Use is subject to license terms. * */ package java.math; /** * Specifies a rounding behavior for numerical operations * capable of discarding precision. Each rounding mode indicates how * the least significant returned digit of a rounded result is to be * calculated. If fewer digits are returned than the digits needed to * represent the exact numerical result, the discarded digits will be * referred to as the discarded fraction regardless the digits' * contribution to the value of the number. In other words, * considered as a numerical value, the discarded fraction could have * an absolute value greater than one. * *
Each rounding mode description includes a table listing how * different two-digit decimal values would round to a one digit * decimal value under the rounding mode in question. The result * column in the tables could be gotten by creating a * BigDecimal number with the specified value, forming a * {@link MathContext} object with the proper settings * (precision set to 1, and the * roundingMode set to the rounding mode in question), and * calling {@link BigDecimal#round round} on this number with the * proper MathContext. A summary table showing the results * of these rounding operations for all rounding modes appears below. * *
*
Result of rounding input to one digit with the given * rounding mode | *||||||||
---|---|---|---|---|---|---|---|---|
Input Number | UP | *DOWN | *CEILING | *FLOOR | *HALF_UP | *HALF_DOWN | *HALF_EVEN | *UNNECESSARY | * *
5.5 | 6 | 5 | 6 | 5 | 6 | 5 | 6 | throw ArithmeticException | *
2.5 | 3 | 2 | 3 | 2 | 3 | 2 | 2 | throw ArithmeticException | *
1.6 | 2 | 1 | 2 | 1 | 2 | 2 | 2 | throw ArithmeticException | *
1.1 | 2 | 1 | 2 | 1 | 1 | 1 | 1 | throw ArithmeticException | *
1.0 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | *
-1.0 | -1 | -1 | -1 | -1 | -1 | -1 | -1 | -1 | *
-1.1 | -2 | -1 | -1 | -2 | -1 | -1 | -1 | throw ArithmeticException | *
-1.6 | -2 | -1 | -1 | -2 | -2 | -2 | -2 | throw ArithmeticException | *
-2.5 | -3 | -2 | -2 | -3 | -3 | -2 | -2 | throw ArithmeticException | *
-5.5 | -6 | -5 | -5 | -6 | -6 | -5 | -6 | throw ArithmeticException | *
This enum is intended to replace the integer-based * enumeration of rounding mode constants in {@link BigDecimal} * ({@link BigDecimal#ROUND_UP}, {@link BigDecimal#ROUND_DOWN}, * etc. ). * * @see BigDecimal * @see MathContext * @version 1.x 01/xx/xx * @author Josh Bloch * @author Mike Cowlishaw * @author Joseph D. Darcy */ public enum RoundingMode { /** * Rounding mode to round away from zero. Always increments the * digit prior to a non-zero discarded fraction. Note that this * rounding mode never decreases the magnitude of the calculated * value. * *
Example: *
Input Number | *Input rounded to one digit with UP rounding * |
---|---|
5.5 | 6 | *
2.5 | 3 | *
1.6 | 2 | *
1.1 | 2 | *
1.0 | 1 | *
-1.0 | -1 | *
-1.1 | -2 | *
-1.6 | -2 | *
-2.5 | -3 | *
-5.5 | -6 | *
Example: *
Input Number | *Input rounded to one digit with DOWN rounding * |
---|---|
5.5 | 5 | *
2.5 | 2 | *
1.6 | 1 | *
1.1 | 1 | *
1.0 | 1 | *
-1.0 | -1 | *
-1.1 | -1 | *
-1.6 | -1 | *
-2.5 | -2 | *
-5.5 | -5 | *
Example: *
Input Number | *Input rounded to one digit with CEILING rounding * |
---|---|
5.5 | 6 | *
2.5 | 3 | *
1.6 | 2 | *
1.1 | 2 | *
1.0 | 1 | *
-1.0 | -1 | *
-1.1 | -1 | *
-1.6 | -1 | *
-2.5 | -2 | *
-5.5 | -5 | *
Example: *
Input Number | *Input rounded to one digit with FLOOR rounding * |
---|---|
5.5 | 5 | *
2.5 | 2 | *
1.6 | 1 | *
1.1 | 1 | *
1.0 | 1 | *
-1.0 | -1 | *
-1.1 | -2 | *
-1.6 | -2 | *
-2.5 | -3 | *
-5.5 | -6 | *
Example: *
Input Number | *Input rounded to one digit with HALF_UP rounding * |
---|---|
5.5 | 6 | *
2.5 | 3 | *
1.6 | 2 | *
1.1 | 1 | *
1.0 | 1 | *
-1.0 | -1 | *
-1.1 | -1 | *
-1.6 | -2 | *
-2.5 | -3 | *
-5.5 | -6 | *
Example: *
Input Number | *Input rounded to one digit with HALF_DOWN rounding * |
---|---|
5.5 | 5 | *
2.5 | 2 | *
1.6 | 2 | *
1.1 | 1 | *
1.0 | 1 | *
-1.0 | -1 | *
-1.1 | -1 | *
-1.6 | -2 | *
-2.5 | -2 | *
-5.5 | -5 | *
Example: *
Input Number | *Input rounded to one digit with HALF_EVEN rounding * |
---|---|
5.5 | 6 | *
2.5 | 2 | *
1.6 | 2 | *
1.1 | 1 | *
1.0 | 1 | *
-1.0 | -1 | *
-1.1 | -1 | *
-1.6 | -2 | *
-2.5 | -2 | *
-5.5 | -6 | *
Example: *
Input Number | *Input rounded to one digit with UNNECESSARY rounding * |
---|---|
5.5 | throw ArithmeticException | *
2.5 | throw ArithmeticException | *
1.6 | throw ArithmeticException | *
1.1 | throw ArithmeticException | *
1.0 | 1 | *
-1.0 | -1 | *
-1.1 | throw ArithmeticException | *
-1.6 | throw ArithmeticException | *
-2.5 | throw ArithmeticException | *
-5.5 | throw ArithmeticException | *