Scala Standard Library 2.13.16 - scala.math.BigDecimal
Keywords: Scala Standard Library 2.13.16 scala.math.BigDecimal

Scala Standard Library2.13.16 < Back


# Packages

-  package root

  This is the documentation for the Scala standard library.

  This is the documentation for the Scala standard library.

  #### Package structure

  The scala package contains core types like `Int`, `Float`, `Array` or `Option` which are accessible in all Scala compilation units without explicit qualification or imports.

  Notable packages include:

  - `scala.collection` and its sub-packages contain Scala's collections framework
    - `scala.collection.immutable` - Immutable, sequential data-structures such as `Vector`, `List`, `Range`, `HashMap` or `HashSet`
    - `scala.collection.mutable` - Mutable, sequential data-structures such as `ArrayBuffer`, `StringBuilder`, `HashMap` or `HashSet`
    - `scala.collection.concurrent` - Mutable, concurrent data-structures such as `TrieMap`
  - `scala.concurrent` - Primitives for concurrent programming such as `Futures` and `Promises`
  - `scala.io` - Input and output operations
  - `scala.math` - Basic math functions and additional numeric types like `BigInt` and `BigDecimal`
  - `scala.sys` - Interaction with other processes and the operating system
  - `scala.util.matching` - Regular expressions

  Other 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.collection.parallel` - Parallel collections (scala-parallel-collections.jar)
  - `scala.util.parsing` - Parser combinators (scala-parser-combinators.jar)
  - `scala.swing` - A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)

  #### Automatic imports

  Identifiers in the scala package and the `scala.Predef` object are always in scope by default.

  Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, `List` is an alias for `scala.collection.immutable.List`.

  Other aliases refer to classes provided by the underlying platform. For example, on the JVM, `String` is an alias for `java.lang.String`.

  Definition Classes
    root
-  package scala

  Core Scala types.

  Core Scala types. They are always available without an explicit import.

  Definition Classes
    root
-  package math

  The package object `scala.math` contains methods for performing basic numeric operations such as elementary exponential, logarithmic, root and trigonometric functions.

  The package object `scala.math` contains methods for performing basic numeric operations such as elementary exponential, logarithmic, root and trigonometric functions.

  All methods forward to java.lang.Math unless otherwise noted.

  Definition Classes
    scala
  See also

    java.lang.Math

- BigDecimal
- BigInt
- Equiv
- Fractional
- Integral
- LowPriorityEquiv
- LowPriorityOrderingImplicits
- Numeric
- Ordered
- Ordering
- PartialOrdering
- PartiallyOrdered
- ScalaNumericAnyConversions
- ScalaNumericConversions

c

scala.math

# BigDecimal

###
Companion object BigDecimal

#### final class BigDecimal extends ScalaNumber with ScalaNumericConversions with Serializable with Ordered[BigDecimal]

`BigDecimal` represents decimal floating-point numbers of arbitrary precision. By default, the precision approximately matches that of IEEE 128-bit floating point numbers (34 decimal digits, `HALF_EVEN` rounding mode). Within the range of IEEE binary128 numbers, `BigDecimal` will agree with `BigInt` for both equality and hash codes (and will agree with primitive types as well). Beyond that range--numbers with more than 4934 digits when written out in full--the `hashCode` of `BigInt` and `BigDecimal` is allowed to diverge due to difficulty in efficiently computing both the decimal representation in `BigDecimal` and the binary representation in `BigInt`.

When creating a `BigDecimal` from a `Double` or `Float`, care must be taken as the binary fraction representation of `Double` and `Float` does not easily convert into a decimal representation. Three explicit schemes are available for conversion. `BigDecimal.decimal` will convert the floating-point number to a decimal text representation, and build a `BigDecimal` based on that. `BigDecimal.binary` will expand the binary fraction to the requested or default precision. `BigDecimal.exact` will expand the binary fraction to the full number of digits, thus producing the exact decimal value corresponding to the binary fraction of that floating-point number. `BigDecimal` equality matches the decimal expansion of `Double`: `BigDecimal.decimal(0.1) == 0.1`. Note that since `0.1f != 0.1`, the same is not true for `Float`. Instead, `0.1f == BigDecimal.decimal((0.1f).toDouble)`.

To test whether a `BigDecimal` number can be converted to a `Double` or `Float` and then back without loss of information by using one of these methods, test with `isDecimalDouble`, `isBinaryDouble`, or `isExactDouble` or the corresponding `Float` versions. Note that `BigInt`'s `isValidDouble` will agree with `isExactDouble`, not the `isDecimalDouble` used by default.

`BigDecimal` uses the decimal representation of binary floating-point numbers to determine equality and hash codes. This yields different answers than conversion between `Long` and `Double` values, where the exact form is used. As always, since floating-point is a lossy representation, it is advisable to take care when assuming identity will be maintained across multiple conversions.

`BigDecimal` maintains a `MathContext` that determines the rounding that is applied to certain calculations. In most cases, the value of the `BigDecimal` is also rounded to the precision specified by the `MathContext`. To create a `BigDecimal` with a different precision than its `MathContext`, use `new BigDecimal(new java.math.BigDecimal(...), mc)`. Rounding will be applied on those mathematical operations that can dramatically change the number of digits in a full representation, namely multiplication, division, and powers. The left-hand argument's `MathContext` always determines the degree of rounding, if any, and is the one propagated through arithmetic operations that do not apply rounding themselves.

Source
  BigDecimal.scala

Linear Supertypes
Ordered[BigDecimal], Comparable[BigDecimal], ScalaNumericConversions, ScalaNumericAnyConversions, ScalaNumber, Number, java.io.Serializable, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. BigDecimal
2. Ordered
3. Comparable
4. ScalaNumericConversions
5. ScalaNumericAnyConversions
6. ScalaNumber
7. Number
8. Serializable
9. AnyRef
10. Any

Implicitly

1. by orderingToOrdered
2. by any2stringadd
3. by StringFormat
4. by Ensuring
5. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new BigDecimal(bigDecimal: java.math.BigDecimal)
2.  new BigDecimal(bigDecimal: java.math.BigDecimal, mc: MathContext)

### Value Members

1.  final def !=(arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

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

   Definition Classes
     AnyRef → Any
2.  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
3.  def %(that: BigDecimal): BigDecimal

   Remainder after dividing this by that.

4.  def *(that: BigDecimal): BigDecimal

   Multiplication of BigDecimals

5.  def +(that: BigDecimal): BigDecimal

   Addition of BigDecimals

6.  def -(that: BigDecimal): BigDecimal

   Subtraction of BigDecimals

7.  def ->[B](y: B): (BigDecimal, B)
   Implicit
     This member is added by an implicit conversion from BigDecimal toArrowAssoc[BigDecimal] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
8.  def /(that: BigDecimal): BigDecimal

   Division of BigDecimals

9.  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. The computation is exact: no rounding is applied.

10.  def <(that: BigDecimal): Boolean

    Returns true if `this` is less than `that`

    Returns true if `this` is less than `that`

    Definition Classes
      Ordered
11.  def <=(that: BigDecimal): Boolean

    Returns true if `this` is less than or equal to `that`.

    Returns true if `this` is less than or equal to `that`.

    Definition Classes
      Ordered
12.  final def ==(arg0: Any): Boolean

    The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

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

    Returns true if `this` is greater than `that`.

    Returns true if `this` is greater than `that`.

    Definition Classes
      Ordered
14.  def >=(that: BigDecimal): Boolean

    Returns true if `this` is greater than or equal to `that`.

    Returns true if `this` is greater than or equal to `that`.

    Definition Classes
      Ordered
15.  def abs: BigDecimal

    Returns the absolute value of this BigDecimal

16.  def apply(mc: MathContext): BigDecimal

    Returns a new BigDecimal based on the supplied MathContext, rounded as needed.

17.  final def asInstanceOf[T0]: T0

    Forces the compiler to treat the receiver object as having type `T0`, even though doing so may violate type safety.

    Forces the compiler to treat the receiver object as having type `T0`, even though doing so may violate type safety.

    This method is useful when you believe you have type information the compiler doesn't, and it also isn't possible to check the type at runtime. In such situations, skipping type safety is the only option.

    It is platform dependent whether `asInstanceOf` has any effect at runtime. It might do a runtime type test on the erasure of `T0`, insert a conversion (such as boxing/unboxing), fill in a default value, or do nothing at all.

    In particular, `asInstanceOf` is not a type test. It does **not** mean:

        this match {
         case x: T0 => x
         case _     => throw ClassCastException("...")

    Use pattern matching or isInstanceOf for type testing instead.

    Situations where `asInstanceOf` is useful:

    - when flow analysis fails to deduce `T0` automatically
    - when down-casting a type parameter or an abstract type member (which cannot be checked at runtime due to type erasure) If there is any doubt and you are able to type test instead, you should do so.

    Be careful of using `asInstanceOf` when `T0` is a primitive type. When `T0` is primitive, `asInstanceOf` may insert a conversion instead of a type test. If your intent is to convert, use a `toT` method (`x.toChar`, `x.toByte`, etc.).

    returns

      the receiver object.

    Definition Classes
      Any
    Exceptions thrown

      `ClassCastException` if the receiver is not an instance of the erasure of `T0`, if that can be checked on this platform

18.  val bigDecimal: java.math.BigDecimal
19.  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 → ScalaNumericAnyConversions → Number
20.  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.

21.  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(classOf[java.lang.CloneNotSupportedException]) @native()
    Note

      not specified by SLS as a member of AnyRef

22.  def compare(that: BigDecimal): Int

    Compares this BigDecimal with the specified BigDecimal

    Compares this BigDecimal with the specified BigDecimal

    Definition Classes
      BigDecimal → Ordered
23.  def compareTo(that: BigDecimal): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`.

    Definition Classes
      Ordered → Comparable
