scala.math

# BigDecimal

#### final class BigDecimal extends ScalaNumber with ScalaNumericConversions with Serializable

`BigDecimal` represents decimal floating-point numbers of arbitrary precision. By default, the precision approximately matches that of IEEE 128-bit floating point numbers (34 decimal digits, `HALF_EVEN` rounding mode). Within the range of IEEE binary128 numbers, `BigDecimal` will agree with `BigInt` for both equality and hash codes (and will agree with primitive types as well). Beyond that range--numbers with more than 4934 digits when written out in full--the `hashCode` of `BigInt` and `BigDecimal` is allowed to diverge due to difficulty in efficiently computing both the decimal representation in `BigDecimal` and the binary representation in `BigInt`.

When creating a `BigDecimal` from a `Double` or `Float`, care must be taken as the binary fraction representation of `Double` and `Float` does not easily convert into a decimal representation. Three explicit schemes are available for conversion. `BigDecimal.decimal` will convert the floating-point number to a decimal text representation, and build a `BigDecimal` based on that. `BigDecimal.binary` will expand the binary fraction to the requested or default precision. `BigDecimal.exact` will expand the binary fraction to the full number of digits, thus producing the exact decimal value corrsponding to the binary fraction of that floating-point number. `BigDecimal` equality matches the decimal expansion of `Double`: `BigDecimal.decimal(0.1) == 0.1`. Note that since `0.1f != 0.1`, the same is not true for `Float`. Instead, `0.1f == BigDecimal.decimal((0.1f).toDouble)`.

To test whether a `BigDecimal` number can be converted to a `Double` or `Float` and then back without loss of information by using one of these methods, test with `isDecimalDouble`, `isBinaryDouble`, or `isExactDouble` or the corresponding `Float` versions. Note that `BigInt`'s `isValidDouble` will agree with `isExactDouble`, not the `isDecimalDouble` used by default.

`BigDecimal` uses the decimal representation of binary floating-point numbers to determine equality and hash codes. This yields different answers than conversion between `Long` and `Double` values, where the exact form is used. As always, since floating-point is a lossy representation, it is advisable to take care when assuming identity will be maintained across multiple conversions.

`BigDecimal` maintains a `MathContext` that determines the rounding that is applied to certain calculations. In most cases, the value of the `BigDecimal` is also rounded to the precision specified by the `MathContext`. To create a `BigDecimal` with a different precision than its `MathContext`, use `new BigDecimal(new java.math.BigDecimal(...), mc)`. Rounding will be applied on those mathematical operations that can dramatically change the number of digits in a full representation, namely multiplication, division, and powers. The left-hand argument's `MathContext` always determines the degree of rounding, if any, and is the one propagated through arithmetic operations that do not apply rounding themselves.

Source
  BigDecimal.scala
Version

  1.1

Linear Supertypes
Serializable, ScalaNumericConversions, ScalaNumericAnyConversions, ScalaNumber, Number, java.io.Serializable, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. BigDecimal
2. Serializable
3. ScalaNumericConversions
4. ScalaNumericAnyConversions
5. ScalaNumber
6. Number
7. Serializable
8. AnyRef
9. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Instance Constructors

1. #### new BigDecimal(bigDecimal: java.math.BigDecimal)

2. #### new BigDecimal(bigDecimal: java.math.BigDecimal, mc: MathContext)

### Value Members

1. #### final def !=(arg0: Any): Boolean

   Definition Classes
     AnyRef → Any

2. #### final def ##(): Int

   Definition Classes
     AnyRef → Any

3. #### def %(that: BigDecimal): BigDecimal

   Remainder after dividing this by that.

4. #### def *(that: BigDecimal): BigDecimal

   Multiplication of BigDecimals

5. #### def +(that: BigDecimal): BigDecimal

   Addition of BigDecimals

6. #### def -(that: BigDecimal): BigDecimal

   Subtraction of BigDecimals

