< prev index next >

src/java.base/share/classes/java/math/RoundingMode.java

Print this page




  73  * <tr align=right><td>-1.0</td> <td>-1</td> <td>-1</td>   <td>-1</td>   <td>-1</td> <td>-1</td>     <td>-1</td>      <td>-1</td>      <td>-1</td>
  74  * <tr align=right><td>-1.1</td> <td>-2</td> <td>-1</td>   <td>-1</td>   <td>-2</td> <td>-1</td>     <td>-1</td>      <td>-1</td>      <td>throw {@code ArithmeticException}</td>
  75  * <tr align=right><td>-1.6</td> <td>-2</td> <td>-1</td>   <td>-1</td>   <td>-2</td> <td>-2</td>     <td>-2</td>      <td>-2</td>      <td>throw {@code ArithmeticException}</td>
  76  * <tr align=right><td>-2.5</td> <td>-3</td> <td>-2</td>   <td>-2</td>   <td>-3</td> <td>-3</td>     <td>-2</td>      <td>-2</td>      <td>throw {@code ArithmeticException}</td>
  77  * <tr align=right><td>-5.5</td> <td>-6</td> <td>-5</td>   <td>-5</td>   <td>-6</td> <td>-6</td>     <td>-5</td>      <td>-6</td>      <td>throw {@code ArithmeticException}</td>
  78  *</table>
  79  *
  80  *
  81  * <p>This {@code enum} is intended to replace the integer-based
  82  * enumeration of rounding mode constants in {@link BigDecimal}
  83  * ({@link BigDecimal#ROUND_UP}, {@link BigDecimal#ROUND_DOWN},
  84  * etc. ).
  85  *
  86  * @see     BigDecimal
  87  * @see     MathContext
  88  * @author  Josh Bloch
  89  * @author  Mike Cowlishaw
  90  * @author  Joseph D. Darcy
  91  * @since 1.5
  92  */

  93 public enum RoundingMode {
  94 
  95         /**
  96          * Rounding mode to round away from zero.  Always increments the
  97          * digit prior to a non-zero discarded fraction.  Note that this
  98          * rounding mode never decreases the magnitude of the calculated
  99          * value.
 100          *
 101          *<p>Example:
 102          *<table border>
 103          * <caption><b>Rounding mode UP Examples</b></caption>
 104          *<tr valign=top><th>Input Number</th>
 105          *    <th>Input rounded to one digit<br> with {@code UP} rounding
 106          *<tr align=right><td>5.5</td>  <td>6</td>
 107          *<tr align=right><td>2.5</td>  <td>3</td>
 108          *<tr align=right><td>1.6</td>  <td>2</td>
 109          *<tr align=right><td>1.1</td>  <td>2</td>
 110          *<tr align=right><td>1.0</td>  <td>1</td>
 111          *<tr align=right><td>-1.0</td> <td>-1</td>
 112          *<tr align=right><td>-1.1</td> <td>-2</td>




  73  * <tr align=right><td>-1.0</td> <td>-1</td> <td>-1</td>   <td>-1</td>   <td>-1</td> <td>-1</td>     <td>-1</td>      <td>-1</td>      <td>-1</td>
  74  * <tr align=right><td>-1.1</td> <td>-2</td> <td>-1</td>   <td>-1</td>   <td>-2</td> <td>-1</td>     <td>-1</td>      <td>-1</td>      <td>throw {@code ArithmeticException}</td>
  75  * <tr align=right><td>-1.6</td> <td>-2</td> <td>-1</td>   <td>-1</td>   <td>-2</td> <td>-2</td>     <td>-2</td>      <td>-2</td>      <td>throw {@code ArithmeticException}</td>
  76  * <tr align=right><td>-2.5</td> <td>-3</td> <td>-2</td>   <td>-2</td>   <td>-3</td> <td>-3</td>     <td>-2</td>      <td>-2</td>      <td>throw {@code ArithmeticException}</td>
  77  * <tr align=right><td>-5.5</td> <td>-6</td> <td>-5</td>   <td>-5</td>   <td>-6</td> <td>-6</td>     <td>-5</td>      <td>-6</td>      <td>throw {@code ArithmeticException}</td>
  78  *</table>
  79  *
  80  *
  81  * <p>This {@code enum} is intended to replace the integer-based
  82  * enumeration of rounding mode constants in {@link BigDecimal}
  83  * ({@link BigDecimal#ROUND_UP}, {@link BigDecimal#ROUND_DOWN},
  84  * etc. ).
  85  *
  86  * @see     BigDecimal
  87  * @see     MathContext
  88  * @author  Josh Bloch
  89  * @author  Mike Cowlishaw
  90  * @author  Joseph D. Darcy
  91  * @since 1.5
  92  */
  93 @SuppressWarnings("deprecation") // Legacy rounding mode constants in BigDecimal
  94 public enum RoundingMode {
  95 
  96         /**
  97          * Rounding mode to round away from zero.  Always increments the
  98          * digit prior to a non-zero discarded fraction.  Note that this
  99          * rounding mode never decreases the magnitude of the calculated
 100          * value.
 101          *
 102          *<p>Example:
 103          *<table border>
 104          * <caption><b>Rounding mode UP Examples</b></caption>
 105          *<tr valign=top><th>Input Number</th>
 106          *    <th>Input rounded to one digit<br> with {@code UP} rounding
 107          *<tr align=right><td>5.5</td>  <td>6</td>
 108          *<tr align=right><td>2.5</td>  <td>3</td>
 109          *<tr align=right><td>1.6</td>  <td>2</td>
 110          *<tr align=right><td>1.1</td>  <td>2</td>
 111          *<tr align=right><td>1.0</td>  <td>1</td>
 112          *<tr align=right><td>-1.0</td> <td>-1</td>
 113          *<tr align=right><td>-1.1</td> <td>-2</td>


< prev index next >