Packages

final class BigDecimal extends ScalaNumber with ScalaNumericConversions with Serializable with Ordered[BigDecimal]

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 corresponding 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
Linear Supertypes
Ordered[BigDecimal], Comparable[BigDecimal], Serializable, ScalaNumericConversions, ScalaNumericAnyConversions, ScalaNumber, Number, java.io.Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BigDecimal
  2. Ordered
  3. Comparable
  4. Serializable
  5. ScalaNumericConversions
  6. ScalaNumericAnyConversions
  7. ScalaNumber
  8. Number
  9. Serializable
  10. AnyRef
  11. Any
Implicitly
  1. by orderingToOrdered
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
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. def %(that: BigDecimal): BigDecimal

    Remainder after dividing this by that.

  2. def *(that: BigDecimal): BigDecimal

    Multiplication of BigDecimals

  3. def +(that: BigDecimal): BigDecimal

    Addition of BigDecimals

  4. def -(that: BigDecimal): BigDecimal

    Subtraction of BigDecimals

  5. def /(that: BigDecimal): BigDecimal

    Division of BigDecimals

  6. 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.

  7. def <(that: BigDecimal): Boolean

    Returns true if this is less than that

    Returns true if this is less than that

    Definition Classes
    Ordered
  8. def <=(that: BigDecimal): Boolean

    Returns true if this is less than or equal to that.

    Returns true if this is less than or equal to that.

    Definition Classes
    Ordered
  9. def >(that: BigDecimal): Boolean

    Returns true if this is greater than that.

    Returns true if this is greater than that.

    Definition Classes
    Ordered
  10. def >=(that: BigDecimal): Boolean

    Returns true if this is greater than or equal to that.

    Returns true if this is greater than or equal to that.

    Definition Classes
    Ordered
  11. def abs: BigDecimal

    Returns the absolute value of this BigDecimal

  12. def apply(mc: MathContext): BigDecimal

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

  13. val bigDecimal: java.math.BigDecimal
  14. 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
    BigDecimalScalaNumericAnyConversions → Number
  15. 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.

  16. def compare(that: BigDecimal): Int

    Compares this BigDecimal with the specified BigDecimal

    Compares this BigDecimal with the specified BigDecimal

    Definition Classes
    BigDecimalOrdered
  17. def compareTo(that: BigDecimal): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Definition Classes
    Ordered → Comparable
  18. 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
    BigDecimalScalaNumericAnyConversions → Number
  19. def equals(that: BigDecimal): Boolean

    Compares this BigDecimal with the specified BigDecimal for equality.

  20. 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

    that

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    BigDecimal → AnyRef → Any
  21. 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
    BigDecimalScalaNumericAnyConversions → Number
  22. 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 BigDecimals with compareTo which deems 2 == 2.00, whereas in java these are unequal with unequal hashCodes. 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 representation of the BigInt form for BigDecimal values with large exponents.

    returns

    the hash code value for this object.

    Definition Classes
    BigDecimal → AnyRef → Any
  23. 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
    BigDecimalScalaNumericAnyConversions → Number
  24. def isBinaryDouble: Boolean

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

  25. def isBinaryFloat: Boolean

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

  26. def isDecimalDouble: Boolean

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

  27. def isDecimalFloat: Boolean

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

  28. def isExactDouble: Boolean

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

  29. def isExactFloat: Boolean

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

  30. 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
    BigDecimalScalaNumericAnyConversions
  31. 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
    BigDecimalScalaNumericAnyConversions
  32. 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
    BigDecimalScalaNumericAnyConversions
  33. def isValidLong: Boolean
  34. 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
    BigDecimalScalaNumericAnyConversions
  35. def isWhole(): Boolean

    returns

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

    Definition Classes
    BigDecimalScalaNumericAnyConversions → ScalaNumber
  36. 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
    BigDecimalScalaNumericAnyConversions → Number
  37. def max(that: BigDecimal): BigDecimal

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

  38. val mc: MathContext
  39. def min(that: BigDecimal): BigDecimal

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

  40. def pow(n: Int): BigDecimal

    Returns a BigDecimal whose value is this ** n.

  41. def precision: Int

    Returns the precision of this BigDecimal.

  42. def quot(that: BigDecimal): BigDecimal

    Divide to Integral value.

  43. def remainder(that: BigDecimal): BigDecimal

    Remainder after dividing this by that.

  44. def round(mc: MathContext): BigDecimal

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

  45. def rounded: BigDecimal

    Returns a BigDecimal rounded according to its own MathContext

  46. def scale: Int

    Returns the scale of this BigDecimal.

  47. def setScale(scale: Int, mode: RoundingMode): BigDecimal
  48. def setScale(scale: Int): BigDecimal

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

  49. 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
    BigDecimalScalaNumericAnyConversions → Number
  50. def signum: Int

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

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

    Like until, but inclusive of the end value.

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

    Like until, but inclusive of the end value.

  53. def toBigInt(): BigInt

    Converts this BigDecimal to a scala.BigInt.

  54. def toBigIntExact(): Option[BigInt]

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

  55. 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
  56. 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.

  57. 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
  58. 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
  59. 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
  60. 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
  61. 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.

  62. 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
  63. 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.

  64. 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
  65. 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.

  66. def toString(): String

    Returns the decimal String representation of this BigDecimal.

    Returns the decimal String representation of this BigDecimal.

    returns

    a String representation of the object.

    Definition Classes
    BigDecimal → AnyRef → Any
  67. def ulp: BigDecimal

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

  68. def unary_-: BigDecimal

    Returns a BigDecimal whose value is the negation of this BigDecimal

  69. def underlying(): java.math.BigDecimal
    Definition Classes
    BigDecimalScalaNumericConversionsScalaNumericAnyConversions → ScalaNumber
  70. def until(end: BigDecimal, step: BigDecimal): Exclusive[scala.BigDecimal]

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

  71. 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

