BigDecimal.sub

Returns the difference of two BigDecimal values.

You can also use the - operator on BigDecimal values.

Syntax

BigDecimal.sub(a, b, rounding?)

Parameters

• a

  The minuend BigDecimal.

• b

  The subtrahend BigDecimal.

• rounding optional

  If present, the rounding object must contain the following properties:

  • roundingMode

    A string specifying the rounding mode: "floor", "ceiling", "down", "up", "half-even", "half-up".

  • maximumSignificantDigits optional

    The number of significant digits (must be >= 1).

  • maximumFractionDigits optional

    The number of digits after the decimal point (must be >= 0).

  Either maximumSignificantDigits or maximumFractionDigits must be present.

Return value

A new BigDecimal.

Examples

10m - 4.7m

5.3

BigDecimal.sub(10m, 4.7m)

5.3

BigDecimal.sub(10m, 4.7m, { roundingMode: "half-even", maximumSignificantDigits: 1 })

5