7. #### def ->[B](y: B): (BigDecimal, B)

   Implicit information
     This member is added by an implicit conversion from BigDecimal to ArrowAssoc[BigDecimal] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()

8. #### def /(that: BigDecimal): BigDecimal

   Division of BigDecimals

9. #### def /%(that: BigDecimal): (BigDecimal, BigDecimal)

   Division and Remainder - returns tuple containing the result of divideToIntegralValue and the remainder.

   Division and Remainder - returns tuple containing the result of divideToIntegralValue and the remainder. The computation is exact: no rounding is applied.

10. #### def <(that: BigDecimal): Boolean

    Less-than of BigDecimals

11. #### def <=(that: BigDecimal): Boolean

    Less-than-or-equals comparison of BigDecimals

12. #### final def ==(arg0: Any): Boolean

    Definition Classes
      AnyRef → Any

13. #### def >(that: BigDecimal): Boolean

    Greater-than comparison of BigDecimals

14. #### def >=(that: BigDecimal): Boolean

    Greater-than-or-equals comparison of BigDecimals

15. #### def abs: BigDecimal

    Returns the absolute value of this BigDecimal

16. #### def apply(mc: MathContext): BigDecimal

    Returns a new BigDecimal based on the supplied MathContext, rounded as needed.

17. #### final def asInstanceOf[T0]: T0

    Definition Classes
      Any

18. #### val bigDecimal: java.math.BigDecimal

19. #### def byteValue(): Byte

    Converts this BigDecimal to a Byte.

    Converts this BigDecimal to a Byte. If the BigDecimal is too big to fit in a Byte, only the low-order 8 bits are returned. Note that this conversion can lose information about the overall magnitude of the BigDecimal value as well as return a result with the opposite sign.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions → Number

20. #### def charValue: Char

    Converts this BigDecimal to a Char.

    Converts this BigDecimal to a Char. If the BigDecimal is too big to fit in a Char, only the low-order 16 bits are returned. Note that this conversion can lose information about the overall magnitude of the BigDecimal value and that it always returns a positive result.

21. #### def clone(): AnyRef

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

22. #### def compare(that: BigDecimal): Int

    Compares this BigDecimal with the specified BigDecimal

23. #### def doubleValue(): Double

    Converts this BigDecimal to a Double.

    Converts this BigDecimal to a Double. if this BigDecimal has too great a magnitude to represent as a double, it will be converted to `Double.NEGATIVE_INFINITY` or `Double.POSITIVE_INFINITY` as appropriate.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions → Number

24. #### def ensuring(cond: (BigDecimal) ⇒ Boolean, msg: ⇒ Any): BigDecimal

    Implicit information
      This member is added by an implicit conversion from BigDecimal to Ensuring[BigDecimal] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

25. #### def ensuring(cond: (BigDecimal) ⇒ Boolean): BigDecimal

    Implicit information
      This member is added by an implicit conversion from BigDecimal to Ensuring[BigDecimal] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

26. #### def ensuring(cond: Boolean, msg: ⇒ Any): BigDecimal

    Implicit information
      This member is added by an implicit conversion from BigDecimal to Ensuring[BigDecimal] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

27. #### def ensuring(cond: Boolean): BigDecimal

    Implicit information
      This member is added by an implicit conversion from BigDecimal to Ensuring[BigDecimal] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

28. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

29. #### def equals(that: BigDecimal): Boolean

    Compares this BigDecimal with the specified BigDecimal for equality.

30. #### def equals(that: Any): Boolean

    Compares this BigDecimal with the specified value for equality.

    Compares this BigDecimal with the specified value for equality. Where `Float` and `Double` disagree, `BigDecimal` will agree with the `Double` value

    Definition Classes
      BigDecimal → AnyRef → Any

31. #### def finalize(): Unit

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

32. #### def floatValue(): Float

    Converts this BigDecimal to a Float.

    Converts this BigDecimal to a Float. if this BigDecimal has too great a magnitude to represent as a float, it will be converted to `Float.NEGATIVE_INFINITY` or `Float.POSITIVE_INFINITY` as appropriate.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions → Number