Shadowed Implicit Value Members

  1. def <(that: BigDecimal): Boolean

    Returns true if this is less than that

    Returns true if this is less than that

    Implicit
    This member is added by an implicit conversion from BigDecimal to Ordered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
    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: Ordered[BigDecimal]).<(that)
    Definition Classes
    Ordered
  2. def <=(that: BigDecimal): Boolean

    Returns true if this is less than or equal to that.

    Returns true if this is less than or equal to that.

    Implicit
    This member is added by an implicit conversion from BigDecimal to Ordered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
    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: Ordered[BigDecimal]).<=(that)
    Definition Classes
    Ordered
  3. def >(that: BigDecimal): Boolean

    Returns true if this is greater than that.

    Returns true if this is greater than that.

    Implicit
    This member is added by an implicit conversion from BigDecimal to Ordered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
    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: Ordered[BigDecimal]).>(that)
    Definition Classes
    Ordered
  4. def >=(that: BigDecimal): Boolean

    Returns true if this is greater than or equal to that.

    Returns true if this is greater than or equal to that.

    Implicit
    This member is added by an implicit conversion from BigDecimal to Ordered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
    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: Ordered[BigDecimal]).>=(that)
    Definition Classes
    Ordered
  5. def compare(that: BigDecimal): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Implement this method to determine how instances of A will be sorted.

    Returns x where:

    • x < 0 when this < that
    • x == 0 when this == that
    • x > 0 when this > that
    Implicit
    This member is added by an implicit conversion from BigDecimal to Ordered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
    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: Ordered[BigDecimal]).compare(that)
    Definition Classes
    Ordered
  6. def compareTo(that: BigDecimal): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Implicit
    This member is added by an implicit conversion from BigDecimal to Ordered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
    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: Ordered[BigDecimal]).compareTo(that)
    Definition Classes
    Ordered → Comparable

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.0) Validity has distinct meanings. Use isExactDouble, isBinaryDouble, or isDecimalDouble 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.0) What constitutes validity is unclear. Use isExactFloat, isBinaryFloat, or isDecimalFloat instead.