Math Types (dw::util::Math)

type OperationContext = {| precision?: Number, roundingMode?: RoundingMode |}

Defines the configuration under which a math operation is executed.

type RoundCeiling = "CEILING"

Rounding mode that rounds toward positive infinity. If the number is positive, it behaves like ROUND_UP. If negative, it behaves like ROUND_DOWN. This rounding mode never decreases the calculated value.

type RoundDown = "DOWN"

Rounding mode that rounds toward zero. It never increments the digit before a discarded fraction (for example, truncates).

type RoundFloor = "FLOOR"

Rounding mode that rounds toward negative infinity. If the number is positive, it behaves like ROUND_DOWN. If negative, it behaves like ROUND_UP.

type RoundHalfDown = "HALF_DOWN"

Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds down. If the discarded fraction is greater than 0.5, it behaves like ROUND_UP. Otherwise, it behaves like ROUND_DOWN.

type RoundHalfEven = "HALF_EVEN"

Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds toward the even neighbor. If the digit to the left of the discarded fraction is odd, it behaves like ROUND_HALF_UP. If even, it behaves like ROUND_HALF_DOWN.

type RoundHalfUp = "HALF_UP"

Rounding mode that rounds toward the nearest neighbor, unless both neighbors are equidistant, in which case it rounds up. If the discarded fraction is greater than or equal to 0.5, it behaves like ROUND_UP. Otherwise, it behaves like ROUND_DOWN.

type RoundUnnecessary = "UNNECESSARY"

Rounding mode that asserts that the requested operation has an exact result, so rounding isn’t necessary.

type RoundUp = "UP"

Rounding mode that rounds away from zero. It always increments the digit before a nonzero discarded fraction.

type RoundingMode = RoundUp | RoundDown | RoundCeiling | RoundFloor | RoundHalfUp | RoundHalfDown | RoundHalfEven | RoundUnnecessary

Enumeration of rounding strategies available for math operations. Available options are: RoundUp, RoundDown, RoundCeiling, RoundFloor, RoundHalfUp, RoundHalfDown, RoundHalfEven, RoundUnnecessary.