Java Doc for BigDecimal.java in  » Internationalization-Localization » icu4j » com » ibm » icu » math » Java Source Code / Java DocumentationJava Source Code and Java Documentation

As the numbers are decimal, there is an exact correspondence between an instance of a BigDecimal object and its String representation; the BigDecimal class provides direct conversions to and from String and character array (char[]) objects, as well as conversions to and from the Java primitive types (which may not be exact) and BigInteger.

In the descriptions of constructors and methods in this documentation, the value of a BigDecimal number object is shown as the result of invoking the toString() method on the object. The internal representation of a decimal number is neither defined nor exposed, and is not permitted to affect the result of any operation.

The floating point arithmetic provided by this class is defined by the ANSI X3.274-1996 standard, and is also documented at http://www2.hursley.ibm.com/decimal
[This URL will change.]

Operator methods

Operations on BigDecimal numbers are controlled by a MathContext object, which provides the context (precision and other information) for the operation. Methods that can take a MathContext parameter implement the standard arithmetic operators for BigDecimal objects and are known as operator methods. The default settings provided by the constant MathContext.DEFAULT (digits=9, form=SCIENTIFIC, lostDigits=false, roundingMode=ROUND_HALF_UP) perform general-purpose floating point arithmetic to nine digits of precision. The MathContext parameter must not be null.

Each operator method also has a version provided which does not take a MathContext parameter. For this version of each method, the context settings used are digits=0, form=PLAIN, lostDigits=false, roundingMode=ROUND_HALF_UP; these settings perform fixed point arithmetic with unlimited precision, as defined for the original BigDecimal class in Java 1.1 and Java 1.2.

For monadic operators, only the optional MathContext parameter is present; the operation acts upon the current object.

For dyadic operators, a BigDecimal parameter is always present; it must not be null. The operation acts with the current object being the left-hand operand and the BigDecimal parameter being the right-hand operand.

For example, adding two BigDecimal objects referred to by the names award and extra could be written as any of:

award.add(extra)
award.add(extra, MathContext.DEFAULT)
award.add(extra, acontext)

(where acontext is a MathContext object), which would return a BigDecimal object whose value is the result of adding award and extra under the appropriate context settings.

When a BigDecimal operator method is used, a set of rules define what the result will be (and, by implication, how the result would be represented as a character string). These rules are defined in the BigDecimal arithmetic documentation (see the URL above), but in summary:

• Results are normally calculated with up to some maximum number of significant digits. For example, if the MathContext parameter for an operation were MathContext.DEFAULT then the result would be rounded to 9 digits; the division of 2 by 3 would then result in 0.666666667.
  You can change the default of 9 significant digits by providing the method with a suitable MathContext object. This lets you calculate using as many digits as you need -- thousands, if necessary. Fixed point (scaled) arithmetic is indicated by using a digits setting of 0 (or omitting the MathContext parameter).
  Similarly, you can change the algorithm used for rounding from the default "classic" algorithm.
• In standard arithmetic (that is, when the form setting is not PLAIN), a zero result is always expressed as the single digit '0' (that is, with no sign, decimal point, or exponent part).
• Except for the division and power operators in standard arithmetic, trailing zeros are preserved (this is in contrast to binary floating point operations and most electronic calculators, which lose the information about trailing zeros in the fractional part of results).
  So, for example:

  new BigDecimal("2.40").add( new BigDecimal("2")) => "4.40"
new BigDecimal("2.40").subtract(new BigDecimal("2")) => "0.40"
new BigDecimal("2.40").multiply(new BigDecimal("2")) => "4.80"
new BigDecimal("2.40").divide( new BigDecimal("2"), def) => "1.2"

  where the value on the right of the => would be the result of the operation, expressed as a String, and def (in this and following examples) refers to MathContext.DEFAULT). This preservation of trailing zeros is desirable for most calculations (including financial calculations). If necessary, trailing zeros may be easily removed using division by 1.

• In standard arithmetic, exponential form is used for a result depending on its value and the current setting of digits (the default is 9 digits). If the number of places needed before the decimal point exceeds the digits setting, or the absolute value of the number is less than 0.000001, then the number will be expressed in exponential notation; thus

  new BigDecimal("1e+6").multiply(new BigDecimal("1e+6"), def)

  results in 1E+12 instead of 1000000000000, and

  new BigDecimal("1").divide(new BigDecimal("3E+10"), def)

  results in 3.33333333E-11 instead of 0.0000000000333333333.

  The form of the exponential notation (scientific or engineering) is determined by the form setting.

  The names of methods in this class follow the conventions established by java.lang.Number, java.math.BigInteger, and java.math.BigDecimal in Java 1.1 and Java 1.2.
  See Also:   MathContext
  author:
     Mike Cowlishaw

Constructs a BigDecimal which is the exact decimal representation of the BigInteger, with a scale of zero. The value of the BigDecimal is identical to the value of the BigInteger. The parameter must not be null.

