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.

Version: 1.1

Linear Supertypes

Serializable, ScalaNumericConversions, ScalaNumericAnyConversions, ScalaNumber, Number, java.io.Serializable, AnyRef, Any

Instance Constructors

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

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def %(that: BigDecimal): BigDecimal

Remainder after dividing this by that.
def *(that: BigDecimal): BigDecimal

Multiplication of BigDecimals
def +(that: BigDecimal): BigDecimal

Addition of BigDecimals
def -(that: BigDecimal): BigDecimal

Subtraction of BigDecimals
def /(that: BigDecimal): BigDecimal

Division of BigDecimals
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.
def <(that: BigDecimal): Boolean

Less-than of BigDecimals
def <=(that: BigDecimal): Boolean

Less-than-or-equals comparison of BigDecimals
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def >(that: BigDecimal): Boolean

Greater-than comparison of BigDecimals
def >=(that: BigDecimal): Boolean

Greater-than-or-equals comparison of BigDecimals
def abs: BigDecimal

Returns the absolute value of this BigDecimal
def apply(mc: MathContext): BigDecimal

Returns a new BigDecimal based on the supplied MathContext, rounded as needed.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val bigDecimal: java.math.BigDecimal
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
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.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def compare(that: BigDecimal): Int

Compares this BigDecimal with the specified BigDecimal
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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(that: BigDecimal): Boolean

Compares this BigDecimal with the specified BigDecimal for equality.
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
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
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.

Definition Classes
BigDecimal → AnyRef → Any
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
def isBinaryDouble: Boolean

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

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

Tests whether this BigDecimal holds the decimal representation of a Double.
def isDecimalFloat: Boolean

Tests whether this BigDecimal holds the decimal representation of a Float.
def isExactDouble: Boolean

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

Tests whether this BigDecimal holds the exact expansion of a Float's binary fractional form into base 10.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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
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
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
def isValidLong: Boolean
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
def isWhole(): Boolean

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

Definition Classes
BigDecimal → ScalaNumericAnyConversions → ScalaNumber
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
def max(that: BigDecimal): BigDecimal

Returns the maximum of this and that, or this if the two are equal
val mc: MathContext
def min(that: BigDecimal): BigDecimal

Returns the minimum of this and that, or this if the two are equal
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pow(n: Int): BigDecimal

Returns a BigDecimal whose value is this ** n.
def precision: Int

Returns the precision of this BigDecimal.
def quot(that: BigDecimal): BigDecimal

Divide to Integral value.
def remainder(that: BigDecimal): BigDecimal

Remainder after dividing this by that.
def round(mc: MathContext): BigDecimal

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

Returns a BigDecimal rounded according to its own MathContext
def scale: Int

Returns the scale of this BigDecimal.
def setScale(scale: Int, mode: RoundingMode): BigDecimal
def setScale(scale: Int): BigDecimal

Returns a BigDecimal whose scale is the specified value, and whose value is numerically equal to this BigDecimal's.
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
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def to(end: BigDecimal, step: BigDecimal): Inclusive[scala.BigDecimal]

Like until, but inclusive of the end value.
def to(end: BigDecimal): Partial[BigDecimal, Inclusive[BigDecimal]]

Like until, but inclusive of the end value.
def toBigInt(): BigInt

Converts this BigDecimal to a scala.BigInt.
def toBigIntExact(): Option[BigInt]

Converts this BigDecimal to a scala.BigInt if it can be done losslessly, returning Some(BigInt) or None.
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
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.
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
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
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
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
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.
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
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.
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
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.
def toString(): String

Returns the decimal String representation of this BigDecimal.
Returns the decimal String representation of this BigDecimal.

Definition Classes
BigDecimal → AnyRef → Any
def ulp: BigDecimal

Returns the size of an ulp, a unit in the last place, of this BigDecimal.
def unary_-: BigDecimal

Returns a BigDecimal whose value is the negation of this BigDecimal
def underlying(): java.math.BigDecimal

Definition Classes
BigDecimal → ScalaNumericConversions → ScalaNumericAnyConversions → ScalaNumber
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
def unifiedPrimitiveHashcode(): Int

Attributes
protected
Definition Classes
ScalaNumericAnyConversions
def until(end: BigDecimal, step: BigDecimal): Exclusive[scala.BigDecimal]

Same as the one-argument until, but creates the range immediately.
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
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

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 distinct meanings. Use isExactDouble, isBinaryDouble, or isDecimalDouble instead.
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.

Related Docs: object BigDecimal | package math

final class BigDecimal extends ScalaNumber with ScalaNumericConversions with Serializable

Instance Constructors

new BigDecimal(bigDecimal: java.math.BigDecimal)

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def %(that: BigDecimal): BigDecimal

def *(that: BigDecimal): BigDecimal

def +(that: BigDecimal): BigDecimal

def -(that: BigDecimal): BigDecimal

def /(that: BigDecimal): BigDecimal

def /%(that: BigDecimal): (BigDecimal, BigDecimal)

def <(that: BigDecimal): Boolean

def <=(that: BigDecimal): Boolean

final def ==(arg0: Any): Boolean

def >(that: BigDecimal): Boolean

def >=(that: BigDecimal): Boolean

def abs: BigDecimal

def apply(mc: MathContext): BigDecimal

final def asInstanceOf[T0]: T0

val bigDecimal: java.math.BigDecimal

def byteValue(): Byte

def charValue: Char

def clone(): AnyRef

def compare(that: BigDecimal): Int

def doubleValue(): Double

final def eq(arg0: AnyRef): Boolean

def equals(that: BigDecimal): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

def floatValue(): Float

final def getClass(): Class[_]

def hashCode(): Int

def intValue(): Int

def isBinaryDouble: Boolean

def isBinaryFloat: Boolean

def isDecimalDouble: Boolean

def isDecimalFloat: Boolean

def isExactDouble: Boolean

def isExactFloat: Boolean

final def isInstanceOf[T0]: Boolean

def isValidByte: Boolean

def isValidChar: Boolean

def isValidInt: Boolean

def isValidLong: Boolean

def isValidShort: Boolean

def isWhole(): Boolean

def longValue(): Long

def max(that: BigDecimal): BigDecimal

val mc: MathContext

def min(that: BigDecimal): BigDecimal

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def pow(n: Int): BigDecimal

def precision: Int

def quot(that: BigDecimal): BigDecimal

def remainder(that: BigDecimal): BigDecimal

def round(mc: MathContext): BigDecimal

def rounded: BigDecimal

def scale: Int

def setScale(scale: Int, mode: RoundingMode): BigDecimal

def setScale(scale: Int): BigDecimal

def shortValue(): Short

def signum: Int

final def synchronized[T0](arg0: ⇒ T0): T0

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

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

def toBigInt(): BigInt

def toBigIntExact(): Option[BigInt]

def toByte: Byte

def toByteExact: Byte

def toChar: Char

def toDouble: Double

def toFloat: Float

def toInt: Int

def toIntExact: Int