decimal — 十进制定点数和浮点数运算

源代码: Lib/decimal.py


decimal 模块为快速、准确舍入的十进制浮点运算提供支持。与 float 数据类型相比,它具有一些优势。

  • “十进制基于一种专为人类设计的浮点模型,并且必然有一个最重要的指导原则——计算机必须提供一种与人们在学校学习的算术相同的方式工作的算术。”——摘自十进制算术规范。

  • 十进制数可以精确表示。相反,像 1.12.2 这样的数字在二进制浮点数中没有精确的表示。最终用户通常不会期望 1.1 + 2.2 显示为 3.3000000000000003,就像使用二进制浮点数时那样。

  • 这种精确性延续到了算术运算中。在十进制浮点数中,0.1 + 0.1 + 0.1 - 0.3 恰好等于零。在二进制浮点数中,结果是 5.5511151231257827e-017。虽然接近于零,但这些差异会阻止可靠的相等性测试,并且差异会累积。因此,在具有严格相等性不变式的会计应用程序中,十进制是首选。

  • decimal 模块包含有效数字的概念,因此 1.30 + 1.20 等于 2.50。保留尾随零以表示有效性。这是货币应用程序的惯用表示方法。对于乘法,“教科书”方法使用被乘数中的所有数字。例如,1.3 * 1.2 得出 1.56,而 1.30 * 1.20 得出 1.5600

  • 与基于硬件的二进制浮点数不同,decimal 模块具有用户可更改的精度(默认为 28 位),可以根据给定问题的需要设置任意大。

    >>> from decimal import *
    >>> getcontext().prec = 6
    >>> Decimal(1) / Decimal(7)
    Decimal('0.142857')
    >>> getcontext().prec = 28
    >>> Decimal(1) / Decimal(7)
    Decimal('0.1428571428571428571428571429')
    
  • 二进制和十进制浮点数都是根据已发布的标准实现的。虽然内置的 float 类型只公开了其功能的一小部分,但 decimal 模块公开了标准的所有必要部分。在需要时,程序员可以完全控制舍入和信号处理。这包括通过使用异常来阻止任何不精确操作来强制执行精确算术的选项。

  • decimal 模块的设计旨在“不偏不倚地支持精确的未舍入十进制算术(有时称为定点算术)和舍入的浮点算术。”——摘自十进制算术规范。

模块设计围绕三个概念展开:十进制数、算术上下文和信号。

十进制数是不可变的。它有一个符号、系数数字和一个指数。为了保持有效性,系数数字不会截断尾随零。十进制数还包括特殊值,例如表示“非数字”的 NaN、正负 Infinity 以及 -0。该标准还区分了 -0+0

算术上下文是一个环境,用于指定精度、舍入规则、指数限制、指示运算结果的标志以及确定是否将信号视为异常的陷阱启用器。舍入选项包括 ROUND_CEILINGROUND_DOWNROUND_FLOORROUND_HALF_DOWNROUND_HALF_EVENROUND_HALF_UPROUND_UPROUND_05UP

信号是在计算过程中出现的一组异常情况。根据应用程序的需要,信号可以被忽略、视为信息性信号或被视为异常。decimal 模块中的信号有:ClampedInvalidOperationDivisionByZeroInexactRoundedSubnormalOverflowUnderflowFloatOperation

对于每个信号,都有一个标志和一个陷阱启用器。当遇到信号时,其标志被设置为 1,然后,如果陷阱启用器被设置为 1,则会引发异常。标志是粘性的,因此用户需要在监视计算之前重置它们。

另请参阅

快速入门教程

使用 decimal 的通常步骤是导入模块,使用 getcontext() 查看当前上下文,并在必要时为精度、舍入或启用的陷阱设置新值。

>>> from decimal import *
>>> getcontext()
Context(prec=28, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[], traps=[Overflow, DivisionByZero,
        InvalidOperation])

>>> getcontext().prec = 7       # Set a new precision

Decimal 实例可以从整数、字符串、浮点数或元组构造。从整数或浮点数构造将执行该整数或浮点数的值的精确转换。十进制数包括特殊值,例如表示“非数字”的 NaN、正负 Infinity 以及 -0

>>> getcontext().prec = 28
>>> Decimal(10)
Decimal('10')
>>> Decimal('3.14')
Decimal('3.14')
>>> Decimal(3.14)
Decimal('3.140000000000000124344978758017532527446746826171875')
>>> Decimal((0, (3, 1, 4), -2))
Decimal('3.14')
>>> Decimal(str(2.0 ** 0.5))
Decimal('1.4142135623730951')
>>> Decimal(2) ** Decimal('0.5')
Decimal('1.414213562373095048801688724')
>>> Decimal('NaN')
Decimal('NaN')
>>> Decimal('-Infinity')
Decimal('-Infinity')

如果 FloatOperation 信号被捕获,则在构造函数或排序比较中意外混合使用 decimal 和 float 会引发异常。

>>> c = getcontext()
>>> c.traps[FloatOperation] = True
>>> Decimal(3.14)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
>>> Decimal('3.5') < 3.7
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
>>> Decimal('3.5') == 3.5
True

3.3 版新增。

新 Decimal 的有效性仅由输入的数字位数决定。上下文精度和舍入仅在算术运算期间起作用。

>>> getcontext().prec = 6
>>> Decimal('3.0')
Decimal('3.0')
>>> Decimal('3.1415926535')
Decimal('3.1415926535')
>>> Decimal('3.1415926535') + Decimal('2.7182818285')
Decimal('5.85987')
>>> getcontext().rounding = ROUND_UP
>>> Decimal('3.1415926535') + Decimal('2.7182818285')
Decimal('5.85988')

如果超过了 C 版本的内部限制,则构造 decimal 会引发 InvalidOperation

>>> Decimal("1e9999999999999999999")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.InvalidOperation: [<class 'decimal.InvalidOperation'>]

3.3 版更变。

Decimal 对象可以与 Python 中的大多数其他类型很好地交互。 这里有一个关于十进制浮点数的小例子:

>>> data = list(map(Decimal, '1.34 1.87 3.45 2.35 1.00 0.03 9.25'.split()))
>>> max(data)
Decimal('9.25')
>>> min(data)
Decimal('0.03')
>>> sorted(data)
[Decimal('0.03'), Decimal('1.00'), Decimal('1.34'), Decimal('1.87'),
 Decimal('2.35'), Decimal('3.45'), Decimal('9.25')]
>>> sum(data)
Decimal('19.29')
>>> a,b,c = data[:3]
>>> str(a)
'1.34'
>>> float(a)
1.34
>>> round(a, 1)
Decimal('1.3')
>>> int(a)
1
>>> a * 5
Decimal('6.70')
>>> a * b
Decimal('2.5058')
>>> c % a
Decimal('0.77')

Decimal 对象也提供了一些数学函数:

>>> getcontext().prec = 28
>>> Decimal(2).sqrt()
Decimal('1.414213562373095048801688724')
>>> Decimal(1).exp()
Decimal('2.718281828459045235360287471')
>>> Decimal('10').ln()
Decimal('2.302585092994045684017991455')
>>> Decimal('10').log10()
Decimal('1')

quantize() 方法将一个数字舍入到固定的指数。 此方法适用于通常将结果舍入到固定小数位的货币应用程序。

>>> Decimal('7.325').quantize(Decimal('.01'), rounding=ROUND_DOWN)
Decimal('7.32')
>>> Decimal('7.325').quantize(Decimal('1.'), rounding=ROUND_UP)
Decimal('8')

如上所示,getcontext() 函数访问当前上下文并允许更改设置。 此方法可以满足大多数应用程序的需求。

对于更高级的工作,使用 Context() 构造函数创建备用上下文可能很有用。 要激活备用上下文,请使用 setcontext() 函数。

根据标准,decimal 模块提供了两个可立即使用的标准上下文,BasicContextExtendedContext。 前者对于调试特别有用,因为许多陷阱都已启用。