The BigDecimal will contain only decimal digits, prefixed with a leading minus sign (hyphen) if the BigInteger is negative.

Constructs a BigDecimal which is the exact decimal representation of the BigInteger, scaled by the second parameter, which may not be negative. The value of the BigDecimal is the BigInteger divided by ten to the power of the scale. The BigInteger parameter must not be null.

The BigDecimal will contain only decimal digits, (with an embedded decimal point followed by scale decimal digits if the scale is positive), prefixed with a leading minus sign (hyphen) if the BigInteger is negative.

Constructs a BigDecimal as though a String had been constructed from the character array and the BigDecimal.BigDecimal(java.lang.String) constructor had then been used.

Constructs a BigDecimal as though a String had been constructed from the character array (or a subarray of that array) and the BigDecimal.BigDecimal(java.lang.String) constructor had then been used.

Constructs a BigDecimal from the parameter, which must not be null and must represent a valid number, as described formally in the documentation referred to BigDecimal above .

In summary, numbers in String form must have at least one digit, may have a leading sign, may have a decimal point, and exponential notation may be used.

If the current object is zero or positive, then the same result as invoking the BigDecimal.plus(MathContext) method with the same parameter is returned. Otherwise, the same result as invoking the BigDecimal.negate(MathContext) method with the same parameter is returned.
Parameters:
  set - The MathContext arithmetic settings.

The same as BigDecimal.add(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).

The length of the decimal part (the scale) of the result will be the maximum of the scales of the two operands.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe addition.

Implements the addition (+) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe addition.
Parameters:
  set - The MathContext arithmetic settings.

