scala.math.BigDecimal

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

BigDecimal
ScalaNumericConversions
ScalaNumber
Number
Serializable
AnyRef
Any

Visibility

Public
All

Impl.

Concrete
Abstract

Instance constructors

new BigDecimal (bigDecimal: BigDecimal)
new BigDecimal (bigDecimal: BigDecimal, mc: MathContext)

Value Members

def != (arg0: AnyRef) : Boolean

attributes: final
definition classes: AnyRef
def != (arg0: Any) : Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ## () : Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf [T0] () : T0

attributes: final
definition classes: AnyRef
def $isInstanceOf [T0] () : Boolean

attributes: final
definition classes: AnyRef
def % (that: BigDecimal) : BigDecimal

Remainder after dividing this by that.

Remainder after dividing this by that.
def * (that: BigDecimal) : BigDecimal

Multiplication of BigDecimals

Multiplication of BigDecimals
def + (that: BigDecimal) : BigDecimal

Addition of BigDecimals

Addition of BigDecimals
def - (that: BigDecimal) : BigDecimal

Subtraction of BigDecimals

Subtraction of BigDecimals
def / (that: BigDecimal) : BigDecimal

Division of BigDecimals

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.
def < (that: BigDecimal) : Boolean

Less-than of BigDecimals

Less-than of BigDecimals
def <= (that: BigDecimal) : Boolean

Less-than-or-equals comparison of BigDecimals

Less-than-or-equals comparison of BigDecimals
def == (arg0: AnyRef) : Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def == (arg0: Any) : Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
def > (that: BigDecimal) : Boolean

Greater-than comparison of BigDecimals

Greater-than comparison of BigDecimals
def >= (that: BigDecimal) : Boolean

Greater-than-or-equals comparison of BigDecimals

Greater-than-or-equals comparison of BigDecimals
def abs : BigDecimal

Returns the absolute value of this BigDecimal

Returns the absolute value of this BigDecimal
def apply (mc: MathContext) : BigDecimal

Returns a new BigDecimal based on the supplied MathContext.

Returns a new BigDecimal based on the supplied MathContext.
def asInstanceOf [T0] : T0

This method is used to cast the receiver object to be of type T0.

This method is used to 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 expression1.asInstanceOf[String] will throw a ClassCastException 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 typed.
returns
the receiver object.
attributes: final
definition classes: Any
val bigDecimal : 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 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.
definition classes: BigDecimal → 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 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.
def clone () : AnyRef

This method creates and returns a copy of the receiver object.

This method creates and returns 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
def compare (that: BigDecimal) : Int

Compares this BigDecimal with the specified BigDecimal

Compares this BigDecimal with the specified BigDecimal
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 or Double.POSITIVE_INFINITY as appropriate.
definition classes: BigDecimal → Number
def eq (arg0: AnyRef) : Boolean

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other 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).
arg0
the object to compare against this object for reference equality.
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equals (that: BigDecimal) : Boolean

Compares this BigDecimal with the specified BigDecimal for equality.

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.@return true if the receiver object is equivalent to the argument; false otherwise. */
definition classes: BigDecimal → AnyRef → Any
def finalize () : Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected[lang]
definition classes: AnyRef
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 or Float.POSITIVE_INFINITY as appropriate.
definition classes: BigDecimal → Number
def getClass () : java.lang.Class[_ <: java.lang.Object]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.
attributes: final
definition classes: AnyRef
def hashCode () : Int

Returns the hash code for this BigDecimal.

Returns the hash code for this BigDecimal. Note that this does not 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.@return the hash code value for the 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 a char, 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.
definition classes: BigDecimal → Number
def isInstanceOf [T0] : Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.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 requested typed.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
attributes: final
definition classes: Any
def isValidByte : Boolean

definition classes: ScalaNumericConversions
def isValidChar : Boolean

definition classes: ScalaNumericConversions
def isValidInt : Boolean

definition classes: ScalaNumericConversions
def isValidShort : Boolean

definition classes: ScalaNumericConversions
def isWhole () : Boolean

attributes: protected[math]
definition classes: BigDecimal → 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 char, 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.
definition classes: BigDecimal → Number
def max (that: BigDecimal) : BigDecimal

Returns the maximum of this and that

Returns the maximum of this and that
val mc : MathContext
def min (that: BigDecimal) : BigDecimal

Returns the minimum of this and that

Returns the minimum of this and that
def ne (arg0: AnyRef) : Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality.
returns
false if the argument is not a reference to the receiver object; true otherwise.
attributes: final
definition classes: AnyRef
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.
attributes: final
definition classes: AnyRef
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.
attributes: final
definition classes: AnyRef
def pow (n: Int) : BigDecimal

Returns a BigDecimal whose value is this ** n.

Returns a BigDecimal whose value is this ** n.
def precision : Int

Returns the precision of this BigDecimal.

Returns the precision of this BigDecimal.
def quot (that: BigDecimal) : BigDecimal

Divide to Integral value.

Divide to Integral value.
def remainder (that: BigDecimal) : BigDecimal

Remainder after dividing this by that.

Remainder after dividing this by that.
def round (mc: MathContext) : BigDecimal

Returns a BigDecimal rounded according to the MathContext settings.

Returns a BigDecimal rounded according to the MathContext settings.
def scale : Int

Returns the scale of this BigDecimal.

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.

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 byte, 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.
definition classes: BigDecimal → Number
def signum : Int