>>> myothercontext = Context(prec=60, rounding=ROUND_HALF_DOWN)
>>> setcontext(myothercontext)
>>> Decimal(1) / Decimal(7)
Decimal('0.142857142857142857142857142857142857142857142857142857142857')

>>> ExtendedContext
Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[], traps=[])
>>> setcontext(ExtendedContext)
>>> Decimal(1) / Decimal(7)
Decimal('0.142857143')
>>> Decimal(42) / Decimal(0)
Decimal('Infinity')

>>> setcontext(BasicContext)
>>> Decimal(42) / Decimal(0)
Traceback (most recent call last):
  File "<pyshell#143>", line 1, in -toplevel-
    Decimal(42) / Decimal(0)
DivisionByZero: x / 0

上下文还具有用于监视计算期间遇到的异常情况的信号标志。 这些标志在被显式清除之前会一直保持设置状态,因此最好在每组受监视的计算之前使用 clear_flags() 方法清除这些标志。

>>> setcontext(ExtendedContext)
>>> getcontext().clear_flags()
>>> Decimal(355) / Decimal(113)
Decimal('3.14159292')
>>> getcontext()
Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[Inexact, Rounded], traps=[])

flags 条目显示圆周率的有理逼近已被舍入(超出上下文精度的数字已被丢弃),并且结果不精确(某些丢弃的数字不为零)。

可以使用上下文 traps 属性中的字典来设置各个陷阱。

>>> setcontext(ExtendedContext)
>>> Decimal(1) / Decimal(0)
Decimal('Infinity')
>>> getcontext().traps[DivisionByZero] = 1
>>> Decimal(1) / Decimal(0)
Traceback (most recent call last):
  File "<pyshell#112>", line 1, in -toplevel-
    Decimal(1) / Decimal(0)
DivisionByZero: x / 0

大多数程序只在开始时调整一次当前上下文。 而且,在许多应用程序中,数据会在循环内通过一次转换转换为 Decimal。 设置好上下文并创建了 Decimal 对象后,程序的大部分操作数据的方式与其他 Python 数字类型没有什么不同。

Decimal 对象

class decimal.Decimal(value='0', context=None)

根据 value 构造一个新的 Decimal 对象。

value 可以是整数、字符串、元组、float 或另一个 Decimal 对象。 如果未给出 value,则返回 Decimal('0')。 如果 value 是字符串,则在删除前导和尾随空格字符以及整个字符串中的下划线后,它应符合十进制数字字符串语法:

sign           ::=  '+' | '-'
digit          ::=  '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
indicator      ::=  'e' | 'E'
digits         ::=  digit [digit]...
decimal-part   ::=  digits '.' [digits] | ['.'] digits
exponent-part  ::=  indicator [sign] digits
infinity       ::=  'Infinity' | 'Inf'
nan            ::=  'NaN' [digits] | 'sNaN' [digits]
numeric-value  ::=  decimal-part [exponent-part] | infinity
numeric-string ::=  [sign] numeric-value | [sign] nan

在上面出现 digit 的地方也允许使用其他 Unicode 十进制数字。 这些数字包括来自各种其他字母表(例如,阿拉伯-印度语和梵语数字)的十进制数字,以及全角数字 '\uff10''\uff19'

如果 valuetuple,则它应包含三个组件:符号(0 表示正数,1 表示负数)、数字 tuple 和整数指数。 例如,Decimal((0, (1, 4, 1, 4), -3)) 返回 Decimal('1.414')

如果 valuefloat,则二进制浮点值将无损转换为其精确的十进制等效值。 此转换通常需要 53 位或更多位精度。 例如,Decimal(float('1.1')) 转换为 Decimal('1.100000000000000088817841970012523233890533447265625')

context 精度不会影响存储的位数。 这完全由 value 中的位数决定。 例如,即使上下文精度只有三位,Decimal('3.00000') 也会记录所有五个零。

context 参数的目的是确定如果 value 是格式错误的字符串该怎么办。 如果上下文捕获到 InvalidOperation,则会引发异常;否则,构造函数将返回一个值为 NaN 的新 Decimal 对象。

一旦构造完毕,Decimal 对象就是不可变的。

在 3.2 版更改: 现在允许构造函数的参数是 float 实例。

在 3.3 版更改: 如果设置了 FloatOperation 陷阱,则 float 参数会引发异常。 默认情况下,陷阱是关闭的。

在 3.6 版更改: 允许使用下划线进行分组,就像代码中的整数和浮点字面量一样。

Decimal 浮点数对象与其他内置数字类型(如 floatint)共享许多属性。 所有常用的数学运算和特殊方法都适用。 同样,Decimal 对象可以被复制、腌制、打印、用作字典键、用作集合元素、比较、排序和强制转换为另一种类型(如 floatint)。

Decimal 对象上的算术运算与整数和浮点数上的算术运算之间存在一些细微差别。 当取余运算符 % 应用于 Decimal 对象时,结果的符号是*被除数*的符号,而不是除数的符号。

>>> (-7) % 4
1
>>> Decimal(-7) % Decimal(4)
Decimal('-3')

整数除法运算符 // 的行为与此类似,返回真实商的整数部分(向零截断)而不是其向下取整,以便保留通常的恒等式 x == (x // y) * y + x % y

>>> -7 // 4
-2
>>> Decimal(-7) // Decimal(4)
Decimal('-1')

%// 运算符分别实现了规范中描述的 remainderdivide-integer 操作。

Decimal 对象通常不能与浮点数或 fractions.Fraction 的实例在算术运算中组合:例如,尝试将 Decimal 添加到 float 会引发 TypeError。但是,可以使用 Python 的比较运算符将 Decimal 实例 x 与另一个数字 y 进行比较。这避免了在对不同类型的数字进行相等比较时出现令人困惑的结果。

版本 3.2 中的变化: 现在完全支持 Decimal 实例与其他数字类型之间的混合类型比较。

除了标准的数字属性外,十进制浮点数对象还有一些专门的方法。

adjusted()

在将系数的最右边数字移出,直到只剩下首位数字后,返回调整后的指数:Decimal('321e+5').adjusted() 返回 7。用于确定最高有效数字相对于小数点的位置。

as_integer_ratio()

返回一对整数 (n, d),以最简分数形式表示给定的 Decimal 实例,分母为正数。

>>> Decimal('-3.14').as_integer_ratio()
(-157, 50)

转换是精确的。如果为无穷大,则引发 OverflowError;如果为 NaN,则引发 ValueError。

3.6 版新增。

as_tuple()

返回数字的 命名元组 表示形式:DecimalTuple(sign, digits, exponent)

canonical()

返回参数的规范编码。目前,Decimal 实例的编码始终是规范的,因此此操作将返回其参数不变。

compare(other, context=None)

比较两个 Decimal 实例的值。compare() 返回一个 Decimal 实例,如果任何一个操作数是 NaN,则结果是 NaN。

a or b is a NaN  ==> Decimal('NaN')
a < b            ==> Decimal('-1')
a == b           ==> Decimal('0')
a > b            ==> Decimal('1')
compare_signal(other, context=None)

此操作与 compare() 方法相同,只是所有 NaN 都发出信号。也就是说,如果两个操作数都不是信号 NaN,则任何静默 NaN 操作数都将被视为信号 NaN。

compare_total(other, context=None)

使用抽象表示形式而不是数值来比较两个操作数。类似于 compare() 方法,但结果给出了 Decimal 实例的总排序。具有相同数值但表示形式不同的两个 Decimal 实例在此排序中比较不相等。

>>> Decimal('12.0').compare_total(Decimal('12'))
Decimal('-1')

静默和信号 NaN 也包括在总排序中。如果两个操作数具有相同的表示形式,则此函数的结果为 Decimal('0');如果第一个操作数在总排序中低于第二个操作数,则为 Decimal('-1');如果第一个操作数在总排序中高于第二个操作数,则为 Decimal('1')。有关总排序的详细信息,请参阅规范。

