Test two objects for inequality.
true
if !(this == that), false otherwise.
Equivalent to x.hashCode
except for boxed numeric types and null
. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null
returns a hashcode where null.hashCode
throws a NullPointerException
.
a hash value consistent with ==
Division and Remainder - returns tuple containing the result of divideToIntegralValue and the remainder. The computation is exact: no rounding is applied.
Returns true if this
is less than that
Returns true if this
is less than or equal to that
.
The expression x == that
is equivalent to if (x eq null) that eq null else x.equals(that)
.
true
if the receiver object is equivalent to the argument; false
otherwise.
Returns true if this
is greater than that
.
Returns true if this
is greater than or equal to that
.
Cast the receiver object to be of type T0
.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String]
will throw a ClassCastException
at runtime, while the expression List(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
the receiver object.
ClassCastException
if the receiver object is not an instance of the erasure of type T0
.
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.
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.
Create a copy of the receiver object.
The default implementation of the clone
method is platform dependent.
a copy of the receiver object.
Compares this BigDecimal with the specified BigDecimal
Result of comparing this
with operand that
.
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.
Tests whether the argument (that
) is a reference to the receiver object (this
).
The eq
method implements an equivalence relation on non-null instances of AnyRef
, and has three additional properties:
x
and y
of type AnyRef
, multiple invocations of x.eq(y)
consistently returns true
or consistently returns false
.For any non-null instance x
of type AnyRef
, x.eq(null)
and null.eq(x)
returns false
.
null.eq(null)
returns true
. When overriding the equals
or hashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).
true
if the argument is a reference to the receiver object; false
otherwise.
Compares this BigDecimal with the specified value for equality. Where Float
and Double
disagree, BigDecimal
will agree with the Double
value
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize
method is invoked, as well as the interaction between finalize
and non-local returns and exceptions, are all platform dependent.
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.
Returns string formatted according to given format
string. Format strings are as for String.format
(@see java.lang.String.format).
Returns the runtime class representation of the object.
a class object corresponding to the runtime type of the receiver.
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.
the hash code value for this object.
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.
Test whether the dynamic type of the receiver object is T0
.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String]
will return false
, while the expression List(1).isInstanceOf[List[String]]
will return true
. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
true
if the receiver object is an instance of erasure of type T0
; false
otherwise.
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.Char 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
.
Returns true
iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns false
.
true
if this number has no decimal component, false
otherwise.
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.
Equivalent to !(this eq that)
.
true
if the argument is not a reference to the receiver object; false
otherwise.
Wakes up a single thread that is waiting on the receiver object's monitor.
not specified by SLS as a member of AnyRef
Wakes up all threads that are waiting on the receiver object's monitor.
not specified by SLS as a member of AnyRef
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.
Returns the value of this as a scala.Byte. This may involve rounding or truncation.
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.
Returns the value of this as a scala.Char. This may involve rounding or truncation.
Returns the value of this as a scala.Double. This may involve rounding or truncation.
Returns the value of this as a scala.Float. This may involve rounding or truncation.
Returns the value of this as an scala.Int. This may involve rounding or truncation.
Returns the value of this as a scala.Long. This may involve rounding or truncation.
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.
Returns the value of this as a scala.Short. This may involve rounding or truncation.
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.
Returns the decimal String representation of this BigDecimal.
a String representation of the object.
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.
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
the end value of the range (exclusive)
the partially constructed NumericRange
(bigDecimal: any2stringadd[BigDecimal]).+(other)
Returns true if this
is less than that
(bigDecimal: Ordered[BigDecimal]).<(that)
Returns true if this
is less than or equal to that
.
(bigDecimal: Ordered[BigDecimal]).<=(that)
Returns true if this
is greater than that
.
(bigDecimal: Ordered[BigDecimal]).>(that)
Returns true if this
is greater than or equal to that
.
(bigDecimal: Ordered[BigDecimal]).>=(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
(bigDecimal: Ordered[BigDecimal]).compare(that)
Result of comparing this
with operand that
.
(bigDecimal: Ordered[BigDecimal]).compareTo(that)
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/math/BigDecimal.html
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 withBigInt
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--thehashCode
ofBigInt
andBigDecimal
is allowed to diverge due to difficulty in efficiently computing both the decimal representation inBigDecimal
and the binary representation inBigInt
.When creating a
BigDecimal
from aDouble
orFloat
, care must be taken as the binary fraction representation ofDouble
andFloat
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 aBigDecimal
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 ofDouble
:BigDecimal.decimal(0.1) == 0.1
. Note that since0.1f != 0.1
, the same is not true forFloat
. Instead,0.1f == BigDecimal.decimal((0.1f).toDouble)
.To test whether a
BigDecimal
number can be converted to aDouble
orFloat
and then back without loss of information by using one of these methods, test withisDecimalDouble
,isBinaryDouble
, orisExactDouble
or the correspondingFloat
versions. Note thatBigInt
'sisValidDouble
will agree withisExactDouble
, not theisDecimalDouble
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 betweenLong
andDouble
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 aMathContext
that determines the rounding that is applied to certain calculations. In most cases, the value of theBigDecimal
is also rounded to the precision specified by theMathContext
. To create aBigDecimal
with a different precision than itsMathContext
, usenew 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'sMathContext
always determines the degree of rounding, if any, and is the one propagated through arithmetic operations that do not apply rounding themselves.