Doc/library/decimal.rst

   1
   2 :mod:`decimal` --- Decimal fixed point and floating point arithmetic
   3 ====================================================================
   4
   5 .. module:: decimal
   6    :synopsis: Implementation of the General Decimal Arithmetic  Specification.
   7
   8
   9 .. moduleauthor:: Eric Price <eprice at tjhsst.edu>
  10 .. moduleauthor:: Facundo Batista <facundo at taniquetil.com.ar>
  11 .. moduleauthor:: Raymond Hettinger <python at rcn.com>
  12 .. moduleauthor:: Aahz <aahz at pobox.com>
  13 .. moduleauthor:: Tim Peters <tim.one at comcast.net>
  14
  15
  16 .. sectionauthor:: Raymond D. Hettinger <python at rcn.com>
  17
  18 .. versionadded:: 2.4
  19
  20 .. import modules for testing inline doctests with the Sphinx doctest builder
  21 .. testsetup:: *
  22
  23    import decimal
  24    import math
  25    from decimal import *
  26    # make sure each group gets a fresh context
  27    setcontext(Context())
  28
  29 The :mod:`decimal` module provides support for decimal floating point
  30 arithmetic.  It offers several advantages over the :class:`float` datatype:
  31
  32 * Decimal "is based on a floating-point model which was designed with people
  33   in mind, and necessarily has a paramount guiding principle -- computers must
  34   provide an arithmetic that works in the same way as the arithmetic that
  35   people learn at school." -- excerpt from the decimal arithmetic specification.
  36
  37 * Decimal numbers can be represented exactly.  In contrast, numbers like
  38   :const:`1.1` do not have an exact representation in binary floating point. End
  39   users typically would not expect :const:`1.1` to display as
  40   :const:`1.1000000000000001` as it does with binary floating point.
  41
  42 * The exactness carries over into arithmetic.  In decimal floating point, ``0.1
  43   + 0.1 + 0.1 - 0.3`` is exactly equal to zero.  In binary floating point, the result
  44   is :const:`5.5511151231257827e-017`.  While near to zero, the differences
  45   prevent reliable equality testing and differences can accumulate. For this
  46   reason, decimal is preferred in accounting applications which have strict
  47   equality invariants.
  48
  49 * The decimal module incorporates a notion of significant places so that ``1.30
  50   + 1.20`` is :const:`2.50`.  The trailing zero is kept to indicate significance.
  51   This is the customary presentation for monetary applications. For
  52   multiplication, the "schoolbook" approach uses all the figures in the
  53   multiplicands.  For instance, ``1.3 * 1.2`` gives :const:`1.56` while ``1.30 *
  54   1.20`` gives :const:`1.5600`.
  55
  56 * Unlike hardware based binary floating point, the decimal module has a user
  57   alterable precision (defaulting to 28 places) which can be as large as needed for
  58   a given problem:
  59
  60      >>> getcontext().prec = 6
  61      >>> Decimal(1) / Decimal(7)
  62      Decimal('0.142857')
  63      >>> getcontext().prec = 28
  64      >>> Decimal(1) / Decimal(7)
  65      Decimal('0.1428571428571428571428571429')
  66
  67 * Both binary and decimal floating point are implemented in terms of published
  68   standards.  While the built-in float type exposes only a modest portion of its
  69   capabilities, the decimal module exposes all required parts of the standard.
  70   When needed, the programmer has full control over rounding and signal handling.
  71   This includes an option to enforce exact arithmetic by using exceptions
  72   to block any inexact operations.
  73
  74 * The decimal module was designed to support "without prejudice, both exact
  75   unrounded decimal arithmetic (sometimes called fixed-point arithmetic)
  76   and rounded floating-point arithmetic."  -- excerpt from the decimal
  77   arithmetic specification.
  78
  79 The module design is centered around three concepts:  the decimal number, the
  80 context for arithmetic, and signals.
  81
  82 A decimal number is immutable.  It has a sign, coefficient digits, and an
  83 exponent.  To preserve significance, the coefficient digits do not truncate
  84 trailing zeros.  Decimals also include special values such as
  85 :const:`Infinity`, :const:`-Infinity`, and :const:`NaN`.  The standard also
  86 differentiates :const:`-0` from :const:`+0`.
  87
  88 The context for arithmetic is an environment specifying precision, rounding
  89 rules, limits on exponents, flags indicating the results of operations, and trap
  90 enablers which determine whether signals are treated as exceptions.  Rounding
  91 options include :const:`ROUND_CEILING`, :const:`ROUND_DOWN`,
  92 :const:`ROUND_FLOOR`, :const:`ROUND_HALF_DOWN`, :const:`ROUND_HALF_EVEN`,
  93 :const:`ROUND_HALF_UP`, :const:`ROUND_UP`, and :const:`ROUND_05UP`.
  94
  95 Signals are groups of exceptional conditions arising during the course of
  96 computation.  Depending on the needs of the application, signals may be ignored,
  97 considered as informational, or treated as exceptions. The signals in the
  98 decimal module are: :const:`Clamped`, :const:`InvalidOperation`,
  99 :const:`DivisionByZero`, :const:`Inexact`, :const:`Rounded`, :const:`Subnormal`,
 100 :const:`Overflow`, and :const:`Underflow`.
 101
 102 For each signal there is a flag and a trap enabler.  When a signal is
 103 encountered, its flag is set to one, then, if the trap enabler is
 104 set to one, an exception is raised.  Flags are sticky, so the user needs to
 105 reset them before monitoring a calculation.
 106
 107
 108 .. seealso::
 109
 110    * IBM's General Decimal Arithmetic Specification, `The General Decimal Arithmetic
 111      Specification <http://speleotrove.com/decimal/>`_.
 112
 113    * IEEE standard 854-1987, `Unofficial IEEE 854 Text
 114      <http://754r.ucbtest.org/standards/854.pdf>`_.
 115
 116 .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 117
 118
 119 .. _decimal-tutorial:
 120
 121 Quick-start Tutorial
 122 --------------------
 123
 124 The usual start to using decimals is importing the module, viewing the current
 125 context with :func:`getcontext` and, if necessary, setting new values for
 126 precision, rounding, or enabled traps::
 127
 128    >>> from decimal import *
 129    >>> getcontext()
 130    Context(prec=28, rounding=ROUND_HALF_EVEN, Emin=-999999999, Emax=999999999,
 131            capitals=1, flags=[], traps=[Overflow, DivisionByZero,
 132            InvalidOperation])
 133
 134    >>> getcontext().prec = 7       # Set a new precision
 135
 136 Decimal instances can be constructed from integers, strings, or tuples.  To
 137 create a Decimal from a :class:`float`, first convert it to a string.  This
 138 serves as an explicit reminder of the details of the conversion (including
 139 representation error).  Decimal numbers include special values such as
 140 :const:`NaN` which stands for "Not a number", positive and negative
 141 :const:`Infinity`, and :const:`-0`.
 142
 143    >>> getcontext().prec = 28
 144    >>> Decimal(10)
 145    Decimal('10')
 146    >>> Decimal('3.14')
 147    Decimal('3.14')
 148    >>> Decimal((0, (3, 1, 4), -2))
 149    Decimal('3.14')
 150    >>> Decimal(str(2.0 ** 0.5))
 151    Decimal('1.41421356237')
 152    >>> Decimal(2) ** Decimal('0.5')
 153    Decimal('1.414213562373095048801688724')
 154    >>> Decimal('NaN')
 155    Decimal('NaN')
 156    >>> Decimal('-Infinity')
 157    Decimal('-Infinity')
 158
 159 The significance of a new Decimal is determined solely by the number of digits
 160 input.  Context precision and rounding only come into play during arithmetic
 161 operations.
 162
 163 .. doctest:: newcontext
 164
 165    >>> getcontext().prec = 6
 166    >>> Decimal('3.0')
 167    Decimal('3.0')
 168    >>> Decimal('3.1415926535')
 169    Decimal('3.1415926535')
 170    >>> Decimal('3.1415926535') + Decimal('2.7182818285')
 171    Decimal('5.85987')
 172    >>> getcontext().rounding = ROUND_UP
 173    >>> Decimal('3.1415926535') + Decimal('2.7182818285')
 174    Decimal('5.85988')
 175
 176 Decimals interact well with much of the rest of Python.  Here is a small decimal
 177 floating point flying circus:
 178
 179 .. doctest::
 180    :options: +NORMALIZE_WHITESPACE
 181
 182    >>> data = map(Decimal, '1.34 1.87 3.45 2.35 1.00 0.03 9.25'.split())
 183    >>> max(data)
 184    Decimal('9.25')
 185    >>> min(data)
 186    Decimal('0.03')
 187    >>> sorted(data)
 188    [Decimal('0.03'), Decimal('1.00'), Decimal('1.34'), Decimal('1.87'),
 189     Decimal('2.35'), Decimal('3.45'), Decimal('9.25')]
 190    >>> sum(data)
 191    Decimal('19.29')
 192    >>> a,b,c = data[:3]
 193    >>> str(a)
 194    '1.34'
 195    >>> float(a)
 196    1.3400000000000001
 197    >>> round(a, 1)     # round() first converts to binary floating point
 198    1.3
 199    >>> int(a)
 200    1
 201    >>> a * 5
 202    Decimal('6.70')
 203    >>> a * b
 204    Decimal('2.5058')
 205    >>> c % a
 206    Decimal('0.77')
 207
 208 And some mathematical functions are also available to Decimal:
 209
 210    >>> getcontext().prec = 28
 211    >>> Decimal(2).sqrt()
 212    Decimal('1.414213562373095048801688724')
 213    >>> Decimal(1).exp()
 214    Decimal('2.718281828459045235360287471')
 215    >>> Decimal('10').ln()
 216    Decimal('2.302585092994045684017991455')
 217    >>> Decimal('10').log10()
 218    Decimal('1')
 219
 220 The :meth:`quantize` method rounds a number to a fixed exponent.  This method is
 221 useful for monetary applications that often round results to a fixed number of
 222 places:
 223
 224    >>> Decimal('7.325').quantize(Decimal('.01'), rounding=ROUND_DOWN)
 225    Decimal('7.32')
 226    >>> Decimal('7.325').quantize(Decimal('1.'), rounding=ROUND_UP)
 227    Decimal('8')
 228
 229 As shown above, the :func:`getcontext` function accesses the current context and
 230 allows the settings to be changed.  This approach meets the needs of most
 231 applications.
 232
 233 For more advanced work, it may be useful to create alternate contexts using the
 234 Context() constructor.  To make an alternate active, use the :func:`setcontext`
 235 function.
 236
 237 In accordance with the standard, the :mod:`Decimal` module provides two ready to
 238 use standard contexts, :const:`BasicContext` and :const:`ExtendedContext`. The
 239 former is especially useful for debugging because many of the traps are
 240 enabled:
 241
 242 .. doctest:: newcontext
 243    :options: +NORMALIZE_WHITESPACE
 244
 245    >>> myothercontext = Context(prec=60, rounding=ROUND_HALF_DOWN)
 246    >>> setcontext(myothercontext)
 247    >>> Decimal(1) / Decimal(7)
 248    Decimal('0.142857142857142857142857142857142857142857142857142857142857')
 249
 250    >>> ExtendedContext
 251    Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999999, Emax=999999999,
 252            capitals=1, flags=[], traps=[])
 253    >>> setcontext(ExtendedContext)
 254    >>> Decimal(1) / Decimal(7)
 255    Decimal('0.142857143')
 256    >>> Decimal(42) / Decimal(0)
 257    Decimal('Infinity')
 258
 259    >>> setcontext(BasicContext)
 260    >>> Decimal(42) / Decimal(0)
 261    Traceback (most recent call last):
 262      File "<pyshell#143>", line 1, in -toplevel-
 263        Decimal(42) / Decimal(0)
 264    DivisionByZero: x / 0
 265
 266 Contexts also have signal flags for monitoring exceptional conditions
 267 encountered during computations.  The flags remain set until explicitly cleared,
 268 so it is best to clear the flags before each set of monitored computations by
 269 using the :meth:`clear_flags` method. ::
 270
 271    >>> setcontext(ExtendedContext)
 272    >>> getcontext().clear_flags()
 273    >>> Decimal(355) / Decimal(113)
 274    Decimal('3.14159292')
 275    >>> getcontext()
 276    Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999999, Emax=999999999,
 277            capitals=1, flags=[Rounded, Inexact], traps=[])
 278
 279 The *flags* entry shows that the rational approximation to :const:`Pi` was
 280 rounded (digits beyond the context precision were thrown away) and that the
 281 result is inexact (some of the discarded digits were non-zero).
 282
 283 Individual traps are set using the dictionary in the :attr:`traps` field of a
 284 context:
 285
 286 .. doctest:: newcontext
 287
 288    >>> setcontext(ExtendedContext)
 289    >>> Decimal(1) / Decimal(0)
 290    Decimal('Infinity')
 291    >>> getcontext().traps[DivisionByZero] = 1
 292    >>> Decimal(1) / Decimal(0)
 293    Traceback (most recent call last):
 294      File "<pyshell#112>", line 1, in -toplevel-
 295        Decimal(1) / Decimal(0)
 296    DivisionByZero: x / 0
 297
 298 Most programs adjust the current context only once, at the beginning of the
 299 program.  And, in many applications, data is converted to :class:`Decimal` with
 300 a single cast inside a loop.  With context set and decimals created, the bulk of
 301 the program manipulates the data no differently than with other Python numeric
 302 types.
 303
 304 .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 305
 306
 307 .. _decimal-decimal:
 308
 309 Decimal objects
 310 ---------------
 311
 312
 313 .. class:: Decimal([value [, context]])
 314
 315    Construct a new :class:`Decimal` object based from *value*.
 316
 317    *value* can be an integer, string, tuple, or another :class:`Decimal`
 318    object. If no *value* is given, returns ``Decimal('0')``.  If *value* is a
 319    string, it should conform to the decimal numeric string syntax after leading
 320    and trailing whitespace characters are removed::
 321
 322       sign           ::=  '+' | '-'
 323       digit          ::=  '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
 324       indicator      ::=  'e' | 'E'
 325       digits         ::=  digit [digit]...
 326       decimal-part   ::=  digits '.' [digits] | ['.'] digits
 327       exponent-part  ::=  indicator [sign] digits
 328       infinity       ::=  'Infinity' | 'Inf'
 329       nan            ::=  'NaN' [digits] | 'sNaN' [digits]
 330       numeric-value  ::=  decimal-part [exponent-part] | infinity
 331       numeric-string ::=  [sign] numeric-value | [sign] nan
 332
 333    If *value* is a :class:`tuple`, it should have three components, a sign
 334    (:const:`0` for positive or :const:`1` for negative), a :class:`tuple` of
 335    digits, and an integer exponent. For example, ``Decimal((0, (1, 4, 1, 4), -3))``
 336    returns ``Decimal('1.414')``.
 337
 338    The *context* precision does not affect how many digits are stored. That is
 339    determined exclusively by the number of digits in *value*. For example,
 340    ``Decimal('3.00000')`` records all five zeros even if the context precision is
 341    only three.
 342
 343    The purpose of the *context* argument is determining what to do if *value* is a
 344    malformed string.  If the context traps :const:`InvalidOperation`, an exception
 345    is raised; otherwise, the constructor returns a new Decimal with the value of
 346    :const:`NaN`.
 347
 348    Once constructed, :class:`Decimal` objects are immutable.
 349
 350    .. versionchanged:: 2.6
 351       leading and trailing whitespace characters are permitted when
 352       creating a Decimal instance from a string.
 353
 354    Decimal floating point objects share many properties with the other built-in
 355    numeric types such as :class:`float` and :class:`int`.  All of the usual math
 356    operations and special methods apply.  Likewise, decimal objects can be
 357    copied, pickled, printed, used as dictionary keys, used as set elements,
 358    compared, sorted, and coerced to another type (such as :class:`float` or
 359    :class:`long`).
 360
 361    In addition to the standard numeric properties, decimal floating point
 362    objects also have a number of specialized methods:
 363
 364
 365    .. method:: adjusted()
 366
 367       Return the adjusted exponent after shifting out the coefficient's
 368       rightmost digits until only the lead digit remains:
 369       ``Decimal('321e+5').adjusted()`` returns seven.  Used for determining the
 370       position of the most significant digit with respect to the decimal point.
 371
 372
 373    .. method:: as_tuple()
 374
 375       Return a :term:`named tuple` representation of the number:
 376       ``DecimalTuple(sign, digits, exponent)``.
 377
 378       .. versionchanged:: 2.6
 379          Use a named tuple.
 380
 381
 382    .. method:: canonical()
 383
 384       Return the canonical encoding of the argument.  Currently, the encoding of
 385       a :class:`Decimal` instance is always canonical, so this operation returns
 386       its argument unchanged.
 387
 388       .. versionadded:: 2.6
 389
 390    .. method:: compare(other[, context])
 391
 392       Compare the values of two Decimal instances.  This operation behaves in
 393       the same way as the usual comparison method :meth:`__cmp__`, except that
 394       :meth:`compare` returns a Decimal instance rather than an integer, and if
 395       either operand is a NaN then the result is a NaN::
 396
 397          a or b is a NaN ==> Decimal('NaN')
 398          a < b           ==> Decimal('-1')
 399          a == b          ==> Decimal('0')
 400          a > b           ==> Decimal('1')
 401
 402    .. method:: compare_signal(other[, context])
 403
 404       This operation is identical to the :meth:`compare` method, except that all
 405       NaNs signal.  That is, if neither operand is a signaling NaN then any
 406       quiet NaN operand is treated as though it were a signaling NaN.
 407
 408       .. versionadded:: 2.6
 409
 410    .. method:: compare_total(other)
 411
 412       Compare two operands using their abstract representation rather than their
 413       numerical value.  Similar to the :meth:`compare` method, but the result
 414       gives a total ordering on :class:`Decimal` instances.  Two
 415       :class:`Decimal` instances with the same numeric value but different
 416       representations compare unequal in this ordering:
 417
 418          >>> Decimal('12.0').compare_total(Decimal('12'))
 419          Decimal('-1')
 420
 421       Quiet and signaling NaNs are also included in the total ordering.  The
 422       result of this function is ``Decimal('0')`` if both operands have the same
 423       representation, ``Decimal('-1')`` if the first operand is lower in the
 424       total order than the second, and ``Decimal('1')`` if the first operand is
 425       higher in the total order than the second operand.  See the specification
 426       for details of the total order.
 427
 428       .. versionadded:: 2.6
 429
 430    .. method:: compare_total_mag(other)
 431
 432       Compare two operands using their abstract representation rather than their
 433       value as in :meth:`compare_total`, but ignoring the sign of each operand.
 434       ``x.compare_total_mag(y)`` is equivalent to
 435       ``x.copy_abs().compare_total(y.copy_abs())``.
 436
 437       .. versionadded:: 2.6
 438
 439    .. method:: conjugate()
 440
 441       Just returns self, this method is only to comply with the Decimal
 442       Specification.
 443
 444       .. versionadded:: 2.6
 445
 446    .. method:: copy_abs()
 447
 448       Return the absolute value of the argument.  This operation is unaffected
 449       by the context and is quiet: no flags are changed and no rounding is
 450       performed.
 451
 452       .. versionadded:: 2.6
 453
 454    .. method:: copy_negate()
 455
 456       Return the negation of the argument.  This operation is unaffected by the
 457       context and is quiet: no flags are changed and no rounding is performed.
 458
 459       .. versionadded:: 2.6
 460
 461    .. method:: copy_sign(other)
 462
 463       Return a copy of the first operand with the sign set to be the same as the
 464       sign of the second operand.  For example:
 465
 466          >>> Decimal('2.3').copy_sign(Decimal('-1.5'))
 467          Decimal('-2.3')
 468
 469       This operation is unaffected by the context and is quiet: no flags are
 470       changed and no rounding is performed.
 471
 472       .. versionadded:: 2.6
 473
 474    .. method:: exp([context])
 475
 476       Return the value of the (natural) exponential function ``e**x`` at the
 477       given number.  The result is correctly rounded using the
 478       :const:`ROUND_HALF_EVEN` rounding mode.
 479
 480       >>> Decimal(1).exp()
 481       Decimal('2.718281828459045235360287471')
 482       >>> Decimal(321).exp()
 483       Decimal('2.561702493119680037517373933E+139')
 484
 485       .. versionadded:: 2.6
 486
 487    .. method:: from_float(f)
 488
 489       Classmethod that converts a float to a decimal number, exactly.
 490
 491       Note `Decimal.from_float(0.1)` is not the same as `Decimal('0.1')`.
 492       Since 0.1 is not exactly representable in binary floating point, the
 493       value is stored as the nearest representable value which is
 494       `0x1.999999999999ap-4`.  That equivalent value in decimal is
 495       `0.1000000000000000055511151231257827021181583404541015625`.
 496
 497       .. doctest::
 498
 499           >>> Decimal.from_float(0.1)
 500           Decimal('0.1000000000000000055511151231257827021181583404541015625')
 501           >>> Decimal.from_float(float('nan'))
 502           Decimal('NaN')
 503           >>> Decimal.from_float(float('inf'))
 504           Decimal('Infinity')
 505           >>> Decimal.from_float(float('-inf'))
 506           Decimal('-Infinity')
 507
 508       .. versionadded:: 2.7
 509
 510    .. method:: fma(other, third[, context])
 511
 512       Fused multiply-add.  Return self*other+third with no rounding of the
 513       intermediate product self*other.
 514
 515       >>> Decimal(2).fma(3, 5)
 516       Decimal('11')
 517
 518       .. versionadded:: 2.6
 519
 520    .. method:: is_canonical()
 521
 522       Return :const:`True` if the argument is canonical and :const:`False`
 523       otherwise.  Currently, a :class:`Decimal` instance is always canonical, so
 524       this operation always returns :const:`True`.
 525
 526       .. versionadded:: 2.6
 527
 528    .. method:: is_finite()
 529
 530       Return :const:`True` if the argument is a finite number, and
 531       :const:`False` if the argument is an infinity or a NaN.
 532
 533       .. versionadded:: 2.6
 534
 535    .. method:: is_infinite()
 536
 537       Return :const:`True` if the argument is either positive or negative
 538       infinity and :const:`False` otherwise.
 539
 540       .. versionadded:: 2.6
 541
 542    .. method:: is_nan()
 543
 544       Return :const:`True` if the argument is a (quiet or signaling) NaN and
 545       :const:`False` otherwise.
 546
 547       .. versionadded:: 2.6
 548
 549    .. method:: is_normal()
 550
 551       Return :const:`True` if the argument is a *normal* finite non-zero
 552       number with an adjusted exponent greater than or equal to *Emin*.
 553       Return :const:`False` if the argument is zero, subnormal, infinite or a
 554       NaN.  Note, the term *normal* is used here in a different sense with
 555       the :meth:`normalize` method which is used to create canonical values.
 556
 557       .. versionadded:: 2.6
 558
 559    .. method:: is_qnan()
 560
 561       Return :const:`True` if the argument is a quiet NaN, and
 562       :const:`False` otherwise.
 563
 564       .. versionadded:: 2.6
 565
 566    .. method:: is_signed()
 567
 568       Return :const:`True` if the argument has a negative sign and
 569       :const:`False` otherwise.  Note that zeros and NaNs can both carry signs.
 570
 571       .. versionadded:: 2.6
 572
 573    .. method:: is_snan()
 574
 575       Return :const:`True` if the argument is a signaling NaN and :const:`False`
 576       otherwise.
 577
 578       .. versionadded:: 2.6
 579
 580    .. method:: is_subnormal()
 581
 582       Return :const:`True` if the argument is subnormal, and :const:`False`
 583       otherwise. A number is subnormal is if it is nonzero, finite, and has an
 584       adjusted exponent less than *Emin*.
 585
 586       .. versionadded:: 2.6
 587
 588    .. method:: is_zero()
 589
 590       Return :const:`True` if the argument is a (positive or negative) zero and
 591       :const:`False` otherwise.
 592
 593       .. versionadded:: 2.6
 594
 595    .. method:: ln([context])
 596
 597       Return the natural (base e) logarithm of the operand.  The result is
 598       correctly rounded using the :const:`ROUND_HALF_EVEN` rounding mode.
 599
 600       .. versionadded:: 2.6
 601
 602    .. method:: log10([context])
 603
 604       Return the base ten logarithm of the operand.  The result is correctly
 605       rounded using the :const:`ROUND_HALF_EVEN` rounding mode.
 606
 607       .. versionadded:: 2.6
 608
 609    .. method:: logb([context])
 610
 611       For a nonzero number, return the adjusted exponent of its operand as a
 612       :class:`Decimal` instance.  If the operand is a zero then
 613       ``Decimal('-Infinity')`` is returned and the :const:`DivisionByZero` flag
 614       is raised.  If the operand is an infinity then ``Decimal('Infinity')`` is
 615       returned.
 616
 617       .. versionadded:: 2.6
 618
 619    .. method:: logical_and(other[, context])
 620
 621       :meth:`logical_and` is a logical operation which takes two *logical
 622       operands* (see :ref:`logical_operands_label`).  The result is the
 623       digit-wise ``and`` of the two operands.
 624
 625       .. versionadded:: 2.6
 626
 627    .. method:: logical_invert(other[, context])
 628
 629       :meth:`logical_invert` is a logical operation.  The argument must
 630       be a *logical operand* (see :ref:`logical_operands_label`).  The
 631       result is the digit-wise inversion of the operand.
 632
 633       .. versionadded:: 2.6
 634
 635    .. method:: logical_or(other[, context])
 636
 637       :meth:`logical_or` is a logical operation which takes two *logical
 638       operands* (see :ref:`logical_operands_label`).  The result is the
 639       digit-wise ``or`` of the two operands.
 640
 641       .. versionadded:: 2.6
 642
 643    .. method:: logical_xor(other[, context])
 644
 645       :meth:`logical_xor` is a logical operation which takes two *logical
 646       operands* (see :ref:`logical_operands_label`).  The result is the
 647       digit-wise exclusive or of the two operands.
 648
 649       .. versionadded:: 2.6
 650
 651    .. method:: max(other[, context])
 652
 653       Like ``max(self, other)`` except that the context rounding rule is applied
 654       before returning and that :const:`NaN` values are either signaled or
 655       ignored (depending on the context and whether they are signaling or
 656       quiet).
 657
 658    .. method:: max_mag(other[, context])
 659
 660       Similar to the :meth:`max` method, but the comparison is done using the
 661       absolute values of the operands.
 662
 663       .. versionadded:: 2.6
 664
 665    .. method:: min(other[, context])
 666
 667       Like ``min(self, other)`` except that the context rounding rule is applied
 668       before returning and that :const:`NaN` values are either signaled or
 669       ignored (depending on the context and whether they are signaling or
 670       quiet).
 671
 672    .. method:: min_mag(other[, context])
 673
 674       Similar to the :meth:`min` method, but the comparison is done using the
 675       absolute values of the operands.
 676
 677       .. versionadded:: 2.6
 678
 679    .. method:: next_minus([context])
 680
 681       Return the largest number representable in the given context (or in the
 682       current thread's context if no context is given) that is smaller than the
 683       given operand.
 684
 685       .. versionadded:: 2.6
 686
 687    .. method:: next_plus([context])
 688
 689       Return the smallest number representable in the given context (or in the
 690       current thread's context if no context is given) that is larger than the
 691       given operand.
 692
 693       .. versionadded:: 2.6
 694
 695    .. method:: next_toward(other[, context])
 696
 697       If the two operands are unequal, return the number closest to the first
 698       operand in the direction of the second operand.  If both operands are
 699       numerically equal, return a copy of the first operand with the sign set to
 700       be the same as the sign of the second operand.
 701
 702       .. versionadded:: 2.6
 703
 704    .. method:: normalize([context])
 705
 706       Normalize the number by stripping the rightmost trailing zeros and
 707       converting any result equal to :const:`Decimal('0')` to
 708       :const:`Decimal('0e0')`. Used for producing canonical values for members
 709       of an equivalence class. For example, ``Decimal('32.100')`` and
 710       ``Decimal('0.321000e+2')`` both normalize to the equivalent value
 711       ``Decimal('32.1')``.
 712
 713    .. method:: number_class([context])
 714
 715       Return a string describing the *class* of the operand.  The returned value
 716       is one of the following ten strings.
 717
 718       * ``"-Infinity"``, indicating that the operand is negative infinity.
 719       * ``"-Normal"``, indicating that the operand is a negative normal number.
 720       * ``"-Subnormal"``, indicating that the operand is negative and subnormal.
 721       * ``"-Zero"``, indicating that the operand is a negative zero.
 722       * ``"+Zero"``, indicating that the operand is a positive zero.
 723       * ``"+Subnormal"``, indicating that the operand is positive and subnormal.
 724       * ``"+Normal"``, indicating that the operand is a positive normal number.
 725       * ``"+Infinity"``, indicating that the operand is positive infinity.
 726       * ``"NaN"``, indicating that the operand is a quiet NaN (Not a Number).
 727       * ``"sNaN"``, indicating that the operand is a signaling NaN.
 728
 729       .. versionadded:: 2.6
 730
 731    .. method:: quantize(exp[, rounding[, context[, watchexp]]])
 732
 733       Return a value equal to the first operand after rounding and having the
 734       exponent of the second operand.
 735
 736       >>> Decimal('1.41421356').quantize(Decimal('1.000'))
 737       Decimal('1.414')
 738
 739       Unlike other operations, if the length of the coefficient after the
 740       quantize operation would be greater than precision, then an
 741       :const:`InvalidOperation` is signaled. This guarantees that, unless there
 742       is an error condition, the quantized exponent is always equal to that of
 743       the right-hand operand.
 744
 745       Also unlike other operations, quantize never signals Underflow, even if
 746       the result is subnormal and inexact.
 747
 748       If the exponent of the second operand is larger than that of the first
 749       then rounding may be necessary.  In this case, the rounding mode is
 750       determined by the ``rounding`` argument if given, else by the given
 751       ``context`` argument; if neither argument is given the rounding mode of
 752       the current thread's context is used.
 753
 754       If *watchexp* is set (default), then an error is returned whenever the
 755       resulting exponent is greater than :attr:`Emax` or less than
 756       :attr:`Etiny`.
 757
 758    .. method:: radix()
 759
 760       Return ``Decimal(10)``, the radix (base) in which the :class:`Decimal`
 761       class does all its arithmetic.  Included for compatibility with the
 762       specification.
 763
 764       .. versionadded:: 2.6
 765
 766    .. method:: remainder_near(other[, context])
 767
 768       Compute the modulo as either a positive or negative value depending on
 769       which is closest to zero.  For instance, ``Decimal(10).remainder_near(6)``
 770       returns ``Decimal('-2')`` which is closer to zero than ``Decimal('4')``.
 771
 772       If both are equally close, the one chosen will have the same sign as
 773       *self*.
 774
 775    .. method:: rotate(other[, context])
 776
 777       Return the result of rotating the digits of the first operand by an amount
 778       specified by the second operand.  The second operand must be an integer in
 779       the range -precision through precision.  The absolute value of the second
 780       operand gives the number of places to rotate.  If the second operand is
 781       positive then rotation is to the left; otherwise rotation is to the right.
 782       The coefficient of the first operand is padded on the left with zeros to
 783       length precision if necessary.  The sign and exponent of the first operand
 784       are unchanged.
 785
 786       .. versionadded:: 2.6
 787
 788    .. method:: same_quantum(other[, context])
 789
 790       Test whether self and other have the same exponent or whether both are
 791       :const:`NaN`.
 792
 793    .. method:: scaleb(other[, context])
 794
 795       Return the first operand with exponent adjusted by the second.
 796       Equivalently, return the first operand multiplied by ``10**other``.  The
 797       second operand must be an integer.
 798
 799       .. versionadded:: 2.6
 800
 801    .. method:: shift(other[, context])
 802
 803       Return the result of shifting the digits of the first operand by an amount
 804       specified by the second operand.  The second operand must be an integer in
 805       the range -precision through precision.  The absolute value of the second
 806       operand gives the number of places to shift.  If the second operand is
 807       positive then the shift is to the left; otherwise the shift is to the
 808       right.  Digits shifted into the coefficient are zeros.  The sign and
 809       exponent of the first operand are unchanged.
 810
 811       .. versionadded:: 2.6
 812
 813    .. method:: sqrt([context])
 814
 815       Return the square root of the argument to full precision.
 816
 817
 818    .. method:: to_eng_string([context])
 819
 820       Convert to an engineering-type string.
 821
 822       Engineering notation has an exponent which is a multiple of 3, so there
 823       are up to 3 digits left of the decimal place.  For example, converts
 824       ``Decimal('123E+1')`` to ``Decimal('1.23E+3')``
 825
 826    .. method:: to_integral([rounding[, context]])
 827
 828       Identical to the :meth:`to_integral_value` method.  The ``to_integral``
 829       name has been kept for compatibility with older versions.
 830
 831    .. method:: to_integral_exact([rounding[, context]])
 832
 833       Round to the nearest integer, signaling :const:`Inexact` or
 834       :const:`Rounded` as appropriate if rounding occurs.  The rounding mode is
 835       determined by the ``rounding`` parameter if given, else by the given
 836       ``context``.  If neither parameter is given then the rounding mode of the
 837       current context is used.
 838
 839       .. versionadded:: 2.6
 840
 841    .. method:: to_integral_value([rounding[, context]])
 842
 843       Round to the nearest integer without signaling :const:`Inexact` or
 844       :const:`Rounded`.  If given, applies *rounding*; otherwise, uses the
 845       rounding method in either the supplied *context* or the current context.
 846
 847       .. versionchanged:: 2.6
 848          renamed from ``to_integral`` to ``to_integral_value``.  The old name
 849          remains valid for compatibility.
 850
 851 .. _logical_operands_label:
 852
 853 Logical operands
 854 ^^^^^^^^^^^^^^^^
 855
 856 The :meth:`logical_and`, :meth:`logical_invert`, :meth:`logical_or`,
 857 and :meth:`logical_xor` methods expect their arguments to be *logical
 858 operands*.  A *logical operand* is a :class:`Decimal` instance whose
 859 exponent and sign are both zero, and whose digits are all either
 860 :const:`0` or :const:`1`.
 861
 862 .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 863
 864
 865 .. _decimal-context:
 866
 867 Context objects
 868 ---------------
 869
 870 Contexts are environments for arithmetic operations.  They govern precision, set
 871 rules for rounding, determine which signals are treated as exceptions, and limit
 872 the range for exponents.
 873
 874 Each thread has its own current context which is accessed or changed using the
 875 :func:`getcontext` and :func:`setcontext` functions:
 876
 877
 878 .. function:: getcontext()
 879
 880    Return the current context for the active thread.
 881
 882
 883 .. function:: setcontext(c)
 884
 885    Set the current context for the active thread to *c*.
 886
 887 Beginning with Python 2.5, you can also use the :keyword:`with` statement and
 888 the :func:`localcontext` function to temporarily change the active context.
 889
 890
 891 .. function:: localcontext([c])
 892
 893    Return a context manager that will set the current context for the active thread
 894    to a copy of *c* on entry to the with-statement and restore the previous context
 895    when exiting the with-statement. If no context is specified, a copy of the
 896    current context is used.
 897
 898    .. versionadded:: 2.5
 899
 900    For example, the following code sets the current decimal precision to 42 places,
 901    performs a calculation, and then automatically restores the previous context::
 902
 903       from decimal import localcontext
 904
 905       with localcontext() as ctx:
 906           ctx.prec = 42   # Perform a high precision calculation
 907           s = calculate_something()
 908       s = +s  # Round the final result back to the default precision
 909
 910 New contexts can also be created using the :class:`Context` constructor
 911 described below. In addition, the module provides three pre-made contexts:
 912
 913
 914 .. class:: BasicContext
 915
 916    This is a standard context defined by the General Decimal Arithmetic
 917    Specification.  Precision is set to nine.  Rounding is set to
 918    :const:`ROUND_HALF_UP`.  All flags are cleared.  All traps are enabled (treated
 919    as exceptions) except :const:`Inexact`, :const:`Rounded`, and
 920    :const:`Subnormal`.
 921
 922    Because many of the traps are enabled, this context is useful for debugging.
 923
 924
 925 .. class:: ExtendedContext
 926
 927    This is a standard context defined by the General Decimal Arithmetic
 928    Specification.  Precision is set to nine.  Rounding is set to
 929    :const:`ROUND_HALF_EVEN`.  All flags are cleared.  No traps are enabled (so that
 930    exceptions are not raised during computations).
 931
 932    Because the traps are disabled, this context is useful for applications that
 933    prefer to have result value of :const:`NaN` or :const:`Infinity` instead of
 934    raising exceptions.  This allows an application to complete a run in the
 935    presence of conditions that would otherwise halt the program.
 936
 937
 938 .. class:: DefaultContext
 939
 940    This context is used by the :class:`Context` constructor as a prototype for new
 941    contexts.  Changing a field (such a precision) has the effect of changing the
 942    default for new contexts creating by the :class:`Context` constructor.
 943
 944    This context is most useful in multi-threaded environments.  Changing one of the
 945    fields before threads are started has the effect of setting system-wide
 946    defaults.  Changing the fields after threads have started is not recommended as
 947    it would require thread synchronization to prevent race conditions.
 948
 949    In single threaded environments, it is preferable to not use this context at
 950    all.  Instead, simply create contexts explicitly as described below.
 951
 952    The default values are precision=28, rounding=ROUND_HALF_EVEN, and enabled traps
 953    for Overflow, InvalidOperation, and DivisionByZero.
 954
 955 In addition to the three supplied contexts, new contexts can be created with the
 956 :class:`Context` constructor.
 957
 958
 959 .. class:: Context(prec=None, rounding=None, traps=None, flags=None, Emin=None, Emax=None, capitals=1)
 960
 961    Creates a new context.  If a field is not specified or is :const:`None`, the
 962    default values are copied from the :const:`DefaultContext`.  If the *flags*
 963    field is not specified or is :const:`None`, all flags are cleared.
 964
 965    The *prec* field is a positive integer that sets the precision for arithmetic
 966    operations in the context.
 967
 968    The *rounding* option is one of:
 969
 970    * :const:`ROUND_CEILING` (towards :const:`Infinity`),
 971    * :const:`ROUND_DOWN` (towards zero),
 972    * :const:`ROUND_FLOOR` (towards :const:`-Infinity`),
 973    * :const:`ROUND_HALF_DOWN` (to nearest with ties going towards zero),
 974    * :const:`ROUND_HALF_EVEN` (to nearest with ties going to nearest even integer),
 975    * :const:`ROUND_HALF_UP` (to nearest with ties going away from zero), or
 976    * :const:`ROUND_UP` (away from zero).
 977    * :const:`ROUND_05UP` (away from zero if last digit after rounding towards zero
 978      would have been 0 or 5; otherwise towards zero)
 979
 980    The *traps* and *flags* fields list any signals to be set. Generally, new
 981    contexts should only set traps and leave the flags clear.
 982
 983    The *Emin* and *Emax* fields are integers specifying the outer limits allowable
 984    for exponents.
 985
 986    The *capitals* field is either :const:`0` or :const:`1` (the default). If set to
 987    :const:`1`, exponents are printed with a capital :const:`E`; otherwise, a
 988    lowercase :const:`e` is used: :const:`Decimal('6.02e+23')`.
 989
 990    .. versionchanged:: 2.6
 991       The :const:`ROUND_05UP` rounding mode was added.
 992
 993    The :class:`Context` class defines several general purpose methods as well as
 994    a large number of methods for doing arithmetic directly in a given context.
 995    In addition, for each of the :class:`Decimal` methods described above (with
 996    the exception of the :meth:`adjusted` and :meth:`as_tuple` methods) there is
 997    a corresponding :class:`Context` method.  For example, ``C.exp(x)`` is
 998    equivalent to ``x.exp(context=C)``.
 999
1000
1001    .. method:: clear_flags()
1002
1003       Resets all of the flags to :const:`0`.
1004
1005    .. method:: copy()
1006
1007       Return a duplicate of the context.
1008
1009    .. method:: copy_decimal(num)
1010
1011       Return a copy of the Decimal instance num.
1012
1013    .. method:: create_decimal(num)
1014
1015       Creates a new Decimal instance from *num* but using *self* as
1016       context. Unlike the :class:`Decimal` constructor, the context precision,
1017       rounding method, flags, and traps are applied to the conversion.
1018
1019       This is useful because constants are often given to a greater precision
1020       than is needed by the application.  Another benefit is that rounding
1021       immediately eliminates unintended effects from digits beyond the current
1022       precision. In the following example, using unrounded inputs means that
1023       adding zero to a sum can change the result:
1024
1025       .. doctest:: newcontext
1026
1027          >>> getcontext().prec = 3
1028          >>> Decimal('3.4445') + Decimal('1.0023')
1029          Decimal('4.45')
1030          >>> Decimal('3.4445') + Decimal(0) + Decimal('1.0023')
1031          Decimal('4.44')
1032
1033       This method implements the to-number operation of the IBM specification.
1034       If the argument is a string, no leading or trailing whitespace is
1035       permitted.
1036
1037    .. method:: create_decimal_from_float(f)
1038
1039       Creates a new Decimal instance from a float *f* but rounding using *self*
1040       as the context.  Unlike the :meth:`Decimal.from_float` class method,
1041       the context precision, rounding method, flags, and traps are applied to
1042       the conversion.
1043
1044       .. doctest::
1045
1046          >>> context = Context(prec=5, rounding=ROUND_DOWN)
1047          >>> context.create_decimal_from_float(math.pi)
1048          Decimal('3.1415')
1049          >>> context = Context(prec=5, traps=[Inexact])
1050          >>> context.create_decimal_from_float(math.pi)
1051          Traceback (most recent call last):
1052              ...
1053          Inexact: None
1054
1055       .. versionadded:: 2.7
1056
1057    .. method:: Etiny()
1058
1059       Returns a value equal to ``Emin - prec + 1`` which is the minimum exponent
1060       value for subnormal results.  When underflow occurs, the exponent is set
1061       to :const:`Etiny`.
1062
1063
1064    .. method:: Etop()
1065
1066       Returns a value equal to ``Emax - prec + 1``.
1067
1068    The usual approach to working with decimals is to create :class:`Decimal`
1069    instances and then apply arithmetic operations which take place within the
1070    current context for the active thread.  An alternative approach is to use
1071    context methods for calculating within a specific context.  The methods are
1072    similar to those for the :class:`Decimal` class and are only briefly
1073    recounted here.
1074
1075
1076    .. method:: abs(x)
1077
1078       Returns the absolute value of *x*.
1079
1080
1081    .. method:: add(x, y)
1082
1083       Return the sum of *x* and *y*.
1084
1085
1086    .. method:: canonical(x)
1087
1088       Returns the same Decimal object *x*.
1089
1090
1091    .. method:: compare(x, y)
1092
1093       Compares *x* and *y* numerically.
1094
1095
1096    .. method:: compare_signal(x, y)
1097
1098       Compares the values of the two operands numerically.
1099
1100
1101    .. method:: compare_total(x, y)
1102
1103       Compares two operands using their abstract representation.
1104
1105
1106    .. method:: compare_total_mag(x, y)
1107
1108       Compares two operands using their abstract representation, ignoring sign.
1109
1110
1111    .. method:: copy_abs(x)
1112
1113       Returns a copy of *x* with the sign set to 0.
1114
1115
1116    .. method:: copy_negate(x)
1117
1118       Returns a copy of *x* with the sign inverted.
1119
1120
1121    .. method:: copy_sign(x, y)
1122
1123       Copies the sign from *y* to *x*.
1124
1125
1126    .. method:: divide(x, y)
1127
1128       Return *x* divided by *y*.
1129
1130
1131    .. method:: divide_int(x, y)
1132
1133       Return *x* divided by *y*, truncated to an integer.
1134
1135
1136    .. method:: divmod(x, y)
1137
1138       Divides two numbers and returns the integer part of the result.
1139
1140
1141    .. method:: exp(x)
1142
1143       Returns `e ** x`.
1144
1145
1146    .. method:: fma(x, y, z)
1147
1148       Returns *x* multiplied by *y*, plus *z*.
1149
1150
1151    .. method:: is_canonical(x)
1152
1153       Returns True if *x* is canonical; otherwise returns False.
1154
1155
1156    .. method:: is_finite(x)
1157
1158       Returns True if *x* is finite; otherwise returns False.
1159
1160
1161    .. method:: is_infinite(x)
1162
1163       Returns True if *x* is infinite; otherwise returns False.
1164
1165
1166    .. method:: is_nan(x)
1167
1168       Returns True if *x* is a qNaN or sNaN; otherwise returns False.
1169
1170
1171    .. method:: is_normal(x)
1172
1173       Returns True if *x* is a normal number; otherwise returns False.
1174
1175
1176    .. method:: is_qnan(x)
1177
1178       Returns True if *x* is a quiet NaN; otherwise returns False.
1179
1180
1181    .. method:: is_signed(x)
1182
1183       Returns True if *x* is negative; otherwise returns False.
1184
1185
1186    .. method:: is_snan(x)
1187
1188       Returns True if *x* is a signaling NaN; otherwise returns False.
1189
1190
1191    .. method:: is_subnormal(x)
1192
1193       Returns True if *x* is subnormal; otherwise returns False.
1194
1195
1196    .. method:: is_zero(x)
1197
1198       Returns True if *x* is a zero; otherwise returns False.
1199
1200
1201    .. method:: ln(x)
1202
1203       Returns the natural (base e) logarithm of *x*.
1204
1205
1206    .. method:: log10(x)
1207
1208       Returns the base 10 logarithm of *x*.
1209
1210
1211    .. method:: logb(x)
1212
1213        Returns the exponent of the magnitude of the operand's MSD.
1214
1215
1216    .. method:: logical_and(x, y)
1217
1218       Applies the logical operation *and* between each operand's digits.
1219
1220
1221    .. method:: logical_invert(x)
1222
1223       Invert all the digits in *x*.
1224
1225
1226    .. method:: logical_or(x, y)
1227
1228       Applies the logical operation *or* between each operand's digits.
1229
1230
1231    .. method:: logical_xor(x, y)
1232
1233       Applies the logical operation *xor* between each operand's digits.
1234
1235
1236    .. method:: max(x, y)
1237
1238       Compares two values numerically and returns the maximum.
1239
1240
1241    .. method:: max_mag(x, y)
1242
1243       Compares the values numerically with their sign ignored.
1244
1245
1246    .. method:: min(x, y)
1247
1248       Compares two values numerically and returns the minimum.
1249
1250
1251    .. method:: min_mag(x, y)
1252
1253       Compares the values numerically with their sign ignored.
1254
1255
1256    .. method:: minus(x)
1257
1258       Minus corresponds to the unary prefix minus operator in Python.
1259
1260
1261    .. method:: multiply(x, y)
1262
1263       Return the product of *x* and *y*.
1264
1265
1266    .. method:: next_minus(x)
1267
1268       Returns the largest representable number smaller than *x*.
1269
1270
1271    .. method:: next_plus(x)
1272
1273       Returns the smallest representable number larger than *x*.
1274
1275
1276    .. method:: next_toward(x, y)
1277
1278       Returns the number closest to *x*, in direction towards *y*.
1279
1280
1281    .. method:: normalize(x)
1282
1283       Reduces *x* to its simplest form.
1284
1285
1286    .. method:: number_class(x)
1287
1288       Returns an indication of the class of *x*.
1289
1290
1291    .. method:: plus(x)
1292
1293       Plus corresponds to the unary prefix plus operator in Python.  This
1294       operation applies the context precision and rounding, so it is *not* an
1295       identity operation.
1296
1297
1298    .. method:: power(x, y[, modulo])
1299
1300       Return ``x`` to the power of ``y``, reduced modulo ``modulo`` if given.
1301
1302       With two arguments, compute ``x**y``.  If ``x`` is negative then ``y``
1303       must be integral.  The result will be inexact unless ``y`` is integral and
1304       the result is finite and can be expressed exactly in 'precision' digits.
1305       The result should always be correctly rounded, using the rounding mode of
1306       the current thread's context.
1307
1308       With three arguments, compute ``(x**y) % modulo``.  For the three argument
1309       form, the following restrictions on the arguments hold:
1310
1311          - all three arguments must be integral
1312          - ``y`` must be nonnegative
1313          - at least one of ``x`` or ``y`` must be nonzero
1314          - ``modulo`` must be nonzero and have at most 'precision' digits
1315
1316       The result of ``Context.power(x, y, modulo)`` is identical to the result
1317       that would be obtained by computing ``(x**y) % modulo`` with unbounded
1318       precision, but is computed more efficiently.  It is always exact.
1319
1320       .. versionchanged:: 2.6
1321          ``y`` may now be nonintegral in ``x**y``.
1322          Stricter requirements for the three-argument version.
1323
1324
1325    .. method:: quantize(x, y)
1326
1327       Returns a value equal to *x* (rounded), having the exponent of *y*.
1328
1329
1330    .. method:: radix()
1331
1332       Just returns 10, as this is Decimal, :)
1333
1334
1335    .. method:: remainder(x, y)
1336
1337       Returns the remainder from integer division.
1338
1339       The sign of the result, if non-zero, is the same as that of the original
1340       dividend.
1341
1342    .. method:: remainder_near(x, y)
1343
1344       Returns ``x - y * n``, where *n* is the integer nearest the exact value
1345       of ``x / y`` (if the result is 0 then its sign will be the sign of *x*).
1346
1347
1348    .. method:: rotate(x, y)
1349
1350       Returns a rotated copy of *x*, *y* times.
1351
1352
1353    .. method:: same_quantum(x, y)
1354
1355       Returns True if the two operands have the same exponent.
1356
1357
1358    .. method:: scaleb (x, y)
1359
1360       Returns the first operand after adding the second value its exp.
1361
1362
1363    .. method:: shift(x, y)
1364
1365       Returns a shifted copy of *x*, *y* times.
1366
1367
1368    .. method:: sqrt(x)
1369
1370       Square root of a non-negative number to context precision.
1371
1372
1373    .. method:: subtract(x, y)
1374
1375       Return the difference between *x* and *y*.
1376
1377
1378    .. method:: to_eng_string(x)
1379
1380       Converts a number to a string, using scientific notation.
1381
1382
1383    .. method:: to_integral_exact(x)
1384
1385       Rounds to an integer.
1386
1387
1388    .. method:: to_sci_string(x)
1389
1390       Converts a number to a string using scientific notation.
1391
1392 .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1393
1394
1395 .. _decimal-signals:
1396
1397 Signals
1398 -------
1399
1400 Signals represent conditions that arise during computation. Each corresponds to
1401 one context flag and one context trap enabler.
1402
1403 The context flag is set whenever the condition is encountered. After the
1404 computation, flags may be checked for informational purposes (for instance, to
1405 determine whether a computation was exact). After checking the flags, be sure to
1406 clear all flags before starting the next computation.
1407
1408 If the context's trap enabler is set for the signal, then the condition causes a
1409 Python exception to be raised.  For example, if the :class:`DivisionByZero` trap
1410 is set, then a :exc:`DivisionByZero` exception is raised upon encountering the
1411 condition.
1412
1413
1414 .. class:: Clamped
1415
1416    Altered an exponent to fit representation constraints.
1417
1418    Typically, clamping occurs when an exponent falls outside the context's
1419    :attr:`Emin` and :attr:`Emax` limits.  If possible, the exponent is reduced to
1420    fit by adding zeros to the coefficient.
1421
1422
1423 .. class:: DecimalException
1424
1425    Base class for other signals and a subclass of :exc:`ArithmeticError`.
1426
1427
1428 .. class:: DivisionByZero
1429
1430    Signals the division of a non-infinite number by zero.
1431
1432    Can occur with division, modulo division, or when raising a number to a negative
1433    power.  If this signal is not trapped, returns :const:`Infinity` or
1434    :const:`-Infinity` with the sign determined by the inputs to the calculation.
1435
1436
1437 .. class:: Inexact
1438
1439    Indicates that rounding occurred and the result is not exact.
1440
1441    Signals when non-zero digits were discarded during rounding. The rounded result
1442    is returned.  The signal flag or trap is used to detect when results are
1443    inexact.
1444
1445
1446 .. class:: InvalidOperation
1447
1448    An invalid operation was performed.
1449
1450    Indicates that an operation was requested that does not make sense. If not
1451    trapped, returns :const:`NaN`.  Possible causes include::
1452
1453       Infinity - Infinity
1454       0 * Infinity
1455       Infinity / Infinity
1456       x % 0
1457       Infinity % x
1458       x._rescale( non-integer )
1459       sqrt(-x) and x > 0
1460       0 ** 0
1461       x ** (non-integer)
1462       x ** Infinity
1463
1464
1465 .. class:: Overflow
1466
1467    Numerical overflow.
1468
1469    Indicates the exponent is larger than :attr:`Emax` after rounding has
1470    occurred.  If not trapped, the result depends on the rounding mode, either
1471    pulling inward to the largest representable finite number or rounding outward
1472    to :const:`Infinity`.  In either case, :class:`Inexact` and :class:`Rounded`
1473    are also signaled.
1474
1475
1476 .. class:: Rounded
1477
1478    Rounding occurred though possibly no information was lost.
1479
1480    Signaled whenever rounding discards digits; even if those digits are zero
1481    (such as rounding :const:`5.00` to :const:`5.0`).  If not trapped, returns
1482    the result unchanged.  This signal is used to detect loss of significant
1483    digits.
1484
1485
1486 .. class:: Subnormal
1487
1488    Exponent was lower than :attr:`Emin` prior to rounding.
1489
1490    Occurs when an operation result is subnormal (the exponent is too small). If
1491    not trapped, returns the result unchanged.
1492
1493
1494 .. class:: Underflow
1495
1496    Numerical underflow with result rounded to zero.
1497
1498    Occurs when a subnormal result is pushed to zero by rounding. :class:`Inexact`
1499    and :class:`Subnormal` are also signaled.
1500
1501 The following table summarizes the hierarchy of signals::
1502
1503    exceptions.ArithmeticError(exceptions.StandardError)
1504        DecimalException
1505            Clamped
1506            DivisionByZero(DecimalException, exceptions.ZeroDivisionError)
1507            Inexact
1508                Overflow(Inexact, Rounded)
1509                Underflow(Inexact, Rounded, Subnormal)
1510            InvalidOperation
1511            Rounded
1512            Subnormal
1513
1514 .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1515
1516
1517 .. _decimal-notes:
1518
1519 Floating Point Notes
1520 --------------------
1521
1522
1523 Mitigating round-off error with increased precision
1524 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1525
1526 The use of decimal floating point eliminates decimal representation error
1527 (making it possible to represent :const:`0.1` exactly); however, some operations
1528 can still incur round-off error when non-zero digits exceed the fixed precision.
1529
1530 The effects of round-off error can be amplified by the addition or subtraction
1531 of nearly offsetting quantities resulting in loss of significance.  Knuth
1532 provides two instructive examples where rounded floating point arithmetic with
1533 insufficient precision causes the breakdown of the associative and distributive
1534 properties of addition:
1535
1536 .. doctest:: newcontext
1537
1538    # Examples from Seminumerical Algorithms, Section 4.2.2.
1539    >>> from decimal import Decimal, getcontext
1540    >>> getcontext().prec = 8
1541
1542    >>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
1543    >>> (u + v) + w
1544    Decimal('9.5111111')
1545    >>> u + (v + w)
1546    Decimal('10')
1547
1548    >>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
1549    >>> (u*v) + (u*w)
1550    Decimal('0.01')
1551    >>> u * (v+w)
1552    Decimal('0.0060000')
1553
1554 The :mod:`decimal` module makes it possible to restore the identities by
1555 expanding the precision sufficiently to avoid loss of significance:
1556
1557 .. doctest:: newcontext
1558
1559    >>> getcontext().prec = 20
1560    >>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
1561    >>> (u + v) + w
1562    Decimal('9.51111111')
1563    >>> u + (v + w)
1564    Decimal('9.51111111')
1565    >>>
1566    >>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
1567    >>> (u*v) + (u*w)
1568    Decimal('0.0060000')
1569    >>> u * (v+w)
1570    Decimal('0.0060000')
1571
1572
1573 Special values
1574 ^^^^^^^^^^^^^^
1575
1576 The number system for the :mod:`decimal` module provides special values
1577 including :const:`NaN`, :const:`sNaN`, :const:`-Infinity`, :const:`Infinity`,
1578 and two zeros, :const:`+0` and :const:`-0`.
1579
1580 Infinities can be constructed directly with:  ``Decimal('Infinity')``. Also,
1581 they can arise from dividing by zero when the :exc:`DivisionByZero` signal is
1582 not trapped.  Likewise, when the :exc:`Overflow` signal is not trapped, infinity
1583 can result from rounding beyond the limits of the largest representable number.
1584
1585 The infinities are signed (affine) and can be used in arithmetic operations
1586 where they get treated as very large, indeterminate numbers.  For instance,
1587 adding a constant to infinity gives another infinite result.
1588
1589 Some operations are indeterminate and return :const:`NaN`, or if the
1590 :exc:`InvalidOperation` signal is trapped, raise an exception.  For example,
1591 ``0/0`` returns :const:`NaN` which means "not a number".  This variety of
1592 :const:`NaN` is quiet and, once created, will flow through other computations
1593 always resulting in another :const:`NaN`.  This behavior can be useful for a
1594 series of computations that occasionally have missing inputs --- it allows the
1595 calculation to proceed while flagging specific results as invalid.
1596
1597 A variant is :const:`sNaN` which signals rather than remaining quiet after every
1598 operation.  This is a useful return value when an invalid result needs to
1599 interrupt a calculation for special handling.
1600
1601 The behavior of Python's comparison operators can be a little surprising where a
1602 :const:`NaN` is involved.  A test for equality where one of the operands is a
1603 quiet or signaling :const:`NaN` always returns :const:`False` (even when doing
1604 ``Decimal('NaN')==Decimal('NaN')``), while a test for inequality always returns
1605 :const:`True`.  An attempt to compare two Decimals using any of the ``<``,
1606 ``<=``, ``>`` or ``>=`` operators will raise the :exc:`InvalidOperation` signal
1607 if either operand is a :const:`NaN`, and return :const:`False` if this signal is
1608 not trapped.  Note that the General Decimal Arithmetic specification does not
1609 specify the behavior of direct comparisons; these rules for comparisons
1610 involving a :const:`NaN` were taken from the IEEE 854 standard (see Table 3 in
1611 section 5.7).  To ensure strict standards-compliance, use the :meth:`compare`
1612 and :meth:`compare-signal` methods instead.
1613
1614 The signed zeros can result from calculations that underflow. They keep the sign
1615 that would have resulted if the calculation had been carried out to greater
1616 precision.  Since their magnitude is zero, both positive and negative zeros are
1617 treated as equal and their sign is informational.
1618
1619 In addition to the two signed zeros which are distinct yet equal, there are
1620 various representations of zero with differing precisions yet equivalent in
1621 value.  This takes a bit of getting used to.  For an eye accustomed to
1622 normalized floating point representations, it is not immediately obvious that
1623 the following calculation returns a value equal to zero:
1624
1625    >>> 1 / Decimal('Infinity')
1626    Decimal('0E-1000000026')
1627
1628 .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1629
1630
1631 .. _decimal-threads:
1632
1633 Working with threads
1634 --------------------
1635
1636 The :func:`getcontext` function accesses a different :class:`Context` object for
1637 each thread.  Having separate thread contexts means that threads may make
1638 changes (such as ``getcontext.prec=10``) without interfering with other threads.
1639
1640 Likewise, the :func:`setcontext` function automatically assigns its target to
1641 the current thread.
1642
1643 If :func:`setcontext` has not been called before :func:`getcontext`, then
1644 :func:`getcontext` will automatically create a new context for use in the
1645 current thread.
1646
1647 The new context is copied from a prototype context called *DefaultContext*. To
1648 control the defaults so that each thread will use the same values throughout the
1649 application, directly modify the *DefaultContext* object. This should be done
1650 *before* any threads are started so that there won't be a race condition between
1651 threads calling :func:`getcontext`. For example::
1652
1653    # Set applicationwide defaults for all threads about to be launched
1654    DefaultContext.prec = 12
1655    DefaultContext.rounding = ROUND_DOWN
1656    DefaultContext.traps = ExtendedContext.traps.copy()
1657    DefaultContext.traps[InvalidOperation] = 1
1658    setcontext(DefaultContext)
1659
1660    # Afterwards, the threads can be started
1661    t1.start()
1662    t2.start()
1663    t3.start()
1664     . . .
1665
1666 .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1667
1668
1669 .. _decimal-recipes:
1670
1671 Recipes
1672 -------
1673
1674 Here are a few recipes that serve as utility functions and that demonstrate ways
1675 to work with the :class:`Decimal` class::
1676
1677    def moneyfmt(value, places=2, curr='', sep=',', dp='.',
1678                 pos='', neg='-', trailneg=''):
1679        """Convert Decimal to a money formatted string.
1680
1681        places:  required number of places after the decimal point
1682        curr:    optional currency symbol before the sign (may be blank)
1683        sep:     optional grouping separator (comma, period, space, or blank)
1684        dp:      decimal point indicator (comma or period)
1685                 only specify as blank when places is zero
1686        pos:     optional sign for positive numbers: '+', space or blank
1687        neg:     optional sign for negative numbers: '-', '(', space or blank
1688        trailneg:optional trailing minus indicator:  '-', ')', space or blank
1689
1690        >>> d = Decimal('-1234567.8901')
1691        >>> moneyfmt(d, curr='$')
1692        '-$1,234,567.89'
1693        >>> moneyfmt(d, places=0, sep='.', dp='', neg='', trailneg='-')
1694        '1.234.568-'
1695        >>> moneyfmt(d, curr='$', neg='(', trailneg=')')
1696        '($1,234,567.89)'
1697        >>> moneyfmt(Decimal(123456789), sep=' ')
1698        '123 456 789.00'
1699        >>> moneyfmt(Decimal('-0.02'), neg='<', trailneg='>')
1700        '<0.02>'
1701
1702        """
1703        q = Decimal(10) ** -places      # 2 places --> '0.01'
1704        sign, digits, exp = value.quantize(q).as_tuple()
1705        result = []
1706        digits = map(str, digits)
1707        build, next = result.append, digits.pop
1708        if sign:
1709            build(trailneg)
1710        for i in range(places):
1711            build(next() if digits else '0')
1712        build(dp)
1713        if not digits:
1714            build('0')
1715        i = 0
1716        while digits:
1717            build(next())
1718            i += 1
1719            if i == 3 and digits:
1720                i = 0
1721                build(sep)
1722        build(curr)
1723        build(neg if sign else pos)
1724        return ''.join(reversed(result))
1725
1726    def pi():
1727        """Compute Pi to the current precision.
1728
1729        >>> print pi()
1730        3.141592653589793238462643383
1731
1732        """
1733        getcontext().prec += 2  # extra digits for intermediate steps
1734        three = Decimal(3)      # substitute "three=3.0" for regular floats
1735        lasts, t, s, n, na, d, da = 0, three, 3, 1, 0, 0, 24
1736        while s != lasts:
1737            lasts = s
1738            n, na = n+na, na+8
1739            d, da = d+da, da+32
1740            t = (t * n) / d
1741            s += t
1742        getcontext().prec -= 2
1743        return +s               # unary plus applies the new precision
1744
1745    def exp(x):
1746        """Return e raised to the power of x.  Result type matches input type.
1747
1748        >>> print exp(Decimal(1))
1749        2.718281828459045235360287471
1750        >>> print exp(Decimal(2))
1751        7.389056098930650227230427461
1752        >>> print exp(2.0)
1753        7.38905609893
1754        >>> print exp(2+0j)
1755        (7.38905609893+0j)
1756
1757        """
1758        getcontext().prec += 2
1759        i, lasts, s, fact, num = 0, 0, 1, 1, 1
1760        while s != lasts:
1761            lasts = s
1762            i += 1
1763            fact *= i
1764            num *= x
1765            s += num / fact
1766        getcontext().prec -= 2
1767        return +s
1768
1769    def cos(x):
1770        """Return the cosine of x as measured in radians.
1771
1772        >>> print cos(Decimal('0.5'))
1773        0.8775825618903727161162815826
1774        >>> print cos(0.5)
1775        0.87758256189
1776        >>> print cos(0.5+0j)
1777        (0.87758256189+0j)
1778
1779        """
1780        getcontext().prec += 2
1781        i, lasts, s, fact, num, sign = 0, 0, 1, 1, 1, 1
1782        while s != lasts:
1783            lasts = s
1784            i += 2
1785            fact *= i * (i-1)
1786            num *= x * x
1787            sign *= -1
1788            s += num / fact * sign
1789        getcontext().prec -= 2
1790        return +s
1791
1792    def sin(x):
1793        """Return the sine of x as measured in radians.
1794
1795        >>> print sin(Decimal('0.5'))
1796        0.4794255386042030002732879352
1797        >>> print sin(0.5)
1798        0.479425538604
1799        >>> print sin(0.5+0j)
1800        (0.479425538604+0j)
1801
1802        """
1803        getcontext().prec += 2
1804        i, lasts, s, fact, num, sign = 1, 0, x, 1, x, 1
1805        while s != lasts:
1806            lasts = s
1807            i += 2
1808            fact *= i * (i-1)
1809            num *= x * x
1810            sign *= -1
1811            s += num / fact * sign
1812        getcontext().prec -= 2
1813        return +s
1814
1815
1816 .. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1817
1818
1819 .. _decimal-faq:
1820
1821 Decimal FAQ
1822 -----------
1823
1824 Q. It is cumbersome to type ``decimal.Decimal('1234.5')``.  Is there a way to
1825 minimize typing when using the interactive interpreter?
1826
1827 A. Some users abbreviate the constructor to just a single letter:
1828
1829    >>> D = decimal.Decimal
1830    >>> D('1.23') + D('3.45')
1831    Decimal('4.68')
1832
1833 Q. In a fixed-point application with two decimal places, some inputs have many
1834 places and need to be rounded.  Others are not supposed to have excess digits
1835 and need to be validated.  What methods should be used?
1836
1837 A. The :meth:`quantize` method rounds to a fixed number of decimal places. If
1838 the :const:`Inexact` trap is set, it is also useful for validation:
1839
1840    >>> TWOPLACES = Decimal(10) ** -2       # same as Decimal('0.01')
1841
1842    >>> # Round to two places
1843    >>> Decimal('3.214').quantize(TWOPLACES)
1844    Decimal('3.21')
1845
1846    >>> # Validate that a number does not exceed two places
1847    >>> Decimal('3.21').quantize(TWOPLACES, context=Context(traps=[Inexact]))
1848    Decimal('3.21')
1849
1850    >>> Decimal('3.214').quantize(TWOPLACES, context=Context(traps=[Inexact]))
1851    Traceback (most recent call last):
1852       ...
1853    Inexact: None
1854
1855 Q. Once I have valid two place inputs, how do I maintain that invariant
1856 throughout an application?
1857
1858 A. Some operations like addition, subtraction, and multiplication by an integer
1859 will automatically preserve fixed point.  Others operations, like division and
1860 non-integer multiplication, will change the number of decimal places and need to
1861 be followed-up with a :meth:`quantize` step:
1862
1863     >>> a = Decimal('102.72')           # Initial fixed-point values
1864     >>> b = Decimal('3.17')
1865     >>> a + b                           # Addition preserves fixed-point
1866     Decimal('105.89')
1867     >>> a - b
1868     Decimal('99.55')
1869     >>> a * 42                          # So does integer multiplication
1870     Decimal('4314.24')
1871     >>> (a * b).quantize(TWOPLACES)     # Must quantize non-integer multiplication
1872     Decimal('325.62')
1873     >>> (b / a).quantize(TWOPLACES)     # And quantize division
1874     Decimal('0.03')
1875
1876 In developing fixed-point applications, it is convenient to define functions
1877 to handle the :meth:`quantize` step:
1878
1879     >>> def mul(x, y, fp=TWOPLACES):
1880     ...     return (x * y).quantize(fp)
1881     >>> def div(x, y, fp=TWOPLACES):
1882     ...     return (x / y).quantize(fp)
1883
1884     >>> mul(a, b)                       # Automatically preserve fixed-point
1885     Decimal('325.62')
1886     >>> div(b, a)
1887     Decimal('0.03')
1888
1889 Q. There are many ways to express the same value.  The numbers :const:`200`,
1890 :const:`200.000`, :const:`2E2`, and :const:`.02E+4` all have the same value at
1891 various precisions. Is there a way to transform them to a single recognizable
1892 canonical value?
1893
1894 A. The :meth:`normalize` method maps all equivalent values to a single
1895 representative:
1896
1897    >>> values = map(Decimal, '200 200.000 2E2 .02E+4'.split())
1898    >>> [v.normalize() for v in values]
1899    [Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2')]
1900
1901 Q. Some decimal values always print with exponential notation.  Is there a way
1902 to get a non-exponential representation?
1903
1904 A. For some values, exponential notation is the only way to express the number
1905 of significant places in the coefficient.  For example, expressing
1906 :const:`5.0E+3` as :const:`5000` keeps the value constant but cannot show the
1907 original's two-place significance.
1908
1909 If an application does not care about tracking significance, it is easy to
1910 remove the exponent and trailing zeros, losing significance, but keeping the
1911 value unchanged::
1912
1913     def remove_exponent(d):
1914         '''Remove exponent and trailing zeros.
1915
1916         >>> remove_exponent(Decimal('5E+3'))
1917         Decimal('5000')
1918
1919         '''
1920         return d.quantize(Decimal(1)) if d == d.to_integral() else d.normalize()
1921
1922 Q. Is there a way to convert a regular float to a Decimal?
1923
1924 A. Yes, the classmethod :meth:`from_float` makes an exact conversion.
1925
1926 The regular decimal constructor does not do this by default because there is
1927 some question about whether it is advisable to mix binary and decimal floating
1928 point. Also, its use requires some care to avoid the representation issues
1929 associated with binary floating point:
1930
1931    >>> Decimal.from_float(1.1)
1932    Decimal('1.100000000000000088817841970012523233890533447265625')
1933
1934 Q. Within a complex calculation, how can I make sure that I haven't gotten a
1935 spurious result because of insufficient precision or rounding anomalies.
1936
1937 A. The decimal module makes it easy to test results.  A best practice is to
1938 re-run calculations using greater precision and with various rounding modes.
1939 Widely differing results indicate insufficient precision, rounding mode issues,
1940 ill-conditioned inputs, or a numerically unstable algorithm.
1941
1942 Q. I noticed that context precision is applied to the results of operations but
1943 not to the inputs.  Is there anything to watch out for when mixing values of
1944 different precisions?
1945
1946 A. Yes.  The principle is that all values are considered to be exact and so is
1947 the arithmetic on those values.  Only the results are rounded.  The advantage
1948 for inputs is that "what you type is what you get".  A disadvantage is that the
1949 results can look odd if you forget that the inputs haven't been rounded:
1950
1951 .. doctest:: newcontext
1952
1953    >>> getcontext().prec = 3
1954    >>> Decimal('3.104') + Decimal('2.104')
1955    Decimal('5.21')
1956    >>> Decimal('3.104') + Decimal('0.000') + Decimal('2.104')
1957    Decimal('5.20')
1958
1959 The solution is either to increase precision or to force rounding of inputs
1960 using the unary plus operation:
1961
1962 .. doctest:: newcontext
1963
1964    >>> getcontext().prec = 3
1965    >>> +Decimal('1.23456789')      # unary plus triggers rounding
1966    Decimal('1.23')
1967
1968 Alternatively, inputs can be rounded upon creation using the
1969 :meth:`Context.create_decimal` method:
1970
1971    >>> Context(prec=5, rounding=ROUND_DOWN).create_decimal('1.2345678')
1972    Decimal('1.2345')
1973