此操作不受上下文的影响,并且是静默的:不会更改任何标志,也不会执行舍入。作为一个例外,如果第二个操作数不能精确转换,则 C 版本可能会引发 InvalidOperation。

compare_total_mag(other, context=None)

compare_total() 一样,使用抽象表示形式而不是值来比较两个操作数,但忽略每个操作数的符号。x.compare_total_mag(y) 等效于 x.copy_abs().compare_total(y.copy_abs())

此操作不受上下文的影响,并且是静默的:不会更改任何标志,也不会执行舍入。作为一个例外,如果第二个操作数不能精确转换,则 C 版本可能会引发 InvalidOperation。

conjugate()

只返回 self,此方法仅用于符合 Decimal 规范。

copy_abs()

返回参数的绝对值。此操作不受上下文的影响,并且是静默的:不会更改任何标志,也不会执行舍入。

copy_negate()

返回参数的负数。此操作不受上下文的影响,并且是静默的:不会更改任何标志,也不会执行舍入。

copy_sign(other, context=None)

返回第一个操作数的副本,其符号设置为与第二个操作数的符号相同。例如

>>> Decimal('2.3').copy_sign(Decimal('-1.5'))
Decimal('-2.3')

此操作不受上下文的影响,并且是静默的:不会更改任何标志,也不会执行舍入。作为一个例外,如果第二个操作数不能精确转换,则 C 版本可能会引发 InvalidOperation。

exp(context=None)

返回给定数字的(自然)指数函数 e**x 的值。使用 ROUND_HALF_EVEN 舍入模式正确舍入结果。

>>> Decimal(1).exp()
Decimal('2.718281828459045235360287471')
>>> Decimal(321).exp()
Decimal('2.561702493119680037517373933E+139')
classmethod from_float(f)

备用构造函数,仅接受 floatint 的实例。

注意,Decimal.from_float(0.1)Decimal('0.1') 不同。由于 0.1 在二进制浮点数中不能精确表示,因此该值存储为最接近的可表示值,即 0x1.999999999999ap-4。该等效的十进制值为 0.1000000000000000055511151231257827021181583404541015625

注意

从 Python 3.2 开始,也可以直接从 float 构造 Decimal 实例。

>>> Decimal.from_float(0.1)
Decimal('0.1000000000000000055511151231257827021181583404541015625')
>>> Decimal.from_float(float('nan'))
Decimal('NaN')
>>> Decimal.from_float(float('inf'))
Decimal('Infinity')
>>> Decimal.from_float(float('-inf'))
Decimal('-Infinity')

3.1 版新增。

fma(other, third, context=None)

融合乘加。返回 self*other+third,不舍入中间乘积 self*other。

>>> Decimal(2).fma(3, 5)
Decimal('11')
is_canonical()

如果参数是规范的,则返回 True,否则返回 False。目前,Decimal 实例始终是规范的,因此此操作始终返回 True

is_finite()

如果参数是有限数,则返回 True,如果参数是无穷大或 NaN,则返回 False

is_infinite()

如果参数是正无穷大或负无穷大,则返回 True,否则返回 False

is_nan()

如果参数是(静默或信号)NaN,则返回 True,否则返回 False

is_normal(context=None)

如果参数是_正规_有限数,则返回 True。如果参数为零、非正规数、无穷大或 NaN,则返回 False

is_qnan()

如果参数是静默 NaN,则返回 True,否则返回 False

is_signed()

如果参数具有负号,则返回 True,否则返回 False。请注意,零和 NaN 都可以带有符号。

is_snan()

如果参数是信号 NaN,则返回 True,否则返回 False

is_subnormal(context=None)

如果参数是非正规数,则返回 True,否则返回 False

is_zero()

如果参数是(正或负)零,则返回 True,否则返回 False

ln(context=None)

返回操作数的自然对数(以 e 为底)。结果使用 ROUND_HALF_EVEN 舍入模式进行正确舍入。

log10(context=None)

返回操作数的以 10 为底的对数。结果使用 ROUND_HALF_EVEN 舍入模式进行正确舍入。

logb(context=None)

对于非零数,返回其操作数的调整后指数,作为 Decimal 实例。如果操作数为零,则返回 Decimal('-Infinity') 并引发 DivisionByZero 标志。如果操作数是无穷大,则返回 Decimal('Infinity')

logical_and(other, context=None)

logical_and() 是一个逻辑运算,它接受两个*逻辑操作数*(请参阅 逻辑操作数)。结果是两个操作数的按位 and

logical_invert(context=None)

logical_invert() 是一个逻辑运算。结果是操作数的按位反转。

logical_or(other, context=None)

logical_or() 是一个逻辑运算,它接受两个*逻辑操作数*(请参阅 逻辑操作数)。结果是两个操作数的按位 or

logical_xor(other, context=None)

logical_xor() 是一个逻辑运算,它接受两个*逻辑操作数*(请参阅 逻辑操作数)。结果是两个操作数的按位异或。

max(other, context=None)

max(self, other) 类似,不同之处在于在返回之前应用上下文舍入规则,并且 NaN 值要么被 segnal,要么被忽略(取决于上下文以及它们是 segnal 还是 quiet)。

max_mag(other, context=None)

max() 方法类似,但比较是使用操作数的绝对值完成的。

min(other, context=None)

min(self, other) 类似,不同之处在于在返回之前应用上下文舍入规则,并且 NaN 值要么被 segnal,要么被忽略(取决于上下文以及它们是 segnal 还是 quiet)。

min_mag(other, context=None)

min() 方法类似,但比较是使用操作数的绝对值完成的。

next_minus(context=None)

返回在给定上下文中(如果未给出上下文,则在当前线程的上下文中)可表示的最大数字,该数字小于给定操作数。

next_plus(context=None)

返回在给定上下文中(如果未给出上下文,则在当前线程的上下文中)可表示的最小数字,该数字大于给定操作数。

next_toward(other, context=None)

如果两个操作数不相等,则返回在第二个操作数方向上最接近第一个操作数的数字。如果两个操作数在数值上相等,则返回第一个操作数的副本,其符号设置为与第二个操作数的符号相同。

normalize(context=None)

用于在当前上下文或指定上下文中生成等价类的规范值。

这与一元加运算具有相同的语义,不同之处在于如果最终结果是有限的,则将其简化为最简形式,删除所有尾随零并保留其符号。也就是说,当系数非零且为 10 的倍数时,系数除以 10,指数加 1。否则(系数为零)指数设置为 0。在所有情况下,符号都不变。

例如,Decimal('32.100')Decimal('0.321000e+2') 都规范化为等效值 Decimal('32.1')

请注意,舍入是在简化为最简形式*之前*应用的。

在最新版本的规范中,此操作也称为 reduce

number_class(context=None)

返回描述操作数*类*的字符串。返回值是以下十个字符串之一。

  • "-Infinity",表示操作数为负无穷大。

  • "-Normal",表示操作数为负的正常数。

  • "-Subnormal",表示操作数为负的次正规数。

  • "-Zero",表示操作数为负零。

  • "+Zero",表示操作数为正零。

  • "+Subnormal",表示操作数为正的次正规数。

  • "+Normal",表示操作数为正的正常数。

  • "+Infinity",表示操作数为正无穷大。

  • "NaN",表示操作数为静默 NaN(非数字)。

  • "sNaN",表示操作数为信号 NaN。

quantize(exp, rounding=None, context=None)

返回第一个操作数在进行四舍五入并取第二个操作数的指数后的值。

>>> Decimal('1.41421356').quantize(Decimal('1.000'))
Decimal('1.414')

与其他操作不同,如果量化操作后系数的长度大于精度,则会发出 InvalidOperation 信号。这保证了,除非出现错误情况,否则量化后的指数始终等于右侧操作数的指数。

