Decimal v1.5.0 Decimal.Context View Source

The context is kept in the process dictionary. It can be accessed with Decimal.get_context/0 and Decimal.set_context/1.

The default context has a precision of 28, the rounding algorithm is :half_up. The set trap enablers are :invalid_operation and :division_by_zero.

Fields

precision - maximum number of decimal digits in the coefficient. If an operation result has more digits it will be rounded to precision digits with the rounding algorithm in rounding.
rounding - the rounding algorithm used when the coefficient’s number of exceeds precision. Strategies explained below.
flags - a list of signals that for which the flag is sent. When an exceptional condition is signalled its flag is set. The flags are sticky and will be set until explicitly cleared.
traps - a list of set trap enablers for signals. When a signal’s trap enabler is set the condition causes Decimal.Error to be raised.

Rounding algorithms

:down - round toward zero (truncate). Discarded digits are ignored, result is unchanged.
:half_up - if the discarded digits is greater than or equal to half of the value of a one in the next left position then the coefficient will be incremented by one (rounded up). Otherwise (the discarded digits are less than half) the discarded digits will be ignored.
:half_even - also known as “round to nearest” or “banker’s rounding”. If the discarded digits is greater than half of the value of a one in the next left position then the coefficient will be incremented by one (rounded up). If they represent less than half discarded digits will be ignored. Otherwise (exactly half), the coefficient is not altered if it’s even, or incremented by one (rounded up) if it’s odd (to make an even number).
:ceiling - round toward +Infinity. If all of the discarded digits are zero or the sign is negative the result is unchanged. Otherwise, the coefficient will be incremented by one (rounded up).
:floor - round toward -Infinity. If all of the discarded digits are zero or the sign is positive the result is unchanged. Otherwise, the sign is negative and coefficient will be incremented by one.
:half_down - if the discarded digits is greater than half of the value of a one in the next left position then the coefficient will be incremented by one (rounded up). Otherwise (the discarded digits are half or less) the discarded digits are ignored.
:up - round away from zero. If all discarded digits are zero the coefficient is not changed, otherwise it is incremented by one (rounded up).

Link to this section Summary

Types

t()

Link to this section Types

t()

t() :: %Decimal.Context{
  flags: [Decimal.signal()],
  precision: pos_integer(),
  rounding: Decimal.rounding(),
  traps: [Decimal.signal()]
}