RoundingMode Class

Definition

[Android.Runtime.Register("java/math/RoundingMode", DoNotGenerateAcw=true)]
public sealed class RoundingMode : Java.Lang.Enum

[<Android.Runtime.Register("java/math/RoundingMode", DoNotGenerateAcw=true)>]
type RoundingMode = class
    inherit Enum

Inheritance

Object

Object

Enum

RoundingMode

Attributes

RegisterAttribute

Remarks

Specifies a rounding policy 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 MathContext object with the proper settings (precision set to 1, and the roundingMode set to the rounding mode in question), and calling 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.

<table class="striped"> <caption><b>Summary of Rounding Operations Under Different Rounding Modes</b></caption> <thead> <tr><th scope="col" rowspan="2">Input Number</th><th scope="col"colspan=8>Result of rounding input to one digit with the given rounding mode</th> <tr style="vertical-align:top"> <th>UP</th> <th>DOWN</th> <th>CEILING</th> <th>FLOOR</th> <th>HALF_UP</th> <th>HALF_DOWN</th> <th>HALF_EVEN</th> <th>UNNECESSARY</th> </thead> <tbody style="text-align:right">

<tr><th scope="row">5.5</th> <td>6</td> <td>5</td> <td>6</td> <td>5</td> <td>6</td> <td>5</td> <td>6</td> <td>throw ArithmeticException</td> <tr><th scope="row">2.5</th> <td>3</td> <td>2</td> <td>3</td> <td>2</td> <td>3</td> <td>2</td> <td>2</td> <td>throw ArithmeticException</td> <tr><th scope="row">1.6</th> <td>2</td> <td>1</td> <td>2</td> <td>1</td> <td>2</td> <td>2</td> <td>2</td> <td>throw ArithmeticException</td> <tr><th scope="row">1.1</th> <td>2</td> <td>1</td> <td>2</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <td>throw ArithmeticException</td> <tr><th scope="row">1.0</th> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <tr><th scope="row">-1.0</th> <td>-1</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>-1</td> <tr><th scope="row">-1.1</th> <td>-2</td> <td>-1</td> <td>-1</td> <td>-2</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>throw ArithmeticException</td> <tr><th scope="row">-1.6</th> <td>-2</td> <td>-1</td> <td>-1</td> <td>-2</td> <td>-2</td> <td>-2</td> <td>-2</td> <td>throw ArithmeticException</td> <tr><th scope="row">-2.5</th> <td>-3</td> <td>-2</td> <td>-2</td> <td>-3</td> <td>-3</td> <td>-2</td> <td>-2</td> <td>throw ArithmeticException</td> <tr><th scope="row">-5.5</th> <td>-6</td> <td>-5</td> <td>-5</td> <td>-6</td> <td>-6</td> <td>-5</td> <td>-6</td> <td>throw ArithmeticException</td> </tbody> </table>

This enum is intended to replace the integer-based enumeration of rounding mode constants in BigDecimal (BigDecimal#ROUND_UP, BigDecimal#ROUND_DOWN, etc. ).

Added in 1.5.

Java documentation for java.math.RoundingMode.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to