同样与其他操作不同,即使结果是次正规数且不精确,quantize 也永远不会发出 Underflow 信号。

如果第二个操作数的指数大于第一个操作数的指数,则可能需要进行四舍五入。在这种情况下,舍入模式由 rounding 参数(如果给出)确定,否则由给定的 context 参数确定;如果两个参数都没有给出,则使用当前线程上下文的舍入模式。

每当结果指数大于 Emax 或小于 Etiny() 时,都会返回错误。

radix()

返回 Decimal(10),即 Decimal 类进行所有算术运算的基数。为了与规范兼容而包含。

remainder_near(other, context=None)

返回 self 除以 other 的余数。这与 self % other 的不同之处在于,余数的符号是选择使其绝对值最小化的符号。更准确地说,返回值是 self - n * other,其中 n 是最接近 self / other 精确值的整数,如果两个整数同样接近,则选择偶数。

如果结果为零,则其符号将是 self 的符号。

>>> Decimal(18).remainder_near(Decimal(10))
Decimal('-2')
>>> Decimal(25).remainder_near(Decimal(10))
Decimal('5')
>>> Decimal(35).remainder_near(Decimal(10))
Decimal('-5')
rotate(other, context=None)

返回将第一个操作数的数字旋转由第二个操作数指定的数量的结果。第二个操作数必须是 -precision 到 precision 范围内的整数。第二个操作数的绝对值给出要旋转的位数。如果第二个操作数为正,则向左旋转;否则向右旋转。如果需要,第一个操作数的系数将在左侧用零填充到长度精度。第一个操作数的符号和指数保持不变。

same_quantum(other, context=None)

测试 self 和 other 是否具有相同的指数,或者两者是否都是 NaN

此操作不受上下文的影响,并且是静默的:不会更改任何标志,也不会执行舍入。作为一个例外,如果第二个操作数不能精确转换,则 C 版本可能会引发 InvalidOperation。

scaleb(other, context=None)

返回指数由第二个操作数调整后的第一个操作数。等效地,返回第一个操作数乘以 10**other。第二个操作数必须是整数。

shift(other, context=None)

返回将第一个操作数的数字移动由第二个操作数指定的数量的结果。第二个操作数必须是 -precision 到 precision 范围内的整数。第二个操作数的绝对值给出要移动的位数。如果第二个操作数为正,则向左移动;否则向右移动。移入系数的数字为零。第一个操作数的符号和指数保持不变。

sqrt(context=None)

返回参数的平方根,精度为完全精度。

to_eng_string(context=None)

转换为字符串,如果需要指数,则使用工程计数法。

工程计数法的指数是 3 的倍数。这可以在小数点左侧最多保留 3 位数字,并且可能需要添加一个或两个尾随零。

例如,这会将 Decimal('123E+1') 转换为 Decimal('1.23E+3')

to_integral(rounding=None, context=None)

to_integral_value() 方法相同。保留 to_integral 名称是为了与旧版本兼容。

to_integral_exact(rounding=None, context=None)

舍入到最接近的整数,如果发生舍入,则根据情况发出 InexactRounded 信号。舍入模式由 rounding 参数(如果给出)确定,否则由给定的 context 确定。如果两个参数都没有给出,则使用当前上下文的舍入模式。

to_integral_value(rounding=None, context=None)

舍入到最接近的整数,不发出 InexactRounded 信号。如果给出,则应用 *rounding*;否则,使用提供的 *context* 或当前上下文中的舍入方法。

可以使用 round() 函数对十进制数进行舍入

round(number)
round(number, ndigits)

如果未给出 *ndigits* 或为 None,则返回最接近 *number* 的 int,将关系舍入为偶数,并忽略 Decimal 上下文的舍入模式。如果 *number* 是无穷大,则引发 OverflowError;如果它是(静默或信号)NaN,则引发 ValueError

如果 *ndigits* 是 int,则遵循上下文的舍入模式,并返回表示 *number* 舍入到最接近 Decimal('1E-ndigits') 倍数的 Decimal;在这种情况下,round(number, ndigits) 等效于 self.quantize(Decimal('1E-ndigits'))。如果 *number* 是静默 NaN,则返回 Decimal('NaN')。如果 *number* 是无穷大、信号 NaN,或者量化操作后系数的长度将大于当前上下文的精度,则引发 InvalidOperation。换句话说,对于非极端情况

  • 如果 *ndigits* 为正数,则返回 *number* 舍入到 *ndigits* 个小数位;

  • 如果 *ndigits* 为零,则返回 *number* 舍入到最接近的整数;

  • 如果 *ndigits* 为负数,则返回 *number* 舍入到最接近 10**abs(ndigits) 的倍数。

例如

>>> from decimal import Decimal, getcontext, ROUND_DOWN
>>> getcontext().rounding = ROUND_DOWN
>>> round(Decimal('3.75'))     # context rounding ignored
4
>>> round(Decimal('3.5'))      # round-ties-to-even
4
>>> round(Decimal('3.75'), 0)  # uses the context rounding
Decimal('3')
>>> round(Decimal('3.75'), 1)
Decimal('3.7')
>>> round(Decimal('3.75'), -1)
Decimal('0E+1')

逻辑操作数

logical_and()logical_invert()logical_or()logical_xor() 方法期望其参数为 *逻辑操作数*。*逻辑操作数* 是一个 Decimal 实例,其指数和符号均为零,并且其数字均为 01

上下文对象

上下文是算术运算的环境。它们控制精度、设置舍入规则、确定哪些信号被视为异常,并限制指数的范围。

每个线程都有自己的当前上下文,可以使用 getcontext()setcontext() 函数访问或更改该上下文

decimal.getcontext()

返回活动线程的当前上下文。

decimal.setcontext(c)

将活动线程的当前上下文设置为 *c*。

您还可以使用 with 语句和 localcontext() 函数临时更改活动上下文。

decimal.localcontext(ctx=None, **kwargs)

返回一个上下文管理器,该管理器将在进入 with 语句时将活动线程的当前上下文设置为 *ctx* 的副本,并在退出 with 语句时恢复先前的上下文。如果没有指定上下文,则使用当前上下文的副本。*kwargs* 参数用于设置新上下文的属性。

例如,以下代码将当前十进制精度设置为 42 位,执行计算,然后自动恢复先前的上下文

from decimal import localcontext

with localcontext() as ctx:
    ctx.prec = 42   # Perform a high precision calculation
    s = calculate_something()
s = +s  # Round the final result back to the default precision

使用关键字参数,代码如下所示

from decimal import localcontext

with localcontext(prec=42) as ctx:
    s = calculate_something()
s = +s

如果 *kwargs* 提供了 TypeError 不支持的属性,则会引发 Context。如果 *kwargs* 为属性提供了无效值,则会引发 TypeErrorValueError

在 3.11 版更改: localcontext() 现在支持通过使用关键字参数设置上下文属性。

也可以使用下面描述的 Context 构造函数创建新的上下文。此外,该模块还提供了三个预先定义的上下文

class decimal.BasicContext

这是由通用十进制算术规范定义的标准上下文。精度设置为九。舍入模式设置为 ROUND_HALF_UP。所有标志都被清除。除了 InexactRoundedSubnormal 之外,所有陷阱都被启用(视为异常)。

由于许多陷阱都被启用,因此此上下文对于调试非常有用。

class decimal.ExtendedContext

这是由通用十进制算术规范定义的标准上下文。精度设置为九。舍入模式设置为 ROUND_HALF_EVEN。所有标志都被清除。没有启用任何陷阱(因此在计算过程中不会引发异常)。

由于陷阱被禁用,因此此上下文对于希望获得 NaNInfinity 结果值而不是引发异常的应用程序非常有用。这允许应用程序在出现否则会停止程序的条件下完成运行。

class decimal.DefaultContext

Context 构造函数使用此上下文作为新上下文的原型。更改字段(例如精度)会更改由 Context 构造函数创建的新上下文的默认值。

