BigDecimal (original) (raw)
scala.math.BigDecimal
See theBigDecimal companion object
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.
Attributes
Companion
Source
Graph
Supertypes
class ScalaNumber
Show all
Members list
Remainder after dividing this by that.
Multiplication of BigDecimals
Subtraction of BigDecimals
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.
Attributes
Source
Returns the absolute value of this BigDecimal
Returns the absolute value of this BigDecimal
Attributes
Source
Returns a new BigDecimal based on the supplied MathContext, rounded as needed.
Returns a new BigDecimal based on the supplied MathContext, rounded as needed.
Attributes
Source
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.
Attributes
Definition Classes
Source
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.
Attributes
Source
Compares this BigDecimal with the specified BigDecimal
Compares this BigDecimal with the specified BigDecimal
Attributes
Source
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.
Attributes
Source
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
Attributes
Definition Classes
Source
Compares this BigDecimal with the specified BigDecimal for equality.
Compares this BigDecimal with the specified BigDecimal for equality.
Attributes
Source
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.
Attributes
Source
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.
Attributes
Definition Classes
Source
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.
Attributes
Source
Tests whether this BigDecimal holds, to within precision, the binary representation of a Double.
Tests whether this BigDecimal holds, to within precision, the binary representation of a Double.
Attributes
Source
Tests whether this BigDecimal holds, to within precision, the binary representation of a Float.
Tests whether this BigDecimal holds, to within precision, the binary representation of a Float.
Attributes
Source
Tests whether this BigDecimal holds the decimal representation of a Double.
Tests whether this BigDecimal holds the decimal representation of a Double.
Attributes
Source
Tests whether this BigDecimal holds the decimal representation of a Float.
Tests whether this BigDecimal holds the decimal representation of a Float.
Attributes
Source
Tests whether this BigDecimal holds the exact expansion of a Double's binary fractional form into base 10.
Tests whether this BigDecimal holds the exact expansion of a Double's binary fractional form into base 10.
Attributes
Source
Tests whether this BigDecimal holds the exact expansion of a Float's binary fractional form into base 10.
Tests whether this BigDecimal holds the exact expansion of a Float's binary fractional form into base 10.
Attributes
Source
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.
Attributes
Definition Classes
Source
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.
Attributes
Definition Classes
Source
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.
Attributes
Definition Classes
Source
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.
Attributes
Definition Classes
Source
Attributes
Returns
**true** if this number has no decimal component, **false** otherwise.
Source
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.
Attributes
Source
Returns the maximum of this and that, or this if the two are equal
Returns the maximum of this and that, or this if the two are equal
Attributes
Source
Returns the minimum of this and that, or this if the two are equal
Returns the minimum of this and that, or this if the two are equal
Attributes
Source
Returns a BigDecimal whose value is this ** n.
Returns a BigDecimal whose value is this ** n.
Attributes
Source
Returns the precision of this BigDecimal.
Divide to Integral value.
Remainder after dividing this by that.
Returns a BigDecimal rounded according to the supplied MathContext settings, but preserving its own MathContext for future operations.
Returns a BigDecimal rounded according to the supplied MathContext settings, but preserving its own MathContext for future operations.
Attributes
Source
Returns a BigDecimal rounded according to its own MathContext
Returns a BigDecimal rounded according to its own MathContext
Attributes
Source
Returns the scale of this BigDecimal.
Returns a BigDecimal whose scale is the specified value, and whose value is numerically equal to this BigDecimal's.
Returns a BigDecimal whose scale is the specified value, and whose value is numerically equal to this BigDecimal's.
Attributes
Source
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.
Attributes
Definition Classes
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.
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.
Attributes
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.
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.
Attributes
Source
Like until, but inclusive of the end value.
Like until, but inclusive of the end value.
Converts this BigDecimal to a scala.BigInt.
Converts this BigDecimal to a scala.BigInt if it can be done losslessly, returning Some(BigInt) or None.
Converts this BigDecimal to a scala.BigInt if it can be done losslessly, returning Some(BigInt) or None.
Attributes
Source
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.
Attributes
Source
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.
Attributes
Source
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.
Attributes
Source
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.
Attributes
Source
Returns the decimal String representation of this BigDecimal.
Returns the decimal String representation of this BigDecimal.
Attributes
Definition Classes
Source
Returns the size of an ulp, a unit in the last place, of this BigDecimal.
Returns the size of an ulp, a unit in the last place, of this BigDecimal.
Attributes
Source
Returns a BigDecimal whose value is the negation of this BigDecimal
Returns a BigDecimal whose value is the negation of this BigDecimal
Attributes
Source
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
Value parameters
end
the end value of the range (exclusive)
Attributes
Returns
the partially constructed NumericRange
Source
Same as the one-argument until, but creates the range immediately.
Same as the one-argument until, but creates the range immediately.
Attributes
Source
Returns true if this is less than that
Returns true if this is less than or equal to that.
Returns true if this is less than or equal to that.
Attributes
Inherited from:
Source
Returns true if this is greater than that.
Returns true if this is greater than or equal to that.
Returns true if this is greater than or equal to that.
Attributes
Inherited from:
Source
Result of comparing this with operand that.
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
Inherited from:
Source
In this article