24.  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 → ScalaNumericAnyConversions → Number
25.  def ensuring(cond: (BigDecimal) => Boolean, msg: => Any): BigDecimal
    Implicit
      This member is added by an implicit conversion from BigDecimal toEnsuring[BigDecimal] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
26.  def ensuring(cond: (BigDecimal) => Boolean): BigDecimal
    Implicit
      This member is added by an implicit conversion from BigDecimal toEnsuring[BigDecimal] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
27.  def ensuring(cond: Boolean, msg: => Any): BigDecimal
    Implicit
      This member is added by an implicit conversion from BigDecimal toEnsuring[BigDecimal] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
28.  def ensuring(cond: Boolean): BigDecimal
    Implicit
      This member is added by an implicit conversion from BigDecimal toEnsuring[BigDecimal] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
29.  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 `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(that: BigDecimal): Boolean

    Compares this BigDecimal with the specified BigDecimal for equality.

31.  def equals(that: Any): Boolean

    Compares this BigDecimal with the specified value for equality.

    Compares this BigDecimal with the specified value for equality. Where `Float` and `Double` disagree, `BigDecimal` will agree with the `Double` value

    that

      the object to compare against this object for equality.

    returns

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

    Definition Classes
      BigDecimal → AnyRef → Any
32.  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(classOf[java.lang.Throwable])
    Note

      not specified by SLS as a member of AnyRef

33.  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 → ScalaNumericAnyConversions → Number
34.  final def getClass(): Class[_ <: AnyRef]

    Returns the runtime class representation of the object.

    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()
35.  def hashCode(): Int

    Returns the hash code for this BigDecimal.

    Returns the hash code for this BigDecimal. Note that this does not merely use the underlying java object's `hashCode` because we compare `BigDecimal`s with `compareTo` which deems 2 == 2.00, whereas in java these are unequal with unequal `hashCode`s. These hash codes agree with `BigInt` for whole numbers up ~4934 digits (the range of IEEE 128 bit floating point). Beyond this, hash codes will disagree; this prevents the explicit representation of the `BigInt` form for `BigDecimal` values with large exponents.

    returns

      the hash code value for this object.

    Definition Classes
      BigDecimal → AnyRef → Any
36.  def intValue: Int

    Converts this BigDecimal to an Int.

    Converts this BigDecimal to an Int. If the BigDecimal is too big to fit in an Int, 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 → ScalaNumericAnyConversions → Number
37.  def isBinaryDouble: Boolean

    Tests whether this `BigDecimal` holds, to within precision, the binary representation of a `Double`.

38.  def isBinaryFloat: Boolean

    Tests whether this `BigDecimal` holds, to within precision, the binary representation of a `Float`.

39.  def isDecimalDouble: Boolean

    Tests whether this `BigDecimal` holds the decimal representation of a `Double`.

40.  def isDecimalFloat: Boolean

    Tests whether this `BigDecimal` holds the decimal representation of a `Float`.

41.  def isExactDouble: Boolean

    Tests whether this `BigDecimal` holds the exact expansion of a `Double`'s binary fractional form into base 10.

42.  def isExactFloat: Boolean

    Tests whether this `BigDecimal` holds the exact expansion of a `Float`'s binary fractional form into base 10.

43.  final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object has the same erasure as `T0`.

    Test whether the dynamic type of the receiver object has the same erasure as `T0`.

    Depending on what `T0` is, the test is done in one of the below ways:

    - `T0` is a non-parameterized class type, e.g. `BigDecimal`: this method returns `true` if the value of the receiver object is a `BigDecimal` or a subtype of `BigDecimal`.
    - `T0` is a parameterized class type, e.g. `List[Int]`: this method returns `true` if the value of the receiver object is some `List[X]` for any `X`. For example, `List(1, 2, 3).isInstanceOf[List[String]]` will return true.
    - `T0` is some singleton type `x.type` or literal `x`: this method returns `this.eq(x)`. For example, `x.isInstanceOf[1]` is equivalent to `x.eq(1)`
    - `T0` is an intersection `X with Y` or `X & Y: this method is equivalent to` x.isInstanceOf[X] && x.isInstanceOf[Y]``
    - `T0` is a union `X | Y`: this method is equivalent to `x.isInstanceOf[X] || x.isInstanceOf[Y]`
    - `T0` is a type parameter or an abstract type member: this method is equivalent to `isInstanceOf[U]` where `U` is `T0`'s upper bound, `Any` if `T0` is unbounded. For example, `x.isInstanceOf[A]` where `A` is an unbounded type parameter will return true for any value of `x`.

    This is exactly equivalent to the type pattern `_: T0`

    returns

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

    Definition Classes
      Any
    Note

      due to the unexpectedness of `List(1, 2, 3).isInstanceOf[List[String]]` returning true and `x.isInstanceOf[A]` where `A` is a type parameter or abstract member returning true, these forms issue a warning.

44.  def isValidByte: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions
45.  def isValidChar: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions
46.  def isValidInt: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions
47.  def isValidLong: Boolean
48.  def isValidShort: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions
49.  def isWhole: Boolean

    returns

      `true` if this number has no decimal component, `false` otherwise.

    Definition Classes
      BigDecimal → ScalaNumericAnyConversions → ScalaNumber
50.  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 Long, 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 → ScalaNumericAnyConversions → Number
51.  def max(that: BigDecimal): BigDecimal

    Returns the maximum of this and that, or this if the two are equal

52.  val mc: MathContext
53.  def min(that: BigDecimal): BigDecimal

    Returns the minimum of this and that, or this if the two are equal

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

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

57.  def pow(n: Int): BigDecimal

    Returns a BigDecimal whose value is this ** n.

58.  def precision: Int

    Returns the precision of this `BigDecimal`.

59.  def quot(that: BigDecimal): BigDecimal

    Divide to Integral value.

60.  def remainder(that: BigDecimal): BigDecimal

    Remainder after dividing this by that.

61.  def round(mc: MathContext): BigDecimal

    Returns a BigDecimal rounded according to the supplied MathContext settings, but preserving its own MathContext for future operations.

62.  def rounded: BigDecimal

    Returns a `BigDecimal` rounded according to its own `MathContext`

63.  def scale: Int

    Returns the scale of this `BigDecimal`.

64.  def setScale(scale: Int, mode: RoundingMode): BigDecimal
65.  def setScale(scale: Int): BigDecimal

    Returns a `BigDecimal` whose scale is the specified value, and whose value is numerically equal to this BigDecimal's.

66.  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 Short, 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 → ScalaNumericAnyConversions → Number
67.  def sign: BigDecimal

    Returns the sign of this BigDecimal; -1 if it is less than 0, +1 if it is greater than 0, 0 if it is equal to 0.

68.  def signum: Int

    Returns the sign of this BigDecimal; -1 if it is less than 0, +1 if it is greater than 0, 0 if it is equal to 0.

69.  final def synchronized[T0](arg0: => T0): T0

    Executes the code in `body` with an exclusive lock on `this`.

    Executes the code in `body` with an exclusive lock on `this`.

    returns

      the result of `body`

    Definition Classes
      AnyRef
70.  def to(end: BigDecimal, step: BigDecimal): Inclusive[scala.BigDecimal]

    Like `until`, but inclusive of the end value.

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

    Like `until`, but inclusive of the end value.

72.  def toBigInt: BigInt

    Converts this `BigDecimal` to a scala.BigInt.

73.  def toBigIntExact: Option[BigInt]

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

74.  def toByte: Byte

    Returns the value of this as a scala.Byte.

    Returns the value of this as a scala.Byte. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
75.  def toByteExact: Byte

    Converts this `BigDecimal` to a scala.Byte, checking for lost information.

    Converts this `BigDecimal` to a scala.Byte, checking for lost information. If this `BigDecimal` has a nonzero fractional part, or is out of the possible range for a scala.Byte result, then a `java.lang.ArithmeticException` is thrown.

76.  def toChar: Char

    Returns the value of this as a scala.Char.

    Returns the value of this as a scala.Char. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
77.  def toDouble: Double

    Returns the value of this as a scala.Double.

    Returns the value of this as a scala.Double. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
78.  def toFloat: Float

    Returns the value of this as a scala.Float.

    Returns the value of this as a scala.Float. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
79.  def toInt: Int

    Returns the value of this as an scala.Int.

    Returns the value of this as an scala.Int. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
80.  def toIntExact: Int

    Converts this `BigDecimal` to a scala.Int, checking for lost information.

    Converts this `BigDecimal` to a scala.Int, checking for lost information. If this `BigDecimal` has a nonzero fractional part, or is out of the possible range for an scala.Int result, then a `java.lang.ArithmeticException` is thrown.

81.  def toLong: Long

    Returns the value of this as a scala.Long.

    Returns the value of this as a scala.Long. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
82.  def toLongExact: Long

    Converts this `BigDecimal` to a scala.Long, checking for lost information.

    Converts this `BigDecimal` to a scala.Long, checking for lost information. If this `BigDecimal` has a nonzero fractional part, or is out of the possible range for a scala.Long result, then a `java.lang.ArithmeticException` is thrown.

83.  def toShort: Short

    Returns the value of this as a scala.Short.

    Returns the value of this as a scala.Short. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
84.  def toShortExact: Short

    Converts this `BigDecimal` to a scala.Short, checking for lost information.

    Converts this `BigDecimal` to a scala.Short, checking for lost information. If this `BigDecimal` has a nonzero fractional part, or is out of the possible range for a scala.Short result, then a `java.lang.ArithmeticException` is thrown.

85.  def toString(): String

    Returns the decimal String representation of this BigDecimal.

    Returns the decimal String representation of this BigDecimal.

    returns

      a String representation of the object.

    Definition Classes
      BigDecimal → AnyRef → Any
86.  def ulp: BigDecimal

    Returns the size of an ulp, a unit in the last place, of this BigDecimal.

87.  def unary_-: BigDecimal

    Returns a BigDecimal whose value is the negation of this BigDecimal

88.  def underlying(): java.math.BigDecimal
    Definition Classes
      BigDecimal → ScalaNumericConversions → ScalaNumber
89.  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
      ScalaNumericAnyConversions
90.  def unifiedPrimitiveHashcode: Int
    Attributes
      protected
    Definition Classes
      ScalaNumericAnyConversions
91.  def until(end: BigDecimal, step: BigDecimal): Exclusive[BigDecimal]

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

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

93.  final def wait(): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
    Note

      not specified by SLS as a member of AnyRef

94.  final def wait(arg0: Long, arg1: Int): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
    Note

      not specified by SLS as a member of AnyRef

95.  final def wait(arg0: Long): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
    Note

      not specified by SLS as a member of AnyRef

### Shadowed Implicit Value Members

1.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from BigDecimal toany2stringadd[BigDecimal] performed by method any2stringadd in scala.Predef.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigDecimal: any2stringadd[BigDecimal]).+(other)

   Definition Classes
     any2stringadd
2.  def <(that: BigDecimal): Boolean

   Returns true if `this` is less than `that`

   Returns true if `this` is less than `that`

   Implicit
     This member is added by an implicit conversion from BigDecimal toOrdered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigDecimal: Ordered[BigDecimal]).<(that)

   Definition Classes
     Ordered
3.  def <=(that: BigDecimal): Boolean

   Returns true if `this` is less than or equal to `that`.

   Returns true if `this` is less than or equal to `that`.

   Implicit
     This member is added by an implicit conversion from BigDecimal toOrdered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigDecimal: Ordered[BigDecimal]).<=(that)

   Definition Classes
     Ordered
4.  def >(that: BigDecimal): Boolean

   Returns true if `this` is greater than `that`.

   Returns true if `this` is greater than `that`.

   Implicit
     This member is added by an implicit conversion from BigDecimal toOrdered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigDecimal: Ordered[BigDecimal]).>(that)

   Definition Classes
     Ordered
5.  def >=(that: BigDecimal): Boolean

   Returns true if `this` is greater than or equal to `that`.

   Returns true if `this` is greater than or equal to `that`.

   Implicit
     This member is added by an implicit conversion from BigDecimal toOrdered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigDecimal: Ordered[BigDecimal]).>=(that)

   Definition Classes
     Ordered
6.  def compare(that: BigDecimal): Int

   Result of comparing `this` with operand `that`.

   Result of comparing `this` with operand `that`.

   Implement this method to determine how instances of A will be sorted.

   Returns `x` where:

   - `x < 0` when `this < that`
   - `x == 0` when `this == that`
   - `x > 0` when `this > that`
   Implicit
     This member is added by an implicit conversion from BigDecimal toOrdered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigDecimal: Ordered[BigDecimal]).compare(that)

   Definition Classes
     Ordered
7.  def compareTo(that: BigDecimal): Int

   Result of comparing `this` with operand `that`.

   Result of comparing `this` with operand `that`.

   Implicit
     This member is added by an implicit conversion from BigDecimal toOrdered[BigDecimal] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigDecimal: Ordered[BigDecimal]).compareTo(that)

   Definition Classes
     Ordered → Comparable

### Deprecated Value Members

1.  def formatted(fmtstr: String): String

   Returns string formatted according to given `format` string.

   Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

   Implicit
     This member is added by an implicit conversion from BigDecimal toStringFormat[BigDecimal] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (BigDecimal, B)
   Implicit
     This member is added by an implicit conversion from BigDecimal toArrowAssoc[BigDecimal] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from Ordered[BigDecimal]

### Inherited from Comparable[BigDecimal]

### Inherited from ScalaNumericConversions

### Inherited from ScalaNumericAnyConversions

### Inherited from ScalaNumber

### Inherited from Number

### Inherited from java.io.Serializable

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion orderingToOrdered fromBigDecimal to Ordered[BigDecimal]

### Inherited by implicit conversion any2stringadd fromBigDecimal to any2stringadd[BigDecimal]

### Inherited by implicit conversion StringFormat fromBigDecimal to StringFormat[BigDecimal]

### Inherited by implicit conversion Ensuring fromBigDecimal to Ensuring[BigDecimal]

### Inherited by implicit conversion ArrowAssoc fromBigDecimal to ArrowAssoc[BigDecimal]

### Ungrouped