The same as BigDecimal.compareTo(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison.

Implements numeric comparison, (as defined in the decimal documentation, see BigDecimalclass header ), and returns a result of type int.

The result will be:

-1	if the current object is less than the first parameter
0	if the current object is equal to the first parameter
1	if the current object is greater than the first parameter.

A BigDecimal.compareTo(Object) method is also provided.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison.
Parameters:
  set - The MathContext arithmetic settings.

If the parameter is null, or is not an instance of the BigDecimal type, an exception is thrown. Otherwise, the parameter is cast to type BigDecimal and the result of the BigDecimal.compareTo(BigDecimal) method, using the cast parameter, is returned.

The BigDecimal.compareTo(BigDecimal,MathContext) method should be used when a MathContext is needed for the comparison.
Parameters:
  rhsobj - The Object for the right hand side ofthe comparison.

The same as BigDecimal.divide(BigDecimal,int) , where the BigDecimal is rhs, and the rounding mode is MathContext.ROUND_HALF_UP . The length of the decimal part (the scale) of the result will be the same as the scale of the current object, if the latter were formatted without exponential notation.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe division.

The same as BigDecimal.divide(BigDecimal,int,int) , where the BigDecimal is rhs, and the second parameter is this.scale(), and the third is round.

The length of the decimal part (the scale) of the result will therefore be the same as the scale of the current object, if the latter were formatted without exponential notation.

Parameters:
  rhs - The BigDecimal for the right hand side ofthe division.
Parameters:
  round - The int rounding mode to be used forthe division (see the MathContext class).

The same as BigDecimal.divide(BigDecimal,MathContext) , where the BigDecimal is rhs, new MathContext(0, MathContext.PLAIN, false, round), except that the length of the decimal part (the scale) to be used for the result is explicit rather than being taken from this.

The length of the decimal part (the scale) of the result will be the same as the scale of the current object, if the latter were formatted without exponential notation.

Parameters:
  rhs - The BigDecimal for the right hand side ofthe division.
Parameters:
  scale - The int scale to be used for the result.
Parameters:
  round - The int rounding mode to be used forthe division (see the MathContext class).

Implements the division (/) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe division.
Parameters:
  set - The MathContext arithmetic settings.

The same as BigDecimal.divideInteger(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).
Parameters:
  rhs - The BigDecimal for the right hand side ofthe integer division.

Implements the integer division operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe integer division.
Parameters:
  set - The MathContext arithmetic settings.

If the parameter is null, or is not an instance of the BigDecimal type, or is not exactly equal to the current BigDecimal object, then false is returned. Otherwise, true is returned.

"Exactly equal", here, means that the String representations of the BigDecimal numbers are identical (they have the same characters in the same sequence).

The BigDecimal.compareTo(BigDecimal,MathContext) method should be used for more general comparisons.
Parameters:
  obj - The Object for the right hand side ofthe comparison.

This method is provided as a primitive for use by more sophisticated classes, such as DecimalFormat, that can apply locale-sensitive editing of the result.

This method is provided as a primitive for use by more sophisticated classes, such as DecimalFormat, that can apply locale-sensitive editing of the result.

The same as BigDecimal.max(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison.

Returns the larger of the current object and the first parameter.

If calling the BigDecimal.compareTo(BigDecimal,MathContext) method with the same parameters would return 1 or 0, then the result of calling the BigDecimal.plus(MathContext) method on the current object (using the same MathContext parameter) is returned. Otherwise, the result of calling the BigDecimal.plus(MathContext) method on the first parameter object (using the same MathContext parameter) is returned.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison.
Parameters:
  set - The MathContext arithmetic settings.

The same as BigDecimal.min(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison.

Returns the smaller of the current object and the first parameter.

If calling the BigDecimal.compareTo(BigDecimal,MathContext) method with the same parameters would return -1 or 0, then the result of calling the BigDecimal.plus(MathContext) method on the current object (using the same MathContext parameter) is returned. Otherwise, the result of calling the BigDecimal.plus(MathContext) method on the first parameter object (using the same MathContext parameter) is returned.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison.
Parameters:
  set - The MathContext arithmetic settings.

this.multiply(TEN.pow(new BigDecimal(-n)))

n may be negative, in which case the method returns the same result as movePointRight(-n).
Parameters:
  n - The int specifying the number of places tomove the decimal point leftwards.

this.multiply(TEN.pow(new BigDecimal(n)))

n may be negative, in which case the method returns the same result as movePointLeft(-n).
Parameters:
  n - The int specifying the number of places tomove the decimal point rightwards.

The same as BigDecimal.add(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).

The length of the decimal part (the scale) of the result will be the sum of the scales of the operands, if they were formatted without exponential notation.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe multiplication.

Implements the multiplication (*) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe multiplication.
Parameters:
  set - The MathContext arithmetic settings.

Implements the negation (Prefix -) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  set - The MathContext arithmetic settings.

Implements the plus (Prefix +) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.

This method is useful for rounding or otherwise applying a context to a decimal value.
Parameters:
  set - The MathContext arithmetic settings.

The same as BigDecimal.pow(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).

The parameter is the power to which the this will be raised; it must be in the range 0 through 999999999, and must have a decimal part of zero.

Implements the power (**) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.

The first parameter is the power to which the this will be raised; it must be in the range -999999999 through 999999999, and must have a decimal part of zero.

The same as BigDecimal.remainder(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).

This is not the modulo operator -- the result may be negative.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe remainder operation.

Implements the remainder operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.

This is not the modulo operator -- the result may be negative.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe remainder operation.
Parameters:
  set - The MathContext arithmetic settings.

If the given scale (which must be zero or positive) is the same as or greater than the length of the decimal part (the scale) of this BigDecimal then trailing zeros will be added to the decimal part as necessary.

If the given scale is less than the length of the decimal part (the scale) of this BigDecimal then trailing digits will be removed, and in this case an ArithmeticException is thrown if any discarded digits are non-zero.

The same as BigDecimal.setScale(int,int) , where the first parameter is the scale, and the second is MathContext.ROUND_UNNECESSARY.
Parameters:
  scale - The int specifying the scale of theresulting BigDecimal.

If the given scale (which must be zero or positive) is the same as or greater than the length of the decimal part (the scale) of this BigDecimal then trailing zeros will be added to the decimal part as necessary.

If the given scale is less than the length of the decimal part (the scale) of this BigDecimal then trailing digits will be removed, and the rounding mode given by the second parameter is used to determine if the remaining digits are affected by a carry. In this case, an IllegalArgumentException is thrown if round is not a valid rounding mode.

If round is MathContext.ROUND_UNNECESSARY, an ArithmeticException is thrown if any discarded digits are non-zero.
Parameters:
  scale - The int specifying the scale of theresulting BigDecimal.
Parameters:
  round - The int rounding mode to be used forthe division (see the MathContext class).

The same as BigDecimal.subtract(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).

The length of the decimal part (the scale) of the result will be the maximum of the scales of the two operands.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe subtraction.

Implements the subtraction (-) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe subtraction.
Parameters:
  set - The MathContext arithmetic settings.

Returns a BigDecimal which is the decimal representation of the 64-bit signed binary floating point parameter.

The result is given by:

(new BigDecimal(lint)).divide(TEN.pow(new BigDecimal(scale)))

A NumberFormatException is thrown if scale is negative.
Parameters:
  lint - The long to be translated.
Parameters:
  scale - The int scale to be applied.

Constructs a BigDecimal as though the parameter had been represented as a String (using its toString method) and the BigDecimal.BigDecimal(java.lang.String) constructor had then been used. The parameter must not be null.

(Note: this constructor is provided only in the com.ibm.icu.math version of the BigDecimal class. It would not be present in a java.math version.)
Parameters:
  bd - The BigDecimal to be translated.

Constructs a BigDecimal which is the exact decimal representation of the BigInteger, with a scale of zero. The value of the BigDecimal is identical to the value of the BigInteger. The parameter must not be null.

The BigDecimal will contain only decimal digits, prefixed with a leading minus sign (hyphen) if the BigInteger is negative. A leading zero will be present only if the BigInteger is zero.
Parameters:
  bi - The BigInteger to be converted.

Constructs a BigDecimal which is the exact decimal representation of the BigInteger, scaled by the second parameter, which may not be negative. The value of the BigDecimal is the BigInteger divided by ten to the power of the scale. The BigInteger parameter must not be null.

The BigDecimal will contain only decimal digits, (with an embedded decimal point followed by scale decimal digits if the scale is positive), prefixed with a leading minus sign (hyphen) if the BigInteger is negative. A leading zero will be present only if the BigInteger is zero.
Parameters:
  bi - The BigInteger to be converted.
Parameters:
  scale - The int specifying the scale.
throws:
  NumberFormatException - if the scale is negative.

Constructs a BigDecimal as though a String had been constructed from the character array and the BigDecimal.BigDecimal(java.lang.String) constructor had then been used. The parameter must not be null.

Using this constructor is faster than using the BigDecimal(String) constructor if the string is already available in character array form.
Parameters:
  inchars - The char[] array containing the numberto be converted.
throws:
  NumberFormatException - if the parameter is not a validnumber.

Constructs a BigDecimal as though a String had been constructed from the character array (or a subarray of that array) and the BigDecimal.BigDecimal(java.lang.String) constructor had then been used. The first parameter must not be null, and the subarray must be wholly contained within it.

Using this constructor is faster than using the BigDecimal(String) constructor if the string is already available within a character array.
Parameters:
  inchars - The char[] array containing the numberto be converted.
Parameters:
  offset - The int offset into the array of thestart of the number to be converted.
Parameters:
  length - The int length of the number.
throws:
  NumberFormatException - if the parameter is not a validnumber for any reason.

Constructs a BigDecimal which is the exact decimal representation of the 64-bit signed binary floating point parameter.

Note that this constructor it an exact conversion; it does not give the same result as converting num to a String using the Double.toString() method and then using the BigDecimal.BigDecimal(java.lang.String) constructor. To get that result, use the static BigDecimal.valueOf(double) method to construct a BigDecimal from a double.
Parameters:
  num - The double to be converted.
throws:
  NumberFormatException - if the parameter is infinite ornot a number.

Constructs a BigDecimal which is the exact decimal representation of the 32-bit signed binary integer parameter. The BigDecimal will contain only decimal digits, prefixed with a leading minus sign (hyphen) if the parameter is negative. A leading zero will be present only if the parameter is zero.
Parameters:
  num - The int to be converted.

Constructs a BigDecimal which is the exact decimal representation of the 64-bit signed binary integer parameter. The BigDecimal will contain only decimal digits, prefixed with a leading minus sign (hyphen) if the parameter is negative. A leading zero will be present only if the parameter is zero.
Parameters:
  num - The long to be converted.

Constructs a BigDecimal from the parameter, which must not be null and must represent a valid number, as described formally in the documentation referred to BigDecimal above .

In summary, numbers in String form must have at least one digit, may have a leading sign, may have a decimal point, and exponential notation may be used. They follow conventional syntax, and may not contain blanks.

Some valid strings from which a BigDecimal might be constructed are:

 "0"         -- Zero
 "12"         -- A whole number
 "-76"         -- A signed whole number
 "12.70"      -- Some decimal places
 "+0.003"      -- Plus sign is allowed
 "17."        -- The same as 17
 ".5"       -- The same as 0.5
 "4E+9"       -- Exponential notation
 "0.73e-7"   -- Exponential notation
 

(Exponential notation means that the number includes an optional sign and a power of ten following an 'E' that indicates how the decimal point will be shifted. Thus the "4E+9" above is just a short way of writing 4000000000, and the "0.73e-7" is short for 0.000000073.)

The BigDecimal constructed from the String is in a standard form, with no blanks, as though the BigDecimal.add(BigDecimal) method had been used to add zero to the number with unlimited precision. If the string uses exponential notation (that is, includes an e or an E), then the BigDecimal number will be expressed in scientific notation (where the power of ten is adjusted so there is a single non-zero digit to the left of the decimal point); in this case if the number is zero then it will be expressed as the single digit 0, and if non-zero it will have an exponent unless that exponent would be 0. The exponent must fit in nine digits both before and after it is expressed in scientific notation.

Any digits in the parameter must be decimal; that is, Character.digit(c, 10) (where c is the character in question) would not return -1.
Parameters:
  string - The String to be converted.
throws:
  NumberFormatException - if the parameter is not a validnumber.

The same as BigDecimal.abs(MathContext) , where the context is new MathContext(0, MathContext.PLAIN).

The length of the decimal part (the scale) of the result will be this.scale() A BigDecimal whose value is the absolutevalue of this BigDecimal.

If the current object is zero or positive, then the same result as invoking the BigDecimal.plus(MathContext) method with the same parameter is returned. Otherwise, the same result as invoking the BigDecimal.negate(MathContext) method with the same parameter is returned.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value is the absolutevalue of this BigDecimal.

The same as BigDecimal.add(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).

The length of the decimal part (the scale) of the result will be the maximum of the scales of the two operands.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe addition. A BigDecimal whose value isthis+rhs, using fixed point arithmetic.

Implements the addition (+) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe addition.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value isthis+rhs.

The same as BigDecimal.compareTo(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison. An int whose value is -1, 0, or 1 asthis is numerically less than, equal to,or greater than rhs.
See Also:   BigDecimal.compareTo(Object)

Implements numeric comparison, (as defined in the decimal documentation, see BigDecimalclass header ), and returns a result of type int.

The result will be:

-1	if the current object is less than the first parameter
0	if the current object is equal to the first parameter
1	if the current object is greater than the first parameter.

A BigDecimal.compareTo(Object) method is also provided.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison.
Parameters:
  set - The MathContext arithmetic settings. An int whose value is -1, 0, or 1 asthis is numerically less than, equal to,or greater than rhs.
See Also:   BigDecimal.compareTo(Object)

If the parameter is null, or is not an instance of the BigDecimal type, an exception is thrown. Otherwise, the parameter is cast to type BigDecimal and the result of the BigDecimal.compareTo(BigDecimal) method, using the cast parameter, is returned.

The BigDecimal.compareTo(BigDecimal,MathContext) method should be used when a MathContext is needed for the comparison.
Parameters:
  rhsobj - The Object for the right hand side ofthe comparison. An int whose value is -1, 0, or 1 asthis is numerically less than, equal to,or greater than rhs.
throws:
  ClassCastException - if rhs cannot be cast toa BigDecimal object.
See Also:   BigDecimal.compareTo(BigDecimal)

The same as BigDecimal.divide(BigDecimal,int) , where the BigDecimal is rhs, and the rounding mode is MathContext.ROUND_HALF_UP . The length of the decimal part (the scale) of the result will be the same as the scale of the current object, if the latter were formatted without exponential notation.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe division. A plain BigDecimal whose value isthis/rhs, using fixed point arithmetic.
throws:
  ArithmeticException - if rhs is zero.

The same as BigDecimal.divide(BigDecimal,int,int) , where the BigDecimal is rhs, and the second parameter is this.scale(), and the third is round.

The length of the decimal part (the scale) of the result will therefore be the same as the scale of the current object, if the latter were formatted without exponential notation.

Parameters:
  rhs - The BigDecimal for the right hand side ofthe division.
Parameters:
  round - The int rounding mode to be used forthe division (see the MathContext class). A plain BigDecimal whose value isthis/rhs, using fixed point arithmeticand the specified rounding mode.
throws:
  IllegalArgumentException - if round is not avalid rounding mode.
throws:
  ArithmeticException - if rhs is zero.
throws:
  ArithmeticException - if round is MathContext.ROUND_UNNECESSARY andthis.scale() is insufficient torepresent the result exactly.

The same as BigDecimal.divide(BigDecimal,MathContext) , where the BigDecimal is rhs, new MathContext(0, MathContext.PLAIN, false, round), except that the length of the decimal part (the scale) to be used for the result is explicit rather than being taken from this.

The length of the decimal part (the scale) of the result will be the same as the scale of the current object, if the latter were formatted without exponential notation.

Parameters:
  rhs - The BigDecimal for the right hand side ofthe division.
Parameters:
  scale - The int scale to be used for the result.
Parameters:
  round - The int rounding mode to be used forthe division (see the MathContext class). A plain BigDecimal whose value isthis/rhs, using fixed point arithmeticand the specified rounding mode.
throws:
  IllegalArgumentException - if round is not avalid rounding mode.
throws:
  ArithmeticException - if rhs is zero.
throws:
  ArithmeticException - if scale is negative.
throws:
  ArithmeticException - if round is MathContext.ROUND_UNNECESSARY and scaleis insufficient to represent the result exactly.

Implements the division (/) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe division.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value isthis/rhs.
throws:
  ArithmeticException - if rhs is zero.

The same as BigDecimal.divideInteger(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).
Parameters:
  rhs - The BigDecimal for the right hand side ofthe integer division. A BigDecimal whose value is the integerpart of this/rhs.
throws:
  ArithmeticException - if rhs is zero.

Implements the integer division operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe integer division.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value is the integerpart of this/rhs.
throws:
  ArithmeticException - if rhs is zero.
throws:
  ArithmeticException - if the result will not fit in thenumber of digits specified for the context.

The double produced is identical to result of expressing the BigDecimal as a String and then converting it using the Double(String) constructor; this can result in values of Double.NEGATIVE_INFINITY or Double.POSITIVE_INFINITY. A double corresponding to this.

If the parameter is null, or is not an instance of the BigDecimal type, or is not exactly equal to the current BigDecimal object, then false is returned. Otherwise, true is returned.

"Exactly equal", here, means that the String representations of the BigDecimal numbers are identical (they have the same characters in the same sequence).

The BigDecimal.compareTo(BigDecimal,MathContext) method should be used for more general comparisons.
Parameters:
  obj - The Object for the right hand side ofthe comparison. A boolean whose value true if andonly if the operands have identical string representations.
throws:
  ClassCastException - if rhs cannot be cast toa BigDecimal object.
See Also:   BigDecimal.compareTo(Object)
See Also:   BigDecimal.compareTo(BigDecimal)
See Also:   BigDecimal.compareTo(BigDecimal,MathContext)

The float produced is identical to result of expressing the BigDecimal as a String and then converting it using the Float(String) constructor; this can result in values of Float.NEGATIVE_INFINITY or Float.POSITIVE_INFINITY. A float corresponding to this.

This method is provided as a primitive for use by more sophisticated classes, such as DecimalFormat, that can apply locale-sensitive editing of the result. The level of formatting that it provides is a necessary part of the BigDecimal class as it is sensitive to and must follow the calculation and rounding rules for BigDecimal arithmetic. However, if the function is provided elsewhere, it may be removed from this class.

The parameters, for both forms of the format method are all of type int. A value of -1 for any parameter indicates that the default action or value for that parameter should be used.

The parameters, before and after, specify the number of characters to be used for the integer part and decimal part of the result respectively. Exponential notation is not used. If either parameter is -1 (which indicates the default action), the number of characters used will be exactly as many as are needed for that part.

before must be a positive number; if it is larger than is needed to contain the integer part, that part is padded on the left with blanks to the requested length. If before is not large enough to contain the integer part of the number (including the sign, for negative numbers) an exception is thrown.

after must be a non-negative number; if it is not the same size as the decimal part of the number, the number will be rounded (or extended with zeros) to fit. Specifying 0 for after will cause the number to be rounded to an integer (that is, it will have no decimal part or decimal point). The rounding method will be the default, MathContext.ROUND_HALF_UP.

Other rounding methods, and the use of exponential notation, can be selected by using BigDecimal.format(int,int,int,int,int,int) . Using the two-parameter form of the method has exactly the same effect as using the six-parameter form with the final four parameters all being -1.
Parameters:
  before - The int specifying the number of placesbefore the decimal point. Use -1 for 'as many asare needed'.
Parameters:
  after - The int specifying the number of placesafter the decimal point. Use -1 for 'as many as areneeded'. A String representing thisBigDecimal, laid out according to thespecified parameters
throws:
  ArithmeticException - if the number cannot be laid out asrequested.
throws:
  IllegalArgumentException - if a parameter is out of range.
See Also:   BigDecimal.toString
See Also:   BigDecimal.toCharArray

This method is provided as a primitive for use by more sophisticated classes, such as DecimalFormat, that can apply locale-sensitive editing of the result. The level of formatting that it provides is a necessary part of the BigDecimal class as it is sensitive to and must follow the calculation and rounding rules for BigDecimal arithmetic. However, if the function is provided elsewhere, it may be removed from this class.

The parameters are all of type int. A value of -1 for any parameter indicates that the default action or value for that parameter should be used.

The first two parameters (before and after) specify the number of characters to be used for the integer part and decimal part of the result respectively, as defined for BigDecimal.format(int,int) . If either of these is -1 (which indicates the default action), the number of characters used will be exactly as many as are needed for that part.

The remaining parameters control the use of exponential notation and rounding. Three (explaces, exdigits, and exform) control the exponent part of the result. As before, the default action for any of these parameters may be selected by using the value -1.

explaces must be a positive number; it sets the number of places (digits after the sign of the exponent) to be used for any exponent part, the default (when explaces is -1) being to use as many as are needed. If explaces is not -1, space is always reserved for an exponent; if one is not needed (for example, if the exponent will be 0) then explaces+2 blanks are appended to the result. If explaces is not -1 and is not large enough to contain the exponent, an exception is thrown.

exdigits sets the trigger point for use of exponential notation. If, before any rounding, the number of places needed before the decimal point exceeds exdigits, or if the absolute value of the result is less than 0.000001, then exponential form will be used, provided that exdigits was specified. When exdigits is -1, exponential notation will never be used. If 0 is specified for exdigits, exponential notation is always used unless the exponent would be 0.

exform sets the form for exponential notation (if needed). It may be either MathContext.SCIENTIFIC or MathContext.ENGINEERING . If the latter, engineering, form is requested, up to three digits (plus sign, if negative) may be needed for the integer part of the result (before). Otherwise, only one digit (plus sign, if negative) is needed.

Finally, the sixth argument, exround, selects the rounding algorithm to be used, and must be one of the values indicated by a public constant in the MathContext class whose name starts with ROUND_. The default (ROUND_HALF_UP) may also be selected by using the value -1, as before.

The special value MathContext.ROUND_UNNECESSARY may be used to detect whether non-zero digits are discarded -- if exround has this value than if non-zero digits would be discarded (rounded) during formatting then an ArithmeticException is thrown.
Parameters:
  before - The int specifying the number of placesbefore the decimal point.Use -1 for 'as many as are needed'.
Parameters:
  after - The int specifying the number of placesafter the decimal point.Use -1 for 'as many as are needed'.
Parameters:
  explaces - The int specifying the number of placesto be used for any exponent.Use -1 for 'as many as are needed'.
Parameters:
  exdigits - The int specifying the trigger(digits before the decimal point) which ifexceeded causes exponential notation to be used.Use 0 to force exponential notation.Use -1 to force plain notation (no exponentialnotation).
Parameters:
  exformint - The int specifying the form ofexponential notation to be used(MathContext.SCIENTIFIC orMathContext.ENGINEERING).
Parameters:
  exround - The int specifying the rounding modeto use.Use -1 for the default, MathContext.ROUND_HALF_UP. A String representing thisBigDecimal, laid out according to thespecified parameters
throws:
  ArithmeticException - if the number cannot be laid out asrequested.
throws:
  IllegalArgumentException - if a parameter is out of range.
See Also:   BigDecimal.toString
See Also:   BigDecimal.toCharArray

Note that two BigDecimal objects are only guaranteed to produce the same hashcode if they are exactly equal (that is, the String representations of the BigDecimal numbers are identical -- they have the same characters in the same sequence). An int that is the hashcode for this.

The same as BigDecimal.max(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison. A BigDecimal whose value isthe maximum of this and rhs.

Returns the larger of the current object and the first parameter.

If calling the BigDecimal.compareTo(BigDecimal,MathContext) method with the same parameters would return 1 or 0, then the result of calling the BigDecimal.plus(MathContext) method on the current object (using the same MathContext parameter) is returned. Otherwise, the result of calling the BigDecimal.plus(MathContext) method on the first parameter object (using the same MathContext parameter) is returned.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value isthe maximum of this and rhs.

The same as BigDecimal.min(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison. A BigDecimal whose value isthe minimum of this and rhs.

Returns the smaller of the current object and the first parameter.

If calling the BigDecimal.compareTo(BigDecimal,MathContext) method with the same parameters would return -1 or 0, then the result of calling the BigDecimal.plus(MathContext) method on the current object (using the same MathContext parameter) is returned. Otherwise, the result of calling the BigDecimal.plus(MathContext) method on the first parameter object (using the same MathContext parameter) is returned.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe comparison.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value isthe minimum of this and rhs.

this.multiply(TEN.pow(new BigDecimal(-n)))

n may be negative, in which case the method returns the same result as movePointRight(-n).
Parameters:
  n - The int specifying the number of places tomove the decimal point leftwards. A BigDecimal derived fromthis, with the decimal point movedn places to the left.

this.multiply(TEN.pow(new BigDecimal(n)))

n may be negative, in which case the method returns the same result as movePointLeft(-n).
Parameters:
  n - The int specifying the number of places tomove the decimal point rightwards. A BigDecimal derived fromthis, with the decimal point movedn places to the right.

The same as BigDecimal.add(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).

The length of the decimal part (the scale) of the result will be the sum of the scales of the operands, if they were formatted without exponential notation.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe multiplication. A BigDecimal whose value isthis*rhs, using fixed point arithmetic.

Implements the multiplication (*) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe multiplication.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value isthis*rhs.

The same as BigDecimal.negate(MathContext) , where the context is new MathContext(0, MathContext.PLAIN).

The length of the decimal part (the scale) of the result will be be this.scale() A BigDecimal whose value is-this.

Implements the negation (Prefix -) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value is-this.

The same as BigDecimal.plus(MathContext) , where the context is new MathContext(0, MathContext.PLAIN).

The length of the decimal part (the scale) of the result will be be this.scale() A BigDecimal whose value is+this.

Implements the plus (Prefix +) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.

This method is useful for rounding or otherwise applying a context to a decimal value.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value is+this.

The same as BigDecimal.pow(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).

The parameter is the power to which the this will be raised; it must be in the range 0 through 999999999, and must have a decimal part of zero. Note that these restrictions may be removed in the future, so they should not be used as a test for a whole number.

In addition, the power must not be negative, as no MathContext is used and so the result would then always be 0.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe operation (the power). A BigDecimal whose value isthis**rhs, using fixed point arithmetic.
throws:
  ArithmeticException - if rhs is out of range oris not a whole number.

Implements the power (**) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.

The first parameter is the power to which the this will be raised; it must be in the range -999999999 through 999999999, and must have a decimal part of zero. Note that these restrictions may be removed in the future, so they should not be used as a test for a whole number.

If the digits setting of the MathContext parameter is 0, the power must be zero or positive.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe operation (the power).
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value isthis**rhs.
throws:
  ArithmeticException - if rhs is out of range oris not a whole number.

The same as BigDecimal.remainder(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).

This is not the modulo operator -- the result may be negative.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe remainder operation. A BigDecimal whose value is the remainderof this/rhs, using fixed point arithmetic.
throws:
  ArithmeticException - if rhs is zero.

Implements the remainder operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.

This is not the modulo operator -- the result may be negative.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe remainder operation.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value is the remainderof this+rhs.
throws:
  ArithmeticException - if rhs is zero.
throws:
  ArithmeticException - if the integer part of the result willnot fit in the number of digits specified for thecontext.

If the given scale (which must be zero or positive) is the same as or greater than the length of the decimal part (the scale) of this BigDecimal then trailing zeros will be added to the decimal part as necessary.

If the given scale is less than the length of the decimal part (the scale) of this BigDecimal then trailing digits will be removed, and in this case an ArithmeticException is thrown if any discarded digits are non-zero.

The same as BigDecimal.setScale(int,int) , where the first parameter is the scale, and the second is MathContext.ROUND_UNNECESSARY.
Parameters:
  scale - The int specifying the scale of theresulting BigDecimal. A plain BigDecimal with the given scale.
throws:
  ArithmeticException - if scale is negative.
throws:
  ArithmeticException - if reducing scale would discardnon-zero digits.

If the given scale (which must be zero or positive) is the same as or greater than the length of the decimal part (the scale) of this BigDecimal then trailing zeros will be added to the decimal part as necessary.

If the given scale is less than the length of the decimal part (the scale) of this BigDecimal then trailing digits will be removed, and the rounding mode given by the second parameter is used to determine if the remaining digits are affected by a carry. In this case, an IllegalArgumentException is thrown if round is not a valid rounding mode.

If round is MathContext.ROUND_UNNECESSARY, an ArithmeticException is thrown if any discarded digits are non-zero.
Parameters:
  scale - The int specifying the scale of theresulting BigDecimal.
Parameters:
  round - The int rounding mode to be used forthe division (see the MathContext class). A plain BigDecimal with the given scale.
throws:
  IllegalArgumentException - if round is not avalid rounding mode.
throws:
  ArithmeticException - if scale is negative.
throws:
  ArithmeticException - if round isMathContext.ROUND_UNNECESSARY, andreducing scale would discard non-zero digits.

The same as BigDecimal.subtract(BigDecimal,MathContext) , where the BigDecimal is rhs, and the context is new MathContext(0, MathContext.PLAIN).

The length of the decimal part (the scale) of the result will be the maximum of the scales of the two operands.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe subtraction. A BigDecimal whose value isthis-rhs, using fixed point arithmetic.

Implements the subtraction (-) operator (as defined in the decimal documentation, see BigDecimalclass header ), and returns the result as a BigDecimal object.
Parameters:
  rhs - The BigDecimal for the right hand side ofthe subtraction.
Parameters:
  set - The MathContext arithmetic settings. A BigDecimal whose value isthis-rhs.

This is an exact conversion; the result is the same as if the BigDecimal were formatted as a plain number without any rounding or exponent and then the java.math.BigDecimal(java.lang.String) constructor were used to construct the result.

(Note: this method is provided only in the com.ibm.icu.math version of the BigDecimal class. It would not be present in a java.math version.) The java.math.BigDecimal equal in valueto this BigDecimal.

Any decimal part is truncated (discarded). If an exception is desired should the decimal part be non-zero, use BigDecimal.toBigIntegerExact() . The java.math.BigInteger equal in valueto the integer part of this BigDecimal.

An exception is thrown if the decimal part (if any) is non-zero. The java.math.BigInteger equal in valueto the integer part of this BigDecimal.
throws:
  ArithmeticException - if this has a non-zerodecimal part.

By definition, using the BigDecimal.BigDecimal(String) constructor on the result String will create a BigDecimal that is exactly equal to the original BigDecimal. The String exactly corresponding to thisBigDecimal.
See Also:   BigDecimal.format(int,int)
See Also:   BigDecimal.format(int,int,int,int,int,int)
See Also:   BigDecimal.toCharArray()

Returns a BigDecimal which is the decimal representation of the 64-bit signed binary floating point parameter. If the parameter is infinite, or is not a number (NaN), a NumberFormatException is thrown.

The number is constructed as though num had been converted to a String using the Double.toString() method and the BigDecimal.BigDecimal(java.lang.String) constructor had then been used. This is typically not an exact conversion.
Parameters:
  dub - The double to be translated. The BigDecimal equal in value todub.
throws:
  NumberFormatException - if the parameter is infinite ornot a number.

The result is given by:

(new BigDecimal(lint)).divide(TEN.pow(new BigDecimal(scale)))

A NumberFormatException is thrown if scale is negative.
Parameters:
  lint - The long to be translated.
Parameters:
  scale - The int scale to be applied. The BigDecimal equal in value tolint.
throws:
  NumberFormatException - if the scale is negative.