BigDecimal
final class BigDecimal(val bigDecimal: BigDecimal, val mc: MathContext) extends ScalaNumber with ScalaNumericConversions with Serializable with Ordered[BigDecimal]
BigDecimal
represents decimal floatingpoint numbers of arbitrary precision.
By default, the precision approximately matches that of IEEE 128bit 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 rangenumbers with more than 4934 digits when written out in fullthe
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 floatingpoint 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 floatingpoint 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 floatingpoint 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 floatingpoint 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 lefthand 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.
trait Ordered[BigDecimal]
trait Comparable[BigDecimal]
trait ScalaNumericConversions
class ScalaNumber
class Number
trait Serializable
class Object
trait Matchable
class Any
Value members
Constructors
Methods
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 representation of the BigInt
form for BigDecimal
values
with large exponents.
 Definition Classes
 Any
 Source
 (source)
Compares this BigDecimal with the specified value for equality. Where
Float
and Double
disagree, BigDecimal
will agree with the Double
value
 Definition Classes
 Any
 Source
 (source)
Tests whether this
BigDecimal
holds, to within precision, the binary representation of a Double
. Source
 (source)
Tests whether this
BigDecimal
holds, to within precision, the binary representation of a Float
. Source
 (source)
Tests whether this
BigDecimal
holds the exact expansion of a Double
's binary fractional form into base 10. Source
 (source)
Tests whether this
BigDecimal
holds the exact expansion of a Float
's binary fractional form into base 10. Source
 (source)
Division and Remainder  returns tuple containing the result of
divideToIntegralValue and the remainder. The computation is exact: no rounding is applied.
 Source
 (source)
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.
 Source
 (source)
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.
 Source
 (source)
Returns a BigDecimal rounded according to the supplied MathContext settings, but
preserving its own MathContext for future operations.
 Source
 (source)
Returns a
BigDecimal
whose scale is the specified value, and whose value is
numerically equal to this BigDecimal's.
 Source
 (source)
Converts this BigDecimal to a Byte.
If the BigDecimal is too big to fit in a Byte, only the loworder 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
 Source
 (source)
Converts this BigDecimal to a Short.
If the BigDecimal is too big to fit in a Short, only the loworder 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
 Source
 (source)
Converts this BigDecimal to a Char.
If the BigDecimal is too big to fit in a Char, only the loworder 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.
 Source
 (source)
Converts this BigDecimal to an Int.
If the BigDecimal is too big to fit in an Int, only the loworder 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.
 Source
 (source)
Converts this BigDecimal to a Long.
If the BigDecimal is too big to fit in a Long, only the loworder 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.
 Source
 (source)
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.
 Source
 (source)
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.
 Source
 (source)
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.
 Source
 (source)
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.
 Source
 (source)
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.
 Source
 (source)
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
 Value Params
 end

the end value of the range (exclusive)
 Returns

the partially constructed NumericRange
 Source
 (source)
Converts this
BigDecimal
to a scala.BigInt if it
can be done losslessly, returning Some(BigInt) or None.
 Source
 (source)
Inherited methods
Returns the value of this as a scala.Char. This may involve
rounding or truncation.
 Inhertied from
 ScalaNumericAnyConversions
 Source
 (source)
Returns the value of this as a scala.Float. This may involve
rounding or truncation.
 Inhertied from
 ScalaNumericAnyConversions
 Source
 (source)
Returns the value of this as an scala.Int. This may involve
rounding or truncation.
 Inhertied from
 ScalaNumericAnyConversions
 Source
 (source)
Returns the value of this as a scala.Byte. This may involve
rounding or truncation.
 Inhertied from
 ScalaNumericAnyConversions
 Source
 (source)
Returns the value of this as a scala.Double. This may involve
rounding or truncation.
 Inhertied from
 ScalaNumericAnyConversions
 Source
 (source)
Returns the value of this as a scala.Long. This may involve
rounding or truncation.
 Inhertied from
 ScalaNumericAnyConversions
 Source
 (source)
Should only be called after all known nonprimitive
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.
 Inhertied from
 ScalaNumericAnyConversions
 Source
 (source)
Returns the value of this as a scala.Short. This may involve
rounding or truncation.
 Inhertied from
 ScalaNumericAnyConversions
 Source
 (source)