此上下文在多线程环境中最有用。在启动线程之前更改其中一个字段会设置系统范围内的默认值。不建议在启动线程后更改字段,因为这需要线程同步以防止竞争条件。

在单线程环境中,最好完全不要使用此上下文。相反,只需按照以下说明显式创建上下文。

默认值为 Context.prec=28Context.rounding=ROUND_HALF_EVEN,以及为 OverflowInvalidOperationDivisionByZero 启用的陷阱。

除了提供的三个上下文之外,还可以使用 Context 构造函数创建新的上下文。

class decimal.Context(prec=None, rounding=None, Emin=None, Emax=None, capitals=None, clamp=None, flags=None, traps=None)

创建一个新的上下文。如果未指定字段或为 None,则从 DefaultContext 复制默认值。如果未指定 *flags* 字段或为 None,则清除所有标志。

*prec* 是一个介于 [1, MAX_PREC] 范围内的整数,用于设置上下文中算术运算的精度。

*rounding* 选项是 舍入模式 部分中列出的常量之一。

*traps* 和 *flags* 字段列出了要设置的所有信号。通常,新上下文应该只设置陷阱,并将标志保持清除状态。

*Emin* 和 *Emax* 字段是指定指数允许范围的整数。*Emin* 必须在 [MIN_EMIN, 0] 范围内,*Emax* 必须在 [0, MAX_EMAX] 范围内。

*capitals* 字段为 01(默认值)。如果设置为 1,则指数使用大写字母 E 打印;否则,使用小写字母 eDecimal('6.02e+23')

clamp 字段为 0(默认值)或 1。如果设置为 1,则在此上下文中可表示的 Decimal 实例的指数 e 严格限制在 Emin - prec + 1 <= e <= Emax - prec + 1 范围内。如果 clamp0,则适用较弱的条件:Decimal 实例的调整后指数最多为 Emax。当 clamp1 时,较大的正规数将在可能的情况下减少其指数,并在其系数中添加相应数量的零,以符合指数约束;这保留了数字的值,但丢失了有关有效尾随零的信息。例如

>>> Context(prec=6, Emax=999, clamp=1).create_decimal('1.23e999')
Decimal('1.23000E+999')

clamp 值为 1 允许与 IEEE 754 中指定的固定宽度十进制交换格式兼容。

Context 类定义了几个通用方法,以及大量用于在给定上下文中直接进行算术运算的方法。此外,对于上面描述的每个 Decimal 方法(adjusted()as_tuple() 方法除外),都有一个对应的 Context 方法。例如,对于 Context 实例 CDecimal 实例 xC.exp(x) 等效于 x.exp(context=C)。每个 Context 方法都接受 Python 整数(int 的实例)作为 Decimal 实例的输入。

clear_flags()

将所有标志重置为 0

clear_traps()

将所有陷阱重置为 0

3.3 版新增。

copy()

返回上下文的副本。

copy_decimal(num)

返回 Decimal 实例 num 的副本。

create_decimal(num)

num 创建一个新的 Decimal 实例,但使用 self 作为上下文。与 Decimal 构造函数不同,上下文精度、舍入方法、标志和陷阱将应用于转换。

这很有用,因为常量的精度通常高于应用程序所需的精度。另一个好处是,立即舍入可以消除超出当前精度的数字带来的意外影响。在以下示例中,使用未舍入的输入意味着将零添加到总和中可能会更改结果

>>> getcontext().prec = 3
>>> Decimal('3.4445') + Decimal('1.0023')
Decimal('4.45')
>>> Decimal('3.4445') + Decimal(0) + Decimal('1.0023')
Decimal('4.44')

此方法实现了 IBM 规范中的转换为数字操作。如果参数是字符串,则不允许使用前导或尾随空格或下划线。

create_decimal_from_float(f)

从浮点数 f 创建一个新的 Decimal 实例,但使用 self 作为上下文进行舍入。与 Decimal.from_float() 类方法不同,上下文精度、舍入方法、标志和陷阱将应用于转换。

>>> context = Context(prec=5, rounding=ROUND_DOWN)
>>> context.create_decimal_from_float(math.pi)
Decimal('3.1415')
>>> context = Context(prec=5, traps=[Inexact])
>>> context.create_decimal_from_float(math.pi)
Traceback (most recent call last):
    ...
decimal.Inexact: None

3.1 版新增。

Etiny()

返回等于 Emin - prec + 1 的值,它是次正规结果的最小指数值。当发生下溢时,指数设置为 Etiny

Etop()

返回等于 Emax - prec + 1 的值。

使用小数的常用方法是创建 Decimal 实例,然后应用在活动线程的当前上下文中进行的算术运算。另一种方法是使用上下文方法在特定上下文中进行计算。这些方法类似于 Decimal 类的那些方法,这里只做简要介绍。

abs(x)

返回 x 的绝对值。

add(x, y)

返回 xy 的总和。

canonical(x)

返回相同的 Decimal 对象 x

compare(x, y)

以数值方式比较*x*和*y*。

compare_signal(x, y)

以数值方式比较两个操作数的值。

compare_total(x, y)

使用抽象表示形式比较两个操作数。

compare_total_mag(x, y)

使用抽象表示形式比较两个操作数,忽略符号。

copy_abs(x)

返回*x*的副本,符号设置为0。

copy_negate(x)

返回*x*的副本,符号反转。

copy_sign(x, y)

将符号从*y*复制到*x*。

divide(x, y)

返回*x*除以*y*的结果。

divide_int(x, y)

返回*x*除以*y*的结果,截断为整数。

divmod(x, y)

将两个数相除并返回结果的整数部分。

exp(x)

返回e ** x

fma(x, y, z)

返回*x*乘以*y*,再加上*z*的结果。

is_canonical(x)

如果*x*是规范的,则返回True;否则返回False

is_finite(x)

如果*x*是有限的,则返回True;否则返回False

is_infinite(x)

如果*x*是无限的,则返回True;否则返回False

is_nan(x)

如果*x*是qNaN或sNaN,则返回True;否则返回False

is_normal(x)

如果*x*是正规数,则返回True;否则返回False

is_qnan(x)

如果*x*是静默NaN,则返回True;否则返回False

is_signed(x)

如果*x*为负数,则返回True;否则返回False

is_snan(x)

如果*x*是信号NaN,则返回True;否则返回False

is_subnormal(x)

如果*x*是非正规数,则返回True;否则返回False

is_zero(x)

如果*x*为零,则返回True;否则返回False

ln(x)

返回*x*的自然对数(以e为底)。

log10(x)

返回*x*的以10为底的对数。

logb(x)

返回操作数的最高有效位大小的指数。

logical_and(x, y)

对每个操作数的各位应用逻辑运算*and*。

logical_invert(x)

反转*x*中的所有位。

logical_or(x, y)

对每个操作数的各位应用逻辑运算*or*。

logical_xor(x, y)

对每个操作数的数字应用逻辑运算 xor

max(x, y)

以数值方式比较两个值并返回最大值。

max_mag(x, y)

忽略符号,以数值方式比较这些值。

min(x, y)

以数值方式比较两个值并返回最小值。

min_mag(x, y)

忽略符号,以数值方式比较这些值。

minus(x)

Minus 对应于 Python 中的一元前缀减号运算符。

multiply(x, y)

返回 xy 的乘积。

next_minus(x)

返回小于 x 的最大可表示数。

next_plus(x)

返回大于 x 的最小可表示数。

next_toward(x, y)

返回最接近 x 的数字,方向朝向 y

normalize(x)

x 简化为最简形式。

number_class(x)

返回 x 的类指示。

plus(x)

Plus 对应于 Python 中的一元前缀加号运算符。此操作应用上下文精度和舍入,因此它不是恒等运算。

power(x, y, modulo=None)

返回 xy 次幂,如果给定,则对 modulo 取模。