33. #### def formatted(fmtstr: String): String

    Returns string formatted according to given `format` string.

    Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

    Implicit information
      This member is added by an implicit conversion from BigDecimal to StringFormat[BigDecimal] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

34. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

35. #### def hashCode(): Int

    Returns the hash code for this BigDecimal.

    Returns the hash code for this BigDecimal. Note that this does not merely use the underlying java object's `hashCode` because we compare `BigDecimal`s with `compareTo` which deems 2 == 2.00, whereas in java these are unequal with unequal `hashCode`s. These hash codes agree with `BigInt` for whole numbers up ~4934 digits (the range of IEEE 128 bit floating point). Beyond this, hash codes will disagree; this prevents the explicit represention of the `BigInt` form for `BigDecimal` values with large exponents.

    Definition Classes
      BigDecimal → AnyRef → Any

36. #### def intValue(): Int

    Converts this BigDecimal to an Int.

    Converts this BigDecimal to an Int. If the BigDecimal is too big to fit in an Int, only the low-order 32 bits are returned. Note that this conversion can lose information about the overall magnitude of the BigDecimal value as well as return a result with the opposite sign.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions → Number

37. #### def isBinaryDouble: Boolean

    Tests whether this `BigDecimal` holds, to within precision, the binary representation of a `Double`.

38. #### def isBinaryFloat: Boolean

    Tests whether this `BigDecimal` holds, to within precision, the binary representation of a `Float`.

39. #### def isDecimalDouble: Boolean

    Tests whether this `BigDecimal` holds the decimal representation of a `Double`.

40. #### def isDecimalFloat: Boolean

    Tests whether this `BigDecimal` holds the decimal representation of a `Float`.

41. #### def isExactDouble: Boolean

    Tests whether this `BigDecimal` holds the exact expansion of a `Double`'s binary fractional form into base 10.

42. #### def isExactFloat: Boolean

    Tests whether this `BigDecimal` holds the exact expansion of a `Float`'s binary fractional form into base 10.

43. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

44. #### def isValidByte: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions

45. #### def isValidChar: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions

46. #### def isValidInt: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions

47. #### def isValidLong: Boolean

48. #### def isValidShort: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions

49. #### def isWhole(): Boolean

    returns

      `true` if this number has no decimal component, `false` otherwise.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions → ScalaNumber

50. #### def longValue(): Long

    Converts this BigDecimal to a Long.

    Converts this BigDecimal to a Long. If the BigDecimal is too big to fit in a Long, only the low-order 64 bits are returned. Note that this conversion can lose information about the overall magnitude of the BigDecimal value as well as return a result with the opposite sign.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions → Number

51. #### def max(that: BigDecimal): BigDecimal

    Returns the maximum of this and that, or this if the two are equal

52. #### val mc: MathContext

53. #### def min(that: BigDecimal): BigDecimal

    Returns the minimum of this and that, or this if the two are equal

54. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

55. #### final def notify(): Unit

    Definition Classes
      AnyRef

56. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

57. #### def pow(n: Int): BigDecimal

    Returns a BigDecimal whose value is this ** n.

58. #### def precision: Int

    Returns the precision of this `BigDecimal`.

59. #### def quot(that: BigDecimal): BigDecimal

    Divide to Integral value.

60. #### def remainder(that: BigDecimal): BigDecimal

    Remainder after dividing this by that.

61. #### def round(mc: MathContext): BigDecimal

    Returns a BigDecimal rounded according to the supplied MathContext settings, but preserving its own MathContext for future operations.

62. #### def rounded: BigDecimal

    Returns a `BigDecimal` rounded according to its own `MathContext`

63. #### def scale: Int

    Returns the scale of this `BigDecimal`.

64. #### def setScale(scale: Int, mode: RoundingMode): BigDecimal

65. #### def setScale(scale: Int): BigDecimal

    Returns a `BigDecimal` whose scale is the specified value, and whose value is numerically equal to this BigDecimal's.

