object BigDecimal extends Serializable
- Source
- BigDecimal.scala
- Since
2.7
- Alphabetic
- By Inheritance
- BigDecimal
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
trueif !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCodeexcept for boxed numeric types andnull.Equivalent to
x.hashCodeexcept 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. Fornullreturns a hashcode wherenull.hashCodethrows aNullPointerException.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).- returns
trueif the receiver object is equivalent to the argument;falseotherwise.
- Definition Classes
- AnyRef → Any
-
def
apply(bd: java.math.BigDecimal): BigDecimal
Constructs a
BigDecimalfrom ajava.math.BigDecimal. -
def
apply(unscaledVal: BigInt, scale: Int, mc: MathContext): BigDecimal
Constructs a
BigDecimalwhose unscaled value is equal to that of the specifiedBigIntvalue.Constructs a
BigDecimalwhose unscaled value is equal to that of the specifiedBigIntvalue.- unscaledVal
the specified
BigIntvalue- scale
the scale
- mc
the precision and rounding mode for creation of this value and future operations on it
- returns
the constructed
BigDecimal
-
def
apply(unscaledVal: BigInt, scale: Int): BigDecimal
Constructs a
BigDecimalwhose unscaled value is equal to that of the specifiedBigIntvalue.Constructs a
BigDecimalwhose unscaled value is equal to that of the specifiedBigIntvalue.- unscaledVal
the specified
BigIntvalue- scale
the scale
- returns
the constructed
BigDecimal
-
def
apply(x: BigInt, mc: MathContext): BigDecimal
Constructs a
BigDecimalwhose value is equal to that of the specifiedBigIntvalue, rounding if necessary.Constructs a
BigDecimalwhose value is equal to that of the specifiedBigIntvalue, rounding if necessary.- x
the specified
BigIntvalue- mc
the precision and rounding mode for creation of this value and future operations on it
- returns
the constructed
BigDecimal
-
def
apply(x: BigInt): BigDecimal
Constructs a
BigDecimalwhose value is equal to that of the specifiedBigIntvalue.Constructs a
BigDecimalwhose value is equal to that of the specifiedBigIntvalue.- x
the specified
BigIntvalue- returns
the constructed
BigDecimal
-
def
apply(x: String, mc: MathContext): BigDecimal
Translates the decimal String representation of a
BigDecimalinto aBigDecimal, rounding if necessary. -
def
apply(x: String): BigDecimal
Translates the decimal String representation of a
BigDecimalinto aBigDecimal. -
def
apply(x: Array[Char], mc: MathContext): BigDecimal
Translates a character array representation of a
BigDecimalinto aBigDecimal, rounding if necessary. -
def
apply(x: Array[Char]): BigDecimal
Translates a character array representation of a
BigDecimalinto aBigDecimal. -
def
apply(d: Double, mc: MathContext): BigDecimal
Constructs a
BigDecimalwhose value is equal to that of the specified double value, but rounded if necessary.Constructs a
BigDecimalwhose value is equal to that of the specified double value, but rounded if necessary. Equivalent toBigDecimal.decimal.- d
the specified
Doublevalue- mc
the precision and rounding mode for creation of this value and future operations on it
- returns
the constructed
BigDecimal
-
def
apply(d: Double): BigDecimal
Constructs a
BigDecimalwhose value is equal to that of the specified double value.Constructs a
BigDecimalwhose value is equal to that of the specified double value. Equivalent toBigDecimal.decimal.- d
the specified
Doublevalue- returns
the constructed
BigDecimal
-
def
apply(unscaledVal: Long, scale: Int, mc: MathContext): BigDecimal
Constructs a
BigDecimalwhose unscaled value is equal to that of the specified long value, but rounded if necessary.Constructs a
BigDecimalwhose unscaled value is equal to that of the specified long value, but rounded if necessary.- unscaledVal
the value
- scale
the scale
- mc
the precision and rounding mode for creation of this value and future operations on it
- returns
the constructed
BigDecimal
-
def
apply(unscaledVal: Long, scale: Int): BigDecimal
Constructs a
BigDecimalwhose unscaled value is equal to that of the specified long value.Constructs a
BigDecimalwhose unscaled value is equal to that of the specified long value.- unscaledVal
the value
- scale
the scale
- returns
the constructed
BigDecimal
-
def
apply(l: Long, mc: MathContext): BigDecimal
Constructs a
BigDecimalwhose value is equal to that of the specified long value, but rounded if necessary.Constructs a
BigDecimalwhose value is equal to that of the specified long value, but rounded if necessary.- l
the specified long value
- mc
the precision and rounding mode for creation of this value and future operations on it
- returns
the constructed
BigDecimal
-
def
apply(l: Long): BigDecimal
Constructs a
BigDecimalwhose value is equal to that of the specified long value.Constructs a
BigDecimalwhose value is equal to that of the specified long value.- l
the specified long value
- returns
the constructed
BigDecimal
-
def
apply(i: Int, mc: MathContext): BigDecimal
Constructs a
BigDecimalwhose value is equal to that of the specifiedIntegervalue, rounding if necessary.Constructs a
BigDecimalwhose value is equal to that of the specifiedIntegervalue, rounding if necessary.- i
the specified integer value
- mc
the precision and rounding mode for creation of this value and future operations on it
- returns
the constructed
BigDecimal
-
def
apply(i: Int): BigDecimal
Constructs a
BigDecimalwhose value is equal to that of the specifiedIntegervalue.Constructs a
BigDecimalwhose value is equal to that of the specifiedIntegervalue.- i
the specified integer value
- returns
the constructed
BigDecimal
-
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 aClassCastExceptionat 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
ClassCastExceptionif the receiver object is not an instance of the erasure of typeT0.
-
def
binary(d: Double): BigDecimal
Constructs a
BigDecimalby expanding the binary fraction contained byDoublevaluedinto a decimal representation.Constructs a
BigDecimalby expanding the binary fraction contained byDoublevaluedinto a decimal representation. Note: this also works correctly on convertedFloats. -
def
binary(d: Double, mc: MathContext): BigDecimal
Constructs a
BigDecimalby expanding the binary fraction contained byDoublevaluedinto a decimal representation, rounding if necessary.Constructs a
BigDecimalby expanding the binary fraction contained byDoublevaluedinto a decimal representation, rounding if necessary. When aFloatis converted to aDouble, the binary fraction is preserved, so this method also works for convertedFloats. -
def
clone(): AnyRef
Create a copy of the receiver object.
-
def
decimal(bd: java.math.BigDecimal, mc: MathContext): BigDecimal
Constructs a
BigDecimalusing ajava.math.BigDecimal, rounding if necessary. -
def
decimal(l: Long): BigDecimal
Constructs a
BigDecimalfrom aLong.Constructs a
BigDecimalfrom aLong. This is identical toBigDecimal(l). -
def
decimal(l: Long, mc: MathContext): BigDecimal
Constructs a
BigDecimalfrom aLong, rounding if necessary.Constructs a
BigDecimalfrom aLong, rounding if necessary. This is identical toBigDecimal(l, mc). -
def
decimal(f: Float): BigDecimal
Constructs a
BigDecimalusing the decimal text representation ofFloatvaluef.Constructs a
BigDecimalusing the decimal text representation ofFloatvaluef. Note thatBigDecimal.decimal(0.1f) != 0.1fsince equality agrees with theDoublerepresentation, and0.1 != 0.1f. -
def
decimal(f: Float, mc: MathContext): BigDecimal
Constructs a
BigDecimalusing the decimal text representation ofFloatvaluef, rounding if necessary.Constructs a
BigDecimalusing the decimal text representation ofFloatvaluef, rounding if necessary. Note thatBigDecimal.decimal(0.1f) != 0.1fsince equality agrees with theDoublerepresentation, and0.1 != 0.1f. -
def
decimal(d: Double): BigDecimal
Constructs a
BigDecimalusing the decimal text representation ofDoublevalued. -
def
decimal(d: Double, mc: MathContext): BigDecimal
Constructs a
BigDecimalusing the decimal text representation ofDoublevalued, rounding if necessary. - val defaultMathContext: MathContext
-
implicit
def
double2bigDecimal(d: Double): BigDecimal
Implicit conversion from
DoubletoBigDecimal. -
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
eqmethod implements an equivalence relation on non-null instances ofAnyRef, and has three additional properties:- It is consistent: for any non-null instances
xandyof typeAnyRef, multiple invocations ofx.eq(y)consistently returnstrueor consistently returnsfalse. - For any non-null instance
xof typeAnyRef,x.eq(null)andnull.eq(x)returnsfalse. null.eq(null)returnstrue.
When overriding the
equalsorhashCodemethods, 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
trueif the argument is a reference to the receiver object;falseotherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
def
exact(cs: Array[Char]): BigDecimal
Constructs a
BigDecimalthat exactly represents the number specified in base 10 in a character array. -
def
exact(s: String): BigDecimal
Constructs a
BigDecimalthat exactly represents the number specified in aString. -
def
exact(l: Long): BigDecimal
Constructs a
BigDecimalthat exactly represents aLong.Constructs a
BigDecimalthat exactly represents aLong. Note that all creation methods forBigDecimalthat do not take aMathContextrepresent aLong; this is equivalent toapply,valueOf, etc.. -
def
exact(bi: BigInt): BigDecimal
Constructs a
BigDecimalthat exactly represents aBigInt. -
def
exact(d: Double): BigDecimal
Constructs a
BigDecimalby fully expanding the binary fraction contained byDoublevalued, adjusting the precision as necessary.Constructs a
BigDecimalby fully expanding the binary fraction contained byDoublevalued, adjusting the precision as necessary. Note: this works correctly on convertedFloats also. -
def
exact(repr: java.math.BigDecimal): BigDecimal
Constructs a
BigDecimalfrom ajava.math.BigDecimal.Constructs a
BigDecimalfrom ajava.math.BigDecimal. The precision is the default forBigDecimalor enough to represent thejava.math.BigDecimalexactly, whichever is greater. -
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
finalizemethod is invoked, as well as the interaction betweenfinalizeand non-local returns and exceptions, are all platform dependent.- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
-
def
hashCode(): Int
The hashCode method for reference types.
-
implicit
def
int2bigDecimal(i: Int): BigDecimal
Implicit conversion from
InttoBigDecimal. -
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
trueif the receiver object is an instance of erasure of typeT0;falseotherwise.
- Definition Classes
- Any
-
implicit
def
javaBigDecimal2bigDecimal(x: java.math.BigDecimal): BigDecimal
Implicit conversion from
java.math.BigDecimaltoscala.BigDecimal. -
implicit
def
long2bigDecimal(l: Long): BigDecimal
Implicit conversion from
LongtoBigDecimal. -
final
def
ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that).Equivalent to
!(this eq that).- returns
trueif the argument is not a reference to the receiver object;falseotherwise.
- 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
- Annotations
- @native()
- 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
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
- returns
a String representation of the object.
- Definition Classes
- AnyRef → Any
-
def
valueOf(x: Long): BigDecimal
Constructs a
BigDecimalusing the java BigDecimal static valueOf constructor.Constructs a
BigDecimalusing the java BigDecimal static valueOf constructor.- x
the specified
Longvalue- returns
the constructed
BigDecimal
-
def
valueOf(d: Double): BigDecimal
Constructs a
BigDecimalusing the java BigDecimal static valueOf constructor.Constructs a
BigDecimalusing the java BigDecimal static valueOf constructor. Equivalent toBigDecimal.decimal.- d
the specified double value
- returns
the constructed
BigDecimal
-
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
- object RoundingMode extends Enumeration
Deprecated Value Members
-
def
apply(bd: java.math.BigDecimal, mc: MathContext): BigDecimal
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) This method appears to round a java.math.BigDecimal but actually doesn't. Use new BigDecimal(bd, mc) instead for no rounding, or BigDecimal.decimal(bd, mc) for rounding.
-
def
apply(x: Float, mc: MathContext): BigDecimal
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) The default conversion from Float may not do what you want. Use BigDecimal.decimal for a String representation, or explicitly convert the Float with .toDouble.
-
def
apply(x: Float): BigDecimal
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) The default conversion from Float may not do what you want. Use BigDecimal.decimal for a String representation, or explicitly convert the Float with .toDouble.
-
def
valueOf(f: Float, mc: MathContext): BigDecimal
Constructs a
BigDecimalusing the java BigDecimal static valueOf constructor.Constructs a
BigDecimalusing the java BigDecimal static valueOf constructor. This is unlikely to do what you want; usevalueOf(f.toDouble)ordecimal(f)instead.- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) Float arguments to valueOf may not do what you wish. Use decimal or valueOf(f.toDouble).
-
def
valueOf(f: Float): BigDecimal
Constructs a
BigDecimalusing the java BigDecimal static valueOf constructor.Constructs a
BigDecimalusing the java BigDecimal static valueOf constructor. This is unlikely to do what you want; usevalueOf(f.toDouble)ordecimal(f)instead.- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) Float arguments to valueOf may not do what you wish. Use decimal or valueOf(f.toDouble).
-
def
valueOf(d: Double, mc: MathContext): BigDecimal
Constructs a
BigDecimalusing the java BigDecimal static valueOf constructor, specifying aMathContextthat is used for computations but isn't used for rounding.Constructs a
BigDecimalusing the java BigDecimal static valueOf constructor, specifying aMathContextthat is used for computations but isn't used for rounding. UseBigDecimal.decimalto useMathContextfor rounding, orBigDecimal(java.math.BigDecimal.valueOf(d), mc)for no rounding.- d
the specified double value
- mc
the
MathContextused for future computations- returns
the constructed
BigDecimal
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) MathContext is not applied to Doubles in valueOf. Use BigDecimal.decimal to use rounding, or java.math.BigDecimal.valueOf to avoid it.
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int,Float,ArrayorOptionwhich are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collectionand its sub-packages contain Scala's collections frameworkscala.collection.immutable- Immutable, sequential data-structures such asVector,List,Range,HashMaporHashSetscala.collection.mutable- Mutable, sequential data-structures such asArrayBuffer,StringBuilder,HashMaporHashSetscala.collection.concurrent- Mutable, concurrent data-structures such asTrieMapscala.collection.parallel.immutable- Immutable, parallel data-structures such asParVector,ParRange,ParHashMaporParHashSetscala.collection.parallel.mutable- Mutable, parallel data-structures such asParArray,ParHashMap,ParTrieMaporParHashSetscala.concurrent- Primitives for concurrent programming such asFuturesandPromisesscala.io- Input and output operationsscala.math- Basic math functions and additional numeric types likeBigIntandBigDecimalscala.sys- Interaction with other processes and the operating systemscala.util.matching- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect- Scala's reflection API (scala-reflect.jar)scala.xml- XML parsing, manipulation, and serialization (scala-xml.jar)scala.swing- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)scala.util.parsing- Parser combinators (scala-parser-combinators.jar)Automatic imports
Identifiers in the scala package and the
scala.Predefobject are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
Listis an alias forscala.collection.immutable.List.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
Stringis an alias forjava.lang.String.