使用两个参数,计算 x**y。如果 x 为负数,则 y 必须为整数。除非 y 为整数并且结果是有限的并且可以用“精度”位数精确表示,否则结果将是不精确的。将使用上下文的舍入模式。在 Python 版本中,结果始终是正确舍入的。

Decimal(0) ** Decimal(0) 导致 InvalidOperation,如果未捕获 InvalidOperation,则导致 Decimal('NaN')

在 3.3 版更改: C 模块根据正确舍入的 exp()ln() 函数计算 power()。结果是明确定义的,但只是“几乎总是正确舍入的”。

使用三个参数,计算 (x**y) % modulo。对于三参数形式,对参数的以下限制成立

  • 所有三个参数必须是整数

  • y 必须是非负数

  • xy 中至少有一个必须是非零的

  • modulo 必须是非零的,并且最多具有“精度”位数

Context.power(x, y, modulo) 产生的值等于通过以无界精度计算 (x**y) % modulo 获得的值,但计算效率更高。结果的指数为零,而不管 xymodulo 的指数如何。结果始终是精确的。

quantize(x, y)

返回一个等于 x(舍入)的值,其指数为 y

radix()

只返回 10,因为这是 Decimal,:)

remainder(x, y)

返回整数除法的余数。

结果的符号(如果非零)与原始被除数的符号相同。

remainder_near(x, y)

返回 x - y * n,其中 n 是最接近 x / y 精确值的整数(如果结果为 0,则其符号将是 x 的符号)。

rotate(x, y)

返回 x 旋转 y 次的副本。

same_quantum(x, y)

如果两个操作数具有相同的指数,则返回 True

scaleb(x, y)

将第二个值添加到其指数后,返回第一个操作数。

shift(x, y)

返回 x 移动 y 次的副本。

sqrt(x)

非负数的平方根,精确到上下文精度。

subtract(x, y)

返回 xy 之间的差。

to_eng_string(x)

转换为字符串,如果需要指数,则使用工程计数法。

工程计数法的指数是 3 的倍数。这可以在小数点左侧最多保留 3 位数字,并且可能需要添加一个或两个尾随零。

to_integral_exact(x)

舍入到整数。

to_sci_string(x)

使用科学计数法将数字转换为字符串。

常量

本节中的常量仅与 C 模块相关。为了兼容性,纯 Python 版本中也包含了这些常量。

32 位

64 位

decimal.MAX_PREC

425000000

999999999999999999

decimal.MAX_EMAX

425000000

999999999999999999

decimal.MIN_EMIN

-425000000

-999999999999999999

decimal.MIN_ETINY

-849999999

-1999999999999999997

decimal.HAVE_THREADS

值为 True。已弃用,因为 Python 现在始终具有线程。

自版本 3.9 起弃用。

decimal.HAVE_CONTEXTVAR

默认值为 True。如果 Python 是 使用 --without-decimal-contextvar 选项 配置的,则 C 版本使用线程本地上下文而不是协程本地上下文,并且值为 False。在某些嵌套上下文场景中,这会稍微快一些。

在版本 3.8.3 中添加。

舍入模式

decimal.ROUND_CEILING

Infinity 舍入。

decimal.ROUND_DOWN

向零舍入。

decimal.ROUND_FLOOR

-Infinity 舍入。

decimal.ROUND_HALF_DOWN

舍入到最接近的值,如果与两个相邻数字的距离相等,则向零舍入。

decimal.ROUND_HALF_EVEN

舍入到最接近的值,如果与两个相邻数字的距离相等,则向最接近的偶数舍入。

decimal.ROUND_HALF_UP

舍入到最接近的值,如果与两个相邻数字的距离相等,则远离零舍入。

decimal.ROUND_UP

远离零舍入。

decimal.ROUND_05UP

如果向零舍入后的最后一位数字为 0 或 5,则远离零舍入;否则向零舍入。

信号

信号表示计算过程中出现的条件。每个信号对应一个上下文标志和一个上下文陷阱启用器。

每当遇到该条件时,就会设置上下文标志。计算完成后,可以检查标志以获取信息(例如,确定计算是否精确)。检查完标志后,请确保在开始下一次计算之前清除所有标志。

如果为信号设置了上下文的陷阱启用器,则该条件会导致引发 Python 异常。例如,如果设置了 DivisionByZero 陷阱,则在遇到该条件时会引发 DivisionByZero 异常。

class decimal.Clamped

更改了指数以适应表示形式约束。

通常,当指数超出上下文的 EminEmax 限制时,就会发生钳位。如果可能,通过在系数中添加零来减小指数以适应。

class decimal.DecimalException

其他信号的基类和 ArithmeticError 的子类。

class decimal.DivisionByZero

表示非无限数除以零。

可能在除法、模除法或将数字提高到负幂时发生。如果未捕获此信号,则返回 Infinity-Infinity,符号由计算的输入确定。

class decimal.Inexact

表示发生了舍入,并且结果不精确。

在舍入过程中丢弃非零数字时发出信号。返回舍入后的结果。信号标志或陷阱用于检测结果何时不精确。

class decimal.InvalidOperation

执行了无效操作。

表示请求了无意义的操作。如果未捕获,则返回 NaN。可能的原因包括

Infinity - Infinity
0 * Infinity
Infinity / Infinity
x % 0
Infinity % x
sqrt(-x) and x > 0
0 ** 0
x ** (non-integer)
x ** Infinity
class decimal.Overflow

数值溢出。

表示在进行舍入后,指数大于 Context.Emax。 如果未捕获,则结果取决于舍入模式,要么向内舍入到最大可表示有限数,要么向外舍入到 Infinity。 无论哪种情况,InexactRounded 也会发出信号。

class decimal.Rounded

发生舍入,但可能没有信息丢失。

每当舍入丢弃数字时发出信号;即使这些数字为零(例如将 5.00 舍入为 5.0)。 如果未捕获,则返回的结果不变。 此信号用于检测有效数字的丢失。

class decimal.Subnormal

舍入前指数低于 Emin

当运算结果为次正规数(指数太小)时发生。 如果未捕获,则返回的结果不变。

class decimal.Underflow

数值下溢,结果舍入为零。

当次正规结果通过舍入推至零时发生。 InexactSubnormal 也会发出信号。

class decimal.FloatOperation

对混合浮点数和 Decimal 启用更严格的语义。

如果未捕获信号(默认),则允许在 Decimal 构造函数、create_decimal() 和所有比较运算符中混合使用浮点数和 Decimal。 转换和比较都是精确的。 通过在上下文标志中设置 FloatOperation 静默记录混合操作的每次发生。 使用 from_float()create_decimal_from_float() 进行的显式转换不会设置标志。

否则(捕获信号),只有相等比较和显式转换是静默的。 所有其他混合操作都会引发 FloatOperation

下表总结了信号的层次结构

exceptions.ArithmeticError(exceptions.Exception)
    DecimalException
        Clamped
        DivisionByZero(DecimalException, exceptions.ZeroDivisionError)
        Inexact
            Overflow(Inexact, Rounded)
            Underflow(Inexact, Rounded, Subnormal)
        InvalidOperation
        Rounded
        Subnormal
        FloatOperation(DecimalException, exceptions.TypeError)

浮点数注意事项

通过提高精度减轻舍入误差

使用十进制浮点数消除了十进制表示误差(从而可以精确表示 0.1);但是,当非零数字超过固定精度时,某些操作仍会导致舍入误差。

通过对几乎抵消的量进行加法或减法运算,舍入误差的影响会被放大,从而导致有效数字的丢失。 Knuth 提供了两个有启发性的例子,其中精度不足的舍入浮点运算会导致加法的结合律和分配律失效

# Examples from Seminumerical Algorithms, Section 4.2.2.
>>> from decimal import Decimal, getcontext
>>> getcontext().prec = 8

>>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
>>> (u + v) + w
Decimal('9.5111111')
>>> u + (v + w)
Decimal('10')