66. #### def shortValue(): Short

    Converts this BigDecimal to a Short.

    Converts this BigDecimal to a Short. If the BigDecimal is too big to fit in a Short, only the low-order 16 bits are returned. Note that this conversion can lose information about the overall magnitude of the BigDecimal value as well as return a result with the opposite sign.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions → Number

67. #### def signum: Int

    Returns the sign of this BigDecimal, i.e.

    Returns the sign of this BigDecimal, i.e. -1 if it is less than 0, +1 if it is greater than 0 0 if it is equal to 0

68. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

69. #### def to(end: BigDecimal, step: BigDecimal): Inclusive[scala.BigDecimal]

    Like `until`, but inclusive of the end value.

70. #### def to(end: BigDecimal): Partial[BigDecimal, Inclusive[BigDecimal]]

    Like `until`, but inclusive of the end value.

71. #### def toBigInt(): BigInt

    Converts this `BigDecimal` to a scala.BigInt.

72. #### def toBigIntExact(): Option[BigInt]

    Converts this `BigDecimal` to a scala.BigInt if it can be done losslessly, returning Some(BigInt) or None.

73. #### def toByte: Byte

    Returns the value of this as a scala.Byte.

    Returns the value of this as a scala.Byte. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

74. #### def toByteExact: Byte

    Converts this `BigDecimal` to a scala.Byte, checking for lost information.

    Converts this `BigDecimal` to a scala.Byte, checking for lost information. If this `BigDecimal` has a nonzero fractional part, or is out of the possible range for a scala.Byte result, then a `java.lang.ArithmeticException` is thrown.

75. #### def toChar: Char

    Returns the value of this as a scala.Char.

    Returns the value of this as a scala.Char. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

76. #### def toDouble: Double

    Returns the value of this as a scala.Double.

    Returns the value of this as a scala.Double. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

77. #### def toFloat: Float

    Returns the value of this as a scala.Float.

    Returns the value of this as a scala.Float. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

78. #### def toInt: Int

    Returns the value of this as an scala.Int.

    Returns the value of this as an scala.Int. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

79. #### def toIntExact: Int

    Converts this `BigDecimal` to a scala.Int, checking for lost information.

    Converts this `BigDecimal` to a scala.Int, checking for lost information. If this `BigDecimal` has a nonzero fractional part, or is out of the possible range for an scala.Int result, then a `java.lang.ArithmeticException` is thrown.

80. #### def toLong: Long

    Returns the value of this as a scala.Long.

    Returns the value of this as a scala.Long. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

81. #### def toLongExact: Long

    Converts this `BigDecimal` to a scala.Long, checking for lost information.

    Converts this `BigDecimal` to a scala.Long, checking for lost information. If this `BigDecimal` has a nonzero fractional part, or is out of the possible range for a scala.Long result, then a `java.lang.ArithmeticException` is thrown.

82. #### def toShort: Short

    Returns the value of this as a scala.Short.

    Returns the value of this as a scala.Short. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

83. #### def toShortExact: Short

    Converts this `BigDecimal` to a scala.Short, checking for lost information.

    Converts this `BigDecimal` to a scala.Short, checking for lost information. If this `BigDecimal` has a nonzero fractional part, or is out of the possible range for a scala.Short result, then a `java.lang.ArithmeticException` is thrown.

84. #### def toString(): String

    Returns the decimal String representation of this BigDecimal.

    Returns the decimal String representation of this BigDecimal.

    Definition Classes
      BigDecimal → AnyRef → Any

85. #### def ulp: BigDecimal

    Returns the size of an ulp, a unit in the last place, of this BigDecimal.

86. #### def unary_-: BigDecimal

    Returns a BigDecimal whose value is the negation of this BigDecimal

87. #### def underlying(): java.math.BigDecimal

    Definition Classes
      BigDecimal → ScalaNumericConversions → ScalaNumericAnyConversions → ScalaNumber

