# BigDecimal

### Inherits

1. ScalaNumericConversions
2. ScalaNumber
3. Number
4. Serializable
5. AnyRef
6. Any

### Value Members

1. #### def *(that: BigDecimal): BigDecimal

Multiplication of BigDecimals

Multiplication of BigDecimals

3. #### def -(that: BigDecimal): BigDecimal

Subtraction of BigDecimals

Subtraction of BigDecimals

4. #### def /(that: BigDecimal): BigDecimal

Division of BigDecimals

Division of BigDecimals

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

6. #### def <(that: BigDecimal): Boolean

Less-than of BigDecimals

Less-than of BigDecimals

7. #### def <=(that: BigDecimal): Boolean

Less-than-or-equals comparison of BigDecimals

Less-than-or-equals comparison of BigDecimals

8. #### def >(that: BigDecimal): Boolean

Greater-than comparison of BigDecimals

Greater-than comparison of BigDecimals

9. #### def >=(that: BigDecimal): Boolean

Greater-than-or-equals comparison of BigDecimals

Greater-than-or-equals comparison of BigDecimals

10. #### def abs: BigDecimal

Returns the absolute value of this BigDecimal

Returns the absolute value of this BigDecimal

11. #### def apply(mc: MathContext): BigDecimal

Returns a new BigDecimal based on the supplied MathContext

Returns a new BigDecimal based on the supplied MathContext.

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

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

15. #### def compare(that: BigDecimal): Int

Compares this BigDecimal with the specified BigDecimal

Compares this BigDecimal with the specified BigDecimal

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

17. #### def equals(that: BigDecimal): Boolean

Compares this BigDecimal with the specified BigDecimal for equality

Compares this BigDecimal with the specified BigDecimal for equality.

18. #### def equals(that: Any): Boolean

Compares this BigDecimal with the specified value for equality

Compares this BigDecimal with the specified value for equality. Will only claim equality with scala.BigDecimal and java.math.BigDecimal.

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

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

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

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

27. #### def max(that: BigDecimal): BigDecimal

Returns the maximum of this and that

Returns the maximum of this and that

29. #### def min(that: BigDecimal): BigDecimal

Returns the minimum of this and that

Returns the minimum of this and that

30. #### def pow(n: Int): BigDecimal

Returns a BigDecimal whose value is this ** n

Returns a BigDecimal whose value is this ** n.

31. #### def precision: Int

Returns the precision of this `BigDecimal`

Returns the precision of this `BigDecimal`.

32. #### def quot(that: BigDecimal): BigDecimal

Divide to Integral value

Divide to Integral value.

33. #### def remainder(that: BigDecimal): BigDecimal

Remainder after dividing this by that

Remainder after dividing this by that.

34. #### def round(mc: MathContext): BigDecimal

Returns a BigDecimal rounded according to the MathContext settings

Returns a BigDecimal rounded according to the MathContext settings.

35. #### def scale: Int

Returns the scale of this `BigDecimal`

Returns the scale of this `BigDecimal`.

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

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

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

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

Like `until`, but inclusive of the end value

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

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

Like `until`, but inclusive of the end value

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

42. #### def toBigInt(): BigInt

Converts this `BigDecimal` to a scala

Converts this `BigDecimal` to a scala.BigInt.

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

45. #### def toByteExact: Byte

This BigDecimal as an exact value

This BigDecimal as an exact value.

55. #### def toString(): String

Returns the decimal String representation of this BigDecimal

Returns the decimal String representation of this BigDecimal.

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

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

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

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