>>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
>>> (u*v) + (u*w)
Decimal('0.01')
>>> u * (v+w)
Decimal('0.0060000')

decimal 模块可以通过充分扩展精度以避免有效数字的丢失来恢复恒等式

>>> getcontext().prec = 20
>>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
>>> (u + v) + w
Decimal('9.51111111')
>>> u + (v + w)
Decimal('9.51111111')
>>>
>>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
>>> (u*v) + (u*w)
Decimal('0.0060000')
>>> u * (v+w)
Decimal('0.0060000')

特殊值

decimal 模块的数字系统提供特殊值,包括 NaNsNaN-InfinityInfinity 以及两个零,+0-0

可以使用以下方法直接构造无穷大:Decimal('Infinity')。 此外,当未捕获 DivisionByZero 信号时,它们也可能由除以零产生。 同样,当未捕获 Overflow 信号时,超出最大可表示数的限制进行舍入可能会导致无穷大。

无穷大是有符号的(仿射),并且可以在算术运算中使用,在算术运算中,它们被视为非常大的不确定数。 例如,将一个常数加到无穷大得到另一个无穷大的结果。

某些操作是不确定的,并返回 NaN,或者如果捕获到 InvalidOperation 信号,则引发异常。 例如,0/0 返回 NaN,这意味着“不是数字”。 这种 NaN 是静默的,一旦创建,它将在其他计算中流动,始终导致另一个 NaN。 此行为对于一系列偶尔缺少输入的计算非常有用 - 它允许计算继续进行,同时将特定结果标记为无效。

一个变体是 sNaN,它在每次操作后发出信号而不是保持静默。 当无效结果需要中断计算以进行特殊处理时,这是一个有用的返回值。

当涉及到 NaN 时,Python 比较运算符的行为可能会有点出乎意料。如果其中一个操作数是静默或信号 NaN,则相等性测试始终返回 False(即使在执行 Decimal('NaN')==Decimal('NaN') 时也是如此),而不等性测试始终返回 True。如果任何一个操作数是 NaN,则尝试使用 <<=>>= 运算符比较两个 Decimal 会引发 InvalidOperation 信号,如果未捕获此信号,则返回 False。请注意,通用十进制算术规范没有指定直接比较的行为;这些涉及 NaN 的比较规则取自 IEEE 854 标准(参见第 5.7 节中的表 3)。为了确保严格符合标准,请改用 compare()compare_signal() 方法。

带符号的零可能是下溢计算的结果。它们保留了如果以更高的精度进行计算将会得到的结果的符号。由于它们的幅度为零,因此正零和负零都被视为相等,并且它们的符号是信息性的。

除了两个不同但相等的带符号零之外,还有各种表示形式的零,它们的精度不同但值相等。这需要一点时间来适应。对于习惯于规范化浮点表示形式的人来说,以下计算返回的值等于零并不立即显而易见

>>> 1 / Decimal('Infinity')
Decimal('0E-1000026')

使用线程

getcontext() 函数为每个线程访问不同的 Context 对象。拥有单独的线程上下文意味着线程可以进行更改(例如 getcontext().prec=10)而不会干扰其他线程。

同样,setcontext() 函数会自动将其目标分配给当前线程。

如果在 getcontext() 之前没有调用 setcontext(),则 getcontext() 将自动创建一个新上下文以在当前线程中使用。

新上下文是从名为 *DefaultContext* 的原型上下文复制的。要控制默认值以便每个线程在整个应用程序中使用相同的值,请直接修改 *DefaultContext* 对象。这应该在启动任何线程*之前*完成,这样在线程调用 getcontext() 之间不会出现竞争条件。例如

# Set applicationwide defaults for all threads about to be launched
DefaultContext.prec = 12
DefaultContext.rounding = ROUND_DOWN
DefaultContext.traps = ExtendedContext.traps.copy()
DefaultContext.traps[InvalidOperation] = 1
setcontext(DefaultContext)

# Afterwards, the threads can be started
t1.start()
t2.start()
t3.start()
 . . .

方法

以下是一些方法,它们充当实用函数,并演示了使用 Decimal 类的方法

def moneyfmt(value, places=2, curr='', sep=',', dp='.',
             pos='', neg='-', trailneg=''):
    """Convert Decimal to a money formatted string.

    places:  required number of places after the decimal point
    curr:    optional currency symbol before the sign (may be blank)
    sep:     optional grouping separator (comma, period, space, or blank)
    dp:      decimal point indicator (comma or period)
             only specify as blank when places is zero
    pos:     optional sign for positive numbers: '+', space or blank
    neg:     optional sign for negative numbers: '-', '(', space or blank
    trailneg:optional trailing minus indicator:  '-', ')', space or blank

    >>> d = Decimal('-1234567.8901')
    >>> moneyfmt(d, curr='$')
    '-$1,234,567.89'
    >>> moneyfmt(d, places=0, sep='.', dp='', neg='', trailneg='-')
    '1.234.568-'
    >>> moneyfmt(d, curr='$', neg='(', trailneg=')')
    '($1,234,567.89)'
    >>> moneyfmt(Decimal(123456789), sep=' ')
    '123 456 789.00'
    >>> moneyfmt(Decimal('-0.02'), neg='<', trailneg='>')
    '<0.02>'

    """
    q = Decimal(10) ** -places      # 2 places --> '0.01'
    sign, digits, exp = value.quantize(q).as_tuple()
    result = []
    digits = list(map(str, digits))
    build, next = result.append, digits.pop
    if sign:
        build(trailneg)
    for i in range(places):
        build(next() if digits else '0')
    if places:
        build(dp)
    if not digits:
        build('0')
    i = 0
    while digits:
        build(next())
        i += 1
        if i == 3 and digits:
            i = 0
            build(sep)
    build(curr)
    build(neg if sign else pos)
    return ''.join(reversed(result))

def pi():
    """Compute Pi to the current precision.

    >>> print(pi())
    3.141592653589793238462643383

    """
    getcontext().prec += 2  # extra digits for intermediate steps
    three = Decimal(3)      # substitute "three=3.0" for regular floats
    lasts, t, s, n, na, d, da = 0, three, 3, 1, 0, 0, 24
    while s != lasts:
        lasts = s
        n, na = n+na, na+8
        d, da = d+da, da+32
        t = (t * n) / d
        s += t
    getcontext().prec -= 2
    return +s               # unary plus applies the new precision