88. #### def unifiedPrimitiveEquals(x: Any): Boolean

    Should only be called after all known non-primitive types have been excluded.

    Should only be called after all known non-primitive types have been excluded. This method won't dispatch anywhere else after checking against the primitives to avoid infinite recursion between equals and this on unknown "Number" variants.

    Additionally, this should only be called if the numeric type is happy to be converted to Long, Float, and Double. If for instance a BigInt much larger than the Long range is sent here, it will claim equality with whatever Long is left in its lower 64 bits. Or a BigDecimal with more precision than Double can hold: same thing. There's no way given the interface available here to prevent this error.

    Attributes
      protected
    Definition Classes
      ScalaNumericAnyConversions

89. #### def unifiedPrimitiveHashcode(): Int

    Attributes
      protected
    Definition Classes
      ScalaNumericAnyConversions

90. #### def until(end: BigDecimal, step: BigDecimal): Exclusive[scala.BigDecimal]

    Same as the one-argument `until`, but creates the range immediately.

91. #### def until(end: BigDecimal): Partial[BigDecimal, Exclusive[BigDecimal]]

    Creates a partially constructed NumericRange[BigDecimal] in range `[start;end)`, where start is the target BigDecimal.

    Creates a partially constructed NumericRange[BigDecimal] in range `[start;end)`, where start is the target BigDecimal. The step must be supplied via the "by" method of the returned object in order to receive the fully constructed range. For example:

        val partial = BigDecimal(1.0) to 2.0       // not usable yet
        val range = partial by 0.01                // now a NumericRange
        val range2 = BigDecimal(0) to 1.0 by 0.01  // all at once of course is fine too

    end

      the end value of the range (exclusive)

    returns

      the partially constructed NumericRange

92. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

93. #### final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

94. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

95. #### def →[B](y: B): (BigDecimal, B)

    Implicit information
      This member is added by an implicit conversion from BigDecimal to ArrowAssoc[BigDecimal] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implicit Value Members

1. #### def +(other: String): String

   Implicit information
     This member is added by an implicit conversion from BigDecimal to any2stringadd[BigDecimal] performed by method any2stringadd in scala.Predef.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigDecimal: any2stringadd[BigDecimal]).+(other)

   Definition Classes
     any2stringadd

### Deprecated Value Members

1. #### def isValidDouble: Boolean

   Tests whether the value is a valid Double.

   Tests whether the value is a valid Double. "Valid" has several distinct meanings, however. Use `isExactDouble`, `isBinaryDouble`, or `isDecimalDouble`, depending on the intended meaning. By default, `decimal` creation is used, so `isDecimalDouble` is probably what you want.

   Annotations
     @deprecated
   Deprecated

     (Since version 2.11) Validity has two distinct meanings. Use `isExactBinaryDouble` or `equivalentToDouble` instead.

2. #### def isValidFloat: Boolean

   Tests whether the value is a valid Float.

   Tests whether the value is a valid Float. "Valid" has several distinct meanings, however. Use `isExactFloat`, `isBinaryFloat`, or `isDecimalFloat`, depending on the intended meaning. By default, `decimal` creation is used, so `isDecimalFloat` is probably what you want.

   Annotations
     @deprecated
   Deprecated

     (Since version 2.11) What constitutes validity is unclear. Use `isExactFloat`, `isBinaryFloat`, or `isDecimalFloat` instead.

### Inherited from Serializable

### Inherited from ScalaNumericConversions

### Inherited from ScalaNumericAnyConversions

### Inherited from ScalaNumber

### Inherited from Number

### Inherited from java.io.Serializable

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from BigDecimal to any2stringadd[BigDecimal]

### Inherited by implicit conversion StringFormat from BigDecimal to StringFormat[BigDecimal]

### Inherited by implicit conversion Ensuring from BigDecimal to Ensuring[BigDecimal]

### Inherited by implicit conversion ArrowAssoc from BigDecimal to ArrowAssoc[BigDecimal]

### Ungrouped