final class BigDecimal 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.
 Source
 BigDecimal.scala
 Version
1.1
 Alphabetic
 By Inheritance
 BigDecimal
 Ordered
 Comparable
 Serializable
 ScalaNumericConversions
 ScalaNumericAnyConversions
 ScalaNumber
 Number
 Serializable
 AnyRef
 Any
 by orderingToOrdered
 by any2stringadd
 by StringFormat
 by Ensuring
 by ArrowAssoc
 Hide All
 Show All
 Public
 All
Instance Constructors
Value Members

final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
 returns
true
if !(this == that), false otherwise.
 Definition Classes
 AnyRef → Any

final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
. returns
a hash value consistent with ==
 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
>[B](y: B): (BigDecimal, B)
 Implicit
 This member is added by an implicit conversion from BigDecimal to ArrowAssoc[BigDecimal] performed by method ArrowAssoc in scala.Predef.
 Definition Classes
 ArrowAssoc
 Annotations
 @inline()

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
Returns true if
this
is less thanthat
Returns true if
this
is less thanthat
 Definition Classes
 Ordered

def
<=(that: BigDecimal): Boolean
Returns true if
this
is less than or equal tothat
.Returns true if
this
is less than or equal tothat
. Definition Classes
 Ordered

final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
. returns
true
if the receiver object is equivalent to the argument;false
otherwise.
 Definition Classes
 AnyRef → Any

def
>(that: BigDecimal): Boolean
Returns true if
this
is greater thanthat
.Returns true if
this
is greater thanthat
. Definition Classes
 Ordered

def
>=(that: BigDecimal): Boolean
Returns true if
this
is greater than or equal tothat
.Returns true if
this
is greater than or equal tothat
. Definition Classes
 Ordered

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
Cast the receiver object to be of type
T0
.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 aClassCastException
at runtime, while the expressionList(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. returns
the receiver object.
 Definition Classes
 Any
 Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
 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 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
 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 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.

def
clone(): AnyRef
Create a copy of the receiver object.

def
compare(that: BigDecimal): Int
Compares this BigDecimal with the specified BigDecimal
Compares this BigDecimal with the specified BigDecimal
 Definition Classes
 BigDecimal → Ordered

def
compareTo(that: BigDecimal): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
. Definition Classes
 Ordered → Comparable

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
orDouble.POSITIVE_INFINITY
as appropriate. Definition Classes
 BigDecimal → ScalaNumericAnyConversions → Number

def
ensuring(cond: (BigDecimal) ⇒ Boolean, msg: ⇒ Any): BigDecimal
 Implicit
 This member is added by an implicit conversion from BigDecimal to Ensuring[BigDecimal] performed by method Ensuring in scala.Predef.
 Definition Classes
 Ensuring

def
ensuring(cond: (BigDecimal) ⇒ Boolean): BigDecimal
 Implicit
 This member is added by an implicit conversion from BigDecimal to Ensuring[BigDecimal] performed by method Ensuring in scala.Predef.
 Definition Classes
 Ensuring

def
ensuring(cond: Boolean, msg: ⇒ Any): BigDecimal
 Implicit
 This member is added by an implicit conversion from BigDecimal to Ensuring[BigDecimal] performed by method Ensuring in scala.Predef.
 Definition Classes
 Ensuring

def
ensuring(cond: Boolean): BigDecimal
 Implicit
 This member is added by an implicit conversion from BigDecimal to Ensuring[BigDecimal] performed by method Ensuring in scala.Predef.
 Definition Classes
 Ensuring

final
def
eq(arg0: AnyRef): Boolean
Tests whether the argument (
that
) is a reference to the receiver object (this
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on nonnull instances ofAnyRef
, and has three additional properties: It is consistent: for any nonnull instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
.  For any nonnull instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
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
). returns
true
if the argument is a reference to the receiver object;false
otherwise.
 Definition Classes
 AnyRef
 It is consistent: for any nonnull instances

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
andDouble
disagree,BigDecimal
will agree with theDouble
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

def
finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
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 betweenfinalize
and nonlocal returns and exceptions, are all platform dependent. 
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
orFloat.POSITIVE_INFINITY
as appropriate. Definition Classes
 BigDecimal → ScalaNumericAnyConversions → Number

def
formatted(fmtstr: String): String
Returns string formatted according to given
format
string.Returns string formatted according to given
format
string. Format strings are as forString.format
(@see java.lang.String.format). Implicit
 This member is added by an implicit conversion from BigDecimal to StringFormat[BigDecimal] performed by method StringFormat in scala.Predef.
 Definition Classes
 StringFormat
 Annotations
 @inline()

final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
 returns
a class object corresponding to the runtime type of the receiver.
 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 compareBigDecimal
s withcompareTo
which deems 2 == 2.00, whereas in java these are unequal with unequalhashCode
s. These hash codes agree withBigInt
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 theBigInt
form forBigDecimal
values with large exponents. returns
the hash code value for this object.
 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 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.
 Definition Classes
 BigDecimal → ScalaNumericAnyConversions → Number

def
isBinaryDouble: Boolean
Tests whether this
BigDecimal
holds, to within precision, the binary representation of aDouble
. 
def
isBinaryFloat: Boolean
Tests whether this
BigDecimal
holds, to within precision, the binary representation of aFloat
. 
def
isDecimalDouble: Boolean
Tests whether this
BigDecimal
holds the decimal representation of aDouble
. 
def
isDecimalFloat: Boolean
Tests whether this
BigDecimal
holds the decimal representation of aFloat
. 
def
isExactDouble: Boolean
Tests whether this
BigDecimal
holds the exact expansion of aDouble
's binary fractional form into base 10. 
def
isExactFloat: Boolean
Tests whether this
BigDecimal
holds the exact expansion of aFloat
's binary fractional form into base 10. 
final
def
isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is
T0
.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 returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. 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. returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
 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 returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returnsfalse
. 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 returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returnsfalse
. 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 returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returnsfalse
. 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 returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returnsfalse
. 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 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.
 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
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
. returns
true
if the argument is not a reference to the receiver object;false
otherwise.
 Definition Classes
 AnyRef

final
def
notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
 Definition Classes
 AnyRef
 Note
not specified by SLS as a member of AnyRef

final
def
notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
 Definition Classes
 AnyRef
 Note
not specified by SLS as a member of 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 ownMathContext

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 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
 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 thisBigDecimal
has a nonzero fractional part, or is out of the possible range for a scala.Byte result, then ajava.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. 
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 thisBigDecimal
has a nonzero fractional part, or is out of the possible range for a scala.Long result, then ajava.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 thisBigDecimal
has a nonzero fractional part, or is out of the possible range for a scala.Short result, then ajava.lang.ArithmeticException
is thrown. 
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

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 nonprimitive types have been excluded.
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.
 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 oneargument
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( ... )

def
→[B](y: B): (BigDecimal, B)
 Implicit
 This member is added by an implicit conversion from BigDecimal to ArrowAssoc[BigDecimal] performed by method ArrowAssoc in scala.Predef.
 Definition Classes
 ArrowAssoc
Shadowed Implicit Value Members

def
+(other: String): String
 Implicit
 This member is added by an implicit conversion from BigDecimal to any2stringadd[BigDecimal] performed by method any2stringadd in scala.Predef.
 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: any2stringadd[BigDecimal]).+(other)
 Definition Classes
 any2stringadd