def exp(x):
    """Return e raised to the power of x.  Result type matches input type.

    >>> print(exp(Decimal(1)))
    2.718281828459045235360287471
    >>> print(exp(Decimal(2)))
    7.389056098930650227230427461
    >>> print(exp(2.0))
    7.38905609893
    >>> print(exp(2+0j))
    (7.38905609893+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num = 0, 0, 1, 1, 1
    while s != lasts:
        lasts = s
        i += 1
        fact *= i
        num *= x
        s += num / fact
    getcontext().prec -= 2
    return +s

def cos(x):
    """Return the cosine of x as measured in radians.

    The Taylor series approximation works best for a small value of x.
    For larger values, first compute x = x % (2 * pi).

    >>> print(cos(Decimal('0.5')))
    0.8775825618903727161162815826
    >>> print(cos(0.5))
    0.87758256189
    >>> print(cos(0.5+0j))
    (0.87758256189+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num, sign = 0, 0, 1, 1, 1, 1
    while s != lasts:
        lasts = s
        i += 2
        fact *= i * (i-1)
        num *= x * x
        sign *= -1
        s += num / fact * sign
    getcontext().prec -= 2
    return +s

def sin(x):
    """Return the sine of x as measured in radians.

    The Taylor series approximation works best for a small value of x.
    For larger values, first compute x = x % (2 * pi).

    >>> print(sin(Decimal('0.5')))
    0.4794255386042030002732879352
    >>> print(sin(0.5))
    0.479425538604
    >>> print(sin(0.5+0j))
    (0.479425538604+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num, sign = 1, 0, x, 1, x, 1
    while s != lasts:
        lasts = s
        i += 2
        fact *= i * (i-1)
        num *= x * x
        sign *= -1
        s += num / fact * sign
    getcontext().prec -= 2
    return +s

Decimal 常见问题解答

问:键入 decimal.Decimal('1234.5') 很麻烦。在使用交互式解释器时,有没有办法减少输入?

答:一些用户将构造函数缩写为一个字母

>>> D = decimal.Decimal
>>> D('1.23') + D('3.45')
Decimal('4.68')

问:在一个具有两位小数的定点应用程序中,一些输入有很多位小数,需要进行舍入。其他输入不应该有多余的数字,需要进行验证。应该使用什么方法?

答:quantize() 方法舍入到固定的小数位数。如果设置了 Inexact 陷阱,它也可用于验证

>>> TWOPLACES = Decimal(10) ** -2       # same as Decimal('0.01')
>>> # Round to two places
>>> Decimal('3.214').quantize(TWOPLACES)
Decimal('3.21')
>>> # Validate that a number does not exceed two places
>>> Decimal('3.21').quantize(TWOPLACES, context=Context(traps=[Inexact]))
Decimal('3.21')
>>> Decimal('3.214').quantize(TWOPLACES, context=Context(traps=[Inexact]))
Traceback (most recent call last):
   ...
Inexact: None

问:一旦我有有效的两位小数输入,如何在整个应用程序中保持该不变式?

答:一些运算(如加法、减法和与整数的乘法)将自动保留定点。其他运算(如除法和非整数乘法)将更改小数位数,并且需要在后面加上 quantize() 步骤

>>> a = Decimal('102.72')           # Initial fixed-point values
>>> b = Decimal('3.17')
>>> a + b                           # Addition preserves fixed-point
Decimal('105.89')
>>> a - b
Decimal('99.55')
>>> a * 42                          # So does integer multiplication
Decimal('4314.24')
>>> (a * b).quantize(TWOPLACES)     # Must quantize non-integer multiplication
Decimal('325.62')
>>> (b / a).quantize(TWOPLACES)     # And quantize division
Decimal('0.03')

在开发定点应用程序时,定义函数来处理 quantize() 步骤很方便

>>> def mul(x, y, fp=TWOPLACES):
...     return (x * y).quantize(fp)
...
>>> def div(x, y, fp=TWOPLACES):
...     return (x / y).quantize(fp)
>>> mul(a, b)                       # Automatically preserve fixed-point
Decimal('325.62')
>>> div(b, a)
Decimal('0.03')

问:有很多方法可以表示相同的值。数字 200200.0002E2.02E+4 在不同的精度下都具有相同的值。有没有办法将它们转换为一个可识别的规范值?

答:normalize() 方法将所有等效值映射到一个代表值

>>> values = map(Decimal, '200 200.000 2E2 .02E+4'.split())
>>> [v.normalize() for v in values]
[Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2')]

问:舍入何时在计算中发生?

答:它发生在计算*之后*。十进制规范的理念是,数字被认为是精确的,并且是独立于当前上下文创建的。它们甚至可以具有比当前上下文更高的精度。计算使用这些精确的输入进行处理,然后将舍入(或其他上下文操作)应用于计算的*结果*

>>> getcontext().prec = 5
>>> pi = Decimal('3.1415926535')   # More than 5 digits
>>> pi                             # All digits are retained
Decimal('3.1415926535')
>>> pi + 0                         # Rounded after an addition
Decimal('3.1416')
>>> pi - Decimal('0.00005')        # Subtract unrounded numbers, then round
Decimal('3.1415')
>>> pi + 0 - Decimal('0.00005').   # Intermediate values are rounded
Decimal('3.1416')

问:一些十进制值总是以指数符号打印。有没有办法得到非指数表示?

答:对于某些值,指数符号是表示系数中有效位数的唯一方法。例如,将 5.0E+3 表示为 5000 可以保持值不变,但不能显示原始值的两位有效数字。

如果应用程序不关心跟踪有效数字,则很容易删除指数和尾随零,从而丢失有效数字,但保持值不变

>>> def remove_exponent(d):
...     return d.quantize(Decimal(1)) if d == d.to_integral() else d.normalize()
>>> remove_exponent(Decimal('5E+3'))
Decimal('5000')

问:有没有办法将常规浮点数转换为 Decimal

答:是的,任何二进制浮点数都可以精确地表示为 Decimal,尽管精确转换可能需要比直觉建议的更高的精度

>>> Decimal(math.pi)
Decimal('3.141592653589793115997963468544185161590576171875')

问:在复杂的计算中,如何确保我没有因为精度不足或舍入异常而得到虚假结果?

答:decimal 模块可以轻松测试结果。最佳实践是使用更高的精度和各种舍入模式重新运行计算。差异很大的结果表明精度不足、舍入模式问题、病态输入或数值不稳定的算法。

问:我注意到上下文精度应用于运算结果,但不应用于输入。在混合不同精度的值时,有什么需要注意的吗?

答:是的。原则是所有值都被认为是精确的,对这些值的算术运算也是如此。只有结果会被舍入。输入的优点是“你输入的就是你得到的”。缺点是,如果您忘记输入尚未舍入,则结果可能看起来很奇怪

>>> getcontext().prec = 3
>>> Decimal('3.104') + Decimal('2.104')
Decimal('5.21')
>>> Decimal('3.104') + Decimal('0.000') + Decimal('2.104')
Decimal('5.20')

解决方案是提高精度或使用一元加号运算强制对输入进行舍入。

>>> getcontext().prec = 3
>>> +Decimal('1.23456789')      # unary plus triggers rounding
Decimal('1.23')

或者,可以使用 Context.create_decimal() 方法在创建输入时对其进行舍入。

>>> Context(prec=5, rounding=ROUND_DOWN).create_decimal('1.2345678')
Decimal('1.2345')

问:CPython 实现对于大数是否快速?

答:是的。在 CPython 和 PyPy3 实现中,C/CFFI 版本的 decimal 模块集成了高速 libmpdec 库,用于任意精度正确舍入的十进制浮点运算 [1]libmpdec 对中等大小的数字使用 Karatsuba 乘法,对非常大的数字使用 数论变换

必须调整上下文以进行精确的任意精度算术运算。 EminEmax 应始终设置为最大值,clamp 应始终为 0(默认值)。设置 prec 需要谨慎。

尝试大数运算的最简单方法是也对 prec 使用最大值 [2]

>>> setcontext(Context(prec=MAX_PREC, Emax=MAX_EMAX, Emin=MIN_EMIN))
>>> x = Decimal(2) ** 256
>>> x / 128
Decimal('904625697166532776746648320380374280103671755200316906558262375061821325312')

对于不精确的结果,MAX_PREC 在 64 位平台上过大,可用内存将不足。

>>> Decimal(1) / 3
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
MemoryError

在具有过度分配的系统(例如 Linux)上,更复杂的方法是根据可用 RAM 量调整 prec。假设您有 8GB RAM,并且预计 10 个并发操作数,每个操作数最多使用 500MB。

>>> import sys
>>>
>>> # Maximum number of digits for a single operand using 500MB in 8-byte words
>>> # with 19 digits per word (4-byte and 9 digits for the 32-bit build):
>>> maxdigits = 19 * ((500 * 1024**2) // 8)
>>>
>>> # Check that this works:
>>> c = Context(prec=maxdigits, Emax=MAX_EMAX, Emin=MIN_EMIN)
>>> c.traps[Inexact] = True
>>> setcontext(c)
>>>
>>> # Fill the available precision with nines:
>>> x = Decimal(0).logical_invert() * 9
>>> sys.getsizeof(x)
524288112
>>> x + 2
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  decimal.Inexact: [<class 'decimal.Inexact'>]

通常(尤其是在没有过度分配的系统上),建议估计更严格的界限,并在预期所有计算都是精确的情况下设置 Inexact 陷阱。