scala.math

# BigDecimal

#### object BigDecimal extends Serializable

Source
  BigDecimal.scala
Version

  1.0

Since

  2.7

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Hide All
2. Show all

1. BigDecimal
2. Serializable
3. Serializable
4. AnyRef
5. Any

Visibility

1. Public
2. All

### Value Members

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

   Definition Classes
     AnyRef

2. #### final def !=(arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

     `true` if !(this == that), false otherwise.

   Definition Classes
     Any

3. #### final def ##(): Int

   Equivalent to `x.hashCode` except for boxed numeric types and `null`.

   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

4. #### final def ==(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

5. #### final def ==(arg0: Any): Boolean

   Test two objects for equality.

   Test two objects for equality. 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
     Any

6. #### object RoundingMode extends Enumeration

7. #### def apply(bd: BigDecimal, mc: MathContext): BigDecimal

8. #### def apply(bd: BigDecimal): BigDecimal

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

10. #### def apply(unscaledVal: BigInt, scale: Int): BigDecimal

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

    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`

11. #### def apply(x: BigInt, mc: MathContext): BigDecimal

12. #### def apply(x: BigInt): BigDecimal

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

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

    x

      the specified `BigInt` value

    returns

      the constructed `BigDecimal`

13. #### def apply(x: String, mc: MathContext): BigDecimal

14. #### def apply(x: String): BigDecimal

    Translates the decimal String representation of a `BigDecimal` into a `BigDecimal`.

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

16. #### def apply(x: Array[Char]): BigDecimal

    Translates a character array representation of a `BigDecimal` into a `BigDecimal`.

17. #### def apply(d: Double, mc: MathContext): BigDecimal

18. #### def apply(d: Double): BigDecimal

    Constructs a `BigDecimal` whose value is equal to that of the specified double value.

    Constructs a `BigDecimal` whose value is equal to that of the specified double value.

    d

      the specified `Double` value

    returns

      the constructed `BigDecimal`

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

20. #### def apply(unscaledVal: Long, scale: Int): BigDecimal

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

    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`

21. #### def apply(l: Long, mc: MathContext): BigDecimal

22. #### def apply(l: Long): BigDecimal

    Constructs a `BigDecimal` whose value is equal to that of the specified long value.

    Constructs a `BigDecimal` whose value is equal to that of the specified long value.

    l

      the specified long value

    returns

      the constructed `BigDecimal`

23. #### def apply(i: Int, mc: MathContext): BigDecimal

24. #### def apply(i: Int): BigDecimal

    Constructs a `BigDecimal` whose value is equal to that of the specified `Integer` value.

    Constructs a `BigDecimal` whose value is equal to that of the specified `Integer` value.

    i

      the specified integer value

    returns

      the constructed `BigDecimal`

25. #### 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 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`.

26. #### def clone(): AnyRef

    Create a copy of the receiver object.

    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()
    Note

      not specified by SLS as a member of AnyRef

27. #### val defaultMathContext: MathContext

28. #### implicit def double2bigDecimal(d: Double): BigDecimal

    Implicit conversion from `Double` to `BigDecimal`.

29. #### final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (`arg0`) is a reference to the receiver object (`this`).

    Tests whether the argument (`arg0`) 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

30. #### def equals(arg0: Any): Boolean

    The equality method for reference types.

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

    See also `equals` in Any.

    returns

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

    Definition Classes
      AnyRef → Any

31. #### 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 between `finalize` and non-local returns and exceptions, are all platform dependent.

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

      not specified by SLS as a member of AnyRef

32. #### final def getClass(): Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    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.

    Definition Classes
      AnyRef → Any
    Note

      not specified by SLS as a member of AnyRef

33. #### def hashCode(): Int

    The hashCode method for reference types.

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

    returns

      the hash code value for this object.

    Definition Classes
      AnyRef → Any

34. #### implicit def int2bigDecimal(i: Int): BigDecimal

    Implicit conversion from `Int` to `BigDecimal`.

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

36. #### implicit def javaBigDecimal2bigDecimal(x: BigDecimal): BigDecimal

    Implicit conversion from `java.math.BigDecimal` to `scala.BigDecimal`.

37. #### implicit def long2bigDecimal(l: Long): BigDecimal

    Implicit conversion from `Long` to `BigDecimal`.

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

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

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

41. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

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

43. #### def valueOf(d: Double, mc: MathContext): BigDecimal

44. #### def valueOf(d: Double): BigDecimal

    Constructs a `BigDecimal` using the java BigDecimal static valueOf constructor.

    Constructs a `BigDecimal` using the java BigDecimal static valueOf constructor.

    d

      the specified double value

    returns

      the constructed `BigDecimal`

45. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

46. #### final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

47. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

### Deprecated Value Members

1. #### val MaxLong: BigDecimal

   Annotations
     @deprecated
   Deprecated

     (Since version 2.9.0) Use Long.MaxValue

2. #### val MinLong: BigDecimal

   Annotations
     @deprecated
   Deprecated

     (Since version 2.9.0) Use Long.MinValue

### Inherited from Serializable

### Inherited from AnyRef

### Inherited from Any