def
<(that: BigDecimal): Boolean
Returns true if
this
is less thanthat
Returns true if
this
is less thanthat
 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

def
<=(that: BigDecimal): Boolean
Returns true if
this
is less than or equal tothat
.Returns true if
this
is less than or equal tothat
. 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

def
>(that: BigDecimal): Boolean
Returns true if
this
is greater thanthat
.Returns true if
this
is greater thanthat
. 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

def
>=(that: BigDecimal): Boolean
Returns true if
this
is greater than or equal tothat
.Returns true if
this
is greater than or equal tothat
. 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

def
compare(that: BigDecimal): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
.Implement this method to determine how instances of A will be sorted.
Returns
x
where:x < 0
whenthis < that
x == 0
whenthis == that
x > 0
whenthis > 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

def
compareTo(that: BigDecimal): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
. 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

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
, orisDecimalDouble
, depending on the intended meaning. By default,decimal
creation is used, soisDecimalDouble
is probably what you want. Annotations
 @deprecated
 Deprecated
(Since version 2.11) Validity has distinct meanings. Use
isExactDouble
,isBinaryDouble
, orisDecimalDouble
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
, orisDecimalFloat
, depending on the intended meaning. By default,decimal
creation is used, soisDecimalFloat
is probably what you want. Annotations
 @deprecated
 Deprecated
(Since version 2.11) What constitutes validity is unclear. Use
isExactFloat
,isBinaryFloat
, orisDecimalFloat
instead.
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its subpackages contain Scala's collections frameworkscala.collection.immutable
 Immutable, sequential datastructures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
 Mutable, sequential datastructures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
 Mutable, concurrent datastructures such asTrieMap
scala.collection.parallel.immutable
 Immutable, parallel datastructures such asParVector
,ParRange
,ParHashMap
orParHashSet
scala.collection.parallel.mutable
 Mutable, parallel datastructures such asParArray
,ParHashMap
,ParTrieMap
orParHashSet
scala.concurrent
 Primitives for concurrent programming such asFutures
andPromises
scala.io
 Input and output operationsscala.math
 Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
 Interaction with other processes and the operating systemscala.util.matching
 Regular expressionsOther packages exist. See the complete list on the left.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect
 Scala's reflection API (scalareflect.jar)scala.xml
 XML parsing, manipulation, and serialization (scalaxml.jar)scala.swing
 A convenient wrapper around Java's GUI framework called Swing (scalaswing.jar)scala.util.parsing
 Parser combinators, including an example implementation of a JSON parser (scalaparsercombinators.jar)Automatic imports
Identifiers in the scala package and the
scala.Predef
object are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
List
is an alias forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.