Returns the sign of this BigDecimal, i.

Returns the sign of this BigDecimal, i.e. -1 if it is less than 0, +1 if it is greater than 0 0 if it is equal to 0
def synchronized [T0] (arg0: T0) : T0

attributes: final
definition classes: AnyRef
def to (end: BigDecimal, step: BigDecimal) : Inclusive[BigDecimal]

Like until, but inclusive of the end value.

Like until, but inclusive of the end value.
def to (end: BigDecimal) : Partial[BigDecimal, Inclusive[BigDecimal]]

Like until, but inclusive of the end value.

Like until, but inclusive of the end value.
def toBigInt () : BigInt

Converts this BigDecimal to a scala.

Converts this BigDecimal to a scala.BigInt.
def toBigIntExact () : Option[BigInt]

Converts this BigDecimal to a scala.

Converts this BigDecimal to a scala.BigInt if it can be done losslessly, returning Some(BigInt) or None.
def toByte : Byte

definition classes: ScalaNumericConversions
def toByteExact : Byte

This BigDecimal as an exact value.

This BigDecimal as an exact value.
def toChar : Char

definition classes: ScalaNumericConversions
def toDouble : Double

definition classes: ScalaNumericConversions
def toFloat : Float

definition classes: ScalaNumericConversions
def toInt : Int

definition classes: ScalaNumericConversions
def toIntExact : Int
def toLong : Long

definition classes: ScalaNumericConversions
def toLongExact : Long
def toShort : Short

definition classes: ScalaNumericConversions
def toShortExact : Short
def toString () : String

Returns the decimal String representation of this BigDecimal.

Returns the decimal String representation of this BigDecimal.@return 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.

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

Returns a BigDecimal whose value is the negation of this BigDecimal
def underlying () : BigDecimal

definition classes: BigDecimal → ScalaNumber
def unifiedPrimitiveEquals (x: Any) : Boolean

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: protected
definition classes: ScalaNumericConversions
def unifiedPrimitiveHashcode () : Int

attributes: protected
definition classes: ScalaNumericConversions
def until (end: BigDecimal, step: BigDecimal) : Exclusive[BigDecimal]

Same as the one-argument until, but creates the range immediately.

Same as the one-argument 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
def wait () : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long, arg1: Int) : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long) : Unit

attributes: final
definition classes: AnyRef

BigDecimal

class BigDecimal extends ScalaNumber with ScalaNumericConversions

Instance constructors

new BigDecimal (bigDecimal: BigDecimal)

new BigDecimal (bigDecimal: BigDecimal, mc: MathContext)

Value Members

def != (arg0: AnyRef) : Boolean

def != (arg0: Any) : Boolean

def ## () : Int

def $asInstanceOf [T0] () : T0

def $isInstanceOf [T0] () : Boolean

def % (that: BigDecimal) : BigDecimal

def * (that: BigDecimal) : BigDecimal

def + (that: BigDecimal) : BigDecimal

def - (that: BigDecimal) : BigDecimal

def / (that: BigDecimal) : BigDecimal

def /% (that: BigDecimal) : (BigDecimal, BigDecimal)

def < (that: BigDecimal) : Boolean

def <= (that: BigDecimal) : Boolean

def == (arg0: AnyRef) : Boolean

def == (arg0: Any) : Boolean

def > (that: BigDecimal) : Boolean

def >= (that: BigDecimal) : Boolean

def abs : BigDecimal

def apply (mc: MathContext) : BigDecimal

def asInstanceOf [T0] : T0

val bigDecimal : BigDecimal

def byteValue () : Byte

def charValue : Char

def clone () : AnyRef

def compare (that: BigDecimal) : Int

def doubleValue () : Double

def eq (arg0: AnyRef) : Boolean

def equals (that: BigDecimal) : Boolean

def equals (that: Any) : Boolean

def finalize () : Unit

def floatValue () : Float

def getClass () : java.lang.Class[_ <: java.lang.Object]

def hashCode () : Int

def intValue () : Int

def isInstanceOf [T0] : Boolean

def isValidByte : Boolean

def isValidChar : Boolean

def isValidInt : Boolean

def isValidShort : Boolean

def isWhole () : Boolean

def longValue () : Long

def max (that: BigDecimal) : BigDecimal

val mc : MathContext

def min (that: BigDecimal) : BigDecimal

def ne (arg0: AnyRef) : Boolean

def notify () : Unit

def notifyAll () : Unit

def pow (n: Int) : BigDecimal

def precision : Int

def quot (that: BigDecimal) : BigDecimal

def remainder (that: BigDecimal) : BigDecimal

def round (mc: MathContext) : BigDecimal

def scale : Int

def setScale (scale: Int, mode: RoundingMode) : BigDecimal

def setScale (scale: Int) : BigDecimal

def shortValue () : Short

def signum : Int

def synchronized [T0] (arg0: T0) : T0

def to (end: BigDecimal, step: BigDecimal) : Inclusive[BigDecimal]

def to (end: BigDecimal) : Partial[BigDecimal, Inclusive[BigDecimal]]

def toBigInt () : BigInt

def toBigIntExact () : Option[BigInt]

def toByte : Byte

def toByteExact : Byte

def toChar : Char

def toDouble : Double

def toFloat : Float

def toInt : Int

def toIntExact : Int

def toLong : Long

def toLongExact : Long

def toShort : Short

def toShortExact : Short

def toString () : String