Object scala.math.BigDecimal

Companion class BigDecimal

object BigDecimal extends Serializable

Source
BigDecimal.scala
Since

2.7

Linear Supertypes

Value Members

final def !=(arg0: Any): Boolean

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 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.

returns

a hash value consistent with ==

Definition Classes
AnyRef → Any

final def ==(arg0: Any): Boolean

The expression x == that is equivalent to if (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 apply(bd: java.math.BigDecimal): BigDecimal

def apply(unscaledVal: BigInt, scale: Int, mc: MathContext): BigDecimal

Constructs a BigDecimal whose unscaled value is equal to that of the specified BigInt value.

unscaledVal

the specified BigInt 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: BigInt, scale: Int): BigDecimal

Constructs a BigDecimal whose unscaled value is equal to that of the specified BigInt value.

unscaledVal

the specified BigInt value

scale

the scale

returns

the constructed BigDecimal

def apply(x: BigInt, mc: MathContext): BigDecimal

Constructs a BigDecimal whose value is equal to that of the specified BigInt value, rounding if necessary.

x

the specified BigInt value

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 BigDecimal whose value is equal to that of the specified BigInt value.

x

the specified BigInt value

returns

the constructed BigDecimal

def apply(x: String, mc: MathContext): BigDecimal

def apply(x: String): BigDecimal

def apply(x: Array[Char], mc: MathContext): BigDecimal

def apply(x: Array[Char]): BigDecimal

def apply(d: Double, mc: MathContext): BigDecimal

Constructs a BigDecimal whose value is equal to that of the specified double value, but rounded if necessary. Equivalent to BigDecimal.decimal.

d

the specified Double value

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 BigDecimal whose value is equal to that of the specified double value. Equivalent to BigDecimal.decimal.

d

the specified Double value

returns

the constructed BigDecimal

def apply(unscaledVal: Long, scale: Int, mc: MathContext): BigDecimal

Constructs a BigDecimal whose 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 BigDecimal whose 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 BigDecimal whose 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 BigDecimal whose 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 BigDecimal whose value is equal to that of the specified Integer value, 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 BigDecimal whose value is equal to that of the specified Integer value.

i

the specified integer value

returns

the constructed BigDecimal

final def asInstanceOf[T0]: 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 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.

returns

the receiver object.

Definition Classes
Any
Exceptions thrown

ClassCastException if the receiver object is not an instance of the erasure of type T0.

def binary(d: Double): BigDecimal

Constructs a BigDecimal by expanding the binary fraction contained by Double value d into a decimal representation. Note: this also works correctly on converted Floats.

def binary(d: Double, mc: MathContext): BigDecimal

Constructs a BigDecimal by expanding the binary fraction contained by Double value d into a decimal representation, rounding if necessary. When a Float is converted to a Double, the binary fraction is preserved, so this method also works for converted Floats.

def clone(): AnyRef

Create a copy of the receiver object.

The default implementation of the clone method is platform dependent.

returns

a copy of the receiver object.

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
Note

not specified by SLS as a member of AnyRef

def decimal(bd: java.math.BigDecimal, mc: MathContext): BigDecimal

def decimal(l: Long): BigDecimal

Constructs a BigDecimal from a Long. This is identical to BigDecimal(l).

def decimal(l: Long, mc: MathContext): BigDecimal

Constructs a BigDecimal from a Long, rounding if necessary. This is identical to BigDecimal(l, mc).

def decimal(f: Float): BigDecimal

Constructs a BigDecimal using the decimal text representation of Float value f. Note that BigDecimal.decimal(0.1f) != 0.1f since equality agrees with the Double representation, and 0.1 != 0.1f.

def decimal(f: Float, mc: MathContext): BigDecimal

Constructs a BigDecimal using the decimal text representation of Float value f, rounding if necessary. Note that BigDecimal.decimal(0.1f) != 0.1f since equality agrees with the Double representation, and 0.1 != 0.1f.

def decimal(d: Double): BigDecimal

def decimal(d: Double, mc: MathContext): BigDecimal

val defaultMathContext: MathContext

implicit def double2bigDecimal(d: Double): BigDecimal

final def eq(arg0: AnyRef): Boolean

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:

    It is consistent: for any non-null instances 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).

returns

true if the argument is a reference to the receiver object; false otherwise.

Definition Classes
AnyRef

def equals(arg0: Any): Boolean

The equality method for reference types. Default implementation delegates to eq.

See also equals in scala.Any.

returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
AnyRef → Any

def exact(cs: Array[Char]): BigDecimal

def exact(s: String): BigDecimal

def exact(l: Long): BigDecimal

Constructs a BigDecimal that exactly represents a Long. Note that all creation methods for BigDecimal that do not take a MathContext represent a Long; this is equivalent to apply, valueOf, etc..

def exact(bi: BigInt): BigDecimal

def exact(d: Double): BigDecimal

Constructs a BigDecimal by fully expanding the binary fraction contained by Double value d, adjusting the precision as necessary. Note: this works correctly on converted Floats also.

def exact(repr: java.math.BigDecimal): BigDecimal

Constructs a BigDecimal from a java.math.BigDecimal. The precision is the default for BigDecimal or enough to represent the java.math.BigDecimal exactly, whichever is greater.

def finalize(): Unit

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.

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.

returns

a class object corresponding to the runtime type of the receiver.

Definition Classes
AnyRef → Any
Annotations
@native()

def hashCode(): Int

The hashCode method for reference types. See hashCode in scala.Any.

returns

the hash code value for this object.

Definition Classes
AnyRef → Any
Annotations
@native()

implicit def int2bigDecimal(i: Int): BigDecimal

final def isInstanceOf[T0]: Boolean

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.

returns

true if the receiver object is an instance of erasure of type T0; false otherwise.

Definition Classes
Any

implicit def javaBigDecimal2bigDecimal(x: java.math.BigDecimal): BigDecimal

implicit def long2bigDecimal(l: Long): BigDecimal

final def ne(arg0: AnyRef): Boolean

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.

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.

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. 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 BigDecimal using the java BigDecimal static valueOf constructor.

x

the specified Long value

returns

the constructed BigDecimal

def valueOf(d: Double): BigDecimal

Constructs a BigDecimal using the java BigDecimal static valueOf constructor. Equivalent to BigDecimal.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

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

object RoundingMode extends Enumeration

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/math/BigDecimal$.html