scala.math

BigDecimal

class BigDecimal extends ScalaNumber with ScalaNumericConversions

go to: companion
linear super types: ScalaNumericConversions, ScalaNumber, Number, Serializable, AnyRef, Any
source: BigDecimal.scala
    version
  1. 1.0

Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. BigDecimal
  2. ScalaNumericConversions
  3. ScalaNumber
  4. Number
  5. Serializable
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new BigDecimal (bigDecimal: BigDecimal)

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

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. 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
  3. def ## () : Int

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

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

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

    Remainder after dividing this by that.

    Remainder after dividing this by that.

  7. def * (that: BigDecimal) : BigDecimal

    Multiplication of BigDecimals

    Multiplication of BigDecimals

  8. def + (that: BigDecimal) : BigDecimal

    Addition of BigDecimals

    Addition of BigDecimals

  9. def - (that: BigDecimal) : BigDecimal

    Subtraction of BigDecimals

    Subtraction of BigDecimals

  10. def / (that: BigDecimal) : BigDecimal

    Division of BigDecimals

    Division of BigDecimals

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

  12. def < (that: BigDecimal) : Boolean

    Less-than of BigDecimals

    Less-than of BigDecimals

  13. def <= (that: BigDecimal) : Boolean

    Less-than-or-equals comparison of BigDecimals

    Less-than-or-equals comparison of BigDecimals

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

    Greater-than comparison of BigDecimals

    Greater-than comparison of BigDecimals

  17. def >= (that: BigDecimal) : Boolean

    Greater-than-or-equals comparison of BigDecimals

    Greater-than-or-equals comparison of BigDecimals

  18. def abs : BigDecimal

    Returns the absolute value of this BigDecimal

    Returns the absolute value of this BigDecimal

  19. def apply (mc: MathContext) : BigDecimal

    Returns a new BigDecimal based on the supplied MathContext.

    Returns a new BigDecimal based on the supplied MathContext.

  20. 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
  21. val bigDecimal : BigDecimal

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

  24. 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
  25. def compare (that: BigDecimal) : Int

    Compares this BigDecimal with the specified BigDecimal

    Compares this BigDecimal with the specified BigDecimal

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

    Compares this BigDecimal with the specified BigDecimal for equality.

    Compares this BigDecimal with the specified BigDecimal for equality.

  29. def equals (that: Any) : Boolean

    Compares this BigDecimal with the specified value for equality.

    Compares this BigDecimal with the specified value for [email protected] true if the receiver object is equivalent to the argument; false otherwise. */

    definition classes: BigDecimal → AnyRef → Any
  30. 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
  31. 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
  32. 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
  33. 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 [email protected] the hash code value for the object. */

    definition classes: BigDecimal → AnyRef → Any
  34. 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
  35. 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
  36. def isValidByte : Boolean

    definition classes: ScalaNumericConversions
  37. def isValidChar : Boolean

    definition classes: ScalaNumericConversions
  38. def isValidInt : Boolean

    definition classes: ScalaNumericConversions
  39. def isValidShort : Boolean

    definition classes: ScalaNumericConversions
  40. def isWhole () : Boolean

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

    Returns the maximum of this and that

    Returns the maximum of this and that

  43. val mc : MathContext

  44. def min (that: BigDecimal) : BigDecimal

    Returns the minimum of this and that

    Returns the minimum of this and that

  45. 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
  46. 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
  47. 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
  48. def pow (n: Int) : BigDecimal

    Returns a BigDecimal whose value is this ** n.

    Returns a BigDecimal whose value is this ** n.

  49. def precision : Int

    Returns the precision of this BigDecimal.

    Returns the precision of this BigDecimal.

  50. def quot (that: BigDecimal) : BigDecimal

    Divide to Integral value.

    Divide to Integral value.

  51. def remainder (that: BigDecimal) : BigDecimal

    Remainder after dividing this by that.

    Remainder after dividing this by that.

  52. def round (mc: MathContext) : BigDecimal

    Returns a BigDecimal rounded according to the MathContext settings.

    Returns a BigDecimal rounded according to the MathContext settings.

  53. def scale : Int

    Returns the scale of this BigDecimal.

    Returns the scale of this BigDecimal.

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

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

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

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

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

    Like until, but inclusive of the end value.

    Like until, but inclusive of the end value.

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

    Like until, but inclusive of the end value.

    Like until, but inclusive of the end value.

  61. def toBigInt () : BigInt

    Converts this BigDecimal to a scala.

    Converts this BigDecimal to a scala.BigInt.

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

  63. def toByte : Byte

    definition classes: ScalaNumericConversions
  64. def toByteExact : Byte

    This BigDecimal as an exact value.

    This BigDecimal as an exact value.

  65. def toChar : Char

    definition classes: ScalaNumericConversions
  66. def toDouble : Double

    definition classes: ScalaNumericConversions
  67. def toFloat : Float

    definition classes: ScalaNumericConversions
  68. def toInt : Int

    definition classes: ScalaNumericConversions
  69. def toIntExact : Int

  70. def toLong : Long

    definition classes: ScalaNumericConversions
  71. def toLongExact : Long

  72. def toShort : Short

    definition classes: ScalaNumericConversions
  73. def toShortExact : Short

  74. def toString () : String

    Returns the decimal String representation of this BigDecimal.

    Returns the decimal String representation of this [email protected] a string representation of the object. */

    definition classes: BigDecimal → AnyRef → Any
  75. 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.

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

  77. def underlying () : BigDecimal

    definition classes: BigDecimal → ScalaNumber
  78. 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
  79. def unifiedPrimitiveHashcode () : Int

    attributes: protected
    definition classes: ScalaNumericConversions
  80. 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.

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

  82. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef

Inherited from ScalaNumericConversions

Inherited from ScalaNumber

Inherited from Number

Inherited from Serializable

Inherited from AnyRef

Inherited from Any