Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1 | # Copyright (c) 2004 Python Software Foundation. |
| 2 | # All rights reserved. |
| 3 | |
| 4 | # Written by Eric Price <eprice at tjhsst.edu> |
| 5 | # and Facundo Batista <facundo at taniquetil.com.ar> |
| 6 | # and Raymond Hettinger <python at rcn.com> |
Fred Drake | 1f34eb1 | 2004-07-01 14:28:36 +0000 | [diff] [blame] | 7 | # and Aahz <aahz at pobox.com> |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 8 | # and Tim Peters |
| 9 | |
Facundo Batista | 6ab2479 | 2009-02-16 15:41:37 +0000 | [diff] [blame] | 10 | # This module should be kept in sync with the latest updates of the |
| 11 | # IBM specification as it evolves. Those updates will be treated |
Raymond Hettinger | 27dbcf2 | 2004-08-19 22:39:55 +0000 | [diff] [blame] | 12 | # as bug fixes (deviation from the spec is a compatibility, usability |
| 13 | # bug) and will be backported. At this point the spec is stabilizing |
| 14 | # and the updates are becoming fewer, smaller, and less significant. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 15 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 16 | """ |
Facundo Batista | 6ab2479 | 2009-02-16 15:41:37 +0000 | [diff] [blame] | 17 | This is an implementation of decimal floating point arithmetic based on |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 18 | the General Decimal Arithmetic Specification: |
| 19 | |
Raymond Hettinger | 960dc36 | 2009-04-21 03:43:15 +0000 | [diff] [blame] | 20 | http://speleotrove.com/decimal/decarith.html |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 21 | |
Raymond Hettinger | 0ea241e | 2004-07-04 13:53:24 +0000 | [diff] [blame] | 22 | and IEEE standard 854-1987: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 23 | |
| 24 | www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html |
| 25 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 26 | Decimal floating point has finite precision with arbitrarily large bounds. |
| 27 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 28 | The purpose of this module is to support arithmetic using familiar |
| 29 | "schoolhouse" rules and to avoid some of the tricky representation |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 30 | issues associated with binary floating point. The package is especially |
| 31 | useful for financial applications or for contexts where users have |
| 32 | expectations that are at odds with binary floating point (for instance, |
| 33 | in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 34 | of the expected Decimal('0.00') returned by decimal floating point). |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 35 | |
| 36 | Here are some examples of using the decimal module: |
| 37 | |
| 38 | >>> from decimal import * |
Raymond Hettinger | bd7f76d | 2004-07-08 00:49:18 +0000 | [diff] [blame] | 39 | >>> setcontext(ExtendedContext) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 40 | >>> Decimal(0) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 41 | Decimal('0') |
| 42 | >>> Decimal('1') |
| 43 | Decimal('1') |
| 44 | >>> Decimal('-.0123') |
| 45 | Decimal('-0.0123') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 46 | >>> Decimal(123456) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 47 | Decimal('123456') |
| 48 | >>> Decimal('123.45e12345678901234567890') |
| 49 | Decimal('1.2345E+12345678901234567892') |
| 50 | >>> Decimal('1.33') + Decimal('1.27') |
| 51 | Decimal('2.60') |
| 52 | >>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41') |
| 53 | Decimal('-2.20') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 54 | >>> dig = Decimal(1) |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 55 | >>> print(dig / Decimal(3)) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 56 | 0.333333333 |
| 57 | >>> getcontext().prec = 18 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 58 | >>> print(dig / Decimal(3)) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 59 | 0.333333333333333333 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 60 | >>> print(dig.sqrt()) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 61 | 1 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 62 | >>> print(Decimal(3).sqrt()) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 63 | 1.73205080756887729 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 64 | >>> print(Decimal(3) ** 123) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 65 | 4.85192780976896427E+58 |
| 66 | >>> inf = Decimal(1) / Decimal(0) |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 67 | >>> print(inf) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 68 | Infinity |
| 69 | >>> neginf = Decimal(-1) / Decimal(0) |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 70 | >>> print(neginf) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 71 | -Infinity |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 72 | >>> print(neginf + inf) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 73 | NaN |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 74 | >>> print(neginf * inf) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 75 | -Infinity |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 76 | >>> print(dig / 0) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 77 | Infinity |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 78 | >>> getcontext().traps[DivisionByZero] = 1 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 79 | >>> print(dig / 0) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 80 | Traceback (most recent call last): |
| 81 | ... |
| 82 | ... |
| 83 | ... |
Guido van Rossum | 6a2a2a0 | 2006-08-26 20:37:44 +0000 | [diff] [blame] | 84 | decimal.DivisionByZero: x / 0 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 85 | >>> c = Context() |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 86 | >>> c.traps[InvalidOperation] = 0 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 87 | >>> print(c.flags[InvalidOperation]) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 88 | 0 |
| 89 | >>> c.divide(Decimal(0), Decimal(0)) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 90 | Decimal('NaN') |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 91 | >>> c.traps[InvalidOperation] = 1 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 92 | >>> print(c.flags[InvalidOperation]) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 93 | 1 |
Raymond Hettinger | 5aa478b | 2004-07-09 10:02:53 +0000 | [diff] [blame] | 94 | >>> c.flags[InvalidOperation] = 0 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 95 | >>> print(c.flags[InvalidOperation]) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 96 | 0 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 97 | >>> print(c.divide(Decimal(0), Decimal(0))) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 98 | Traceback (most recent call last): |
| 99 | ... |
| 100 | ... |
| 101 | ... |
Guido van Rossum | 6a2a2a0 | 2006-08-26 20:37:44 +0000 | [diff] [blame] | 102 | decimal.InvalidOperation: 0 / 0 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 103 | >>> print(c.flags[InvalidOperation]) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 104 | 1 |
Raymond Hettinger | 5aa478b | 2004-07-09 10:02:53 +0000 | [diff] [blame] | 105 | >>> c.flags[InvalidOperation] = 0 |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 106 | >>> c.traps[InvalidOperation] = 0 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 107 | >>> print(c.divide(Decimal(0), Decimal(0))) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 108 | NaN |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 109 | >>> print(c.flags[InvalidOperation]) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 110 | 1 |
| 111 | >>> |
| 112 | """ |
| 113 | |
| 114 | __all__ = [ |
| 115 | # Two major classes |
| 116 | 'Decimal', 'Context', |
| 117 | |
| 118 | # Contexts |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 119 | 'DefaultContext', 'BasicContext', 'ExtendedContext', |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 120 | |
| 121 | # Exceptions |
Raymond Hettinger | d87ac8f | 2004-07-09 10:52:54 +0000 | [diff] [blame] | 122 | 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero', |
| 123 | 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow', |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 124 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 125 | # Constants for use in setting up contexts |
| 126 | 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING', |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 127 | 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP', |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 128 | |
| 129 | # Functions for manipulating contexts |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 130 | 'setcontext', 'getcontext', 'localcontext' |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 131 | ] |
| 132 | |
Raymond Hettinger | 960dc36 | 2009-04-21 03:43:15 +0000 | [diff] [blame] | 133 | __version__ = '1.70' # Highest version of the spec this complies with |
| 134 | |
Raymond Hettinger | eb26084 | 2005-06-07 18:52:34 +0000 | [diff] [blame] | 135 | import copy as _copy |
Raymond Hettinger | 771ed76 | 2009-01-03 19:20:32 +0000 | [diff] [blame] | 136 | import math as _math |
Raymond Hettinger | 82417ca | 2009-02-03 03:54:28 +0000 | [diff] [blame] | 137 | import numbers as _numbers |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 138 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 139 | try: |
| 140 | from collections import namedtuple as _namedtuple |
| 141 | DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent') |
| 142 | except ImportError: |
| 143 | DecimalTuple = lambda *args: args |
| 144 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 145 | # Rounding |
Raymond Hettinger | 0ea241e | 2004-07-04 13:53:24 +0000 | [diff] [blame] | 146 | ROUND_DOWN = 'ROUND_DOWN' |
| 147 | ROUND_HALF_UP = 'ROUND_HALF_UP' |
| 148 | ROUND_HALF_EVEN = 'ROUND_HALF_EVEN' |
| 149 | ROUND_CEILING = 'ROUND_CEILING' |
| 150 | ROUND_FLOOR = 'ROUND_FLOOR' |
| 151 | ROUND_UP = 'ROUND_UP' |
| 152 | ROUND_HALF_DOWN = 'ROUND_HALF_DOWN' |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 153 | ROUND_05UP = 'ROUND_05UP' |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 154 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 155 | # Errors |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 156 | |
| 157 | class DecimalException(ArithmeticError): |
Raymond Hettinger | 5aa478b | 2004-07-09 10:02:53 +0000 | [diff] [blame] | 158 | """Base exception class. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 159 | |
| 160 | Used exceptions derive from this. |
| 161 | If an exception derives from another exception besides this (such as |
| 162 | Underflow (Inexact, Rounded, Subnormal) that indicates that it is only |
| 163 | called if the others are present. This isn't actually used for |
| 164 | anything, though. |
| 165 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 166 | handle -- Called when context._raise_error is called and the |
| 167 | trap_enabler is set. First argument is self, second is the |
| 168 | context. More arguments can be given, those being after |
| 169 | the explanation in _raise_error (For example, |
| 170 | context._raise_error(NewError, '(-x)!', self._sign) would |
| 171 | call NewError().handle(context, self._sign).) |
| 172 | |
| 173 | To define a new exception, it should be sufficient to have it derive |
| 174 | from DecimalException. |
| 175 | """ |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 176 | def handle(self, context, *args): |
| 177 | pass |
| 178 | |
| 179 | |
| 180 | class Clamped(DecimalException): |
| 181 | """Exponent of a 0 changed to fit bounds. |
| 182 | |
| 183 | This occurs and signals clamped if the exponent of a result has been |
| 184 | altered in order to fit the constraints of a specific concrete |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 185 | representation. This may occur when the exponent of a zero result would |
| 186 | be outside the bounds of a representation, or when a large normal |
| 187 | number would have an encoded exponent that cannot be represented. In |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 188 | this latter case, the exponent is reduced to fit and the corresponding |
| 189 | number of zero digits are appended to the coefficient ("fold-down"). |
| 190 | """ |
| 191 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 192 | class InvalidOperation(DecimalException): |
| 193 | """An invalid operation was performed. |
| 194 | |
| 195 | Various bad things cause this: |
| 196 | |
| 197 | Something creates a signaling NaN |
| 198 | -INF + INF |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 199 | 0 * (+-)INF |
| 200 | (+-)INF / (+-)INF |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 201 | x % 0 |
| 202 | (+-)INF % x |
| 203 | x._rescale( non-integer ) |
| 204 | sqrt(-x) , x > 0 |
| 205 | 0 ** 0 |
| 206 | x ** (non-integer) |
| 207 | x ** (+-)INF |
| 208 | An operand is invalid |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 209 | |
| 210 | The result of the operation after these is a quiet positive NaN, |
| 211 | except when the cause is a signaling NaN, in which case the result is |
| 212 | also a quiet NaN, but with the original sign, and an optional |
| 213 | diagnostic information. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 214 | """ |
| 215 | def handle(self, context, *args): |
| 216 | if args: |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 217 | ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True) |
| 218 | return ans._fix_nan(context) |
Mark Dickinson | f923641 | 2009-01-02 23:23:21 +0000 | [diff] [blame] | 219 | return _NaN |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 220 | |
| 221 | class ConversionSyntax(InvalidOperation): |
| 222 | """Trying to convert badly formed string. |
| 223 | |
| 224 | This occurs and signals invalid-operation if an string is being |
| 225 | converted to a number and it does not conform to the numeric string |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 226 | syntax. The result is [0,qNaN]. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 227 | """ |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 228 | def handle(self, context, *args): |
Mark Dickinson | f923641 | 2009-01-02 23:23:21 +0000 | [diff] [blame] | 229 | return _NaN |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 230 | |
| 231 | class DivisionByZero(DecimalException, ZeroDivisionError): |
| 232 | """Division by 0. |
| 233 | |
| 234 | This occurs and signals division-by-zero if division of a finite number |
| 235 | by zero was attempted (during a divide-integer or divide operation, or a |
| 236 | power operation with negative right-hand operand), and the dividend was |
| 237 | not zero. |
| 238 | |
| 239 | The result of the operation is [sign,inf], where sign is the exclusive |
| 240 | or of the signs of the operands for divide, or is 1 for an odd power of |
| 241 | -0, for power. |
| 242 | """ |
| 243 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 244 | def handle(self, context, sign, *args): |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 245 | return _SignedInfinity[sign] |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 246 | |
| 247 | class DivisionImpossible(InvalidOperation): |
| 248 | """Cannot perform the division adequately. |
| 249 | |
| 250 | This occurs and signals invalid-operation if the integer result of a |
| 251 | divide-integer or remainder operation had too many digits (would be |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 252 | longer than precision). The result is [0,qNaN]. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 253 | """ |
| 254 | |
| 255 | def handle(self, context, *args): |
Mark Dickinson | f923641 | 2009-01-02 23:23:21 +0000 | [diff] [blame] | 256 | return _NaN |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 257 | |
| 258 | class DivisionUndefined(InvalidOperation, ZeroDivisionError): |
| 259 | """Undefined result of division. |
| 260 | |
| 261 | This occurs and signals invalid-operation if division by zero was |
| 262 | attempted (during a divide-integer, divide, or remainder operation), and |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 263 | the dividend is also zero. The result is [0,qNaN]. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 264 | """ |
| 265 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 266 | def handle(self, context, *args): |
Mark Dickinson | f923641 | 2009-01-02 23:23:21 +0000 | [diff] [blame] | 267 | return _NaN |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 268 | |
| 269 | class Inexact(DecimalException): |
| 270 | """Had to round, losing information. |
| 271 | |
| 272 | This occurs and signals inexact whenever the result of an operation is |
| 273 | not exact (that is, it needed to be rounded and any discarded digits |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 274 | were non-zero), or if an overflow or underflow condition occurs. The |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 275 | result in all cases is unchanged. |
| 276 | |
| 277 | The inexact signal may be tested (or trapped) to determine if a given |
| 278 | operation (or sequence of operations) was inexact. |
| 279 | """ |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 280 | |
| 281 | class InvalidContext(InvalidOperation): |
| 282 | """Invalid context. Unknown rounding, for example. |
| 283 | |
| 284 | This occurs and signals invalid-operation if an invalid context was |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 285 | detected during an operation. This can occur if contexts are not checked |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 286 | on creation and either the precision exceeds the capability of the |
| 287 | underlying concrete representation or an unknown or unsupported rounding |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 288 | was specified. These aspects of the context need only be checked when |
| 289 | the values are required to be used. The result is [0,qNaN]. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 290 | """ |
| 291 | |
| 292 | def handle(self, context, *args): |
Mark Dickinson | f923641 | 2009-01-02 23:23:21 +0000 | [diff] [blame] | 293 | return _NaN |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 294 | |
| 295 | class Rounded(DecimalException): |
| 296 | """Number got rounded (not necessarily changed during rounding). |
| 297 | |
| 298 | This occurs and signals rounded whenever the result of an operation is |
| 299 | rounded (that is, some zero or non-zero digits were discarded from the |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 300 | coefficient), or if an overflow or underflow condition occurs. The |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 301 | result in all cases is unchanged. |
| 302 | |
| 303 | The rounded signal may be tested (or trapped) to determine if a given |
| 304 | operation (or sequence of operations) caused a loss of precision. |
| 305 | """ |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 306 | |
| 307 | class Subnormal(DecimalException): |
| 308 | """Exponent < Emin before rounding. |
| 309 | |
| 310 | This occurs and signals subnormal whenever the result of a conversion or |
| 311 | operation is subnormal (that is, its adjusted exponent is less than |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 312 | Emin, before any rounding). The result in all cases is unchanged. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 313 | |
| 314 | The subnormal signal may be tested (or trapped) to determine if a given |
| 315 | or operation (or sequence of operations) yielded a subnormal result. |
| 316 | """ |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 317 | |
| 318 | class Overflow(Inexact, Rounded): |
| 319 | """Numerical overflow. |
| 320 | |
| 321 | This occurs and signals overflow if the adjusted exponent of a result |
| 322 | (from a conversion or from an operation that is not an attempt to divide |
| 323 | by zero), after rounding, would be greater than the largest value that |
| 324 | can be handled by the implementation (the value Emax). |
| 325 | |
| 326 | The result depends on the rounding mode: |
| 327 | |
| 328 | For round-half-up and round-half-even (and for round-half-down and |
| 329 | round-up, if implemented), the result of the operation is [sign,inf], |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 330 | where sign is the sign of the intermediate result. For round-down, the |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 331 | result is the largest finite number that can be represented in the |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 332 | current precision, with the sign of the intermediate result. For |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 333 | round-ceiling, the result is the same as for round-down if the sign of |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 334 | the intermediate result is 1, or is [0,inf] otherwise. For round-floor, |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 335 | the result is the same as for round-down if the sign of the intermediate |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 336 | result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 337 | will also be raised. |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 338 | """ |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 339 | |
| 340 | def handle(self, context, sign, *args): |
| 341 | if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN, |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 342 | ROUND_HALF_DOWN, ROUND_UP): |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 343 | return _SignedInfinity[sign] |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 344 | if sign == 0: |
| 345 | if context.rounding == ROUND_CEILING: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 346 | return _SignedInfinity[sign] |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 347 | return _dec_from_triple(sign, '9'*context.prec, |
| 348 | context.Emax-context.prec+1) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 349 | if sign == 1: |
| 350 | if context.rounding == ROUND_FLOOR: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 351 | return _SignedInfinity[sign] |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 352 | return _dec_from_triple(sign, '9'*context.prec, |
| 353 | context.Emax-context.prec+1) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 354 | |
| 355 | |
| 356 | class Underflow(Inexact, Rounded, Subnormal): |
| 357 | """Numerical underflow with result rounded to 0. |
| 358 | |
| 359 | This occurs and signals underflow if a result is inexact and the |
| 360 | adjusted exponent of the result would be smaller (more negative) than |
| 361 | the smallest value that can be handled by the implementation (the value |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 362 | Emin). That is, the result is both inexact and subnormal. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 363 | |
| 364 | The result after an underflow will be a subnormal number rounded, if |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 365 | necessary, so that its exponent is not less than Etiny. This may result |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 366 | in 0 with the sign of the intermediate result and an exponent of Etiny. |
| 367 | |
| 368 | In all cases, Inexact, Rounded, and Subnormal will also be raised. |
| 369 | """ |
| 370 | |
Raymond Hettinger | 5aa478b | 2004-07-09 10:02:53 +0000 | [diff] [blame] | 371 | # List of public traps and flags |
Raymond Hettinger | fed5296 | 2004-07-14 15:41:57 +0000 | [diff] [blame] | 372 | _signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded, |
Raymond Hettinger | 5aa478b | 2004-07-09 10:02:53 +0000 | [diff] [blame] | 373 | Underflow, InvalidOperation, Subnormal] |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 374 | |
Raymond Hettinger | 5aa478b | 2004-07-09 10:02:53 +0000 | [diff] [blame] | 375 | # Map conditions (per the spec) to signals |
| 376 | _condition_map = {ConversionSyntax:InvalidOperation, |
| 377 | DivisionImpossible:InvalidOperation, |
| 378 | DivisionUndefined:InvalidOperation, |
| 379 | InvalidContext:InvalidOperation} |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 380 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 381 | ##### Context Functions ################################################## |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 382 | |
Raymond Hettinger | ef66deb | 2004-07-14 21:04:27 +0000 | [diff] [blame] | 383 | # The getcontext() and setcontext() function manage access to a thread-local |
| 384 | # current context. Py2.4 offers direct support for thread locals. If that |
Georg Brandl | f992640 | 2008-06-13 06:32:25 +0000 | [diff] [blame] | 385 | # is not available, use threading.current_thread() which is slower but will |
Raymond Hettinger | 7e71fa5 | 2004-12-18 19:07:19 +0000 | [diff] [blame] | 386 | # work for older Pythons. If threads are not part of the build, create a |
| 387 | # mock threading object with threading.local() returning the module namespace. |
| 388 | |
| 389 | try: |
| 390 | import threading |
| 391 | except ImportError: |
| 392 | # Python was compiled without threads; create a mock object instead |
| 393 | import sys |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 394 | class MockThreading(object): |
Raymond Hettinger | 7e71fa5 | 2004-12-18 19:07:19 +0000 | [diff] [blame] | 395 | def local(self, sys=sys): |
| 396 | return sys.modules[__name__] |
| 397 | threading = MockThreading() |
| 398 | del sys, MockThreading |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 399 | |
Raymond Hettinger | ef66deb | 2004-07-14 21:04:27 +0000 | [diff] [blame] | 400 | try: |
| 401 | threading.local |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 402 | |
Raymond Hettinger | ef66deb | 2004-07-14 21:04:27 +0000 | [diff] [blame] | 403 | except AttributeError: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 404 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 405 | # To fix reloading, force it to create a new context |
| 406 | # Old contexts have different exceptions in their dicts, making problems. |
Georg Brandl | f992640 | 2008-06-13 06:32:25 +0000 | [diff] [blame] | 407 | if hasattr(threading.current_thread(), '__decimal_context__'): |
| 408 | del threading.current_thread().__decimal_context__ |
Raymond Hettinger | ef66deb | 2004-07-14 21:04:27 +0000 | [diff] [blame] | 409 | |
| 410 | def setcontext(context): |
| 411 | """Set this thread's context to context.""" |
| 412 | if context in (DefaultContext, BasicContext, ExtendedContext): |
Raymond Hettinger | 9fce44b | 2004-08-08 04:03:24 +0000 | [diff] [blame] | 413 | context = context.copy() |
Raymond Hettinger | 61992ef | 2004-08-06 23:42:16 +0000 | [diff] [blame] | 414 | context.clear_flags() |
Georg Brandl | f992640 | 2008-06-13 06:32:25 +0000 | [diff] [blame] | 415 | threading.current_thread().__decimal_context__ = context |
Raymond Hettinger | ef66deb | 2004-07-14 21:04:27 +0000 | [diff] [blame] | 416 | |
| 417 | def getcontext(): |
| 418 | """Returns this thread's context. |
| 419 | |
| 420 | If this thread does not yet have a context, returns |
| 421 | a new context and sets this thread's context. |
| 422 | New contexts are copies of DefaultContext. |
| 423 | """ |
| 424 | try: |
Georg Brandl | f992640 | 2008-06-13 06:32:25 +0000 | [diff] [blame] | 425 | return threading.current_thread().__decimal_context__ |
Raymond Hettinger | ef66deb | 2004-07-14 21:04:27 +0000 | [diff] [blame] | 426 | except AttributeError: |
| 427 | context = Context() |
Georg Brandl | f992640 | 2008-06-13 06:32:25 +0000 | [diff] [blame] | 428 | threading.current_thread().__decimal_context__ = context |
Raymond Hettinger | ef66deb | 2004-07-14 21:04:27 +0000 | [diff] [blame] | 429 | return context |
| 430 | |
| 431 | else: |
| 432 | |
| 433 | local = threading.local() |
Raymond Hettinger | 9fce44b | 2004-08-08 04:03:24 +0000 | [diff] [blame] | 434 | if hasattr(local, '__decimal_context__'): |
| 435 | del local.__decimal_context__ |
Raymond Hettinger | ef66deb | 2004-07-14 21:04:27 +0000 | [diff] [blame] | 436 | |
| 437 | def getcontext(_local=local): |
| 438 | """Returns this thread's context. |
| 439 | |
| 440 | If this thread does not yet have a context, returns |
| 441 | a new context and sets this thread's context. |
| 442 | New contexts are copies of DefaultContext. |
| 443 | """ |
| 444 | try: |
| 445 | return _local.__decimal_context__ |
| 446 | except AttributeError: |
| 447 | context = Context() |
| 448 | _local.__decimal_context__ = context |
| 449 | return context |
| 450 | |
| 451 | def setcontext(context, _local=local): |
| 452 | """Set this thread's context to context.""" |
| 453 | if context in (DefaultContext, BasicContext, ExtendedContext): |
Raymond Hettinger | 9fce44b | 2004-08-08 04:03:24 +0000 | [diff] [blame] | 454 | context = context.copy() |
Raymond Hettinger | 61992ef | 2004-08-06 23:42:16 +0000 | [diff] [blame] | 455 | context.clear_flags() |
Raymond Hettinger | ef66deb | 2004-07-14 21:04:27 +0000 | [diff] [blame] | 456 | _local.__decimal_context__ = context |
| 457 | |
| 458 | del threading, local # Don't contaminate the namespace |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 459 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 460 | def localcontext(ctx=None): |
| 461 | """Return a context manager for a copy of the supplied context |
| 462 | |
| 463 | Uses a copy of the current context if no context is specified |
| 464 | The returned context manager creates a local decimal context |
| 465 | in a with statement: |
| 466 | def sin(x): |
| 467 | with localcontext() as ctx: |
| 468 | ctx.prec += 2 |
| 469 | # Rest of sin calculation algorithm |
| 470 | # uses a precision 2 greater than normal |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 471 | return +s # Convert result to normal precision |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 472 | |
| 473 | def sin(x): |
| 474 | with localcontext(ExtendedContext): |
| 475 | # Rest of sin calculation algorithm |
| 476 | # uses the Extended Context from the |
| 477 | # General Decimal Arithmetic Specification |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 478 | return +s # Convert result to normal context |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 479 | |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 480 | >>> setcontext(DefaultContext) |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 481 | >>> print(getcontext().prec) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 482 | 28 |
| 483 | >>> with localcontext(): |
| 484 | ... ctx = getcontext() |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 485 | ... ctx.prec += 2 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 486 | ... print(ctx.prec) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 487 | ... |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 488 | 30 |
| 489 | >>> with localcontext(ExtendedContext): |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 490 | ... print(getcontext().prec) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 491 | ... |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 492 | 9 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 493 | >>> print(getcontext().prec) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 494 | 28 |
| 495 | """ |
| 496 | if ctx is None: ctx = getcontext() |
| 497 | return _ContextManager(ctx) |
| 498 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 499 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 500 | ##### Decimal class ####################################################### |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 501 | |
Raymond Hettinger | a0fd888 | 2009-01-20 07:24:44 +0000 | [diff] [blame] | 502 | # Do not subclass Decimal from numbers.Real and do not register it as such |
| 503 | # (because Decimals are not interoperable with floats). See the notes in |
| 504 | # numbers.py for more detail. |
| 505 | |
| 506 | class Decimal(object): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 507 | """Floating point class for decimal arithmetic.""" |
| 508 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 509 | __slots__ = ('_exp','_int','_sign', '_is_special') |
| 510 | # Generally, the value of the Decimal instance is given by |
| 511 | # (-1)**_sign * _int * 10**_exp |
| 512 | # Special values are signified by _is_special == True |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 513 | |
Raymond Hettinger | dab988d | 2004-10-09 07:10:44 +0000 | [diff] [blame] | 514 | # We're immutable, so use __new__ not __init__ |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 515 | def __new__(cls, value="0", context=None): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 516 | """Create a decimal point instance. |
| 517 | |
| 518 | >>> Decimal('3.14') # string input |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 519 | Decimal('3.14') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 520 | >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 521 | Decimal('3.14') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 522 | >>> Decimal(314) # int |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 523 | Decimal('314') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 524 | >>> Decimal(Decimal(314)) # another decimal instance |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 525 | Decimal('314') |
Christian Heimes | a62da1d | 2008-01-12 19:39:10 +0000 | [diff] [blame] | 526 | >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 527 | Decimal('3.14') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 528 | """ |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 529 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 530 | # Note that the coefficient, self._int, is actually stored as |
| 531 | # a string rather than as a tuple of digits. This speeds up |
| 532 | # the "digits to integer" and "integer to digits" conversions |
| 533 | # that are used in almost every arithmetic operation on |
| 534 | # Decimals. This is an internal detail: the as_tuple function |
| 535 | # and the Decimal constructor still deal with tuples of |
| 536 | # digits. |
| 537 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 538 | self = object.__new__(cls) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 539 | |
Christian Heimes | d59c64c | 2007-11-30 19:27:20 +0000 | [diff] [blame] | 540 | # From a string |
| 541 | # REs insist on real strings, so we can too. |
| 542 | if isinstance(value, str): |
Christian Heimes | a62da1d | 2008-01-12 19:39:10 +0000 | [diff] [blame] | 543 | m = _parser(value.strip()) |
Christian Heimes | d59c64c | 2007-11-30 19:27:20 +0000 | [diff] [blame] | 544 | if m is None: |
| 545 | if context is None: |
| 546 | context = getcontext() |
| 547 | return context._raise_error(ConversionSyntax, |
| 548 | "Invalid literal for Decimal: %r" % value) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 549 | |
Christian Heimes | d59c64c | 2007-11-30 19:27:20 +0000 | [diff] [blame] | 550 | if m.group('sign') == "-": |
| 551 | self._sign = 1 |
| 552 | else: |
| 553 | self._sign = 0 |
| 554 | intpart = m.group('int') |
| 555 | if intpart is not None: |
| 556 | # finite number |
Mark Dickinson | 8d23829 | 2009-08-02 10:16:33 +0000 | [diff] [blame] | 557 | fracpart = m.group('frac') or '' |
Christian Heimes | d59c64c | 2007-11-30 19:27:20 +0000 | [diff] [blame] | 558 | exp = int(m.group('exp') or '0') |
Mark Dickinson | 8d23829 | 2009-08-02 10:16:33 +0000 | [diff] [blame] | 559 | self._int = str(int(intpart+fracpart)) |
| 560 | self._exp = exp - len(fracpart) |
Christian Heimes | d59c64c | 2007-11-30 19:27:20 +0000 | [diff] [blame] | 561 | self._is_special = False |
| 562 | else: |
| 563 | diag = m.group('diag') |
| 564 | if diag is not None: |
| 565 | # NaN |
Mark Dickinson | 8d23829 | 2009-08-02 10:16:33 +0000 | [diff] [blame] | 566 | self._int = str(int(diag or '0')).lstrip('0') |
Christian Heimes | d59c64c | 2007-11-30 19:27:20 +0000 | [diff] [blame] | 567 | if m.group('signal'): |
| 568 | self._exp = 'N' |
| 569 | else: |
| 570 | self._exp = 'n' |
| 571 | else: |
| 572 | # infinity |
| 573 | self._int = '0' |
| 574 | self._exp = 'F' |
| 575 | self._is_special = True |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 576 | return self |
| 577 | |
| 578 | # From an integer |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 579 | if isinstance(value, int): |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 580 | if value >= 0: |
| 581 | self._sign = 0 |
| 582 | else: |
| 583 | self._sign = 1 |
| 584 | self._exp = 0 |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 585 | self._int = str(abs(value)) |
Christian Heimes | d59c64c | 2007-11-30 19:27:20 +0000 | [diff] [blame] | 586 | self._is_special = False |
| 587 | return self |
| 588 | |
| 589 | # From another decimal |
| 590 | if isinstance(value, Decimal): |
| 591 | self._exp = value._exp |
| 592 | self._sign = value._sign |
| 593 | self._int = value._int |
| 594 | self._is_special = value._is_special |
| 595 | return self |
| 596 | |
| 597 | # From an internal working value |
| 598 | if isinstance(value, _WorkRep): |
| 599 | self._sign = value.sign |
| 600 | self._int = str(value.int) |
| 601 | self._exp = int(value.exp) |
| 602 | self._is_special = False |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 603 | return self |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 604 | |
| 605 | # tuple/list conversion (possibly from as_tuple()) |
| 606 | if isinstance(value, (list,tuple)): |
| 607 | if len(value) != 3: |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 608 | raise ValueError('Invalid tuple size in creation of Decimal ' |
| 609 | 'from list or tuple. The list or tuple ' |
| 610 | 'should have exactly three elements.') |
| 611 | # process sign. The isinstance test rejects floats |
| 612 | if not (isinstance(value[0], int) and value[0] in (0,1)): |
| 613 | raise ValueError("Invalid sign. The first value in the tuple " |
| 614 | "should be an integer; either 0 for a " |
| 615 | "positive number or 1 for a negative number.") |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 616 | self._sign = value[0] |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 617 | if value[2] == 'F': |
| 618 | # infinity: value[1] is ignored |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 619 | self._int = '0' |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 620 | self._exp = value[2] |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 621 | self._is_special = True |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 622 | else: |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 623 | # process and validate the digits in value[1] |
| 624 | digits = [] |
| 625 | for digit in value[1]: |
| 626 | if isinstance(digit, int) and 0 <= digit <= 9: |
| 627 | # skip leading zeros |
| 628 | if digits or digit != 0: |
| 629 | digits.append(digit) |
| 630 | else: |
| 631 | raise ValueError("The second value in the tuple must " |
| 632 | "be composed of integers in the range " |
| 633 | "0 through 9.") |
| 634 | if value[2] in ('n', 'N'): |
| 635 | # NaN: digits form the diagnostic |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 636 | self._int = ''.join(map(str, digits)) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 637 | self._exp = value[2] |
| 638 | self._is_special = True |
| 639 | elif isinstance(value[2], int): |
| 640 | # finite number: digits give the coefficient |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 641 | self._int = ''.join(map(str, digits or [0])) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 642 | self._exp = value[2] |
| 643 | self._is_special = False |
| 644 | else: |
| 645 | raise ValueError("The third value in the tuple must " |
| 646 | "be an integer, or one of the " |
| 647 | "strings 'F', 'n', 'N'.") |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 648 | return self |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 649 | |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 650 | if isinstance(value, float): |
| 651 | raise TypeError("Cannot convert float to Decimal. " + |
| 652 | "First convert the float to a string") |
| 653 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 654 | raise TypeError("Cannot convert %r to Decimal" % value) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 655 | |
Mark Dickinson | ba298e4 | 2009-01-04 21:17:43 +0000 | [diff] [blame] | 656 | # @classmethod, but @decorator is not valid Python 2.3 syntax, so |
| 657 | # don't use it (see notes on Py2.3 compatibility at top of file) |
Raymond Hettinger | 771ed76 | 2009-01-03 19:20:32 +0000 | [diff] [blame] | 658 | def from_float(cls, f): |
| 659 | """Converts a float to a decimal number, exactly. |
| 660 | |
| 661 | Note that Decimal.from_float(0.1) is not the same as Decimal('0.1'). |
| 662 | Since 0.1 is not exactly representable in binary floating point, the |
| 663 | value is stored as the nearest representable value which is |
| 664 | 0x1.999999999999ap-4. The exact equivalent of the value in decimal |
| 665 | is 0.1000000000000000055511151231257827021181583404541015625. |
| 666 | |
| 667 | >>> Decimal.from_float(0.1) |
| 668 | Decimal('0.1000000000000000055511151231257827021181583404541015625') |
| 669 | >>> Decimal.from_float(float('nan')) |
| 670 | Decimal('NaN') |
| 671 | >>> Decimal.from_float(float('inf')) |
| 672 | Decimal('Infinity') |
| 673 | >>> Decimal.from_float(-float('inf')) |
| 674 | Decimal('-Infinity') |
| 675 | >>> Decimal.from_float(-0.0) |
| 676 | Decimal('-0') |
| 677 | |
| 678 | """ |
| 679 | if isinstance(f, int): # handle integer inputs |
| 680 | return cls(f) |
| 681 | if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float |
| 682 | return cls(repr(f)) |
Mark Dickinson | ba298e4 | 2009-01-04 21:17:43 +0000 | [diff] [blame] | 683 | if _math.copysign(1.0, f) == 1.0: |
| 684 | sign = 0 |
| 685 | else: |
| 686 | sign = 1 |
Raymond Hettinger | 771ed76 | 2009-01-03 19:20:32 +0000 | [diff] [blame] | 687 | n, d = abs(f).as_integer_ratio() |
| 688 | k = d.bit_length() - 1 |
| 689 | result = _dec_from_triple(sign, str(n*5**k), -k) |
Mark Dickinson | ba298e4 | 2009-01-04 21:17:43 +0000 | [diff] [blame] | 690 | if cls is Decimal: |
| 691 | return result |
| 692 | else: |
| 693 | return cls(result) |
| 694 | from_float = classmethod(from_float) |
Raymond Hettinger | 771ed76 | 2009-01-03 19:20:32 +0000 | [diff] [blame] | 695 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 696 | def _isnan(self): |
| 697 | """Returns whether the number is not actually one. |
| 698 | |
| 699 | 0 if a number |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 700 | 1 if NaN |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 701 | 2 if sNaN |
| 702 | """ |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 703 | if self._is_special: |
| 704 | exp = self._exp |
| 705 | if exp == 'n': |
| 706 | return 1 |
| 707 | elif exp == 'N': |
| 708 | return 2 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 709 | return 0 |
| 710 | |
| 711 | def _isinfinity(self): |
| 712 | """Returns whether the number is infinite |
| 713 | |
| 714 | 0 if finite or not a number |
| 715 | 1 if +INF |
| 716 | -1 if -INF |
| 717 | """ |
| 718 | if self._exp == 'F': |
| 719 | if self._sign: |
| 720 | return -1 |
| 721 | return 1 |
| 722 | return 0 |
| 723 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 724 | def _check_nans(self, other=None, context=None): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 725 | """Returns whether the number is not actually one. |
| 726 | |
| 727 | if self, other are sNaN, signal |
| 728 | if self, other are NaN return nan |
| 729 | return 0 |
| 730 | |
| 731 | Done before operations. |
| 732 | """ |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 733 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 734 | self_is_nan = self._isnan() |
| 735 | if other is None: |
| 736 | other_is_nan = False |
| 737 | else: |
| 738 | other_is_nan = other._isnan() |
| 739 | |
| 740 | if self_is_nan or other_is_nan: |
| 741 | if context is None: |
| 742 | context = getcontext() |
| 743 | |
| 744 | if self_is_nan == 2: |
| 745 | return context._raise_error(InvalidOperation, 'sNaN', |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 746 | self) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 747 | if other_is_nan == 2: |
| 748 | return context._raise_error(InvalidOperation, 'sNaN', |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 749 | other) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 750 | if self_is_nan: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 751 | return self._fix_nan(context) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 752 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 753 | return other._fix_nan(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 754 | return 0 |
| 755 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 756 | def _compare_check_nans(self, other, context): |
| 757 | """Version of _check_nans used for the signaling comparisons |
| 758 | compare_signal, __le__, __lt__, __ge__, __gt__. |
| 759 | |
| 760 | Signal InvalidOperation if either self or other is a (quiet |
| 761 | or signaling) NaN. Signaling NaNs take precedence over quiet |
| 762 | NaNs. |
| 763 | |
| 764 | Return 0 if neither operand is a NaN. |
| 765 | |
| 766 | """ |
| 767 | if context is None: |
| 768 | context = getcontext() |
| 769 | |
| 770 | if self._is_special or other._is_special: |
| 771 | if self.is_snan(): |
| 772 | return context._raise_error(InvalidOperation, |
| 773 | 'comparison involving sNaN', |
| 774 | self) |
| 775 | elif other.is_snan(): |
| 776 | return context._raise_error(InvalidOperation, |
| 777 | 'comparison involving sNaN', |
| 778 | other) |
| 779 | elif self.is_qnan(): |
| 780 | return context._raise_error(InvalidOperation, |
| 781 | 'comparison involving NaN', |
| 782 | self) |
| 783 | elif other.is_qnan(): |
| 784 | return context._raise_error(InvalidOperation, |
| 785 | 'comparison involving NaN', |
| 786 | other) |
| 787 | return 0 |
| 788 | |
Jack Diederich | 4dafcc4 | 2006-11-28 19:15:13 +0000 | [diff] [blame] | 789 | def __bool__(self): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 790 | """Return True if self is nonzero; otherwise return False. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 791 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 792 | NaNs and infinities are considered nonzero. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 793 | """ |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 794 | return self._is_special or self._int != '0' |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 795 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 796 | def _cmp(self, other): |
| 797 | """Compare the two non-NaN decimal instances self and other. |
| 798 | |
| 799 | Returns -1 if self < other, 0 if self == other and 1 |
| 800 | if self > other. This routine is for internal use only.""" |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 801 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 802 | if self._is_special or other._is_special: |
Mark Dickinson | e6aad75 | 2009-01-25 10:48:51 +0000 | [diff] [blame] | 803 | self_inf = self._isinfinity() |
| 804 | other_inf = other._isinfinity() |
| 805 | if self_inf == other_inf: |
| 806 | return 0 |
| 807 | elif self_inf < other_inf: |
| 808 | return -1 |
| 809 | else: |
| 810 | return 1 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 811 | |
Mark Dickinson | e6aad75 | 2009-01-25 10:48:51 +0000 | [diff] [blame] | 812 | # check for zeros; Decimal('0') == Decimal('-0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 813 | if not self: |
| 814 | if not other: |
| 815 | return 0 |
| 816 | else: |
| 817 | return -((-1)**other._sign) |
| 818 | if not other: |
| 819 | return (-1)**self._sign |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 820 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 821 | # If different signs, neg one is less |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 822 | if other._sign < self._sign: |
| 823 | return -1 |
| 824 | if self._sign < other._sign: |
| 825 | return 1 |
| 826 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 827 | self_adjusted = self.adjusted() |
| 828 | other_adjusted = other.adjusted() |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 829 | if self_adjusted == other_adjusted: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 830 | self_padded = self._int + '0'*(self._exp - other._exp) |
| 831 | other_padded = other._int + '0'*(other._exp - self._exp) |
Mark Dickinson | e6aad75 | 2009-01-25 10:48:51 +0000 | [diff] [blame] | 832 | if self_padded == other_padded: |
| 833 | return 0 |
| 834 | elif self_padded < other_padded: |
| 835 | return -(-1)**self._sign |
| 836 | else: |
| 837 | return (-1)**self._sign |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 838 | elif self_adjusted > other_adjusted: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 839 | return (-1)**self._sign |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 840 | else: # self_adjusted < other_adjusted |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 841 | return -((-1)**self._sign) |
| 842 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 843 | # Note: The Decimal standard doesn't cover rich comparisons for |
| 844 | # Decimals. In particular, the specification is silent on the |
| 845 | # subject of what should happen for a comparison involving a NaN. |
| 846 | # We take the following approach: |
| 847 | # |
| 848 | # == comparisons involving a NaN always return False |
| 849 | # != comparisons involving a NaN always return True |
| 850 | # <, >, <= and >= comparisons involving a (quiet or signaling) |
| 851 | # NaN signal InvalidOperation, and return False if the |
Christian Heimes | 3feef61 | 2008-02-11 06:19:17 +0000 | [diff] [blame] | 852 | # InvalidOperation is not trapped. |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 853 | # |
| 854 | # This behavior is designed to conform as closely as possible to |
| 855 | # that specified by IEEE 754. |
| 856 | |
Raymond Hettinger | 0aeac10 | 2004-07-05 22:53:03 +0000 | [diff] [blame] | 857 | def __eq__(self, other): |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 858 | other = _convert_other(other) |
| 859 | if other is NotImplemented: |
| 860 | return other |
| 861 | if self.is_nan() or other.is_nan(): |
| 862 | return False |
| 863 | return self._cmp(other) == 0 |
Raymond Hettinger | 0aeac10 | 2004-07-05 22:53:03 +0000 | [diff] [blame] | 864 | |
| 865 | def __ne__(self, other): |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 866 | other = _convert_other(other) |
| 867 | if other is NotImplemented: |
| 868 | return other |
| 869 | if self.is_nan() or other.is_nan(): |
| 870 | return True |
| 871 | return self._cmp(other) != 0 |
Raymond Hettinger | 0aeac10 | 2004-07-05 22:53:03 +0000 | [diff] [blame] | 872 | |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 873 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 874 | def __lt__(self, other, context=None): |
| 875 | other = _convert_other(other) |
| 876 | if other is NotImplemented: |
| 877 | return other |
| 878 | ans = self._compare_check_nans(other, context) |
| 879 | if ans: |
| 880 | return False |
| 881 | return self._cmp(other) < 0 |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 882 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 883 | def __le__(self, other, context=None): |
| 884 | other = _convert_other(other) |
| 885 | if other is NotImplemented: |
| 886 | return other |
| 887 | ans = self._compare_check_nans(other, context) |
| 888 | if ans: |
| 889 | return False |
| 890 | return self._cmp(other) <= 0 |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 891 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 892 | def __gt__(self, other, context=None): |
| 893 | other = _convert_other(other) |
| 894 | if other is NotImplemented: |
| 895 | return other |
| 896 | ans = self._compare_check_nans(other, context) |
| 897 | if ans: |
| 898 | return False |
| 899 | return self._cmp(other) > 0 |
| 900 | |
| 901 | def __ge__(self, other, context=None): |
| 902 | other = _convert_other(other) |
| 903 | if other is NotImplemented: |
| 904 | return other |
| 905 | ans = self._compare_check_nans(other, context) |
| 906 | if ans: |
| 907 | return False |
| 908 | return self._cmp(other) >= 0 |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 909 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 910 | def compare(self, other, context=None): |
| 911 | """Compares one to another. |
| 912 | |
| 913 | -1 => a < b |
| 914 | 0 => a = b |
| 915 | 1 => a > b |
| 916 | NaN => one is NaN |
| 917 | Like __cmp__, but returns Decimal instances. |
| 918 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 919 | other = _convert_other(other, raiseit=True) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 920 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 921 | # Compare(NaN, NaN) = NaN |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 922 | if (self._is_special or other and other._is_special): |
| 923 | ans = self._check_nans(other, context) |
| 924 | if ans: |
| 925 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 926 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 927 | return Decimal(self._cmp(other)) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 928 | |
| 929 | def __hash__(self): |
| 930 | """x.__hash__() <==> hash(x)""" |
| 931 | # Decimal integers must hash the same as the ints |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 932 | # |
| 933 | # The hash of a nonspecial noninteger Decimal must depend only |
| 934 | # on the value of that Decimal, and not on its representation. |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 935 | # For example: hash(Decimal('100E-1')) == hash(Decimal('10')). |
Raymond Hettinger | bea3f6f | 2005-03-15 04:59:17 +0000 | [diff] [blame] | 936 | if self._is_special: |
| 937 | if self._isnan(): |
| 938 | raise TypeError('Cannot hash a NaN value.') |
| 939 | return hash(str(self)) |
Thomas Wouters | 8ce81f7 | 2007-09-20 18:22:40 +0000 | [diff] [blame] | 940 | if not self: |
| 941 | return 0 |
| 942 | if self._isinteger(): |
| 943 | op = _WorkRep(self.to_integral_value()) |
| 944 | # to make computation feasible for Decimals with large |
| 945 | # exponent, we use the fact that hash(n) == hash(m) for |
| 946 | # any two nonzero integers n and m such that (i) n and m |
| 947 | # have the same sign, and (ii) n is congruent to m modulo |
| 948 | # 2**64-1. So we can replace hash((-1)**s*c*10**e) with |
| 949 | # hash((-1)**s*c*pow(10, e, 2**64-1). |
| 950 | return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1)) |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 951 | # The value of a nonzero nonspecial Decimal instance is |
| 952 | # faithfully represented by the triple consisting of its sign, |
| 953 | # its adjusted exponent, and its coefficient with trailing |
| 954 | # zeros removed. |
| 955 | return hash((self._sign, |
| 956 | self._exp+len(self._int), |
| 957 | self._int.rstrip('0'))) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 958 | |
| 959 | def as_tuple(self): |
| 960 | """Represents the number as a triple tuple. |
| 961 | |
| 962 | To show the internals exactly as they are. |
| 963 | """ |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 964 | return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 965 | |
| 966 | def __repr__(self): |
| 967 | """Represents the number as an instance of Decimal.""" |
| 968 | # Invariant: eval(repr(d)) == d |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 969 | return "Decimal('%s')" % str(self) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 970 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 971 | def __str__(self, eng=False, context=None): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 972 | """Return string representation of the number in scientific notation. |
| 973 | |
| 974 | Captures all of the information in the underlying representation. |
| 975 | """ |
| 976 | |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 977 | sign = ['', '-'][self._sign] |
Raymond Hettinger | e5a0a96 | 2005-06-20 09:49:42 +0000 | [diff] [blame] | 978 | if self._is_special: |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 979 | if self._exp == 'F': |
| 980 | return sign + 'Infinity' |
| 981 | elif self._exp == 'n': |
| 982 | return sign + 'NaN' + self._int |
| 983 | else: # self._exp == 'N' |
| 984 | return sign + 'sNaN' + self._int |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 985 | |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 986 | # number of digits of self._int to left of decimal point |
| 987 | leftdigits = self._exp + len(self._int) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 988 | |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 989 | # dotplace is number of digits of self._int to the left of the |
| 990 | # decimal point in the mantissa of the output string (that is, |
| 991 | # after adjusting the exponent) |
| 992 | if self._exp <= 0 and leftdigits > -6: |
| 993 | # no exponent required |
| 994 | dotplace = leftdigits |
| 995 | elif not eng: |
| 996 | # usual scientific notation: 1 digit on left of the point |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 997 | dotplace = 1 |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 998 | elif self._int == '0': |
| 999 | # engineering notation, zero |
| 1000 | dotplace = (leftdigits + 1) % 3 - 1 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1001 | else: |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1002 | # engineering notation, nonzero |
| 1003 | dotplace = (leftdigits - 1) % 3 + 1 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1004 | |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1005 | if dotplace <= 0: |
| 1006 | intpart = '0' |
| 1007 | fracpart = '.' + '0'*(-dotplace) + self._int |
| 1008 | elif dotplace >= len(self._int): |
| 1009 | intpart = self._int+'0'*(dotplace-len(self._int)) |
| 1010 | fracpart = '' |
| 1011 | else: |
| 1012 | intpart = self._int[:dotplace] |
| 1013 | fracpart = '.' + self._int[dotplace:] |
| 1014 | if leftdigits == dotplace: |
| 1015 | exp = '' |
| 1016 | else: |
| 1017 | if context is None: |
| 1018 | context = getcontext() |
| 1019 | exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace) |
| 1020 | |
| 1021 | return sign + intpart + fracpart + exp |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1022 | |
| 1023 | def to_eng_string(self, context=None): |
| 1024 | """Convert to engineering-type string. |
| 1025 | |
| 1026 | Engineering notation has an exponent which is a multiple of 3, so there |
| 1027 | are up to 3 digits left of the decimal place. |
| 1028 | |
| 1029 | Same rules for when in exponential and when as a value as in __str__. |
| 1030 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1031 | return self.__str__(eng=True, context=context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1032 | |
| 1033 | def __neg__(self, context=None): |
| 1034 | """Returns a copy with the sign switched. |
| 1035 | |
| 1036 | Rounds, if it has reason. |
| 1037 | """ |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1038 | if self._is_special: |
| 1039 | ans = self._check_nans(context=context) |
| 1040 | if ans: |
| 1041 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1042 | |
| 1043 | if not self: |
| 1044 | # -Decimal('0') is Decimal('0'), not Decimal('-0') |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 1045 | ans = self.copy_abs() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1046 | else: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1047 | ans = self.copy_negate() |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1048 | |
| 1049 | if context is None: |
| 1050 | context = getcontext() |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1051 | return ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1052 | |
| 1053 | def __pos__(self, context=None): |
| 1054 | """Returns a copy, unless it is a sNaN. |
| 1055 | |
| 1056 | Rounds the number (if more then precision digits) |
| 1057 | """ |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1058 | if self._is_special: |
| 1059 | ans = self._check_nans(context=context) |
| 1060 | if ans: |
| 1061 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1062 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1063 | if not self: |
| 1064 | # + (-0) = 0 |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 1065 | ans = self.copy_abs() |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1066 | else: |
| 1067 | ans = Decimal(self) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1068 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1069 | if context is None: |
| 1070 | context = getcontext() |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1071 | return ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1072 | |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1073 | def __abs__(self, round=True, context=None): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1074 | """Returns the absolute value of self. |
| 1075 | |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1076 | If the keyword argument 'round' is false, do not round. The |
| 1077 | expression self.__abs__(round=False) is equivalent to |
| 1078 | self.copy_abs(). |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1079 | """ |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1080 | if not round: |
| 1081 | return self.copy_abs() |
| 1082 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1083 | if self._is_special: |
| 1084 | ans = self._check_nans(context=context) |
| 1085 | if ans: |
| 1086 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1087 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1088 | if self._sign: |
| 1089 | ans = self.__neg__(context=context) |
| 1090 | else: |
| 1091 | ans = self.__pos__(context=context) |
| 1092 | |
| 1093 | return ans |
| 1094 | |
| 1095 | def __add__(self, other, context=None): |
| 1096 | """Returns self + other. |
| 1097 | |
| 1098 | -INF + INF (or the reverse) cause InvalidOperation errors. |
| 1099 | """ |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1100 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1101 | if other is NotImplemented: |
| 1102 | return other |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1103 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1104 | if context is None: |
| 1105 | context = getcontext() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1106 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1107 | if self._is_special or other._is_special: |
| 1108 | ans = self._check_nans(other, context) |
| 1109 | if ans: |
| 1110 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1111 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1112 | if self._isinfinity(): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1113 | # If both INF, same sign => same as both, opposite => error. |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1114 | if self._sign != other._sign and other._isinfinity(): |
| 1115 | return context._raise_error(InvalidOperation, '-INF + INF') |
| 1116 | return Decimal(self) |
| 1117 | if other._isinfinity(): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1118 | return Decimal(other) # Can't both be infinity here |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1119 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1120 | exp = min(self._exp, other._exp) |
| 1121 | negativezero = 0 |
| 1122 | if context.rounding == ROUND_FLOOR and self._sign != other._sign: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1123 | # If the answer is 0, the sign should be negative, in this case. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1124 | negativezero = 1 |
| 1125 | |
| 1126 | if not self and not other: |
| 1127 | sign = min(self._sign, other._sign) |
| 1128 | if negativezero: |
| 1129 | sign = 1 |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1130 | ans = _dec_from_triple(sign, '0', exp) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1131 | ans = ans._fix(context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1132 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1133 | if not self: |
Facundo Batista | 99b5548 | 2004-10-26 23:38:46 +0000 | [diff] [blame] | 1134 | exp = max(exp, other._exp - context.prec-1) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1135 | ans = other._rescale(exp, context.rounding) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1136 | ans = ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1137 | return ans |
| 1138 | if not other: |
Facundo Batista | 99b5548 | 2004-10-26 23:38:46 +0000 | [diff] [blame] | 1139 | exp = max(exp, self._exp - context.prec-1) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1140 | ans = self._rescale(exp, context.rounding) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1141 | ans = ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1142 | return ans |
| 1143 | |
| 1144 | op1 = _WorkRep(self) |
| 1145 | op2 = _WorkRep(other) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1146 | op1, op2 = _normalize(op1, op2, context.prec) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1147 | |
| 1148 | result = _WorkRep() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1149 | if op1.sign != op2.sign: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1150 | # Equal and opposite |
Raymond Hettinger | 17931de | 2004-10-27 06:21:46 +0000 | [diff] [blame] | 1151 | if op1.int == op2.int: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1152 | ans = _dec_from_triple(negativezero, '0', exp) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1153 | ans = ans._fix(context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1154 | return ans |
Raymond Hettinger | 17931de | 2004-10-27 06:21:46 +0000 | [diff] [blame] | 1155 | if op1.int < op2.int: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1156 | op1, op2 = op2, op1 |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1157 | # OK, now abs(op1) > abs(op2) |
Raymond Hettinger | 17931de | 2004-10-27 06:21:46 +0000 | [diff] [blame] | 1158 | if op1.sign == 1: |
| 1159 | result.sign = 1 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1160 | op1.sign, op2.sign = op2.sign, op1.sign |
| 1161 | else: |
Raymond Hettinger | 17931de | 2004-10-27 06:21:46 +0000 | [diff] [blame] | 1162 | result.sign = 0 |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1163 | # So we know the sign, and op1 > 0. |
Raymond Hettinger | 17931de | 2004-10-27 06:21:46 +0000 | [diff] [blame] | 1164 | elif op1.sign == 1: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1165 | result.sign = 1 |
Raymond Hettinger | 17931de | 2004-10-27 06:21:46 +0000 | [diff] [blame] | 1166 | op1.sign, op2.sign = (0, 0) |
| 1167 | else: |
| 1168 | result.sign = 0 |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1169 | # Now, op1 > abs(op2) > 0 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1170 | |
Raymond Hettinger | 17931de | 2004-10-27 06:21:46 +0000 | [diff] [blame] | 1171 | if op2.sign == 0: |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1172 | result.int = op1.int + op2.int |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1173 | else: |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1174 | result.int = op1.int - op2.int |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1175 | |
| 1176 | result.exp = op1.exp |
| 1177 | ans = Decimal(result) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1178 | ans = ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1179 | return ans |
| 1180 | |
| 1181 | __radd__ = __add__ |
| 1182 | |
| 1183 | def __sub__(self, other, context=None): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1184 | """Return self - other""" |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1185 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1186 | if other is NotImplemented: |
| 1187 | return other |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1188 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1189 | if self._is_special or other._is_special: |
| 1190 | ans = self._check_nans(other, context=context) |
| 1191 | if ans: |
| 1192 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1193 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1194 | # self - other is computed as self + other.copy_negate() |
| 1195 | return self.__add__(other.copy_negate(), context=context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1196 | |
| 1197 | def __rsub__(self, other, context=None): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1198 | """Return other - self""" |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1199 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1200 | if other is NotImplemented: |
| 1201 | return other |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1202 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1203 | return other.__sub__(self, context=context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1204 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1205 | def __mul__(self, other, context=None): |
| 1206 | """Return self * other. |
| 1207 | |
| 1208 | (+-) INF * 0 (or its reverse) raise InvalidOperation. |
| 1209 | """ |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1210 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1211 | if other is NotImplemented: |
| 1212 | return other |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1213 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1214 | if context is None: |
| 1215 | context = getcontext() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1216 | |
Raymond Hettinger | d87ac8f | 2004-07-09 10:52:54 +0000 | [diff] [blame] | 1217 | resultsign = self._sign ^ other._sign |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1218 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1219 | if self._is_special or other._is_special: |
| 1220 | ans = self._check_nans(other, context) |
| 1221 | if ans: |
| 1222 | return ans |
| 1223 | |
| 1224 | if self._isinfinity(): |
| 1225 | if not other: |
| 1226 | return context._raise_error(InvalidOperation, '(+-)INF * 0') |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 1227 | return _SignedInfinity[resultsign] |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1228 | |
| 1229 | if other._isinfinity(): |
| 1230 | if not self: |
| 1231 | return context._raise_error(InvalidOperation, '0 * (+-)INF') |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 1232 | return _SignedInfinity[resultsign] |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1233 | |
| 1234 | resultexp = self._exp + other._exp |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1235 | |
| 1236 | # Special case for multiplying by zero |
| 1237 | if not self or not other: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1238 | ans = _dec_from_triple(resultsign, '0', resultexp) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1239 | # Fixing in case the exponent is out of bounds |
| 1240 | ans = ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1241 | return ans |
| 1242 | |
| 1243 | # Special case for multiplying by power of 10 |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1244 | if self._int == '1': |
| 1245 | ans = _dec_from_triple(resultsign, other._int, resultexp) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1246 | ans = ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1247 | return ans |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1248 | if other._int == '1': |
| 1249 | ans = _dec_from_triple(resultsign, self._int, resultexp) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1250 | ans = ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1251 | return ans |
| 1252 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1253 | op1 = _WorkRep(self) |
| 1254 | op2 = _WorkRep(other) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1255 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1256 | ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1257 | ans = ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1258 | |
| 1259 | return ans |
| 1260 | __rmul__ = __mul__ |
| 1261 | |
Neal Norwitz | bcc0db8 | 2006-03-24 08:14:36 +0000 | [diff] [blame] | 1262 | def __truediv__(self, other, context=None): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1263 | """Return self / other.""" |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1264 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1265 | if other is NotImplemented: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1266 | return NotImplemented |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1267 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1268 | if context is None: |
| 1269 | context = getcontext() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1270 | |
Raymond Hettinger | d87ac8f | 2004-07-09 10:52:54 +0000 | [diff] [blame] | 1271 | sign = self._sign ^ other._sign |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1272 | |
| 1273 | if self._is_special or other._is_special: |
| 1274 | ans = self._check_nans(other, context) |
| 1275 | if ans: |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1276 | return ans |
| 1277 | |
| 1278 | if self._isinfinity() and other._isinfinity(): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1279 | return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1280 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1281 | if self._isinfinity(): |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 1282 | return _SignedInfinity[sign] |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1283 | |
| 1284 | if other._isinfinity(): |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1285 | context._raise_error(Clamped, 'Division by infinity') |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1286 | return _dec_from_triple(sign, '0', context.Etiny()) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1287 | |
| 1288 | # Special cases for zeroes |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1289 | if not other: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1290 | if not self: |
| 1291 | return context._raise_error(DivisionUndefined, '0 / 0') |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1292 | return context._raise_error(DivisionByZero, 'x / 0', sign) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1293 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1294 | if not self: |
| 1295 | exp = self._exp - other._exp |
| 1296 | coeff = 0 |
| 1297 | else: |
| 1298 | # OK, so neither = 0, INF or NaN |
| 1299 | shift = len(other._int) - len(self._int) + context.prec + 1 |
| 1300 | exp = self._exp - other._exp - shift |
| 1301 | op1 = _WorkRep(self) |
| 1302 | op2 = _WorkRep(other) |
| 1303 | if shift >= 0: |
| 1304 | coeff, remainder = divmod(op1.int * 10**shift, op2.int) |
| 1305 | else: |
| 1306 | coeff, remainder = divmod(op1.int, op2.int * 10**-shift) |
| 1307 | if remainder: |
| 1308 | # result is not exact; adjust to ensure correct rounding |
| 1309 | if coeff % 5 == 0: |
| 1310 | coeff += 1 |
| 1311 | else: |
| 1312 | # result is exact; get as close to ideal exponent as possible |
| 1313 | ideal_exp = self._exp - other._exp |
| 1314 | while exp < ideal_exp and coeff % 10 == 0: |
| 1315 | coeff //= 10 |
| 1316 | exp += 1 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1317 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1318 | ans = _dec_from_triple(sign, str(coeff), exp) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1319 | return ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1320 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1321 | def _divide(self, other, context): |
| 1322 | """Return (self // other, self % other), to context.prec precision. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1323 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1324 | Assumes that neither self nor other is a NaN, that self is not |
| 1325 | infinite and that other is nonzero. |
| 1326 | """ |
| 1327 | sign = self._sign ^ other._sign |
| 1328 | if other._isinfinity(): |
| 1329 | ideal_exp = self._exp |
| 1330 | else: |
| 1331 | ideal_exp = min(self._exp, other._exp) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1332 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1333 | expdiff = self.adjusted() - other.adjusted() |
| 1334 | if not self or other._isinfinity() or expdiff <= -2: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1335 | return (_dec_from_triple(sign, '0', 0), |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1336 | self._rescale(ideal_exp, context.rounding)) |
| 1337 | if expdiff <= context.prec: |
| 1338 | op1 = _WorkRep(self) |
| 1339 | op2 = _WorkRep(other) |
| 1340 | if op1.exp >= op2.exp: |
| 1341 | op1.int *= 10**(op1.exp - op2.exp) |
| 1342 | else: |
| 1343 | op2.int *= 10**(op2.exp - op1.exp) |
| 1344 | q, r = divmod(op1.int, op2.int) |
| 1345 | if q < 10**context.prec: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1346 | return (_dec_from_triple(sign, str(q), 0), |
| 1347 | _dec_from_triple(self._sign, str(r), ideal_exp)) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1348 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1349 | # Here the quotient is too large to be representable |
| 1350 | ans = context._raise_error(DivisionImpossible, |
| 1351 | 'quotient too large in //, % or divmod') |
| 1352 | return ans, ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1353 | |
Neal Norwitz | bcc0db8 | 2006-03-24 08:14:36 +0000 | [diff] [blame] | 1354 | def __rtruediv__(self, other, context=None): |
| 1355 | """Swaps self/other and returns __truediv__.""" |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1356 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1357 | if other is NotImplemented: |
| 1358 | return other |
Neal Norwitz | bcc0db8 | 2006-03-24 08:14:36 +0000 | [diff] [blame] | 1359 | return other.__truediv__(self, context=context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1360 | |
| 1361 | def __divmod__(self, other, context=None): |
| 1362 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1363 | Return (self // other, self % other) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1364 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1365 | other = _convert_other(other) |
| 1366 | if other is NotImplemented: |
| 1367 | return other |
| 1368 | |
| 1369 | if context is None: |
| 1370 | context = getcontext() |
| 1371 | |
| 1372 | ans = self._check_nans(other, context) |
| 1373 | if ans: |
| 1374 | return (ans, ans) |
| 1375 | |
| 1376 | sign = self._sign ^ other._sign |
| 1377 | if self._isinfinity(): |
| 1378 | if other._isinfinity(): |
| 1379 | ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)') |
| 1380 | return ans, ans |
| 1381 | else: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 1382 | return (_SignedInfinity[sign], |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1383 | context._raise_error(InvalidOperation, 'INF % x')) |
| 1384 | |
| 1385 | if not other: |
| 1386 | if not self: |
| 1387 | ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)') |
| 1388 | return ans, ans |
| 1389 | else: |
| 1390 | return (context._raise_error(DivisionByZero, 'x // 0', sign), |
| 1391 | context._raise_error(InvalidOperation, 'x % 0')) |
| 1392 | |
| 1393 | quotient, remainder = self._divide(other, context) |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1394 | remainder = remainder._fix(context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1395 | return quotient, remainder |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1396 | |
| 1397 | def __rdivmod__(self, other, context=None): |
| 1398 | """Swaps self/other and returns __divmod__.""" |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1399 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1400 | if other is NotImplemented: |
| 1401 | return other |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1402 | return other.__divmod__(self, context=context) |
| 1403 | |
| 1404 | def __mod__(self, other, context=None): |
| 1405 | """ |
| 1406 | self % other |
| 1407 | """ |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1408 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1409 | if other is NotImplemented: |
| 1410 | return other |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1411 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1412 | if context is None: |
| 1413 | context = getcontext() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1414 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1415 | ans = self._check_nans(other, context) |
| 1416 | if ans: |
| 1417 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1418 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1419 | if self._isinfinity(): |
| 1420 | return context._raise_error(InvalidOperation, 'INF % x') |
| 1421 | elif not other: |
| 1422 | if self: |
| 1423 | return context._raise_error(InvalidOperation, 'x % 0') |
| 1424 | else: |
| 1425 | return context._raise_error(DivisionUndefined, '0 % 0') |
| 1426 | |
| 1427 | remainder = self._divide(other, context)[1] |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 1428 | remainder = remainder._fix(context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1429 | return remainder |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1430 | |
| 1431 | def __rmod__(self, other, context=None): |
| 1432 | """Swaps self/other and returns __mod__.""" |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1433 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1434 | if other is NotImplemented: |
| 1435 | return other |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1436 | return other.__mod__(self, context=context) |
| 1437 | |
| 1438 | def remainder_near(self, other, context=None): |
| 1439 | """ |
| 1440 | Remainder nearest to 0- abs(remainder-near) <= other/2 |
| 1441 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1442 | if context is None: |
| 1443 | context = getcontext() |
| 1444 | |
| 1445 | other = _convert_other(other, raiseit=True) |
| 1446 | |
| 1447 | ans = self._check_nans(other, context) |
| 1448 | if ans: |
| 1449 | return ans |
| 1450 | |
| 1451 | # self == +/-infinity -> InvalidOperation |
| 1452 | if self._isinfinity(): |
| 1453 | return context._raise_error(InvalidOperation, |
| 1454 | 'remainder_near(infinity, x)') |
| 1455 | |
| 1456 | # other == 0 -> either InvalidOperation or DivisionUndefined |
| 1457 | if not other: |
| 1458 | if self: |
| 1459 | return context._raise_error(InvalidOperation, |
| 1460 | 'remainder_near(x, 0)') |
| 1461 | else: |
| 1462 | return context._raise_error(DivisionUndefined, |
| 1463 | 'remainder_near(0, 0)') |
| 1464 | |
| 1465 | # other = +/-infinity -> remainder = self |
| 1466 | if other._isinfinity(): |
| 1467 | ans = Decimal(self) |
| 1468 | return ans._fix(context) |
| 1469 | |
| 1470 | # self = 0 -> remainder = self, with ideal exponent |
| 1471 | ideal_exponent = min(self._exp, other._exp) |
| 1472 | if not self: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1473 | ans = _dec_from_triple(self._sign, '0', ideal_exponent) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1474 | return ans._fix(context) |
| 1475 | |
| 1476 | # catch most cases of large or small quotient |
| 1477 | expdiff = self.adjusted() - other.adjusted() |
| 1478 | if expdiff >= context.prec + 1: |
| 1479 | # expdiff >= prec+1 => abs(self/other) > 10**prec |
| 1480 | return context._raise_error(DivisionImpossible) |
| 1481 | if expdiff <= -2: |
| 1482 | # expdiff <= -2 => abs(self/other) < 0.1 |
| 1483 | ans = self._rescale(ideal_exponent, context.rounding) |
| 1484 | return ans._fix(context) |
| 1485 | |
| 1486 | # adjust both arguments to have the same exponent, then divide |
| 1487 | op1 = _WorkRep(self) |
| 1488 | op2 = _WorkRep(other) |
| 1489 | if op1.exp >= op2.exp: |
| 1490 | op1.int *= 10**(op1.exp - op2.exp) |
| 1491 | else: |
| 1492 | op2.int *= 10**(op2.exp - op1.exp) |
| 1493 | q, r = divmod(op1.int, op2.int) |
| 1494 | # remainder is r*10**ideal_exponent; other is +/-op2.int * |
| 1495 | # 10**ideal_exponent. Apply correction to ensure that |
| 1496 | # abs(remainder) <= abs(other)/2 |
| 1497 | if 2*r + (q&1) > op2.int: |
| 1498 | r -= op2.int |
| 1499 | q += 1 |
| 1500 | |
| 1501 | if q >= 10**context.prec: |
| 1502 | return context._raise_error(DivisionImpossible) |
| 1503 | |
| 1504 | # result has same sign as self unless r is negative |
| 1505 | sign = self._sign |
| 1506 | if r < 0: |
| 1507 | sign = 1-sign |
| 1508 | r = -r |
| 1509 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1510 | ans = _dec_from_triple(sign, str(r), ideal_exponent) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1511 | return ans._fix(context) |
| 1512 | |
| 1513 | def __floordiv__(self, other, context=None): |
| 1514 | """self // other""" |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1515 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1516 | if other is NotImplemented: |
| 1517 | return other |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1518 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1519 | if context is None: |
| 1520 | context = getcontext() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1521 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1522 | ans = self._check_nans(other, context) |
| 1523 | if ans: |
| 1524 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1525 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1526 | if self._isinfinity(): |
| 1527 | if other._isinfinity(): |
| 1528 | return context._raise_error(InvalidOperation, 'INF // INF') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1529 | else: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 1530 | return _SignedInfinity[self._sign ^ other._sign] |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1531 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1532 | if not other: |
| 1533 | if self: |
| 1534 | return context._raise_error(DivisionByZero, 'x // 0', |
| 1535 | self._sign ^ other._sign) |
| 1536 | else: |
| 1537 | return context._raise_error(DivisionUndefined, '0 // 0') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1538 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1539 | return self._divide(other, context)[0] |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1540 | |
| 1541 | def __rfloordiv__(self, other, context=None): |
| 1542 | """Swaps self/other and returns __floordiv__.""" |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1543 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 1544 | if other is NotImplemented: |
| 1545 | return other |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1546 | return other.__floordiv__(self, context=context) |
| 1547 | |
| 1548 | def __float__(self): |
| 1549 | """Float representation.""" |
| 1550 | return float(str(self)) |
| 1551 | |
| 1552 | def __int__(self): |
Brett Cannon | 46b0802 | 2005-03-01 03:12:26 +0000 | [diff] [blame] | 1553 | """Converts self to an int, truncating if necessary.""" |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1554 | if self._is_special: |
| 1555 | if self._isnan(): |
Mark Dickinson | 8fde3da | 2009-09-08 19:23:44 +0000 | [diff] [blame] | 1556 | raise ValueError("Cannot convert NaN to integer") |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1557 | elif self._isinfinity(): |
Mark Dickinson | 8fde3da | 2009-09-08 19:23:44 +0000 | [diff] [blame] | 1558 | raise OverflowError("Cannot convert infinity to integer") |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1559 | s = (-1)**self._sign |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1560 | if self._exp >= 0: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1561 | return s*int(self._int)*10**self._exp |
Raymond Hettinger | 605ed02 | 2004-11-24 07:28:48 +0000 | [diff] [blame] | 1562 | else: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1563 | return s*int(self._int[:self._exp] or '0') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1564 | |
Christian Heimes | 969fe57 | 2008-01-25 11:23:10 +0000 | [diff] [blame] | 1565 | __trunc__ = __int__ |
| 1566 | |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 1567 | def real(self): |
| 1568 | return self |
Mark Dickinson | 315a20a | 2009-01-04 21:34:18 +0000 | [diff] [blame] | 1569 | real = property(real) |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 1570 | |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 1571 | def imag(self): |
| 1572 | return Decimal(0) |
Mark Dickinson | 315a20a | 2009-01-04 21:34:18 +0000 | [diff] [blame] | 1573 | imag = property(imag) |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 1574 | |
| 1575 | def conjugate(self): |
| 1576 | return self |
| 1577 | |
| 1578 | def __complex__(self): |
| 1579 | return complex(float(self)) |
| 1580 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1581 | def _fix_nan(self, context): |
| 1582 | """Decapitate the payload of a NaN to fit the context""" |
| 1583 | payload = self._int |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1584 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1585 | # maximum length of payload is precision if _clamp=0, |
| 1586 | # precision-1 if _clamp=1. |
| 1587 | max_payload_len = context.prec - context._clamp |
| 1588 | if len(payload) > max_payload_len: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1589 | payload = payload[len(payload)-max_payload_len:].lstrip('0') |
| 1590 | return _dec_from_triple(self._sign, payload, self._exp, True) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1591 | return Decimal(self) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1592 | |
Raymond Hettinger | dab988d | 2004-10-09 07:10:44 +0000 | [diff] [blame] | 1593 | def _fix(self, context): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1594 | """Round if it is necessary to keep self within prec precision. |
| 1595 | |
| 1596 | Rounds and fixes the exponent. Does not raise on a sNaN. |
| 1597 | |
| 1598 | Arguments: |
| 1599 | self - Decimal instance |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1600 | context - context used. |
| 1601 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1602 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1603 | if self._is_special: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1604 | if self._isnan(): |
| 1605 | # decapitate payload if necessary |
| 1606 | return self._fix_nan(context) |
| 1607 | else: |
| 1608 | # self is +/-Infinity; return unaltered |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 1609 | return Decimal(self) |
| 1610 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1611 | # if self is zero then exponent should be between Etiny and |
| 1612 | # Emax if _clamp==0, and between Etiny and Etop if _clamp==1. |
| 1613 | Etiny = context.Etiny() |
| 1614 | Etop = context.Etop() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1615 | if not self: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1616 | exp_max = [context.Emax, Etop][context._clamp] |
| 1617 | new_exp = min(max(self._exp, Etiny), exp_max) |
| 1618 | if new_exp != self._exp: |
| 1619 | context._raise_error(Clamped) |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1620 | return _dec_from_triple(self._sign, '0', new_exp) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1621 | else: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1622 | return Decimal(self) |
| 1623 | |
| 1624 | # exp_min is the smallest allowable exponent of the result, |
| 1625 | # equal to max(self.adjusted()-context.prec+1, Etiny) |
| 1626 | exp_min = len(self._int) + self._exp - context.prec |
| 1627 | if exp_min > Etop: |
| 1628 | # overflow: exp_min > Etop iff self.adjusted() > Emax |
| 1629 | context._raise_error(Inexact) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1630 | context._raise_error(Rounded) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1631 | return context._raise_error(Overflow, 'above Emax', self._sign) |
| 1632 | self_is_subnormal = exp_min < Etiny |
| 1633 | if self_is_subnormal: |
| 1634 | context._raise_error(Subnormal) |
| 1635 | exp_min = Etiny |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1636 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1637 | # round if self has too many digits |
| 1638 | if self._exp < exp_min: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1639 | context._raise_error(Rounded) |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1640 | digits = len(self._int) + self._exp - exp_min |
| 1641 | if digits < 0: |
| 1642 | self = _dec_from_triple(self._sign, '1', exp_min-1) |
| 1643 | digits = 0 |
| 1644 | this_function = getattr(self, self._pick_rounding_function[context.rounding]) |
| 1645 | changed = this_function(digits) |
| 1646 | coeff = self._int[:digits] or '0' |
| 1647 | if changed == 1: |
| 1648 | coeff = str(int(coeff)+1) |
| 1649 | ans = _dec_from_triple(self._sign, coeff, exp_min) |
| 1650 | |
| 1651 | if changed: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1652 | context._raise_error(Inexact) |
| 1653 | if self_is_subnormal: |
| 1654 | context._raise_error(Underflow) |
| 1655 | if not ans: |
| 1656 | # raise Clamped on underflow to 0 |
| 1657 | context._raise_error(Clamped) |
| 1658 | elif len(ans._int) == context.prec+1: |
| 1659 | # we get here only if rescaling rounds the |
| 1660 | # cofficient up to exactly 10**context.prec |
| 1661 | if ans._exp < Etop: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1662 | ans = _dec_from_triple(ans._sign, |
| 1663 | ans._int[:-1], ans._exp+1) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1664 | else: |
| 1665 | # Inexact and Rounded have already been raised |
| 1666 | ans = context._raise_error(Overflow, 'above Emax', |
| 1667 | self._sign) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1668 | return ans |
| 1669 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1670 | # fold down if _clamp == 1 and self has too few digits |
| 1671 | if context._clamp == 1 and self._exp > Etop: |
| 1672 | context._raise_error(Clamped) |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1673 | self_padded = self._int + '0'*(self._exp - Etop) |
| 1674 | return _dec_from_triple(self._sign, self_padded, Etop) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1675 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1676 | # here self was representable to begin with; return unchanged |
| 1677 | return Decimal(self) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1678 | |
| 1679 | _pick_rounding_function = {} |
| 1680 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1681 | # for each of the rounding functions below: |
| 1682 | # self is a finite, nonzero Decimal |
| 1683 | # prec is an integer satisfying 0 <= prec < len(self._int) |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1684 | # |
| 1685 | # each function returns either -1, 0, or 1, as follows: |
| 1686 | # 1 indicates that self should be rounded up (away from zero) |
| 1687 | # 0 indicates that self should be truncated, and that all the |
| 1688 | # digits to be truncated are zeros (so the value is unchanged) |
| 1689 | # -1 indicates that there are nonzero digits to be truncated |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1690 | |
| 1691 | def _round_down(self, prec): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1692 | """Also known as round-towards-0, truncate.""" |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1693 | if _all_zeros(self._int, prec): |
| 1694 | return 0 |
| 1695 | else: |
| 1696 | return -1 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1697 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1698 | def _round_up(self, prec): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1699 | """Rounds away from 0.""" |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1700 | return -self._round_down(prec) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1701 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1702 | def _round_half_up(self, prec): |
| 1703 | """Rounds 5 up (away from 0)""" |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1704 | if self._int[prec] in '56789': |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1705 | return 1 |
| 1706 | elif _all_zeros(self._int, prec): |
| 1707 | return 0 |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1708 | else: |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1709 | return -1 |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1710 | |
| 1711 | def _round_half_down(self, prec): |
| 1712 | """Round 5 down""" |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1713 | if _exact_half(self._int, prec): |
| 1714 | return -1 |
| 1715 | else: |
| 1716 | return self._round_half_up(prec) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1717 | |
| 1718 | def _round_half_even(self, prec): |
| 1719 | """Round 5 to even, rest to nearest.""" |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1720 | if _exact_half(self._int, prec) and \ |
| 1721 | (prec == 0 or self._int[prec-1] in '02468'): |
| 1722 | return -1 |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1723 | else: |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1724 | return self._round_half_up(prec) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1725 | |
| 1726 | def _round_ceiling(self, prec): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1727 | """Rounds up (not away from 0 if negative.)""" |
| 1728 | if self._sign: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1729 | return self._round_down(prec) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1730 | else: |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1731 | return -self._round_down(prec) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1732 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1733 | def _round_floor(self, prec): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1734 | """Rounds down (not towards 0 if negative)""" |
| 1735 | if not self._sign: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1736 | return self._round_down(prec) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1737 | else: |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1738 | return -self._round_down(prec) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1739 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1740 | def _round_05up(self, prec): |
| 1741 | """Round down unless digit prec-1 is 0 or 5.""" |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1742 | if prec and self._int[prec-1] not in '05': |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1743 | return self._round_down(prec) |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 1744 | else: |
| 1745 | return -self._round_down(prec) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1746 | |
Mark Dickinson | b27406c | 2008-05-09 13:42:33 +0000 | [diff] [blame] | 1747 | def __round__(self, n=None): |
| 1748 | """Round self to the nearest integer, or to a given precision. |
| 1749 | |
| 1750 | If only one argument is supplied, round a finite Decimal |
| 1751 | instance self to the nearest integer. If self is infinite or |
| 1752 | a NaN then a Python exception is raised. If self is finite |
| 1753 | and lies exactly halfway between two integers then it is |
| 1754 | rounded to the integer with even last digit. |
| 1755 | |
| 1756 | >>> round(Decimal('123.456')) |
| 1757 | 123 |
| 1758 | >>> round(Decimal('-456.789')) |
| 1759 | -457 |
| 1760 | >>> round(Decimal('-3.0')) |
| 1761 | -3 |
| 1762 | >>> round(Decimal('2.5')) |
| 1763 | 2 |
| 1764 | >>> round(Decimal('3.5')) |
| 1765 | 4 |
| 1766 | >>> round(Decimal('Inf')) |
| 1767 | Traceback (most recent call last): |
| 1768 | ... |
Mark Dickinson | b27406c | 2008-05-09 13:42:33 +0000 | [diff] [blame] | 1769 | OverflowError: cannot round an infinity |
| 1770 | >>> round(Decimal('NaN')) |
| 1771 | Traceback (most recent call last): |
| 1772 | ... |
Mark Dickinson | b27406c | 2008-05-09 13:42:33 +0000 | [diff] [blame] | 1773 | ValueError: cannot round a NaN |
| 1774 | |
| 1775 | If a second argument n is supplied, self is rounded to n |
| 1776 | decimal places using the rounding mode for the current |
| 1777 | context. |
| 1778 | |
| 1779 | For an integer n, round(self, -n) is exactly equivalent to |
| 1780 | self.quantize(Decimal('1En')). |
| 1781 | |
| 1782 | >>> round(Decimal('123.456'), 0) |
| 1783 | Decimal('123') |
| 1784 | >>> round(Decimal('123.456'), 2) |
| 1785 | Decimal('123.46') |
| 1786 | >>> round(Decimal('123.456'), -2) |
| 1787 | Decimal('1E+2') |
| 1788 | >>> round(Decimal('-Infinity'), 37) |
| 1789 | Decimal('NaN') |
| 1790 | >>> round(Decimal('sNaN123'), 0) |
| 1791 | Decimal('NaN123') |
| 1792 | |
| 1793 | """ |
| 1794 | if n is not None: |
| 1795 | # two-argument form: use the equivalent quantize call |
| 1796 | if not isinstance(n, int): |
| 1797 | raise TypeError('Second argument to round should be integral') |
| 1798 | exp = _dec_from_triple(0, '1', -n) |
| 1799 | return self.quantize(exp) |
| 1800 | |
| 1801 | # one-argument form |
| 1802 | if self._is_special: |
| 1803 | if self.is_nan(): |
| 1804 | raise ValueError("cannot round a NaN") |
| 1805 | else: |
| 1806 | raise OverflowError("cannot round an infinity") |
| 1807 | return int(self._rescale(0, ROUND_HALF_EVEN)) |
| 1808 | |
| 1809 | def __floor__(self): |
| 1810 | """Return the floor of self, as an integer. |
| 1811 | |
| 1812 | For a finite Decimal instance self, return the greatest |
| 1813 | integer n such that n <= self. If self is infinite or a NaN |
| 1814 | then a Python exception is raised. |
| 1815 | |
| 1816 | """ |
| 1817 | if self._is_special: |
| 1818 | if self.is_nan(): |
| 1819 | raise ValueError("cannot round a NaN") |
| 1820 | else: |
| 1821 | raise OverflowError("cannot round an infinity") |
| 1822 | return int(self._rescale(0, ROUND_FLOOR)) |
| 1823 | |
| 1824 | def __ceil__(self): |
| 1825 | """Return the ceiling of self, as an integer. |
| 1826 | |
| 1827 | For a finite Decimal instance self, return the least integer n |
| 1828 | such that n >= self. If self is infinite or a NaN then a |
| 1829 | Python exception is raised. |
| 1830 | |
| 1831 | """ |
| 1832 | if self._is_special: |
| 1833 | if self.is_nan(): |
| 1834 | raise ValueError("cannot round a NaN") |
| 1835 | else: |
| 1836 | raise OverflowError("cannot round an infinity") |
| 1837 | return int(self._rescale(0, ROUND_CEILING)) |
| 1838 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1839 | def fma(self, other, third, context=None): |
| 1840 | """Fused multiply-add. |
| 1841 | |
| 1842 | Returns self*other+third with no rounding of the intermediate |
| 1843 | product self*other. |
| 1844 | |
| 1845 | self and other are multiplied together, with no rounding of |
| 1846 | the result. The third operand is then added to the result, |
| 1847 | and a single final rounding is performed. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1848 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1849 | |
| 1850 | other = _convert_other(other, raiseit=True) |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 1851 | |
| 1852 | # compute product; raise InvalidOperation if either operand is |
| 1853 | # a signaling NaN or if the product is zero times infinity. |
| 1854 | if self._is_special or other._is_special: |
| 1855 | if context is None: |
| 1856 | context = getcontext() |
| 1857 | if self._exp == 'N': |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 1858 | return context._raise_error(InvalidOperation, 'sNaN', self) |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 1859 | if other._exp == 'N': |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 1860 | return context._raise_error(InvalidOperation, 'sNaN', other) |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 1861 | if self._exp == 'n': |
| 1862 | product = self |
| 1863 | elif other._exp == 'n': |
| 1864 | product = other |
| 1865 | elif self._exp == 'F': |
| 1866 | if not other: |
| 1867 | return context._raise_error(InvalidOperation, |
| 1868 | 'INF * 0 in fma') |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 1869 | product = _SignedInfinity[self._sign ^ other._sign] |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 1870 | elif other._exp == 'F': |
| 1871 | if not self: |
| 1872 | return context._raise_error(InvalidOperation, |
| 1873 | '0 * INF in fma') |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 1874 | product = _SignedInfinity[self._sign ^ other._sign] |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 1875 | else: |
| 1876 | product = _dec_from_triple(self._sign ^ other._sign, |
| 1877 | str(int(self._int) * int(other._int)), |
| 1878 | self._exp + other._exp) |
| 1879 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1880 | third = _convert_other(third, raiseit=True) |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 1881 | return product.__add__(third, context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1882 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1883 | def _power_modulo(self, other, modulo, context=None): |
| 1884 | """Three argument version of __pow__""" |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1885 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1886 | # if can't convert other and modulo to Decimal, raise |
| 1887 | # TypeError; there's no point returning NotImplemented (no |
| 1888 | # equivalent of __rpow__ for three argument pow) |
| 1889 | other = _convert_other(other, raiseit=True) |
| 1890 | modulo = _convert_other(modulo, raiseit=True) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1891 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1892 | if context is None: |
| 1893 | context = getcontext() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1894 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1895 | # deal with NaNs: if there are any sNaNs then first one wins, |
| 1896 | # (i.e. behaviour for NaNs is identical to that of fma) |
| 1897 | self_is_nan = self._isnan() |
| 1898 | other_is_nan = other._isnan() |
| 1899 | modulo_is_nan = modulo._isnan() |
| 1900 | if self_is_nan or other_is_nan or modulo_is_nan: |
| 1901 | if self_is_nan == 2: |
| 1902 | return context._raise_error(InvalidOperation, 'sNaN', |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 1903 | self) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1904 | if other_is_nan == 2: |
| 1905 | return context._raise_error(InvalidOperation, 'sNaN', |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 1906 | other) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1907 | if modulo_is_nan == 2: |
| 1908 | return context._raise_error(InvalidOperation, 'sNaN', |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 1909 | modulo) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1910 | if self_is_nan: |
| 1911 | return self._fix_nan(context) |
| 1912 | if other_is_nan: |
| 1913 | return other._fix_nan(context) |
| 1914 | return modulo._fix_nan(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 1915 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1916 | # check inputs: we apply same restrictions as Python's pow() |
| 1917 | if not (self._isinteger() and |
| 1918 | other._isinteger() and |
| 1919 | modulo._isinteger()): |
| 1920 | return context._raise_error(InvalidOperation, |
| 1921 | 'pow() 3rd argument not allowed ' |
| 1922 | 'unless all arguments are integers') |
| 1923 | if other < 0: |
| 1924 | return context._raise_error(InvalidOperation, |
| 1925 | 'pow() 2nd argument cannot be ' |
| 1926 | 'negative when 3rd argument specified') |
| 1927 | if not modulo: |
| 1928 | return context._raise_error(InvalidOperation, |
| 1929 | 'pow() 3rd argument cannot be 0') |
| 1930 | |
| 1931 | # additional restriction for decimal: the modulus must be less |
| 1932 | # than 10**prec in absolute value |
| 1933 | if modulo.adjusted() >= context.prec: |
| 1934 | return context._raise_error(InvalidOperation, |
| 1935 | 'insufficient precision: pow() 3rd ' |
| 1936 | 'argument must not have more than ' |
| 1937 | 'precision digits') |
| 1938 | |
| 1939 | # define 0**0 == NaN, for consistency with two-argument pow |
| 1940 | # (even though it hurts!) |
| 1941 | if not other and not self: |
| 1942 | return context._raise_error(InvalidOperation, |
| 1943 | 'at least one of pow() 1st argument ' |
| 1944 | 'and 2nd argument must be nonzero ;' |
| 1945 | '0**0 is not defined') |
| 1946 | |
| 1947 | # compute sign of result |
| 1948 | if other._iseven(): |
| 1949 | sign = 0 |
| 1950 | else: |
| 1951 | sign = self._sign |
| 1952 | |
| 1953 | # convert modulo to a Python integer, and self and other to |
| 1954 | # Decimal integers (i.e. force their exponents to be >= 0) |
| 1955 | modulo = abs(int(modulo)) |
| 1956 | base = _WorkRep(self.to_integral_value()) |
| 1957 | exponent = _WorkRep(other.to_integral_value()) |
| 1958 | |
| 1959 | # compute result using integer pow() |
| 1960 | base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo |
| 1961 | for i in range(exponent.exp): |
| 1962 | base = pow(base, 10, modulo) |
| 1963 | base = pow(base, exponent.int, modulo) |
| 1964 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1965 | return _dec_from_triple(sign, str(base), 0) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 1966 | |
| 1967 | def _power_exact(self, other, p): |
| 1968 | """Attempt to compute self**other exactly. |
| 1969 | |
| 1970 | Given Decimals self and other and an integer p, attempt to |
| 1971 | compute an exact result for the power self**other, with p |
| 1972 | digits of precision. Return None if self**other is not |
| 1973 | exactly representable in p digits. |
| 1974 | |
| 1975 | Assumes that elimination of special cases has already been |
| 1976 | performed: self and other must both be nonspecial; self must |
| 1977 | be positive and not numerically equal to 1; other must be |
| 1978 | nonzero. For efficiency, other._exp should not be too large, |
| 1979 | so that 10**abs(other._exp) is a feasible calculation.""" |
| 1980 | |
| 1981 | # In the comments below, we write x for the value of self and |
| 1982 | # y for the value of other. Write x = xc*10**xe and y = |
| 1983 | # yc*10**ye. |
| 1984 | |
| 1985 | # The main purpose of this method is to identify the *failure* |
| 1986 | # of x**y to be exactly representable with as little effort as |
| 1987 | # possible. So we look for cheap and easy tests that |
| 1988 | # eliminate the possibility of x**y being exact. Only if all |
| 1989 | # these tests are passed do we go on to actually compute x**y. |
| 1990 | |
| 1991 | # Here's the main idea. First normalize both x and y. We |
| 1992 | # express y as a rational m/n, with m and n relatively prime |
| 1993 | # and n>0. Then for x**y to be exactly representable (at |
| 1994 | # *any* precision), xc must be the nth power of a positive |
| 1995 | # integer and xe must be divisible by n. If m is negative |
| 1996 | # then additionally xc must be a power of either 2 or 5, hence |
| 1997 | # a power of 2**n or 5**n. |
| 1998 | # |
| 1999 | # There's a limit to how small |y| can be: if y=m/n as above |
| 2000 | # then: |
| 2001 | # |
| 2002 | # (1) if xc != 1 then for the result to be representable we |
| 2003 | # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So |
| 2004 | # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <= |
| 2005 | # 2**(1/|y|), hence xc**|y| < 2 and the result is not |
| 2006 | # representable. |
| 2007 | # |
| 2008 | # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if |
| 2009 | # |y| < 1/|xe| then the result is not representable. |
| 2010 | # |
| 2011 | # Note that since x is not equal to 1, at least one of (1) and |
| 2012 | # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) < |
| 2013 | # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye. |
| 2014 | # |
| 2015 | # There's also a limit to how large y can be, at least if it's |
| 2016 | # positive: the normalized result will have coefficient xc**y, |
| 2017 | # so if it's representable then xc**y < 10**p, and y < |
| 2018 | # p/log10(xc). Hence if y*log10(xc) >= p then the result is |
| 2019 | # not exactly representable. |
| 2020 | |
| 2021 | # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye, |
| 2022 | # so |y| < 1/xe and the result is not representable. |
| 2023 | # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y| |
| 2024 | # < 1/nbits(xc). |
| 2025 | |
| 2026 | x = _WorkRep(self) |
| 2027 | xc, xe = x.int, x.exp |
| 2028 | while xc % 10 == 0: |
| 2029 | xc //= 10 |
| 2030 | xe += 1 |
| 2031 | |
| 2032 | y = _WorkRep(other) |
| 2033 | yc, ye = y.int, y.exp |
| 2034 | while yc % 10 == 0: |
| 2035 | yc //= 10 |
| 2036 | ye += 1 |
| 2037 | |
| 2038 | # case where xc == 1: result is 10**(xe*y), with xe*y |
| 2039 | # required to be an integer |
| 2040 | if xc == 1: |
| 2041 | if ye >= 0: |
| 2042 | exponent = xe*yc*10**ye |
| 2043 | else: |
| 2044 | exponent, remainder = divmod(xe*yc, 10**-ye) |
| 2045 | if remainder: |
| 2046 | return None |
| 2047 | if y.sign == 1: |
| 2048 | exponent = -exponent |
| 2049 | # if other is a nonnegative integer, use ideal exponent |
| 2050 | if other._isinteger() and other._sign == 0: |
| 2051 | ideal_exponent = self._exp*int(other) |
| 2052 | zeros = min(exponent-ideal_exponent, p-1) |
| 2053 | else: |
| 2054 | zeros = 0 |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2055 | return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2056 | |
| 2057 | # case where y is negative: xc must be either a power |
| 2058 | # of 2 or a power of 5. |
| 2059 | if y.sign == 1: |
| 2060 | last_digit = xc % 10 |
| 2061 | if last_digit in (2,4,6,8): |
| 2062 | # quick test for power of 2 |
| 2063 | if xc & -xc != xc: |
| 2064 | return None |
| 2065 | # now xc is a power of 2; e is its exponent |
| 2066 | e = _nbits(xc)-1 |
| 2067 | # find e*y and xe*y; both must be integers |
| 2068 | if ye >= 0: |
| 2069 | y_as_int = yc*10**ye |
| 2070 | e = e*y_as_int |
| 2071 | xe = xe*y_as_int |
| 2072 | else: |
| 2073 | ten_pow = 10**-ye |
| 2074 | e, remainder = divmod(e*yc, ten_pow) |
| 2075 | if remainder: |
| 2076 | return None |
| 2077 | xe, remainder = divmod(xe*yc, ten_pow) |
| 2078 | if remainder: |
| 2079 | return None |
| 2080 | |
| 2081 | if e*65 >= p*93: # 93/65 > log(10)/log(5) |
| 2082 | return None |
| 2083 | xc = 5**e |
| 2084 | |
| 2085 | elif last_digit == 5: |
| 2086 | # e >= log_5(xc) if xc is a power of 5; we have |
| 2087 | # equality all the way up to xc=5**2658 |
| 2088 | e = _nbits(xc)*28//65 |
| 2089 | xc, remainder = divmod(5**e, xc) |
| 2090 | if remainder: |
| 2091 | return None |
| 2092 | while xc % 5 == 0: |
| 2093 | xc //= 5 |
| 2094 | e -= 1 |
| 2095 | if ye >= 0: |
| 2096 | y_as_integer = yc*10**ye |
| 2097 | e = e*y_as_integer |
| 2098 | xe = xe*y_as_integer |
| 2099 | else: |
| 2100 | ten_pow = 10**-ye |
| 2101 | e, remainder = divmod(e*yc, ten_pow) |
| 2102 | if remainder: |
| 2103 | return None |
| 2104 | xe, remainder = divmod(xe*yc, ten_pow) |
| 2105 | if remainder: |
| 2106 | return None |
| 2107 | if e*3 >= p*10: # 10/3 > log(10)/log(2) |
| 2108 | return None |
| 2109 | xc = 2**e |
| 2110 | else: |
| 2111 | return None |
| 2112 | |
| 2113 | if xc >= 10**p: |
| 2114 | return None |
| 2115 | xe = -e-xe |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2116 | return _dec_from_triple(0, str(xc), xe) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2117 | |
| 2118 | # now y is positive; find m and n such that y = m/n |
| 2119 | if ye >= 0: |
| 2120 | m, n = yc*10**ye, 1 |
| 2121 | else: |
| 2122 | if xe != 0 and len(str(abs(yc*xe))) <= -ye: |
| 2123 | return None |
| 2124 | xc_bits = _nbits(xc) |
| 2125 | if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye: |
| 2126 | return None |
| 2127 | m, n = yc, 10**(-ye) |
| 2128 | while m % 2 == n % 2 == 0: |
| 2129 | m //= 2 |
| 2130 | n //= 2 |
| 2131 | while m % 5 == n % 5 == 0: |
| 2132 | m //= 5 |
| 2133 | n //= 5 |
| 2134 | |
| 2135 | # compute nth root of xc*10**xe |
| 2136 | if n > 1: |
| 2137 | # if 1 < xc < 2**n then xc isn't an nth power |
| 2138 | if xc != 1 and xc_bits <= n: |
| 2139 | return None |
| 2140 | |
| 2141 | xe, rem = divmod(xe, n) |
| 2142 | if rem != 0: |
| 2143 | return None |
| 2144 | |
| 2145 | # compute nth root of xc using Newton's method |
| 2146 | a = 1 << -(-_nbits(xc)//n) # initial estimate |
| 2147 | while True: |
| 2148 | q, r = divmod(xc, a**(n-1)) |
| 2149 | if a <= q: |
| 2150 | break |
| 2151 | else: |
| 2152 | a = (a*(n-1) + q)//n |
| 2153 | if not (a == q and r == 0): |
| 2154 | return None |
| 2155 | xc = a |
| 2156 | |
| 2157 | # now xc*10**xe is the nth root of the original xc*10**xe |
| 2158 | # compute mth power of xc*10**xe |
| 2159 | |
| 2160 | # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m > |
| 2161 | # 10**p and the result is not representable. |
| 2162 | if xc > 1 and m > p*100//_log10_lb(xc): |
| 2163 | return None |
| 2164 | xc = xc**m |
| 2165 | xe *= m |
| 2166 | if xc > 10**p: |
| 2167 | return None |
| 2168 | |
| 2169 | # by this point the result *is* exactly representable |
| 2170 | # adjust the exponent to get as close as possible to the ideal |
| 2171 | # exponent, if necessary |
| 2172 | str_xc = str(xc) |
| 2173 | if other._isinteger() and other._sign == 0: |
| 2174 | ideal_exponent = self._exp*int(other) |
| 2175 | zeros = min(xe-ideal_exponent, p-len(str_xc)) |
| 2176 | else: |
| 2177 | zeros = 0 |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2178 | return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2179 | |
| 2180 | def __pow__(self, other, modulo=None, context=None): |
| 2181 | """Return self ** other [ % modulo]. |
| 2182 | |
| 2183 | With two arguments, compute self**other. |
| 2184 | |
| 2185 | With three arguments, compute (self**other) % modulo. For the |
| 2186 | three argument form, the following restrictions on the |
| 2187 | arguments hold: |
| 2188 | |
| 2189 | - all three arguments must be integral |
| 2190 | - other must be nonnegative |
| 2191 | - either self or other (or both) must be nonzero |
| 2192 | - modulo must be nonzero and must have at most p digits, |
| 2193 | where p is the context precision. |
| 2194 | |
| 2195 | If any of these restrictions is violated the InvalidOperation |
| 2196 | flag is raised. |
| 2197 | |
| 2198 | The result of pow(self, other, modulo) is identical to the |
| 2199 | result that would be obtained by computing (self**other) % |
| 2200 | modulo with unbounded precision, but is computed more |
| 2201 | efficiently. It is always exact. |
| 2202 | """ |
| 2203 | |
| 2204 | if modulo is not None: |
| 2205 | return self._power_modulo(other, modulo, context) |
| 2206 | |
| 2207 | other = _convert_other(other) |
| 2208 | if other is NotImplemented: |
| 2209 | return other |
| 2210 | |
| 2211 | if context is None: |
| 2212 | context = getcontext() |
| 2213 | |
| 2214 | # either argument is a NaN => result is NaN |
| 2215 | ans = self._check_nans(other, context) |
| 2216 | if ans: |
| 2217 | return ans |
| 2218 | |
| 2219 | # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity) |
| 2220 | if not other: |
| 2221 | if not self: |
| 2222 | return context._raise_error(InvalidOperation, '0 ** 0') |
| 2223 | else: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2224 | return _One |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2225 | |
| 2226 | # result has sign 1 iff self._sign is 1 and other is an odd integer |
| 2227 | result_sign = 0 |
| 2228 | if self._sign == 1: |
| 2229 | if other._isinteger(): |
| 2230 | if not other._iseven(): |
| 2231 | result_sign = 1 |
| 2232 | else: |
| 2233 | # -ve**noninteger = NaN |
| 2234 | # (-0)**noninteger = 0**noninteger |
| 2235 | if self: |
| 2236 | return context._raise_error(InvalidOperation, |
| 2237 | 'x ** y with x negative and y not an integer') |
| 2238 | # negate self, without doing any unwanted rounding |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2239 | self = self.copy_negate() |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2240 | |
| 2241 | # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity |
| 2242 | if not self: |
| 2243 | if other._sign == 0: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2244 | return _dec_from_triple(result_sign, '0', 0) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2245 | else: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2246 | return _SignedInfinity[result_sign] |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2247 | |
| 2248 | # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2249 | if self._isinfinity(): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2250 | if other._sign == 0: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2251 | return _SignedInfinity[result_sign] |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2252 | else: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2253 | return _dec_from_triple(result_sign, '0', 0) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2254 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2255 | # 1**other = 1, but the choice of exponent and the flags |
| 2256 | # depend on the exponent of self, and on whether other is a |
| 2257 | # positive integer, a negative integer, or neither |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2258 | if self == _One: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2259 | if other._isinteger(): |
| 2260 | # exp = max(self._exp*max(int(other), 0), |
| 2261 | # 1-context.prec) but evaluating int(other) directly |
| 2262 | # is dangerous until we know other is small (other |
| 2263 | # could be 1e999999999) |
| 2264 | if other._sign == 1: |
| 2265 | multiplier = 0 |
| 2266 | elif other > context.prec: |
| 2267 | multiplier = context.prec |
| 2268 | else: |
| 2269 | multiplier = int(other) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2270 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2271 | exp = self._exp * multiplier |
| 2272 | if exp < 1-context.prec: |
| 2273 | exp = 1-context.prec |
| 2274 | context._raise_error(Rounded) |
| 2275 | else: |
| 2276 | context._raise_error(Inexact) |
| 2277 | context._raise_error(Rounded) |
| 2278 | exp = 1-context.prec |
| 2279 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2280 | return _dec_from_triple(result_sign, '1'+'0'*-exp, exp) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2281 | |
| 2282 | # compute adjusted exponent of self |
| 2283 | self_adj = self.adjusted() |
| 2284 | |
| 2285 | # self ** infinity is infinity if self > 1, 0 if self < 1 |
| 2286 | # self ** -infinity is infinity if self < 1, 0 if self > 1 |
| 2287 | if other._isinfinity(): |
| 2288 | if (other._sign == 0) == (self_adj < 0): |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2289 | return _dec_from_triple(result_sign, '0', 0) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2290 | else: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2291 | return _SignedInfinity[result_sign] |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2292 | |
| 2293 | # from here on, the result always goes through the call |
| 2294 | # to _fix at the end of this function. |
| 2295 | ans = None |
| 2296 | |
| 2297 | # crude test to catch cases of extreme overflow/underflow. If |
| 2298 | # log10(self)*other >= 10**bound and bound >= len(str(Emax)) |
| 2299 | # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence |
| 2300 | # self**other >= 10**(Emax+1), so overflow occurs. The test |
| 2301 | # for underflow is similar. |
| 2302 | bound = self._log10_exp_bound() + other.adjusted() |
| 2303 | if (self_adj >= 0) == (other._sign == 0): |
| 2304 | # self > 1 and other +ve, or self < 1 and other -ve |
| 2305 | # possibility of overflow |
| 2306 | if bound >= len(str(context.Emax)): |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2307 | ans = _dec_from_triple(result_sign, '1', context.Emax+1) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2308 | else: |
| 2309 | # self > 1 and other -ve, or self < 1 and other +ve |
| 2310 | # possibility of underflow to 0 |
| 2311 | Etiny = context.Etiny() |
| 2312 | if bound >= len(str(-Etiny)): |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2313 | ans = _dec_from_triple(result_sign, '1', Etiny-1) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2314 | |
| 2315 | # try for an exact result with precision +1 |
| 2316 | if ans is None: |
| 2317 | ans = self._power_exact(other, context.prec + 1) |
| 2318 | if ans is not None and result_sign == 1: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2319 | ans = _dec_from_triple(1, ans._int, ans._exp) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2320 | |
| 2321 | # usual case: inexact result, x**y computed directly as exp(y*log(x)) |
| 2322 | if ans is None: |
| 2323 | p = context.prec |
| 2324 | x = _WorkRep(self) |
| 2325 | xc, xe = x.int, x.exp |
| 2326 | y = _WorkRep(other) |
| 2327 | yc, ye = y.int, y.exp |
| 2328 | if y.sign == 1: |
| 2329 | yc = -yc |
| 2330 | |
| 2331 | # compute correctly rounded result: start with precision +3, |
| 2332 | # then increase precision until result is unambiguously roundable |
| 2333 | extra = 3 |
| 2334 | while True: |
| 2335 | coeff, exp = _dpower(xc, xe, yc, ye, p+extra) |
| 2336 | if coeff % (5*10**(len(str(coeff))-p-1)): |
| 2337 | break |
| 2338 | extra += 3 |
| 2339 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2340 | ans = _dec_from_triple(result_sign, str(coeff), exp) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2341 | |
| 2342 | # the specification says that for non-integer other we need to |
| 2343 | # raise Inexact, even when the result is actually exact. In |
| 2344 | # the same way, we need to raise Underflow here if the result |
| 2345 | # is subnormal. (The call to _fix will take care of raising |
| 2346 | # Rounded and Subnormal, as usual.) |
| 2347 | if not other._isinteger(): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2348 | context._raise_error(Inexact) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2349 | # pad with zeros up to length context.prec+1 if necessary |
| 2350 | if len(ans._int) <= context.prec: |
| 2351 | expdiff = context.prec+1 - len(ans._int) |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2352 | ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff, |
| 2353 | ans._exp-expdiff) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2354 | if ans.adjusted() < context.Emin: |
| 2355 | context._raise_error(Underflow) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2356 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2357 | # unlike exp, ln and log10, the power function respects the |
| 2358 | # rounding mode; no need to use ROUND_HALF_EVEN here |
| 2359 | ans = ans._fix(context) |
| 2360 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2361 | |
| 2362 | def __rpow__(self, other, context=None): |
| 2363 | """Swaps self/other and returns __pow__.""" |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2364 | other = _convert_other(other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 2365 | if other is NotImplemented: |
| 2366 | return other |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2367 | return other.__pow__(self, context=context) |
| 2368 | |
| 2369 | def normalize(self, context=None): |
| 2370 | """Normalize- strip trailing 0s, change anything equal to 0 to 0e0""" |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2371 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2372 | if context is None: |
| 2373 | context = getcontext() |
| 2374 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2375 | if self._is_special: |
| 2376 | ans = self._check_nans(context=context) |
| 2377 | if ans: |
| 2378 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2379 | |
Raymond Hettinger | dab988d | 2004-10-09 07:10:44 +0000 | [diff] [blame] | 2380 | dup = self._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2381 | if dup._isinfinity(): |
| 2382 | return dup |
| 2383 | |
| 2384 | if not dup: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2385 | return _dec_from_triple(dup._sign, '0', 0) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2386 | exp_max = [context.Emax, context.Etop()][context._clamp] |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2387 | end = len(dup._int) |
| 2388 | exp = dup._exp |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2389 | while dup._int[end-1] == '0' and exp < exp_max: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2390 | exp += 1 |
| 2391 | end -= 1 |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2392 | return _dec_from_triple(dup._sign, dup._int[:end], exp) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2393 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2394 | def quantize(self, exp, rounding=None, context=None, watchexp=True): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2395 | """Quantize self so its exponent is the same as that of exp. |
| 2396 | |
| 2397 | Similar to self._rescale(exp._exp) but with error checking. |
| 2398 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2399 | exp = _convert_other(exp, raiseit=True) |
| 2400 | |
| 2401 | if context is None: |
| 2402 | context = getcontext() |
| 2403 | if rounding is None: |
| 2404 | rounding = context.rounding |
| 2405 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2406 | if self._is_special or exp._is_special: |
| 2407 | ans = self._check_nans(exp, context) |
| 2408 | if ans: |
| 2409 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2410 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2411 | if exp._isinfinity() or self._isinfinity(): |
| 2412 | if exp._isinfinity() and self._isinfinity(): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2413 | return Decimal(self) # if both are inf, it is OK |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2414 | return context._raise_error(InvalidOperation, |
| 2415 | 'quantize with one INF') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2416 | |
| 2417 | # if we're not watching exponents, do a simple rescale |
| 2418 | if not watchexp: |
| 2419 | ans = self._rescale(exp._exp, rounding) |
| 2420 | # raise Inexact and Rounded where appropriate |
| 2421 | if ans._exp > self._exp: |
| 2422 | context._raise_error(Rounded) |
| 2423 | if ans != self: |
| 2424 | context._raise_error(Inexact) |
| 2425 | return ans |
| 2426 | |
| 2427 | # exp._exp should be between Etiny and Emax |
| 2428 | if not (context.Etiny() <= exp._exp <= context.Emax): |
| 2429 | return context._raise_error(InvalidOperation, |
| 2430 | 'target exponent out of bounds in quantize') |
| 2431 | |
| 2432 | if not self: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2433 | ans = _dec_from_triple(self._sign, '0', exp._exp) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2434 | return ans._fix(context) |
| 2435 | |
| 2436 | self_adjusted = self.adjusted() |
| 2437 | if self_adjusted > context.Emax: |
| 2438 | return context._raise_error(InvalidOperation, |
| 2439 | 'exponent of quantize result too large for current context') |
| 2440 | if self_adjusted - exp._exp + 1 > context.prec: |
| 2441 | return context._raise_error(InvalidOperation, |
| 2442 | 'quantize result has too many digits for current context') |
| 2443 | |
| 2444 | ans = self._rescale(exp._exp, rounding) |
| 2445 | if ans.adjusted() > context.Emax: |
| 2446 | return context._raise_error(InvalidOperation, |
| 2447 | 'exponent of quantize result too large for current context') |
| 2448 | if len(ans._int) > context.prec: |
| 2449 | return context._raise_error(InvalidOperation, |
| 2450 | 'quantize result has too many digits for current context') |
| 2451 | |
| 2452 | # raise appropriate flags |
| 2453 | if ans._exp > self._exp: |
| 2454 | context._raise_error(Rounded) |
| 2455 | if ans != self: |
| 2456 | context._raise_error(Inexact) |
| 2457 | if ans and ans.adjusted() < context.Emin: |
| 2458 | context._raise_error(Subnormal) |
| 2459 | |
| 2460 | # call to fix takes care of any necessary folddown |
| 2461 | ans = ans._fix(context) |
| 2462 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2463 | |
| 2464 | def same_quantum(self, other): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 2465 | """Return True if self and other have the same exponent; otherwise |
| 2466 | return False. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2467 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 2468 | If either operand is a special value, the following rules are used: |
| 2469 | * return True if both operands are infinities |
| 2470 | * return True if both operands are NaNs |
| 2471 | * otherwise, return False. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2472 | """ |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 2473 | other = _convert_other(other, raiseit=True) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2474 | if self._is_special or other._is_special: |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 2475 | return (self.is_nan() and other.is_nan() or |
| 2476 | self.is_infinite() and other.is_infinite()) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2477 | return self._exp == other._exp |
| 2478 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2479 | def _rescale(self, exp, rounding): |
| 2480 | """Rescale self so that the exponent is exp, either by padding with zeros |
| 2481 | or by truncating digits, using the given rounding mode. |
| 2482 | |
| 2483 | Specials are returned without change. This operation is |
| 2484 | quiet: it raises no flags, and uses no information from the |
| 2485 | context. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2486 | |
| 2487 | exp = exp to scale to (an integer) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2488 | rounding = rounding mode |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2489 | """ |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2490 | if self._is_special: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2491 | return Decimal(self) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2492 | if not self: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2493 | return _dec_from_triple(self._sign, '0', exp) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2494 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2495 | if self._exp >= exp: |
| 2496 | # pad answer with zeros if necessary |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2497 | return _dec_from_triple(self._sign, |
| 2498 | self._int + '0'*(self._exp - exp), exp) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2499 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2500 | # too many digits; round and lose data. If self.adjusted() < |
| 2501 | # exp-1, replace self by 10**(exp-1) before rounding |
| 2502 | digits = len(self._int) + self._exp - exp |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2503 | if digits < 0: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2504 | self = _dec_from_triple(self._sign, '1', exp-1) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2505 | digits = 0 |
| 2506 | this_function = getattr(self, self._pick_rounding_function[rounding]) |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 2507 | changed = this_function(digits) |
| 2508 | coeff = self._int[:digits] or '0' |
| 2509 | if changed == 1: |
| 2510 | coeff = str(int(coeff)+1) |
| 2511 | return _dec_from_triple(self._sign, coeff, exp) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2512 | |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 2513 | def _round(self, places, rounding): |
| 2514 | """Round a nonzero, nonspecial Decimal to a fixed number of |
| 2515 | significant figures, using the given rounding mode. |
| 2516 | |
| 2517 | Infinities, NaNs and zeros are returned unaltered. |
| 2518 | |
| 2519 | This operation is quiet: it raises no flags, and uses no |
| 2520 | information from the context. |
| 2521 | |
| 2522 | """ |
| 2523 | if places <= 0: |
| 2524 | raise ValueError("argument should be at least 1 in _round") |
| 2525 | if self._is_special or not self: |
| 2526 | return Decimal(self) |
| 2527 | ans = self._rescale(self.adjusted()+1-places, rounding) |
| 2528 | # it can happen that the rescale alters the adjusted exponent; |
| 2529 | # for example when rounding 99.97 to 3 significant figures. |
| 2530 | # When this happens we end up with an extra 0 at the end of |
| 2531 | # the number; a second rescale fixes this. |
| 2532 | if ans.adjusted() != self.adjusted(): |
| 2533 | ans = ans._rescale(ans.adjusted()+1-places, rounding) |
| 2534 | return ans |
| 2535 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2536 | def to_integral_exact(self, rounding=None, context=None): |
| 2537 | """Rounds to a nearby integer. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2538 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2539 | If no rounding mode is specified, take the rounding mode from |
| 2540 | the context. This method raises the Rounded and Inexact flags |
| 2541 | when appropriate. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2542 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2543 | See also: to_integral_value, which does exactly the same as |
| 2544 | this method except that it doesn't raise Inexact or Rounded. |
| 2545 | """ |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2546 | if self._is_special: |
| 2547 | ans = self._check_nans(context=context) |
| 2548 | if ans: |
| 2549 | return ans |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2550 | return Decimal(self) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2551 | if self._exp >= 0: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2552 | return Decimal(self) |
| 2553 | if not self: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2554 | return _dec_from_triple(self._sign, '0', 0) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2555 | if context is None: |
| 2556 | context = getcontext() |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2557 | if rounding is None: |
| 2558 | rounding = context.rounding |
| 2559 | context._raise_error(Rounded) |
| 2560 | ans = self._rescale(0, rounding) |
| 2561 | if ans != self: |
| 2562 | context._raise_error(Inexact) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2563 | return ans |
| 2564 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2565 | def to_integral_value(self, rounding=None, context=None): |
| 2566 | """Rounds to the nearest integer, without raising inexact, rounded.""" |
| 2567 | if context is None: |
| 2568 | context = getcontext() |
| 2569 | if rounding is None: |
| 2570 | rounding = context.rounding |
| 2571 | if self._is_special: |
| 2572 | ans = self._check_nans(context=context) |
| 2573 | if ans: |
| 2574 | return ans |
| 2575 | return Decimal(self) |
| 2576 | if self._exp >= 0: |
| 2577 | return Decimal(self) |
| 2578 | else: |
| 2579 | return self._rescale(0, rounding) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2580 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2581 | # the method name changed, but we provide also the old one, for compatibility |
| 2582 | to_integral = to_integral_value |
| 2583 | |
| 2584 | def sqrt(self, context=None): |
| 2585 | """Return the square root of self.""" |
Christian Heimes | 0348fb6 | 2008-03-26 12:55:56 +0000 | [diff] [blame] | 2586 | if context is None: |
| 2587 | context = getcontext() |
| 2588 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2589 | if self._is_special: |
| 2590 | ans = self._check_nans(context=context) |
| 2591 | if ans: |
| 2592 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2593 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2594 | if self._isinfinity() and self._sign == 0: |
| 2595 | return Decimal(self) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2596 | |
| 2597 | if not self: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2598 | # exponent = self._exp // 2. sqrt(-0) = -0 |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2599 | ans = _dec_from_triple(self._sign, '0', self._exp // 2) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2600 | return ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2601 | |
| 2602 | if self._sign == 1: |
| 2603 | return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0') |
| 2604 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2605 | # At this point self represents a positive number. Let p be |
| 2606 | # the desired precision and express self in the form c*100**e |
| 2607 | # with c a positive real number and e an integer, c and e |
| 2608 | # being chosen so that 100**(p-1) <= c < 100**p. Then the |
| 2609 | # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1) |
| 2610 | # <= sqrt(c) < 10**p, so the closest representable Decimal at |
| 2611 | # precision p is n*10**e where n = round_half_even(sqrt(c)), |
| 2612 | # the closest integer to sqrt(c) with the even integer chosen |
| 2613 | # in the case of a tie. |
| 2614 | # |
| 2615 | # To ensure correct rounding in all cases, we use the |
| 2616 | # following trick: we compute the square root to an extra |
| 2617 | # place (precision p+1 instead of precision p), rounding down. |
| 2618 | # Then, if the result is inexact and its last digit is 0 or 5, |
| 2619 | # we increase the last digit to 1 or 6 respectively; if it's |
| 2620 | # exact we leave the last digit alone. Now the final round to |
| 2621 | # p places (or fewer in the case of underflow) will round |
| 2622 | # correctly and raise the appropriate flags. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2623 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2624 | # use an extra digit of precision |
| 2625 | prec = context.prec+1 |
| 2626 | |
| 2627 | # write argument in the form c*100**e where e = self._exp//2 |
| 2628 | # is the 'ideal' exponent, to be used if the square root is |
| 2629 | # exactly representable. l is the number of 'digits' of c in |
| 2630 | # base 100, so that 100**(l-1) <= c < 100**l. |
| 2631 | op = _WorkRep(self) |
| 2632 | e = op.exp >> 1 |
| 2633 | if op.exp & 1: |
| 2634 | c = op.int * 10 |
| 2635 | l = (len(self._int) >> 1) + 1 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2636 | else: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2637 | c = op.int |
| 2638 | l = len(self._int)+1 >> 1 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2639 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2640 | # rescale so that c has exactly prec base 100 'digits' |
| 2641 | shift = prec-l |
| 2642 | if shift >= 0: |
| 2643 | c *= 100**shift |
| 2644 | exact = True |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2645 | else: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2646 | c, remainder = divmod(c, 100**-shift) |
| 2647 | exact = not remainder |
| 2648 | e -= shift |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2649 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2650 | # find n = floor(sqrt(c)) using Newton's method |
| 2651 | n = 10**prec |
| 2652 | while True: |
| 2653 | q = c//n |
| 2654 | if n <= q: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2655 | break |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2656 | else: |
| 2657 | n = n + q >> 1 |
| 2658 | exact = exact and n*n == c |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2659 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2660 | if exact: |
| 2661 | # result is exact; rescale to use ideal exponent e |
| 2662 | if shift >= 0: |
| 2663 | # assert n % 10**shift == 0 |
| 2664 | n //= 10**shift |
| 2665 | else: |
| 2666 | n *= 10**-shift |
| 2667 | e += shift |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2668 | else: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2669 | # result is not exact; fix last digit as described above |
| 2670 | if n % 5 == 0: |
| 2671 | n += 1 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2672 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2673 | ans = _dec_from_triple(0, str(n), e) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2674 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2675 | # round, and fit to current context |
| 2676 | context = context._shallow_copy() |
| 2677 | rounding = context._set_rounding(ROUND_HALF_EVEN) |
Raymond Hettinger | dab988d | 2004-10-09 07:10:44 +0000 | [diff] [blame] | 2678 | ans = ans._fix(context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2679 | context.rounding = rounding |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2680 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2681 | return ans |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2682 | |
| 2683 | def max(self, other, context=None): |
| 2684 | """Returns the larger value. |
| 2685 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2686 | Like max(self, other) except if one is not a number, returns |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2687 | NaN (and signals if one is sNaN). Also rounds. |
| 2688 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2689 | other = _convert_other(other, raiseit=True) |
| 2690 | |
| 2691 | if context is None: |
| 2692 | context = getcontext() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2693 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2694 | if self._is_special or other._is_special: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 2695 | # If one operand is a quiet NaN and the other is number, then the |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2696 | # number is always returned |
| 2697 | sn = self._isnan() |
| 2698 | on = other._isnan() |
| 2699 | if sn or on: |
Facundo Batista | 708d581 | 2008-12-11 04:20:07 +0000 | [diff] [blame] | 2700 | if on == 1 and sn == 0: |
| 2701 | return self._fix(context) |
| 2702 | if sn == 1 and on == 0: |
| 2703 | return other._fix(context) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2704 | return self._check_nans(other, context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2705 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 2706 | c = self._cmp(other) |
Raymond Hettinger | d6c700a | 2004-08-17 06:39:37 +0000 | [diff] [blame] | 2707 | if c == 0: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 2708 | # If both operands are finite and equal in numerical value |
Raymond Hettinger | d6c700a | 2004-08-17 06:39:37 +0000 | [diff] [blame] | 2709 | # then an ordering is applied: |
| 2710 | # |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 2711 | # If the signs differ then max returns the operand with the |
Raymond Hettinger | d6c700a | 2004-08-17 06:39:37 +0000 | [diff] [blame] | 2712 | # positive sign and min returns the operand with the negative sign |
| 2713 | # |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 2714 | # If the signs are the same then the exponent is used to select |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2715 | # the result. This is exactly the ordering used in compare_total. |
| 2716 | c = self.compare_total(other) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2717 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2718 | if c == -1: |
| 2719 | ans = other |
| 2720 | else: |
| 2721 | ans = self |
| 2722 | |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 2723 | return ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2724 | |
| 2725 | def min(self, other, context=None): |
| 2726 | """Returns the smaller value. |
| 2727 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 2728 | Like min(self, other) except if one is not a number, returns |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2729 | NaN (and signals if one is sNaN). Also rounds. |
| 2730 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2731 | other = _convert_other(other, raiseit=True) |
| 2732 | |
| 2733 | if context is None: |
| 2734 | context = getcontext() |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2735 | |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2736 | if self._is_special or other._is_special: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 2737 | # If one operand is a quiet NaN and the other is number, then the |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2738 | # number is always returned |
| 2739 | sn = self._isnan() |
| 2740 | on = other._isnan() |
| 2741 | if sn or on: |
Facundo Batista | 708d581 | 2008-12-11 04:20:07 +0000 | [diff] [blame] | 2742 | if on == 1 and sn == 0: |
| 2743 | return self._fix(context) |
| 2744 | if sn == 1 and on == 0: |
| 2745 | return other._fix(context) |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2746 | return self._check_nans(other, context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2747 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 2748 | c = self._cmp(other) |
Raymond Hettinger | d6c700a | 2004-08-17 06:39:37 +0000 | [diff] [blame] | 2749 | if c == 0: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2750 | c = self.compare_total(other) |
| 2751 | |
| 2752 | if c == -1: |
| 2753 | ans = self |
| 2754 | else: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2755 | ans = other |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 2756 | |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 2757 | return ans._fix(context) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2758 | |
| 2759 | def _isinteger(self): |
| 2760 | """Returns whether self is an integer""" |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2761 | if self._is_special: |
| 2762 | return False |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2763 | if self._exp >= 0: |
| 2764 | return True |
| 2765 | rest = self._int[self._exp:] |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2766 | return rest == '0'*len(rest) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2767 | |
| 2768 | def _iseven(self): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2769 | """Returns True if self is even. Assumes self is an integer.""" |
| 2770 | if not self or self._exp > 0: |
| 2771 | return True |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2772 | return self._int[-1+self._exp] in '02468' |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2773 | |
| 2774 | def adjusted(self): |
| 2775 | """Return the adjusted exponent of self""" |
| 2776 | try: |
| 2777 | return self._exp + len(self._int) - 1 |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 2778 | # If NaN or Infinity, self._exp is string |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 2779 | except TypeError: |
| 2780 | return 0 |
| 2781 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2782 | def canonical(self, context=None): |
| 2783 | """Returns the same Decimal object. |
| 2784 | |
| 2785 | As we do not have different encodings for the same number, the |
| 2786 | received object already is in its canonical form. |
| 2787 | """ |
| 2788 | return self |
| 2789 | |
| 2790 | def compare_signal(self, other, context=None): |
| 2791 | """Compares self to the other operand numerically. |
| 2792 | |
| 2793 | It's pretty much like compare(), but all NaNs signal, with signaling |
| 2794 | NaNs taking precedence over quiet NaNs. |
| 2795 | """ |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 2796 | other = _convert_other(other, raiseit = True) |
| 2797 | ans = self._compare_check_nans(other, context) |
| 2798 | if ans: |
| 2799 | return ans |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2800 | return self.compare(other, context=context) |
| 2801 | |
| 2802 | def compare_total(self, other): |
| 2803 | """Compares self to other using the abstract representations. |
| 2804 | |
| 2805 | This is not like the standard compare, which use their numerical |
| 2806 | value. Note that a total ordering is defined for all possible abstract |
| 2807 | representations. |
| 2808 | """ |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 2809 | other = _convert_other(other, raiseit=True) |
| 2810 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2811 | # if one is negative and the other is positive, it's easy |
| 2812 | if self._sign and not other._sign: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2813 | return _NegativeOne |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2814 | if not self._sign and other._sign: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2815 | return _One |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2816 | sign = self._sign |
| 2817 | |
| 2818 | # let's handle both NaN types |
| 2819 | self_nan = self._isnan() |
| 2820 | other_nan = other._isnan() |
| 2821 | if self_nan or other_nan: |
| 2822 | if self_nan == other_nan: |
Mark Dickinson | 7a6bcce | 2009-08-28 13:44:35 +0000 | [diff] [blame] | 2823 | # compare payloads as though they're integers |
| 2824 | self_key = len(self._int), self._int |
| 2825 | other_key = len(other._int), other._int |
| 2826 | if self_key < other_key: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2827 | if sign: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2828 | return _One |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2829 | else: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2830 | return _NegativeOne |
Mark Dickinson | 7a6bcce | 2009-08-28 13:44:35 +0000 | [diff] [blame] | 2831 | if self_key > other_key: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2832 | if sign: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2833 | return _NegativeOne |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2834 | else: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2835 | return _One |
| 2836 | return _Zero |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2837 | |
| 2838 | if sign: |
| 2839 | if self_nan == 1: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2840 | return _NegativeOne |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2841 | if other_nan == 1: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2842 | return _One |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2843 | if self_nan == 2: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2844 | return _NegativeOne |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2845 | if other_nan == 2: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2846 | return _One |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2847 | else: |
| 2848 | if self_nan == 1: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2849 | return _One |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2850 | if other_nan == 1: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2851 | return _NegativeOne |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2852 | if self_nan == 2: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2853 | return _One |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2854 | if other_nan == 2: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2855 | return _NegativeOne |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2856 | |
| 2857 | if self < other: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2858 | return _NegativeOne |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2859 | if self > other: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2860 | return _One |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2861 | |
| 2862 | if self._exp < other._exp: |
| 2863 | if sign: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2864 | return _One |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2865 | else: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2866 | return _NegativeOne |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2867 | if self._exp > other._exp: |
| 2868 | if sign: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2869 | return _NegativeOne |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2870 | else: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2871 | return _One |
| 2872 | return _Zero |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2873 | |
| 2874 | |
| 2875 | def compare_total_mag(self, other): |
| 2876 | """Compares self to other using abstract repr., ignoring sign. |
| 2877 | |
| 2878 | Like compare_total, but with operand's sign ignored and assumed to be 0. |
| 2879 | """ |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 2880 | other = _convert_other(other, raiseit=True) |
| 2881 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2882 | s = self.copy_abs() |
| 2883 | o = other.copy_abs() |
| 2884 | return s.compare_total(o) |
| 2885 | |
| 2886 | def copy_abs(self): |
| 2887 | """Returns a copy with the sign set to 0. """ |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2888 | return _dec_from_triple(0, self._int, self._exp, self._is_special) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2889 | |
| 2890 | def copy_negate(self): |
| 2891 | """Returns a copy with the sign inverted.""" |
| 2892 | if self._sign: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2893 | return _dec_from_triple(0, self._int, self._exp, self._is_special) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2894 | else: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2895 | return _dec_from_triple(1, self._int, self._exp, self._is_special) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2896 | |
| 2897 | def copy_sign(self, other): |
| 2898 | """Returns self with the sign of other.""" |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2899 | return _dec_from_triple(other._sign, self._int, |
| 2900 | self._exp, self._is_special) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2901 | |
| 2902 | def exp(self, context=None): |
| 2903 | """Returns e ** self.""" |
| 2904 | |
| 2905 | if context is None: |
| 2906 | context = getcontext() |
| 2907 | |
| 2908 | # exp(NaN) = NaN |
| 2909 | ans = self._check_nans(context=context) |
| 2910 | if ans: |
| 2911 | return ans |
| 2912 | |
| 2913 | # exp(-Infinity) = 0 |
| 2914 | if self._isinfinity() == -1: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2915 | return _Zero |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2916 | |
| 2917 | # exp(0) = 1 |
| 2918 | if not self: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 2919 | return _One |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2920 | |
| 2921 | # exp(Infinity) = Infinity |
| 2922 | if self._isinfinity() == 1: |
| 2923 | return Decimal(self) |
| 2924 | |
| 2925 | # the result is now guaranteed to be inexact (the true |
| 2926 | # mathematical result is transcendental). There's no need to |
| 2927 | # raise Rounded and Inexact here---they'll always be raised as |
| 2928 | # a result of the call to _fix. |
| 2929 | p = context.prec |
| 2930 | adj = self.adjusted() |
| 2931 | |
| 2932 | # we only need to do any computation for quite a small range |
| 2933 | # of adjusted exponents---for example, -29 <= adj <= 10 for |
| 2934 | # the default context. For smaller exponent the result is |
| 2935 | # indistinguishable from 1 at the given precision, while for |
| 2936 | # larger exponent the result either overflows or underflows. |
| 2937 | if self._sign == 0 and adj > len(str((context.Emax+1)*3)): |
| 2938 | # overflow |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2939 | ans = _dec_from_triple(0, '1', context.Emax+1) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2940 | elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)): |
| 2941 | # underflow to 0 |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2942 | ans = _dec_from_triple(0, '1', context.Etiny()-1) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2943 | elif self._sign == 0 and adj < -p: |
| 2944 | # p+1 digits; final round will raise correct flags |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2945 | ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2946 | elif self._sign == 1 and adj < -p-1: |
| 2947 | # p+1 digits; final round will raise correct flags |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2948 | ans = _dec_from_triple(0, '9'*(p+1), -p-1) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2949 | # general case |
| 2950 | else: |
| 2951 | op = _WorkRep(self) |
| 2952 | c, e = op.int, op.exp |
| 2953 | if op.sign == 1: |
| 2954 | c = -c |
| 2955 | |
| 2956 | # compute correctly rounded result: increase precision by |
| 2957 | # 3 digits at a time until we get an unambiguously |
| 2958 | # roundable result |
| 2959 | extra = 3 |
| 2960 | while True: |
| 2961 | coeff, exp = _dexp(c, e, p+extra) |
| 2962 | if coeff % (5*10**(len(str(coeff))-p-1)): |
| 2963 | break |
| 2964 | extra += 3 |
| 2965 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 2966 | ans = _dec_from_triple(0, str(coeff), exp) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2967 | |
| 2968 | # at this stage, ans should round correctly with *any* |
| 2969 | # rounding mode, not just with ROUND_HALF_EVEN |
| 2970 | context = context._shallow_copy() |
| 2971 | rounding = context._set_rounding(ROUND_HALF_EVEN) |
| 2972 | ans = ans._fix(context) |
| 2973 | context.rounding = rounding |
| 2974 | |
| 2975 | return ans |
| 2976 | |
| 2977 | def is_canonical(self): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 2978 | """Return True if self is canonical; otherwise return False. |
| 2979 | |
| 2980 | Currently, the encoding of a Decimal instance is always |
| 2981 | canonical, so this method returns True for any Decimal. |
| 2982 | """ |
| 2983 | return True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2984 | |
| 2985 | def is_finite(self): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 2986 | """Return True if self is finite; otherwise return False. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2987 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 2988 | A Decimal instance is considered finite if it is neither |
| 2989 | infinite nor a NaN. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2990 | """ |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 2991 | return not self._is_special |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2992 | |
| 2993 | def is_infinite(self): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 2994 | """Return True if self is infinite; otherwise return False.""" |
| 2995 | return self._exp == 'F' |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 2996 | |
| 2997 | def is_nan(self): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 2998 | """Return True if self is a qNaN or sNaN; otherwise return False.""" |
| 2999 | return self._exp in ('n', 'N') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3000 | |
| 3001 | def is_normal(self, context=None): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 3002 | """Return True if self is a normal number; otherwise return False.""" |
| 3003 | if self._is_special or not self: |
| 3004 | return False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3005 | if context is None: |
| 3006 | context = getcontext() |
Mark Dickinson | 2d4fce2 | 2009-10-20 13:40:25 +0000 | [diff] [blame] | 3007 | return context.Emin <= self.adjusted() |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3008 | |
| 3009 | def is_qnan(self): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 3010 | """Return True if self is a quiet NaN; otherwise return False.""" |
| 3011 | return self._exp == 'n' |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3012 | |
| 3013 | def is_signed(self): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 3014 | """Return True if self is negative; otherwise return False.""" |
| 3015 | return self._sign == 1 |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3016 | |
| 3017 | def is_snan(self): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 3018 | """Return True if self is a signaling NaN; otherwise return False.""" |
| 3019 | return self._exp == 'N' |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3020 | |
| 3021 | def is_subnormal(self, context=None): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 3022 | """Return True if self is subnormal; otherwise return False.""" |
| 3023 | if self._is_special or not self: |
| 3024 | return False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3025 | if context is None: |
| 3026 | context = getcontext() |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 3027 | return self.adjusted() < context.Emin |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3028 | |
| 3029 | def is_zero(self): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 3030 | """Return True if self is a zero; otherwise return False.""" |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3031 | return not self._is_special and self._int == '0' |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3032 | |
| 3033 | def _ln_exp_bound(self): |
| 3034 | """Compute a lower bound for the adjusted exponent of self.ln(). |
| 3035 | In other words, compute r such that self.ln() >= 10**r. Assumes |
| 3036 | that self is finite and positive and that self != 1. |
| 3037 | """ |
| 3038 | |
| 3039 | # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1 |
| 3040 | adj = self._exp + len(self._int) - 1 |
| 3041 | if adj >= 1: |
| 3042 | # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10) |
| 3043 | return len(str(adj*23//10)) - 1 |
| 3044 | if adj <= -2: |
| 3045 | # argument <= 0.1 |
| 3046 | return len(str((-1-adj)*23//10)) - 1 |
| 3047 | op = _WorkRep(self) |
| 3048 | c, e = op.int, op.exp |
| 3049 | if adj == 0: |
| 3050 | # 1 < self < 10 |
| 3051 | num = str(c-10**-e) |
| 3052 | den = str(c) |
| 3053 | return len(num) - len(den) - (num < den) |
| 3054 | # adj == -1, 0.1 <= self < 1 |
| 3055 | return e + len(str(10**-e - c)) - 1 |
| 3056 | |
| 3057 | |
| 3058 | def ln(self, context=None): |
| 3059 | """Returns the natural (base e) logarithm of self.""" |
| 3060 | |
| 3061 | if context is None: |
| 3062 | context = getcontext() |
| 3063 | |
| 3064 | # ln(NaN) = NaN |
| 3065 | ans = self._check_nans(context=context) |
| 3066 | if ans: |
| 3067 | return ans |
| 3068 | |
| 3069 | # ln(0.0) == -Infinity |
| 3070 | if not self: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 3071 | return _NegativeInfinity |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3072 | |
| 3073 | # ln(Infinity) = Infinity |
| 3074 | if self._isinfinity() == 1: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 3075 | return _Infinity |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3076 | |
| 3077 | # ln(1.0) == 0.0 |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 3078 | if self == _One: |
| 3079 | return _Zero |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3080 | |
| 3081 | # ln(negative) raises InvalidOperation |
| 3082 | if self._sign == 1: |
| 3083 | return context._raise_error(InvalidOperation, |
| 3084 | 'ln of a negative value') |
| 3085 | |
| 3086 | # result is irrational, so necessarily inexact |
| 3087 | op = _WorkRep(self) |
| 3088 | c, e = op.int, op.exp |
| 3089 | p = context.prec |
| 3090 | |
| 3091 | # correctly rounded result: repeatedly increase precision by 3 |
| 3092 | # until we get an unambiguously roundable result |
| 3093 | places = p - self._ln_exp_bound() + 2 # at least p+3 places |
| 3094 | while True: |
| 3095 | coeff = _dlog(c, e, places) |
| 3096 | # assert len(str(abs(coeff)))-p >= 1 |
| 3097 | if coeff % (5*10**(len(str(abs(coeff)))-p-1)): |
| 3098 | break |
| 3099 | places += 3 |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3100 | ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3101 | |
| 3102 | context = context._shallow_copy() |
| 3103 | rounding = context._set_rounding(ROUND_HALF_EVEN) |
| 3104 | ans = ans._fix(context) |
| 3105 | context.rounding = rounding |
| 3106 | return ans |
| 3107 | |
| 3108 | def _log10_exp_bound(self): |
| 3109 | """Compute a lower bound for the adjusted exponent of self.log10(). |
| 3110 | In other words, find r such that self.log10() >= 10**r. |
| 3111 | Assumes that self is finite and positive and that self != 1. |
| 3112 | """ |
| 3113 | |
| 3114 | # For x >= 10 or x < 0.1 we only need a bound on the integer |
| 3115 | # part of log10(self), and this comes directly from the |
| 3116 | # exponent of x. For 0.1 <= x <= 10 we use the inequalities |
| 3117 | # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| > |
| 3118 | # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0 |
| 3119 | |
| 3120 | adj = self._exp + len(self._int) - 1 |
| 3121 | if adj >= 1: |
| 3122 | # self >= 10 |
| 3123 | return len(str(adj))-1 |
| 3124 | if adj <= -2: |
| 3125 | # self < 0.1 |
| 3126 | return len(str(-1-adj))-1 |
| 3127 | op = _WorkRep(self) |
| 3128 | c, e = op.int, op.exp |
| 3129 | if adj == 0: |
| 3130 | # 1 < self < 10 |
| 3131 | num = str(c-10**-e) |
| 3132 | den = str(231*c) |
| 3133 | return len(num) - len(den) - (num < den) + 2 |
| 3134 | # adj == -1, 0.1 <= self < 1 |
| 3135 | num = str(10**-e-c) |
| 3136 | return len(num) + e - (num < "231") - 1 |
| 3137 | |
| 3138 | def log10(self, context=None): |
| 3139 | """Returns the base 10 logarithm of self.""" |
| 3140 | |
| 3141 | if context is None: |
| 3142 | context = getcontext() |
| 3143 | |
| 3144 | # log10(NaN) = NaN |
| 3145 | ans = self._check_nans(context=context) |
| 3146 | if ans: |
| 3147 | return ans |
| 3148 | |
| 3149 | # log10(0.0) == -Infinity |
| 3150 | if not self: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 3151 | return _NegativeInfinity |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3152 | |
| 3153 | # log10(Infinity) = Infinity |
| 3154 | if self._isinfinity() == 1: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 3155 | return _Infinity |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3156 | |
| 3157 | # log10(negative or -Infinity) raises InvalidOperation |
| 3158 | if self._sign == 1: |
| 3159 | return context._raise_error(InvalidOperation, |
| 3160 | 'log10 of a negative value') |
| 3161 | |
| 3162 | # log10(10**n) = n |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3163 | if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3164 | # answer may need rounding |
| 3165 | ans = Decimal(self._exp + len(self._int) - 1) |
| 3166 | else: |
| 3167 | # result is irrational, so necessarily inexact |
| 3168 | op = _WorkRep(self) |
| 3169 | c, e = op.int, op.exp |
| 3170 | p = context.prec |
| 3171 | |
| 3172 | # correctly rounded result: repeatedly increase precision |
| 3173 | # until result is unambiguously roundable |
| 3174 | places = p-self._log10_exp_bound()+2 |
| 3175 | while True: |
| 3176 | coeff = _dlog10(c, e, places) |
| 3177 | # assert len(str(abs(coeff)))-p >= 1 |
| 3178 | if coeff % (5*10**(len(str(abs(coeff)))-p-1)): |
| 3179 | break |
| 3180 | places += 3 |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3181 | ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3182 | |
| 3183 | context = context._shallow_copy() |
| 3184 | rounding = context._set_rounding(ROUND_HALF_EVEN) |
| 3185 | ans = ans._fix(context) |
| 3186 | context.rounding = rounding |
| 3187 | return ans |
| 3188 | |
| 3189 | def logb(self, context=None): |
| 3190 | """ Returns the exponent of the magnitude of self's MSD. |
| 3191 | |
| 3192 | The result is the integer which is the exponent of the magnitude |
| 3193 | of the most significant digit of self (as though it were truncated |
| 3194 | to a single digit while maintaining the value of that digit and |
| 3195 | without limiting the resulting exponent). |
| 3196 | """ |
| 3197 | # logb(NaN) = NaN |
| 3198 | ans = self._check_nans(context=context) |
| 3199 | if ans: |
| 3200 | return ans |
| 3201 | |
| 3202 | if context is None: |
| 3203 | context = getcontext() |
| 3204 | |
| 3205 | # logb(+/-Inf) = +Inf |
| 3206 | if self._isinfinity(): |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 3207 | return _Infinity |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3208 | |
| 3209 | # logb(0) = -Inf, DivisionByZero |
| 3210 | if not self: |
| 3211 | return context._raise_error(DivisionByZero, 'logb(0)', 1) |
| 3212 | |
| 3213 | # otherwise, simply return the adjusted exponent of self, as a |
| 3214 | # Decimal. Note that no attempt is made to fit the result |
| 3215 | # into the current context. |
Mark Dickinson | b090761 | 2009-10-07 19:24:43 +0000 | [diff] [blame] | 3216 | ans = Decimal(self.adjusted()) |
| 3217 | return ans._fix(context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3218 | |
| 3219 | def _islogical(self): |
| 3220 | """Return True if self is a logical operand. |
| 3221 | |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 3222 | For being logical, it must be a finite number with a sign of 0, |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3223 | an exponent of 0, and a coefficient whose digits must all be |
| 3224 | either 0 or 1. |
| 3225 | """ |
| 3226 | if self._sign != 0 or self._exp != 0: |
| 3227 | return False |
| 3228 | for dig in self._int: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3229 | if dig not in '01': |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3230 | return False |
| 3231 | return True |
| 3232 | |
| 3233 | def _fill_logical(self, context, opa, opb): |
| 3234 | dif = context.prec - len(opa) |
| 3235 | if dif > 0: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3236 | opa = '0'*dif + opa |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3237 | elif dif < 0: |
| 3238 | opa = opa[-context.prec:] |
| 3239 | dif = context.prec - len(opb) |
| 3240 | if dif > 0: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3241 | opb = '0'*dif + opb |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3242 | elif dif < 0: |
| 3243 | opb = opb[-context.prec:] |
| 3244 | return opa, opb |
| 3245 | |
| 3246 | def logical_and(self, other, context=None): |
| 3247 | """Applies an 'and' operation between self and other's digits.""" |
| 3248 | if context is None: |
| 3249 | context = getcontext() |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3250 | |
| 3251 | other = _convert_other(other, raiseit=True) |
| 3252 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3253 | if not self._islogical() or not other._islogical(): |
| 3254 | return context._raise_error(InvalidOperation) |
| 3255 | |
| 3256 | # fill to context.prec |
| 3257 | (opa, opb) = self._fill_logical(context, self._int, other._int) |
| 3258 | |
| 3259 | # make the operation, and clean starting zeroes |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3260 | result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)]) |
| 3261 | return _dec_from_triple(0, result.lstrip('0') or '0', 0) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3262 | |
| 3263 | def logical_invert(self, context=None): |
| 3264 | """Invert all its digits.""" |
| 3265 | if context is None: |
| 3266 | context = getcontext() |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3267 | return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0), |
| 3268 | context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3269 | |
| 3270 | def logical_or(self, other, context=None): |
| 3271 | """Applies an 'or' operation between self and other's digits.""" |
| 3272 | if context is None: |
| 3273 | context = getcontext() |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3274 | |
| 3275 | other = _convert_other(other, raiseit=True) |
| 3276 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3277 | if not self._islogical() or not other._islogical(): |
| 3278 | return context._raise_error(InvalidOperation) |
| 3279 | |
| 3280 | # fill to context.prec |
| 3281 | (opa, opb) = self._fill_logical(context, self._int, other._int) |
| 3282 | |
| 3283 | # make the operation, and clean starting zeroes |
Mark Dickinson | 315a20a | 2009-01-04 21:34:18 +0000 | [diff] [blame] | 3284 | result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)]) |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3285 | return _dec_from_triple(0, result.lstrip('0') or '0', 0) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3286 | |
| 3287 | def logical_xor(self, other, context=None): |
| 3288 | """Applies an 'xor' operation between self and other's digits.""" |
| 3289 | if context is None: |
| 3290 | context = getcontext() |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3291 | |
| 3292 | other = _convert_other(other, raiseit=True) |
| 3293 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3294 | if not self._islogical() or not other._islogical(): |
| 3295 | return context._raise_error(InvalidOperation) |
| 3296 | |
| 3297 | # fill to context.prec |
| 3298 | (opa, opb) = self._fill_logical(context, self._int, other._int) |
| 3299 | |
| 3300 | # make the operation, and clean starting zeroes |
Mark Dickinson | 315a20a | 2009-01-04 21:34:18 +0000 | [diff] [blame] | 3301 | result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)]) |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3302 | return _dec_from_triple(0, result.lstrip('0') or '0', 0) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3303 | |
| 3304 | def max_mag(self, other, context=None): |
| 3305 | """Compares the values numerically with their sign ignored.""" |
| 3306 | other = _convert_other(other, raiseit=True) |
| 3307 | |
| 3308 | if context is None: |
| 3309 | context = getcontext() |
| 3310 | |
| 3311 | if self._is_special or other._is_special: |
| 3312 | # If one operand is a quiet NaN and the other is number, then the |
| 3313 | # number is always returned |
| 3314 | sn = self._isnan() |
| 3315 | on = other._isnan() |
| 3316 | if sn or on: |
Facundo Batista | 708d581 | 2008-12-11 04:20:07 +0000 | [diff] [blame] | 3317 | if on == 1 and sn == 0: |
| 3318 | return self._fix(context) |
| 3319 | if sn == 1 and on == 0: |
| 3320 | return other._fix(context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3321 | return self._check_nans(other, context) |
| 3322 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 3323 | c = self.copy_abs()._cmp(other.copy_abs()) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3324 | if c == 0: |
| 3325 | c = self.compare_total(other) |
| 3326 | |
| 3327 | if c == -1: |
| 3328 | ans = other |
| 3329 | else: |
| 3330 | ans = self |
| 3331 | |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 3332 | return ans._fix(context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3333 | |
| 3334 | def min_mag(self, other, context=None): |
| 3335 | """Compares the values numerically with their sign ignored.""" |
| 3336 | other = _convert_other(other, raiseit=True) |
| 3337 | |
| 3338 | if context is None: |
| 3339 | context = getcontext() |
| 3340 | |
| 3341 | if self._is_special or other._is_special: |
| 3342 | # If one operand is a quiet NaN and the other is number, then the |
| 3343 | # number is always returned |
| 3344 | sn = self._isnan() |
| 3345 | on = other._isnan() |
| 3346 | if sn or on: |
Facundo Batista | 708d581 | 2008-12-11 04:20:07 +0000 | [diff] [blame] | 3347 | if on == 1 and sn == 0: |
| 3348 | return self._fix(context) |
| 3349 | if sn == 1 and on == 0: |
| 3350 | return other._fix(context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3351 | return self._check_nans(other, context) |
| 3352 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 3353 | c = self.copy_abs()._cmp(other.copy_abs()) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3354 | if c == 0: |
| 3355 | c = self.compare_total(other) |
| 3356 | |
| 3357 | if c == -1: |
| 3358 | ans = self |
| 3359 | else: |
| 3360 | ans = other |
| 3361 | |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 3362 | return ans._fix(context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3363 | |
| 3364 | def next_minus(self, context=None): |
| 3365 | """Returns the largest representable number smaller than itself.""" |
| 3366 | if context is None: |
| 3367 | context = getcontext() |
| 3368 | |
| 3369 | ans = self._check_nans(context=context) |
| 3370 | if ans: |
| 3371 | return ans |
| 3372 | |
| 3373 | if self._isinfinity() == -1: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 3374 | return _NegativeInfinity |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3375 | if self._isinfinity() == 1: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3376 | return _dec_from_triple(0, '9'*context.prec, context.Etop()) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3377 | |
| 3378 | context = context.copy() |
| 3379 | context._set_rounding(ROUND_FLOOR) |
| 3380 | context._ignore_all_flags() |
| 3381 | new_self = self._fix(context) |
| 3382 | if new_self != self: |
| 3383 | return new_self |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3384 | return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1), |
| 3385 | context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3386 | |
| 3387 | def next_plus(self, context=None): |
| 3388 | """Returns the smallest representable number larger than itself.""" |
| 3389 | if context is None: |
| 3390 | context = getcontext() |
| 3391 | |
| 3392 | ans = self._check_nans(context=context) |
| 3393 | if ans: |
| 3394 | return ans |
| 3395 | |
| 3396 | if self._isinfinity() == 1: |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 3397 | return _Infinity |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3398 | if self._isinfinity() == -1: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3399 | return _dec_from_triple(1, '9'*context.prec, context.Etop()) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3400 | |
| 3401 | context = context.copy() |
| 3402 | context._set_rounding(ROUND_CEILING) |
| 3403 | context._ignore_all_flags() |
| 3404 | new_self = self._fix(context) |
| 3405 | if new_self != self: |
| 3406 | return new_self |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3407 | return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1), |
| 3408 | context) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3409 | |
| 3410 | def next_toward(self, other, context=None): |
| 3411 | """Returns the number closest to self, in the direction towards other. |
| 3412 | |
| 3413 | The result is the closest representable number to self |
| 3414 | (excluding self) that is in the direction towards other, |
| 3415 | unless both have the same value. If the two operands are |
| 3416 | numerically equal, then the result is a copy of self with the |
| 3417 | sign set to be the same as the sign of other. |
| 3418 | """ |
| 3419 | other = _convert_other(other, raiseit=True) |
| 3420 | |
| 3421 | if context is None: |
| 3422 | context = getcontext() |
| 3423 | |
| 3424 | ans = self._check_nans(other, context) |
| 3425 | if ans: |
| 3426 | return ans |
| 3427 | |
Christian Heimes | 77c02eb | 2008-02-09 02:18:51 +0000 | [diff] [blame] | 3428 | comparison = self._cmp(other) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3429 | if comparison == 0: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3430 | return self.copy_sign(other) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3431 | |
| 3432 | if comparison == -1: |
| 3433 | ans = self.next_plus(context) |
| 3434 | else: # comparison == 1 |
| 3435 | ans = self.next_minus(context) |
| 3436 | |
| 3437 | # decide which flags to raise using value of ans |
| 3438 | if ans._isinfinity(): |
| 3439 | context._raise_error(Overflow, |
| 3440 | 'Infinite result from next_toward', |
| 3441 | ans._sign) |
| 3442 | context._raise_error(Rounded) |
| 3443 | context._raise_error(Inexact) |
| 3444 | elif ans.adjusted() < context.Emin: |
| 3445 | context._raise_error(Underflow) |
| 3446 | context._raise_error(Subnormal) |
| 3447 | context._raise_error(Rounded) |
| 3448 | context._raise_error(Inexact) |
| 3449 | # if precision == 1 then we don't raise Clamped for a |
| 3450 | # result 0E-Etiny. |
| 3451 | if not ans: |
| 3452 | context._raise_error(Clamped) |
| 3453 | |
| 3454 | return ans |
| 3455 | |
| 3456 | def number_class(self, context=None): |
| 3457 | """Returns an indication of the class of self. |
| 3458 | |
| 3459 | The class is one of the following strings: |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 3460 | sNaN |
| 3461 | NaN |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3462 | -Infinity |
| 3463 | -Normal |
| 3464 | -Subnormal |
| 3465 | -Zero |
| 3466 | +Zero |
| 3467 | +Subnormal |
| 3468 | +Normal |
| 3469 | +Infinity |
| 3470 | """ |
| 3471 | if self.is_snan(): |
| 3472 | return "sNaN" |
| 3473 | if self.is_qnan(): |
| 3474 | return "NaN" |
| 3475 | inf = self._isinfinity() |
| 3476 | if inf == 1: |
| 3477 | return "+Infinity" |
| 3478 | if inf == -1: |
| 3479 | return "-Infinity" |
| 3480 | if self.is_zero(): |
| 3481 | if self._sign: |
| 3482 | return "-Zero" |
| 3483 | else: |
| 3484 | return "+Zero" |
| 3485 | if context is None: |
| 3486 | context = getcontext() |
| 3487 | if self.is_subnormal(context=context): |
| 3488 | if self._sign: |
| 3489 | return "-Subnormal" |
| 3490 | else: |
| 3491 | return "+Subnormal" |
| 3492 | # just a normal, regular, boring number, :) |
| 3493 | if self._sign: |
| 3494 | return "-Normal" |
| 3495 | else: |
| 3496 | return "+Normal" |
| 3497 | |
| 3498 | def radix(self): |
| 3499 | """Just returns 10, as this is Decimal, :)""" |
| 3500 | return Decimal(10) |
| 3501 | |
| 3502 | def rotate(self, other, context=None): |
| 3503 | """Returns a rotated copy of self, value-of-other times.""" |
| 3504 | if context is None: |
| 3505 | context = getcontext() |
| 3506 | |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3507 | other = _convert_other(other, raiseit=True) |
| 3508 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3509 | ans = self._check_nans(other, context) |
| 3510 | if ans: |
| 3511 | return ans |
| 3512 | |
| 3513 | if other._exp != 0: |
| 3514 | return context._raise_error(InvalidOperation) |
| 3515 | if not (-context.prec <= int(other) <= context.prec): |
| 3516 | return context._raise_error(InvalidOperation) |
| 3517 | |
| 3518 | if self._isinfinity(): |
| 3519 | return Decimal(self) |
| 3520 | |
| 3521 | # get values, pad if necessary |
| 3522 | torot = int(other) |
| 3523 | rotdig = self._int |
| 3524 | topad = context.prec - len(rotdig) |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3525 | if topad > 0: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3526 | rotdig = '0'*topad + rotdig |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3527 | elif topad < 0: |
| 3528 | rotdig = rotdig[-topad:] |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3529 | |
| 3530 | # let's rotate! |
| 3531 | rotated = rotdig[torot:] + rotdig[:torot] |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3532 | return _dec_from_triple(self._sign, |
| 3533 | rotated.lstrip('0') or '0', self._exp) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3534 | |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3535 | def scaleb(self, other, context=None): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3536 | """Returns self operand after adding the second value to its exp.""" |
| 3537 | if context is None: |
| 3538 | context = getcontext() |
| 3539 | |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3540 | other = _convert_other(other, raiseit=True) |
| 3541 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3542 | ans = self._check_nans(other, context) |
| 3543 | if ans: |
| 3544 | return ans |
| 3545 | |
| 3546 | if other._exp != 0: |
| 3547 | return context._raise_error(InvalidOperation) |
| 3548 | liminf = -2 * (context.Emax + context.prec) |
| 3549 | limsup = 2 * (context.Emax + context.prec) |
| 3550 | if not (liminf <= int(other) <= limsup): |
| 3551 | return context._raise_error(InvalidOperation) |
| 3552 | |
| 3553 | if self._isinfinity(): |
| 3554 | return Decimal(self) |
| 3555 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3556 | d = _dec_from_triple(self._sign, self._int, self._exp + int(other)) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3557 | d = d._fix(context) |
| 3558 | return d |
| 3559 | |
| 3560 | def shift(self, other, context=None): |
| 3561 | """Returns a shifted copy of self, value-of-other times.""" |
| 3562 | if context is None: |
| 3563 | context = getcontext() |
| 3564 | |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3565 | other = _convert_other(other, raiseit=True) |
| 3566 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3567 | ans = self._check_nans(other, context) |
| 3568 | if ans: |
| 3569 | return ans |
| 3570 | |
| 3571 | if other._exp != 0: |
| 3572 | return context._raise_error(InvalidOperation) |
| 3573 | if not (-context.prec <= int(other) <= context.prec): |
| 3574 | return context._raise_error(InvalidOperation) |
| 3575 | |
| 3576 | if self._isinfinity(): |
| 3577 | return Decimal(self) |
| 3578 | |
| 3579 | # get values, pad if necessary |
| 3580 | torot = int(other) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3581 | rotdig = self._int |
| 3582 | topad = context.prec - len(rotdig) |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3583 | if topad > 0: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3584 | rotdig = '0'*topad + rotdig |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3585 | elif topad < 0: |
| 3586 | rotdig = rotdig[-topad:] |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3587 | |
| 3588 | # let's shift! |
| 3589 | if torot < 0: |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3590 | shifted = rotdig[:torot] |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3591 | else: |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3592 | shifted = rotdig + '0'*torot |
| 3593 | shifted = shifted[-context.prec:] |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3594 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3595 | return _dec_from_triple(self._sign, |
Mark Dickinson | 9050bb2 | 2009-10-29 12:25:07 +0000 | [diff] [blame^] | 3596 | shifted.lstrip('0') or '0', self._exp) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3597 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3598 | # Support for pickling, copy, and deepcopy |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3599 | def __reduce__(self): |
| 3600 | return (self.__class__, (str(self),)) |
| 3601 | |
| 3602 | def __copy__(self): |
| 3603 | if type(self) == Decimal: |
| 3604 | return self # I'm immutable; therefore I am my own clone |
| 3605 | return self.__class__(str(self)) |
| 3606 | |
| 3607 | def __deepcopy__(self, memo): |
| 3608 | if type(self) == Decimal: |
| 3609 | return self # My components are also immutable |
| 3610 | return self.__class__(str(self)) |
| 3611 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3612 | # PEP 3101 support. the _localeconv keyword argument should be |
| 3613 | # considered private: it's provided for ease of testing only. |
| 3614 | def __format__(self, specifier, context=None, _localeconv=None): |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3615 | """Format a Decimal instance according to the given specifier. |
| 3616 | |
| 3617 | The specifier should be a standard format specifier, with the |
| 3618 | form described in PEP 3101. Formatting types 'e', 'E', 'f', |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3619 | 'F', 'g', 'G', 'n' and '%' are supported. If the formatting |
| 3620 | type is omitted it defaults to 'g' or 'G', depending on the |
| 3621 | value of context.capitals. |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3622 | """ |
| 3623 | |
| 3624 | # Note: PEP 3101 says that if the type is not present then |
| 3625 | # there should be at least one digit after the decimal point. |
| 3626 | # We take the liberty of ignoring this requirement for |
| 3627 | # Decimal---it's presumably there to make sure that |
| 3628 | # format(float, '') behaves similarly to str(float). |
| 3629 | if context is None: |
| 3630 | context = getcontext() |
| 3631 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3632 | spec = _parse_format_specifier(specifier, _localeconv=_localeconv) |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3633 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3634 | # special values don't care about the type or precision |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3635 | if self._is_special: |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3636 | sign = _format_sign(self._sign, spec) |
| 3637 | body = str(self.copy_abs()) |
| 3638 | return _format_align(sign, body, spec) |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3639 | |
| 3640 | # a type of None defaults to 'g' or 'G', depending on context |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3641 | if spec['type'] is None: |
| 3642 | spec['type'] = ['g', 'G'][context.capitals] |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3643 | |
| 3644 | # if type is '%', adjust exponent of self accordingly |
| 3645 | if spec['type'] == '%': |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3646 | self = _dec_from_triple(self._sign, self._int, self._exp+2) |
| 3647 | |
| 3648 | # round if necessary, taking rounding mode from the context |
| 3649 | rounding = context.rounding |
| 3650 | precision = spec['precision'] |
| 3651 | if precision is not None: |
| 3652 | if spec['type'] in 'eE': |
| 3653 | self = self._round(precision+1, rounding) |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3654 | elif spec['type'] in 'fF%': |
| 3655 | self = self._rescale(-precision, rounding) |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3656 | elif spec['type'] in 'gG' and len(self._int) > precision: |
| 3657 | self = self._round(precision, rounding) |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3658 | # special case: zeros with a positive exponent can't be |
| 3659 | # represented in fixed point; rescale them to 0e0. |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3660 | if not self and self._exp > 0 and spec['type'] in 'fF%': |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3661 | self = self._rescale(0, rounding) |
| 3662 | |
| 3663 | # figure out placement of the decimal point |
| 3664 | leftdigits = self._exp + len(self._int) |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3665 | if spec['type'] in 'eE': |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3666 | if not self and precision is not None: |
| 3667 | dotplace = 1 - precision |
| 3668 | else: |
| 3669 | dotplace = 1 |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3670 | elif spec['type'] in 'fF%': |
| 3671 | dotplace = leftdigits |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3672 | elif spec['type'] in 'gG': |
| 3673 | if self._exp <= 0 and leftdigits > -6: |
| 3674 | dotplace = leftdigits |
| 3675 | else: |
| 3676 | dotplace = 1 |
| 3677 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3678 | # find digits before and after decimal point, and get exponent |
| 3679 | if dotplace < 0: |
| 3680 | intpart = '0' |
| 3681 | fracpart = '0'*(-dotplace) + self._int |
| 3682 | elif dotplace > len(self._int): |
| 3683 | intpart = self._int + '0'*(dotplace-len(self._int)) |
| 3684 | fracpart = '' |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3685 | else: |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3686 | intpart = self._int[:dotplace] or '0' |
| 3687 | fracpart = self._int[dotplace:] |
| 3688 | exp = leftdigits-dotplace |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3689 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 3690 | # done with the decimal-specific stuff; hand over the rest |
| 3691 | # of the formatting to the _format_number function |
| 3692 | return _format_number(self._sign, intpart, fracpart, exp, spec) |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 3693 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 3694 | def _dec_from_triple(sign, coefficient, exponent, special=False): |
| 3695 | """Create a decimal instance directly, without any validation, |
| 3696 | normalization (e.g. removal of leading zeros) or argument |
| 3697 | conversion. |
| 3698 | |
| 3699 | This function is for *internal use only*. |
| 3700 | """ |
| 3701 | |
| 3702 | self = object.__new__(Decimal) |
| 3703 | self._sign = sign |
| 3704 | self._int = coefficient |
| 3705 | self._exp = exponent |
| 3706 | self._is_special = special |
| 3707 | |
| 3708 | return self |
| 3709 | |
Raymond Hettinger | 82417ca | 2009-02-03 03:54:28 +0000 | [diff] [blame] | 3710 | # Register Decimal as a kind of Number (an abstract base class). |
| 3711 | # However, do not register it as Real (because Decimals are not |
| 3712 | # interoperable with floats). |
| 3713 | _numbers.Number.register(Decimal) |
| 3714 | |
| 3715 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3716 | ##### Context class ####################################################### |
Raymond Hettinger | d9c0a7a | 2004-07-03 10:02:28 +0000 | [diff] [blame] | 3717 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3718 | |
| 3719 | # get rounding method function: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3720 | rounding_functions = [name for name in Decimal.__dict__.keys() |
| 3721 | if name.startswith('_round_')] |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3722 | for name in rounding_functions: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3723 | # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3724 | globalname = name[1:].upper() |
| 3725 | val = globals()[globalname] |
| 3726 | Decimal._pick_rounding_function[val] = name |
| 3727 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3728 | del name, val, globalname, rounding_functions |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3729 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 3730 | class _ContextManager(object): |
| 3731 | """Context manager class to support localcontext(). |
Guido van Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 3732 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 3733 | Sets a copy of the supplied context in __enter__() and restores |
| 3734 | the previous decimal context in __exit__() |
Guido van Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 3735 | """ |
| 3736 | def __init__(self, new_context): |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 3737 | self.new_context = new_context.copy() |
Guido van Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 3738 | def __enter__(self): |
| 3739 | self.saved_context = getcontext() |
| 3740 | setcontext(self.new_context) |
| 3741 | return self.new_context |
| 3742 | def __exit__(self, t, v, tb): |
| 3743 | setcontext(self.saved_context) |
Guido van Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 3744 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3745 | class Context(object): |
| 3746 | """Contains the context for a Decimal instance. |
| 3747 | |
| 3748 | Contains: |
| 3749 | prec - precision (for use in rounding, division, square roots..) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3750 | rounding - rounding type (how you round) |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 3751 | traps - If traps[exception] = 1, then the exception is |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3752 | raised when it is caused. Otherwise, a value is |
| 3753 | substituted in. |
Raymond Hettinger | 86173da | 2008-02-01 20:38:12 +0000 | [diff] [blame] | 3754 | flags - When an exception is caused, flags[exception] is set. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3755 | (Whether or not the trap_enabler is set) |
| 3756 | Should be reset by user of Decimal instance. |
Raymond Hettinger | 0ea241e | 2004-07-04 13:53:24 +0000 | [diff] [blame] | 3757 | Emin - Minimum exponent |
| 3758 | Emax - Maximum exponent |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3759 | capitals - If 1, 1*10^1 is printed as 1E+1. |
| 3760 | If 0, printed as 1e1 |
Raymond Hettinger | e0f1581 | 2004-07-05 05:36:39 +0000 | [diff] [blame] | 3761 | _clamp - If 1, change exponents if too high (Default 0) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3762 | """ |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3763 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3764 | def __init__(self, prec=None, rounding=None, |
Raymond Hettinger | abf8a56 | 2004-10-12 09:12:16 +0000 | [diff] [blame] | 3765 | traps=None, flags=None, |
Raymond Hettinger | 0ea241e | 2004-07-04 13:53:24 +0000 | [diff] [blame] | 3766 | Emin=None, Emax=None, |
Raymond Hettinger | e0f1581 | 2004-07-05 05:36:39 +0000 | [diff] [blame] | 3767 | capitals=None, _clamp=0, |
Raymond Hettinger | abf8a56 | 2004-10-12 09:12:16 +0000 | [diff] [blame] | 3768 | _ignored_flags=None): |
| 3769 | if flags is None: |
| 3770 | flags = [] |
| 3771 | if _ignored_flags is None: |
| 3772 | _ignored_flags = [] |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 3773 | if not isinstance(flags, dict): |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 3774 | flags = dict([(s, int(s in flags)) for s in _signals]) |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 3775 | if traps is not None and not isinstance(traps, dict): |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 3776 | traps = dict([(s, int(s in traps)) for s in _signals]) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3777 | for name, val in locals().items(): |
| 3778 | if val is None: |
Raymond Hettinger | eb26084 | 2005-06-07 18:52:34 +0000 | [diff] [blame] | 3779 | setattr(self, name, _copy.copy(getattr(DefaultContext, name))) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3780 | else: |
| 3781 | setattr(self, name, val) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3782 | del self.self |
| 3783 | |
Raymond Hettinger | b1b605e | 2004-07-04 01:55:39 +0000 | [diff] [blame] | 3784 | def __repr__(self): |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 3785 | """Show the current context.""" |
Raymond Hettinger | b1b605e | 2004-07-04 01:55:39 +0000 | [diff] [blame] | 3786 | s = [] |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3787 | s.append('Context(prec=%(prec)d, rounding=%(rounding)s, ' |
| 3788 | 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d' |
| 3789 | % vars(self)) |
| 3790 | names = [f.__name__ for f, v in self.flags.items() if v] |
| 3791 | s.append('flags=[' + ', '.join(names) + ']') |
| 3792 | names = [t.__name__ for t, v in self.traps.items() if v] |
| 3793 | s.append('traps=[' + ', '.join(names) + ']') |
Raymond Hettinger | b1b605e | 2004-07-04 01:55:39 +0000 | [diff] [blame] | 3794 | return ', '.join(s) + ')' |
| 3795 | |
Raymond Hettinger | d9c0a7a | 2004-07-03 10:02:28 +0000 | [diff] [blame] | 3796 | def clear_flags(self): |
| 3797 | """Reset all flags to zero""" |
| 3798 | for flag in self.flags: |
Raymond Hettinger | b1b605e | 2004-07-04 01:55:39 +0000 | [diff] [blame] | 3799 | self.flags[flag] = 0 |
Raymond Hettinger | d9c0a7a | 2004-07-03 10:02:28 +0000 | [diff] [blame] | 3800 | |
Raymond Hettinger | 9fce44b | 2004-08-08 04:03:24 +0000 | [diff] [blame] | 3801 | def _shallow_copy(self): |
| 3802 | """Returns a shallow copy from self.""" |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 3803 | nc = Context(self.prec, self.rounding, self.traps, |
| 3804 | self.flags, self.Emin, self.Emax, |
| 3805 | self.capitals, self._clamp, self._ignored_flags) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3806 | return nc |
Raymond Hettinger | 9fce44b | 2004-08-08 04:03:24 +0000 | [diff] [blame] | 3807 | |
| 3808 | def copy(self): |
| 3809 | """Returns a deep copy from self.""" |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3810 | nc = Context(self.prec, self.rounding, self.traps.copy(), |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 3811 | self.flags.copy(), self.Emin, self.Emax, |
| 3812 | self.capitals, self._clamp, self._ignored_flags) |
Raymond Hettinger | 9fce44b | 2004-08-08 04:03:24 +0000 | [diff] [blame] | 3813 | return nc |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3814 | __copy__ = copy |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3815 | |
Raymond Hettinger | 5aa478b | 2004-07-09 10:02:53 +0000 | [diff] [blame] | 3816 | def _raise_error(self, condition, explanation = None, *args): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3817 | """Handles an error |
| 3818 | |
| 3819 | If the flag is in _ignored_flags, returns the default response. |
Raymond Hettinger | 86173da | 2008-02-01 20:38:12 +0000 | [diff] [blame] | 3820 | Otherwise, it sets the flag, then, if the corresponding |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3821 | trap_enabler is set, it reaises the exception. Otherwise, it returns |
Raymond Hettinger | 86173da | 2008-02-01 20:38:12 +0000 | [diff] [blame] | 3822 | the default value after setting the flag. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3823 | """ |
Raymond Hettinger | 5aa478b | 2004-07-09 10:02:53 +0000 | [diff] [blame] | 3824 | error = _condition_map.get(condition, condition) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3825 | if error in self._ignored_flags: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3826 | # Don't touch the flag |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3827 | return error().handle(self, *args) |
| 3828 | |
Raymond Hettinger | 86173da | 2008-02-01 20:38:12 +0000 | [diff] [blame] | 3829 | self.flags[error] = 1 |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 3830 | if not self.traps[error]: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3831 | # The errors define how to handle themselves. |
Raymond Hettinger | 5aa478b | 2004-07-09 10:02:53 +0000 | [diff] [blame] | 3832 | return condition().handle(self, *args) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3833 | |
| 3834 | # Errors should only be risked on copies of the context |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3835 | # self._ignored_flags = [] |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 3836 | raise error(explanation) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3837 | |
| 3838 | def _ignore_all_flags(self): |
| 3839 | """Ignore all flags, if they are raised""" |
Raymond Hettinger | fed5296 | 2004-07-14 15:41:57 +0000 | [diff] [blame] | 3840 | return self._ignore_flags(*_signals) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3841 | |
| 3842 | def _ignore_flags(self, *flags): |
| 3843 | """Ignore the flags, if they are raised""" |
| 3844 | # Do not mutate-- This way, copies of a context leave the original |
| 3845 | # alone. |
| 3846 | self._ignored_flags = (self._ignored_flags + list(flags)) |
| 3847 | return list(flags) |
| 3848 | |
| 3849 | def _regard_flags(self, *flags): |
| 3850 | """Stop ignoring the flags, if they are raised""" |
| 3851 | if flags and isinstance(flags[0], (tuple,list)): |
| 3852 | flags = flags[0] |
| 3853 | for flag in flags: |
| 3854 | self._ignored_flags.remove(flag) |
| 3855 | |
Nick Coghlan | d1abd25 | 2008-07-15 15:46:38 +0000 | [diff] [blame] | 3856 | # We inherit object.__hash__, so we must deny this explicitly |
| 3857 | __hash__ = None |
Raymond Hettinger | 5aa478b | 2004-07-09 10:02:53 +0000 | [diff] [blame] | 3858 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3859 | def Etiny(self): |
| 3860 | """Returns Etiny (= Emin - prec + 1)""" |
| 3861 | return int(self.Emin - self.prec + 1) |
| 3862 | |
| 3863 | def Etop(self): |
Raymond Hettinger | e0f1581 | 2004-07-05 05:36:39 +0000 | [diff] [blame] | 3864 | """Returns maximum exponent (= Emax - prec + 1)""" |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3865 | return int(self.Emax - self.prec + 1) |
| 3866 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3867 | def _set_rounding(self, type): |
| 3868 | """Sets the rounding type. |
| 3869 | |
| 3870 | Sets the rounding type, and returns the current (previous) |
| 3871 | rounding type. Often used like: |
| 3872 | |
| 3873 | context = context.copy() |
| 3874 | # so you don't change the calling context |
| 3875 | # if an error occurs in the middle. |
| 3876 | rounding = context._set_rounding(ROUND_UP) |
| 3877 | val = self.__sub__(other, context=context) |
| 3878 | context._set_rounding(rounding) |
| 3879 | |
| 3880 | This will make it round up for that operation. |
| 3881 | """ |
| 3882 | rounding = self.rounding |
| 3883 | self.rounding= type |
| 3884 | return rounding |
| 3885 | |
Raymond Hettinger | fed5296 | 2004-07-14 15:41:57 +0000 | [diff] [blame] | 3886 | def create_decimal(self, num='0'): |
Christian Heimes | a62da1d | 2008-01-12 19:39:10 +0000 | [diff] [blame] | 3887 | """Creates a new Decimal instance but using self as context. |
| 3888 | |
| 3889 | This method implements the to-number operation of the |
| 3890 | IBM Decimal specification.""" |
| 3891 | |
| 3892 | if isinstance(num, str) and num != num.strip(): |
| 3893 | return self._raise_error(ConversionSyntax, |
| 3894 | "no trailing or leading whitespace is " |
| 3895 | "permitted.") |
| 3896 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3897 | d = Decimal(num, context=self) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3898 | if d._isnan() and len(d._int) > self.prec - self._clamp: |
| 3899 | return self._raise_error(ConversionSyntax, |
| 3900 | "diagnostic info too long in NaN") |
Raymond Hettinger | dab988d | 2004-10-09 07:10:44 +0000 | [diff] [blame] | 3901 | return d._fix(self) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3902 | |
Raymond Hettinger | 771ed76 | 2009-01-03 19:20:32 +0000 | [diff] [blame] | 3903 | def create_decimal_from_float(self, f): |
| 3904 | """Creates a new Decimal instance from a float but rounding using self |
| 3905 | as the context. |
| 3906 | |
| 3907 | >>> context = Context(prec=5, rounding=ROUND_DOWN) |
| 3908 | >>> context.create_decimal_from_float(3.1415926535897932) |
| 3909 | Decimal('3.1415') |
| 3910 | >>> context = Context(prec=5, traps=[Inexact]) |
| 3911 | >>> context.create_decimal_from_float(3.1415926535897932) |
| 3912 | Traceback (most recent call last): |
| 3913 | ... |
| 3914 | decimal.Inexact: None |
| 3915 | |
| 3916 | """ |
| 3917 | d = Decimal.from_float(f) # An exact conversion |
| 3918 | return d._fix(self) # Apply the context rounding |
| 3919 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3920 | # Methods |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3921 | def abs(self, a): |
| 3922 | """Returns the absolute value of the operand. |
| 3923 | |
| 3924 | If the operand is negative, the result is the same as using the minus |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3925 | operation on the operand. Otherwise, the result is the same as using |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3926 | the plus operation on the operand. |
| 3927 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3928 | >>> ExtendedContext.abs(Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3929 | Decimal('2.1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3930 | >>> ExtendedContext.abs(Decimal('-100')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3931 | Decimal('100') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3932 | >>> ExtendedContext.abs(Decimal('101.5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3933 | Decimal('101.5') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3934 | >>> ExtendedContext.abs(Decimal('-101.5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3935 | Decimal('101.5') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3936 | """ |
| 3937 | return a.__abs__(context=self) |
| 3938 | |
| 3939 | def add(self, a, b): |
| 3940 | """Return the sum of the two operands. |
| 3941 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3942 | >>> ExtendedContext.add(Decimal('12'), Decimal('7.00')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3943 | Decimal('19.00') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3944 | >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3945 | Decimal('1.02E+4') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3946 | """ |
| 3947 | return a.__add__(b, context=self) |
| 3948 | |
| 3949 | def _apply(self, a): |
Raymond Hettinger | dab988d | 2004-10-09 07:10:44 +0000 | [diff] [blame] | 3950 | return str(a._fix(self)) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3951 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3952 | def canonical(self, a): |
| 3953 | """Returns the same Decimal object. |
| 3954 | |
| 3955 | As we do not have different encodings for the same number, the |
| 3956 | received object already is in its canonical form. |
| 3957 | |
| 3958 | >>> ExtendedContext.canonical(Decimal('2.50')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3959 | Decimal('2.50') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3960 | """ |
| 3961 | return a.canonical(context=self) |
| 3962 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3963 | def compare(self, a, b): |
| 3964 | """Compares values numerically. |
| 3965 | |
| 3966 | If the signs of the operands differ, a value representing each operand |
| 3967 | ('-1' if the operand is less than zero, '0' if the operand is zero or |
| 3968 | negative zero, or '1' if the operand is greater than zero) is used in |
| 3969 | place of that operand for the comparison instead of the actual |
| 3970 | operand. |
| 3971 | |
| 3972 | The comparison is then effected by subtracting the second operand from |
| 3973 | the first and then returning a value according to the result of the |
| 3974 | subtraction: '-1' if the result is less than zero, '0' if the result is |
| 3975 | zero or negative zero, or '1' if the result is greater than zero. |
| 3976 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3977 | >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3978 | Decimal('-1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3979 | >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3980 | Decimal('0') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3981 | >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3982 | Decimal('0') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3983 | >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3984 | Decimal('1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3985 | >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3986 | Decimal('1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 3987 | >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 3988 | Decimal('-1') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 3989 | """ |
| 3990 | return a.compare(b, context=self) |
| 3991 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 3992 | def compare_signal(self, a, b): |
| 3993 | """Compares the values of the two operands numerically. |
| 3994 | |
| 3995 | It's pretty much like compare(), but all NaNs signal, with signaling |
| 3996 | NaNs taking precedence over quiet NaNs. |
| 3997 | |
| 3998 | >>> c = ExtendedContext |
| 3999 | >>> c.compare_signal(Decimal('2.1'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4000 | Decimal('-1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4001 | >>> c.compare_signal(Decimal('2.1'), Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4002 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4003 | >>> c.flags[InvalidOperation] = 0 |
| 4004 | >>> print(c.flags[InvalidOperation]) |
| 4005 | 0 |
| 4006 | >>> c.compare_signal(Decimal('NaN'), Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4007 | Decimal('NaN') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4008 | >>> print(c.flags[InvalidOperation]) |
| 4009 | 1 |
| 4010 | >>> c.flags[InvalidOperation] = 0 |
| 4011 | >>> print(c.flags[InvalidOperation]) |
| 4012 | 0 |
| 4013 | >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4014 | Decimal('NaN') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4015 | >>> print(c.flags[InvalidOperation]) |
| 4016 | 1 |
| 4017 | """ |
| 4018 | return a.compare_signal(b, context=self) |
| 4019 | |
| 4020 | def compare_total(self, a, b): |
| 4021 | """Compares two operands using their abstract representation. |
| 4022 | |
| 4023 | This is not like the standard compare, which use their numerical |
| 4024 | value. Note that a total ordering is defined for all possible abstract |
| 4025 | representations. |
| 4026 | |
| 4027 | >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4028 | Decimal('-1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4029 | >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4030 | Decimal('-1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4031 | >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4032 | Decimal('-1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4033 | >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4034 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4035 | >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4036 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4037 | >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4038 | Decimal('-1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4039 | """ |
| 4040 | return a.compare_total(b) |
| 4041 | |
| 4042 | def compare_total_mag(self, a, b): |
| 4043 | """Compares two operands using their abstract representation ignoring sign. |
| 4044 | |
| 4045 | Like compare_total, but with operand's sign ignored and assumed to be 0. |
| 4046 | """ |
| 4047 | return a.compare_total_mag(b) |
| 4048 | |
| 4049 | def copy_abs(self, a): |
| 4050 | """Returns a copy of the operand with the sign set to 0. |
| 4051 | |
| 4052 | >>> ExtendedContext.copy_abs(Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4053 | Decimal('2.1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4054 | >>> ExtendedContext.copy_abs(Decimal('-100')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4055 | Decimal('100') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4056 | """ |
| 4057 | return a.copy_abs() |
| 4058 | |
| 4059 | def copy_decimal(self, a): |
| 4060 | """Returns a copy of the decimal objet. |
| 4061 | |
| 4062 | >>> ExtendedContext.copy_decimal(Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4063 | Decimal('2.1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4064 | >>> ExtendedContext.copy_decimal(Decimal('-1.00')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4065 | Decimal('-1.00') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4066 | """ |
| 4067 | return Decimal(a) |
| 4068 | |
| 4069 | def copy_negate(self, a): |
| 4070 | """Returns a copy of the operand with the sign inverted. |
| 4071 | |
| 4072 | >>> ExtendedContext.copy_negate(Decimal('101.5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4073 | Decimal('-101.5') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4074 | >>> ExtendedContext.copy_negate(Decimal('-101.5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4075 | Decimal('101.5') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4076 | """ |
| 4077 | return a.copy_negate() |
| 4078 | |
| 4079 | def copy_sign(self, a, b): |
| 4080 | """Copies the second operand's sign to the first one. |
| 4081 | |
| 4082 | In detail, it returns a copy of the first operand with the sign |
| 4083 | equal to the sign of the second operand. |
| 4084 | |
| 4085 | >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4086 | Decimal('1.50') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4087 | >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4088 | Decimal('1.50') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4089 | >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4090 | Decimal('-1.50') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4091 | >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4092 | Decimal('-1.50') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4093 | """ |
| 4094 | return a.copy_sign(b) |
| 4095 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4096 | def divide(self, a, b): |
| 4097 | """Decimal division in a specified context. |
| 4098 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4099 | >>> ExtendedContext.divide(Decimal('1'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4100 | Decimal('0.333333333') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4101 | >>> ExtendedContext.divide(Decimal('2'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4102 | Decimal('0.666666667') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4103 | >>> ExtendedContext.divide(Decimal('5'), Decimal('2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4104 | Decimal('2.5') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4105 | >>> ExtendedContext.divide(Decimal('1'), Decimal('10')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4106 | Decimal('0.1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4107 | >>> ExtendedContext.divide(Decimal('12'), Decimal('12')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4108 | Decimal('1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4109 | >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4110 | Decimal('4.00') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4111 | >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4112 | Decimal('1.20') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4113 | >>> ExtendedContext.divide(Decimal('1000'), Decimal('100')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4114 | Decimal('10') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4115 | >>> ExtendedContext.divide(Decimal('1000'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4116 | Decimal('1000') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4117 | >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4118 | Decimal('1.20E+6') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4119 | """ |
Neal Norwitz | bcc0db8 | 2006-03-24 08:14:36 +0000 | [diff] [blame] | 4120 | return a.__truediv__(b, context=self) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4121 | |
| 4122 | def divide_int(self, a, b): |
| 4123 | """Divides two numbers and returns the integer part of the result. |
| 4124 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4125 | >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4126 | Decimal('0') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4127 | >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4128 | Decimal('3') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4129 | >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4130 | Decimal('3') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4131 | """ |
| 4132 | return a.__floordiv__(b, context=self) |
| 4133 | |
| 4134 | def divmod(self, a, b): |
| 4135 | return a.__divmod__(b, context=self) |
| 4136 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4137 | def exp(self, a): |
| 4138 | """Returns e ** a. |
| 4139 | |
| 4140 | >>> c = ExtendedContext.copy() |
| 4141 | >>> c.Emin = -999 |
| 4142 | >>> c.Emax = 999 |
| 4143 | >>> c.exp(Decimal('-Infinity')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4144 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4145 | >>> c.exp(Decimal('-1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4146 | Decimal('0.367879441') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4147 | >>> c.exp(Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4148 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4149 | >>> c.exp(Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4150 | Decimal('2.71828183') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4151 | >>> c.exp(Decimal('0.693147181')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4152 | Decimal('2.00000000') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4153 | >>> c.exp(Decimal('+Infinity')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4154 | Decimal('Infinity') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4155 | """ |
| 4156 | return a.exp(context=self) |
| 4157 | |
| 4158 | def fma(self, a, b, c): |
| 4159 | """Returns a multiplied by b, plus c. |
| 4160 | |
| 4161 | The first two operands are multiplied together, using multiply, |
| 4162 | the third operand is then added to the result of that |
| 4163 | multiplication, using add, all with only one final rounding. |
| 4164 | |
| 4165 | >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4166 | Decimal('22') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4167 | >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4168 | Decimal('-8') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4169 | >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4170 | Decimal('1.38435736E+12') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4171 | """ |
| 4172 | return a.fma(b, c, context=self) |
| 4173 | |
| 4174 | def is_canonical(self, a): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4175 | """Return True if the operand is canonical; otherwise return False. |
| 4176 | |
| 4177 | Currently, the encoding of a Decimal instance is always |
| 4178 | canonical, so this method returns True for any Decimal. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4179 | |
| 4180 | >>> ExtendedContext.is_canonical(Decimal('2.50')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4181 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4182 | """ |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4183 | return a.is_canonical() |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4184 | |
| 4185 | def is_finite(self, a): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4186 | """Return True if the operand is finite; otherwise return False. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4187 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4188 | A Decimal instance is considered finite if it is neither |
| 4189 | infinite nor a NaN. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4190 | |
| 4191 | >>> ExtendedContext.is_finite(Decimal('2.50')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4192 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4193 | >>> ExtendedContext.is_finite(Decimal('-0.3')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4194 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4195 | >>> ExtendedContext.is_finite(Decimal('0')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4196 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4197 | >>> ExtendedContext.is_finite(Decimal('Inf')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4198 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4199 | >>> ExtendedContext.is_finite(Decimal('NaN')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4200 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4201 | """ |
| 4202 | return a.is_finite() |
| 4203 | |
| 4204 | def is_infinite(self, a): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4205 | """Return True if the operand is infinite; otherwise return False. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4206 | |
| 4207 | >>> ExtendedContext.is_infinite(Decimal('2.50')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4208 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4209 | >>> ExtendedContext.is_infinite(Decimal('-Inf')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4210 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4211 | >>> ExtendedContext.is_infinite(Decimal('NaN')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4212 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4213 | """ |
| 4214 | return a.is_infinite() |
| 4215 | |
| 4216 | def is_nan(self, a): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4217 | """Return True if the operand is a qNaN or sNaN; |
| 4218 | otherwise return False. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4219 | |
| 4220 | >>> ExtendedContext.is_nan(Decimal('2.50')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4221 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4222 | >>> ExtendedContext.is_nan(Decimal('NaN')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4223 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4224 | >>> ExtendedContext.is_nan(Decimal('-sNaN')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4225 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4226 | """ |
| 4227 | return a.is_nan() |
| 4228 | |
| 4229 | def is_normal(self, a): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4230 | """Return True if the operand is a normal number; |
| 4231 | otherwise return False. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4232 | |
| 4233 | >>> c = ExtendedContext.copy() |
| 4234 | >>> c.Emin = -999 |
| 4235 | >>> c.Emax = 999 |
| 4236 | >>> c.is_normal(Decimal('2.50')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4237 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4238 | >>> c.is_normal(Decimal('0.1E-999')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4239 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4240 | >>> c.is_normal(Decimal('0.00')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4241 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4242 | >>> c.is_normal(Decimal('-Inf')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4243 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4244 | >>> c.is_normal(Decimal('NaN')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4245 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4246 | """ |
| 4247 | return a.is_normal(context=self) |
| 4248 | |
| 4249 | def is_qnan(self, a): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4250 | """Return True if the operand is a quiet NaN; otherwise return False. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4251 | |
| 4252 | >>> ExtendedContext.is_qnan(Decimal('2.50')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4253 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4254 | >>> ExtendedContext.is_qnan(Decimal('NaN')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4255 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4256 | >>> ExtendedContext.is_qnan(Decimal('sNaN')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4257 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4258 | """ |
| 4259 | return a.is_qnan() |
| 4260 | |
| 4261 | def is_signed(self, a): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4262 | """Return True if the operand is negative; otherwise return False. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4263 | |
| 4264 | >>> ExtendedContext.is_signed(Decimal('2.50')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4265 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4266 | >>> ExtendedContext.is_signed(Decimal('-12')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4267 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4268 | >>> ExtendedContext.is_signed(Decimal('-0')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4269 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4270 | """ |
| 4271 | return a.is_signed() |
| 4272 | |
| 4273 | def is_snan(self, a): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4274 | """Return True if the operand is a signaling NaN; |
| 4275 | otherwise return False. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4276 | |
| 4277 | >>> ExtendedContext.is_snan(Decimal('2.50')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4278 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4279 | >>> ExtendedContext.is_snan(Decimal('NaN')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4280 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4281 | >>> ExtendedContext.is_snan(Decimal('sNaN')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4282 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4283 | """ |
| 4284 | return a.is_snan() |
| 4285 | |
| 4286 | def is_subnormal(self, a): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4287 | """Return True if the operand is subnormal; otherwise return False. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4288 | |
| 4289 | >>> c = ExtendedContext.copy() |
| 4290 | >>> c.Emin = -999 |
| 4291 | >>> c.Emax = 999 |
| 4292 | >>> c.is_subnormal(Decimal('2.50')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4293 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4294 | >>> c.is_subnormal(Decimal('0.1E-999')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4295 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4296 | >>> c.is_subnormal(Decimal('0.00')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4297 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4298 | >>> c.is_subnormal(Decimal('-Inf')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4299 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4300 | >>> c.is_subnormal(Decimal('NaN')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4301 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4302 | """ |
| 4303 | return a.is_subnormal(context=self) |
| 4304 | |
| 4305 | def is_zero(self, a): |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4306 | """Return True if the operand is a zero; otherwise return False. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4307 | |
| 4308 | >>> ExtendedContext.is_zero(Decimal('0')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4309 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4310 | >>> ExtendedContext.is_zero(Decimal('2.50')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4311 | False |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4312 | >>> ExtendedContext.is_zero(Decimal('-0E+2')) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 4313 | True |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4314 | """ |
| 4315 | return a.is_zero() |
| 4316 | |
| 4317 | def ln(self, a): |
| 4318 | """Returns the natural (base e) logarithm of the operand. |
| 4319 | |
| 4320 | >>> c = ExtendedContext.copy() |
| 4321 | >>> c.Emin = -999 |
| 4322 | >>> c.Emax = 999 |
| 4323 | >>> c.ln(Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4324 | Decimal('-Infinity') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4325 | >>> c.ln(Decimal('1.000')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4326 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4327 | >>> c.ln(Decimal('2.71828183')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4328 | Decimal('1.00000000') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4329 | >>> c.ln(Decimal('10')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4330 | Decimal('2.30258509') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4331 | >>> c.ln(Decimal('+Infinity')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4332 | Decimal('Infinity') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4333 | """ |
| 4334 | return a.ln(context=self) |
| 4335 | |
| 4336 | def log10(self, a): |
| 4337 | """Returns the base 10 logarithm of the operand. |
| 4338 | |
| 4339 | >>> c = ExtendedContext.copy() |
| 4340 | >>> c.Emin = -999 |
| 4341 | >>> c.Emax = 999 |
| 4342 | >>> c.log10(Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4343 | Decimal('-Infinity') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4344 | >>> c.log10(Decimal('0.001')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4345 | Decimal('-3') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4346 | >>> c.log10(Decimal('1.000')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4347 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4348 | >>> c.log10(Decimal('2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4349 | Decimal('0.301029996') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4350 | >>> c.log10(Decimal('10')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4351 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4352 | >>> c.log10(Decimal('70')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4353 | Decimal('1.84509804') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4354 | >>> c.log10(Decimal('+Infinity')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4355 | Decimal('Infinity') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4356 | """ |
| 4357 | return a.log10(context=self) |
| 4358 | |
| 4359 | def logb(self, a): |
| 4360 | """ Returns the exponent of the magnitude of the operand's MSD. |
| 4361 | |
| 4362 | The result is the integer which is the exponent of the magnitude |
| 4363 | of the most significant digit of the operand (as though the |
| 4364 | operand were truncated to a single digit while maintaining the |
| 4365 | value of that digit and without limiting the resulting exponent). |
| 4366 | |
| 4367 | >>> ExtendedContext.logb(Decimal('250')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4368 | Decimal('2') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4369 | >>> ExtendedContext.logb(Decimal('2.50')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4370 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4371 | >>> ExtendedContext.logb(Decimal('0.03')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4372 | Decimal('-2') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4373 | >>> ExtendedContext.logb(Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4374 | Decimal('-Infinity') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4375 | """ |
| 4376 | return a.logb(context=self) |
| 4377 | |
| 4378 | def logical_and(self, a, b): |
| 4379 | """Applies the logical operation 'and' between each operand's digits. |
| 4380 | |
| 4381 | The operands must be both logical numbers. |
| 4382 | |
| 4383 | >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4384 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4385 | >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4386 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4387 | >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4388 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4389 | >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4390 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4391 | >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4392 | Decimal('1000') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4393 | >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4394 | Decimal('10') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4395 | """ |
| 4396 | return a.logical_and(b, context=self) |
| 4397 | |
| 4398 | def logical_invert(self, a): |
| 4399 | """Invert all the digits in the operand. |
| 4400 | |
| 4401 | The operand must be a logical number. |
| 4402 | |
| 4403 | >>> ExtendedContext.logical_invert(Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4404 | Decimal('111111111') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4405 | >>> ExtendedContext.logical_invert(Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4406 | Decimal('111111110') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4407 | >>> ExtendedContext.logical_invert(Decimal('111111111')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4408 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4409 | >>> ExtendedContext.logical_invert(Decimal('101010101')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4410 | Decimal('10101010') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4411 | """ |
| 4412 | return a.logical_invert(context=self) |
| 4413 | |
| 4414 | def logical_or(self, a, b): |
| 4415 | """Applies the logical operation 'or' between each operand's digits. |
| 4416 | |
| 4417 | The operands must be both logical numbers. |
| 4418 | |
| 4419 | >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4420 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4421 | >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4422 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4423 | >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4424 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4425 | >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4426 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4427 | >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4428 | Decimal('1110') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4429 | >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4430 | Decimal('1110') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4431 | """ |
| 4432 | return a.logical_or(b, context=self) |
| 4433 | |
| 4434 | def logical_xor(self, a, b): |
| 4435 | """Applies the logical operation 'xor' between each operand's digits. |
| 4436 | |
| 4437 | The operands must be both logical numbers. |
| 4438 | |
| 4439 | >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4440 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4441 | >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4442 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4443 | >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4444 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4445 | >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4446 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4447 | >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4448 | Decimal('110') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4449 | >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4450 | Decimal('1101') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4451 | """ |
| 4452 | return a.logical_xor(b, context=self) |
| 4453 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4454 | def max(self, a,b): |
| 4455 | """max compares two values numerically and returns the maximum. |
| 4456 | |
| 4457 | If either operand is a NaN then the general rules apply. |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 4458 | Otherwise, the operands are compared as though by the compare |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 4459 | operation. If they are numerically equal then the left-hand operand |
| 4460 | is chosen as the result. Otherwise the maximum (closer to positive |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4461 | infinity) of the two operands is chosen as the result. |
| 4462 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4463 | >>> ExtendedContext.max(Decimal('3'), Decimal('2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4464 | Decimal('3') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4465 | >>> ExtendedContext.max(Decimal('-10'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4466 | Decimal('3') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4467 | >>> ExtendedContext.max(Decimal('1.0'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4468 | Decimal('1') |
Raymond Hettinger | d6c700a | 2004-08-17 06:39:37 +0000 | [diff] [blame] | 4469 | >>> ExtendedContext.max(Decimal('7'), Decimal('NaN')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4470 | Decimal('7') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4471 | """ |
| 4472 | return a.max(b, context=self) |
| 4473 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4474 | def max_mag(self, a, b): |
| 4475 | """Compares the values numerically with their sign ignored.""" |
| 4476 | return a.max_mag(b, context=self) |
| 4477 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4478 | def min(self, a,b): |
| 4479 | """min compares two values numerically and returns the minimum. |
| 4480 | |
| 4481 | If either operand is a NaN then the general rules apply. |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 4482 | Otherwise, the operands are compared as though by the compare |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 4483 | operation. If they are numerically equal then the left-hand operand |
| 4484 | is chosen as the result. Otherwise the minimum (closer to negative |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4485 | infinity) of the two operands is chosen as the result. |
| 4486 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4487 | >>> ExtendedContext.min(Decimal('3'), Decimal('2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4488 | Decimal('2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4489 | >>> ExtendedContext.min(Decimal('-10'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4490 | Decimal('-10') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4491 | >>> ExtendedContext.min(Decimal('1.0'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4492 | Decimal('1.0') |
Raymond Hettinger | d6c700a | 2004-08-17 06:39:37 +0000 | [diff] [blame] | 4493 | >>> ExtendedContext.min(Decimal('7'), Decimal('NaN')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4494 | Decimal('7') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4495 | """ |
| 4496 | return a.min(b, context=self) |
| 4497 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4498 | def min_mag(self, a, b): |
| 4499 | """Compares the values numerically with their sign ignored.""" |
| 4500 | return a.min_mag(b, context=self) |
| 4501 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4502 | def minus(self, a): |
| 4503 | """Minus corresponds to unary prefix minus in Python. |
| 4504 | |
| 4505 | The operation is evaluated using the same rules as subtract; the |
| 4506 | operation minus(a) is calculated as subtract('0', a) where the '0' |
| 4507 | has the same exponent as the operand. |
| 4508 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4509 | >>> ExtendedContext.minus(Decimal('1.3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4510 | Decimal('-1.3') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4511 | >>> ExtendedContext.minus(Decimal('-1.3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4512 | Decimal('1.3') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4513 | """ |
| 4514 | return a.__neg__(context=self) |
| 4515 | |
| 4516 | def multiply(self, a, b): |
| 4517 | """multiply multiplies two operands. |
| 4518 | |
| 4519 | If either operand is a special value then the general rules apply. |
| 4520 | Otherwise, the operands are multiplied together ('long multiplication'), |
| 4521 | resulting in a number which may be as long as the sum of the lengths |
| 4522 | of the two operands. |
| 4523 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4524 | >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4525 | Decimal('3.60') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4526 | >>> ExtendedContext.multiply(Decimal('7'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4527 | Decimal('21') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4528 | >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4529 | Decimal('0.72') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4530 | >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4531 | Decimal('-0.0') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4532 | >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4533 | Decimal('4.28135971E+11') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4534 | """ |
| 4535 | return a.__mul__(b, context=self) |
| 4536 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4537 | def next_minus(self, a): |
| 4538 | """Returns the largest representable number smaller than a. |
| 4539 | |
| 4540 | >>> c = ExtendedContext.copy() |
| 4541 | >>> c.Emin = -999 |
| 4542 | >>> c.Emax = 999 |
| 4543 | >>> ExtendedContext.next_minus(Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4544 | Decimal('0.999999999') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4545 | >>> c.next_minus(Decimal('1E-1007')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4546 | Decimal('0E-1007') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4547 | >>> ExtendedContext.next_minus(Decimal('-1.00000003')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4548 | Decimal('-1.00000004') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4549 | >>> c.next_minus(Decimal('Infinity')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4550 | Decimal('9.99999999E+999') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4551 | """ |
| 4552 | return a.next_minus(context=self) |
| 4553 | |
| 4554 | def next_plus(self, a): |
| 4555 | """Returns the smallest representable number larger than a. |
| 4556 | |
| 4557 | >>> c = ExtendedContext.copy() |
| 4558 | >>> c.Emin = -999 |
| 4559 | >>> c.Emax = 999 |
| 4560 | >>> ExtendedContext.next_plus(Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4561 | Decimal('1.00000001') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4562 | >>> c.next_plus(Decimal('-1E-1007')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4563 | Decimal('-0E-1007') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4564 | >>> ExtendedContext.next_plus(Decimal('-1.00000003')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4565 | Decimal('-1.00000002') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4566 | >>> c.next_plus(Decimal('-Infinity')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4567 | Decimal('-9.99999999E+999') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4568 | """ |
| 4569 | return a.next_plus(context=self) |
| 4570 | |
| 4571 | def next_toward(self, a, b): |
| 4572 | """Returns the number closest to a, in direction towards b. |
| 4573 | |
| 4574 | The result is the closest representable number from the first |
| 4575 | operand (but not the first operand) that is in the direction |
| 4576 | towards the second operand, unless the operands have the same |
| 4577 | value. |
| 4578 | |
| 4579 | >>> c = ExtendedContext.copy() |
| 4580 | >>> c.Emin = -999 |
| 4581 | >>> c.Emax = 999 |
| 4582 | >>> c.next_toward(Decimal('1'), Decimal('2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4583 | Decimal('1.00000001') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4584 | >>> c.next_toward(Decimal('-1E-1007'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4585 | Decimal('-0E-1007') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4586 | >>> c.next_toward(Decimal('-1.00000003'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4587 | Decimal('-1.00000002') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4588 | >>> c.next_toward(Decimal('1'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4589 | Decimal('0.999999999') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4590 | >>> c.next_toward(Decimal('1E-1007'), Decimal('-100')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4591 | Decimal('0E-1007') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4592 | >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4593 | Decimal('-1.00000004') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4594 | >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4595 | Decimal('-0.00') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4596 | """ |
| 4597 | return a.next_toward(b, context=self) |
| 4598 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4599 | def normalize(self, a): |
Raymond Hettinger | e0f1581 | 2004-07-05 05:36:39 +0000 | [diff] [blame] | 4600 | """normalize reduces an operand to its simplest form. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4601 | |
| 4602 | Essentially a plus operation with all trailing zeros removed from the |
| 4603 | result. |
| 4604 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4605 | >>> ExtendedContext.normalize(Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4606 | Decimal('2.1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4607 | >>> ExtendedContext.normalize(Decimal('-2.0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4608 | Decimal('-2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4609 | >>> ExtendedContext.normalize(Decimal('1.200')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4610 | Decimal('1.2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4611 | >>> ExtendedContext.normalize(Decimal('-120')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4612 | Decimal('-1.2E+2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4613 | >>> ExtendedContext.normalize(Decimal('120.00')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4614 | Decimal('1.2E+2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4615 | >>> ExtendedContext.normalize(Decimal('0.00')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4616 | Decimal('0') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4617 | """ |
| 4618 | return a.normalize(context=self) |
| 4619 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4620 | def number_class(self, a): |
| 4621 | """Returns an indication of the class of the operand. |
| 4622 | |
| 4623 | The class is one of the following strings: |
| 4624 | -sNaN |
| 4625 | -NaN |
| 4626 | -Infinity |
| 4627 | -Normal |
| 4628 | -Subnormal |
| 4629 | -Zero |
| 4630 | +Zero |
| 4631 | +Subnormal |
| 4632 | +Normal |
| 4633 | +Infinity |
| 4634 | |
| 4635 | >>> c = Context(ExtendedContext) |
| 4636 | >>> c.Emin = -999 |
| 4637 | >>> c.Emax = 999 |
| 4638 | >>> c.number_class(Decimal('Infinity')) |
| 4639 | '+Infinity' |
| 4640 | >>> c.number_class(Decimal('1E-10')) |
| 4641 | '+Normal' |
| 4642 | >>> c.number_class(Decimal('2.50')) |
| 4643 | '+Normal' |
| 4644 | >>> c.number_class(Decimal('0.1E-999')) |
| 4645 | '+Subnormal' |
| 4646 | >>> c.number_class(Decimal('0')) |
| 4647 | '+Zero' |
| 4648 | >>> c.number_class(Decimal('-0')) |
| 4649 | '-Zero' |
| 4650 | >>> c.number_class(Decimal('-0.1E-999')) |
| 4651 | '-Subnormal' |
| 4652 | >>> c.number_class(Decimal('-1E-10')) |
| 4653 | '-Normal' |
| 4654 | >>> c.number_class(Decimal('-2.50')) |
| 4655 | '-Normal' |
| 4656 | >>> c.number_class(Decimal('-Infinity')) |
| 4657 | '-Infinity' |
| 4658 | >>> c.number_class(Decimal('NaN')) |
| 4659 | 'NaN' |
| 4660 | >>> c.number_class(Decimal('-NaN')) |
| 4661 | 'NaN' |
| 4662 | >>> c.number_class(Decimal('sNaN')) |
| 4663 | 'sNaN' |
| 4664 | """ |
| 4665 | return a.number_class(context=self) |
| 4666 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4667 | def plus(self, a): |
| 4668 | """Plus corresponds to unary prefix plus in Python. |
| 4669 | |
| 4670 | The operation is evaluated using the same rules as add; the |
| 4671 | operation plus(a) is calculated as add('0', a) where the '0' |
| 4672 | has the same exponent as the operand. |
| 4673 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4674 | >>> ExtendedContext.plus(Decimal('1.3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4675 | Decimal('1.3') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4676 | >>> ExtendedContext.plus(Decimal('-1.3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4677 | Decimal('-1.3') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4678 | """ |
| 4679 | return a.__pos__(context=self) |
| 4680 | |
| 4681 | def power(self, a, b, modulo=None): |
| 4682 | """Raises a to the power of b, to modulo if given. |
| 4683 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4684 | With two arguments, compute a**b. If a is negative then b |
| 4685 | must be integral. The result will be inexact unless b is |
| 4686 | integral and the result is finite and can be expressed exactly |
| 4687 | in 'precision' digits. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4688 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4689 | With three arguments, compute (a**b) % modulo. For the |
| 4690 | three argument form, the following restrictions on the |
| 4691 | arguments hold: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4692 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4693 | - all three arguments must be integral |
| 4694 | - b must be nonnegative |
| 4695 | - at least one of a or b must be nonzero |
| 4696 | - modulo must be nonzero and have at most 'precision' digits |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4697 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4698 | The result of pow(a, b, modulo) is identical to the result |
| 4699 | that would be obtained by computing (a**b) % modulo with |
| 4700 | unbounded precision, but is computed more efficiently. It is |
| 4701 | always exact. |
| 4702 | |
| 4703 | >>> c = ExtendedContext.copy() |
| 4704 | >>> c.Emin = -999 |
| 4705 | >>> c.Emax = 999 |
| 4706 | >>> c.power(Decimal('2'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4707 | Decimal('8') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4708 | >>> c.power(Decimal('-2'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4709 | Decimal('-8') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4710 | >>> c.power(Decimal('2'), Decimal('-3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4711 | Decimal('0.125') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4712 | >>> c.power(Decimal('1.7'), Decimal('8')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4713 | Decimal('69.7575744') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4714 | >>> c.power(Decimal('10'), Decimal('0.301029996')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4715 | Decimal('2.00000000') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4716 | >>> c.power(Decimal('Infinity'), Decimal('-1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4717 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4718 | >>> c.power(Decimal('Infinity'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4719 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4720 | >>> c.power(Decimal('Infinity'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4721 | Decimal('Infinity') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4722 | >>> c.power(Decimal('-Infinity'), Decimal('-1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4723 | Decimal('-0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4724 | >>> c.power(Decimal('-Infinity'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4725 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4726 | >>> c.power(Decimal('-Infinity'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4727 | Decimal('-Infinity') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4728 | >>> c.power(Decimal('-Infinity'), Decimal('2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4729 | Decimal('Infinity') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4730 | >>> c.power(Decimal('0'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4731 | Decimal('NaN') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4732 | |
| 4733 | >>> c.power(Decimal('3'), Decimal('7'), Decimal('16')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4734 | Decimal('11') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4735 | >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4736 | Decimal('-11') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4737 | >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4738 | Decimal('1') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4739 | >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4740 | Decimal('11') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4741 | >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4742 | Decimal('11729830') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4743 | >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4744 | Decimal('-0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4745 | >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4746 | Decimal('1') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4747 | """ |
| 4748 | return a.__pow__(b, modulo, context=self) |
| 4749 | |
| 4750 | def quantize(self, a, b): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 4751 | """Returns a value equal to 'a' (rounded), having the exponent of 'b'. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4752 | |
| 4753 | The coefficient of the result is derived from that of the left-hand |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 4754 | operand. It may be rounded using the current rounding setting (if the |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4755 | exponent is being increased), multiplied by a positive power of ten (if |
| 4756 | the exponent is being decreased), or is unchanged (if the exponent is |
| 4757 | already equal to that of the right-hand operand). |
| 4758 | |
| 4759 | Unlike other operations, if the length of the coefficient after the |
| 4760 | quantize operation would be greater than precision then an Invalid |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 4761 | operation condition is raised. This guarantees that, unless there is |
| 4762 | an error condition, the exponent of the result of a quantize is always |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4763 | equal to that of the right-hand operand. |
| 4764 | |
| 4765 | Also unlike other operations, quantize will never raise Underflow, even |
| 4766 | if the result is subnormal and inexact. |
| 4767 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4768 | >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4769 | Decimal('2.170') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4770 | >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4771 | Decimal('2.17') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4772 | >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4773 | Decimal('2.2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4774 | >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4775 | Decimal('2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4776 | >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4777 | Decimal('0E+1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4778 | >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4779 | Decimal('-Infinity') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4780 | >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4781 | Decimal('NaN') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4782 | >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4783 | Decimal('-0') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4784 | >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4785 | Decimal('-0E+5') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4786 | >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4787 | Decimal('NaN') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4788 | >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4789 | Decimal('NaN') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4790 | >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4791 | Decimal('217.0') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4792 | >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4793 | Decimal('217') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4794 | >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4795 | Decimal('2.2E+2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4796 | >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4797 | Decimal('2E+2') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4798 | """ |
| 4799 | return a.quantize(b, context=self) |
| 4800 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4801 | def radix(self): |
| 4802 | """Just returns 10, as this is Decimal, :) |
| 4803 | |
| 4804 | >>> ExtendedContext.radix() |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4805 | Decimal('10') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4806 | """ |
| 4807 | return Decimal(10) |
| 4808 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4809 | def remainder(self, a, b): |
| 4810 | """Returns the remainder from integer division. |
| 4811 | |
| 4812 | The result is the residue of the dividend after the operation of |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 4813 | calculating integer division as described for divide-integer, rounded |
| 4814 | to precision digits if necessary. The sign of the result, if |
| 4815 | non-zero, is the same as that of the original dividend. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4816 | |
| 4817 | This operation will fail under the same conditions as integer division |
| 4818 | (that is, if integer division on the same two operands would fail, the |
| 4819 | remainder cannot be calculated). |
| 4820 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4821 | >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4822 | Decimal('2.1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4823 | >>> ExtendedContext.remainder(Decimal('10'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4824 | Decimal('1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4825 | >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4826 | Decimal('-1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4827 | >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4828 | Decimal('0.2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4829 | >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4830 | Decimal('0.1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4831 | >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4832 | Decimal('1.0') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4833 | """ |
| 4834 | return a.__mod__(b, context=self) |
| 4835 | |
| 4836 | def remainder_near(self, a, b): |
| 4837 | """Returns to be "a - b * n", where n is the integer nearest the exact |
| 4838 | value of "x / b" (if two integers are equally near then the even one |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 4839 | is chosen). If the result is equal to 0 then its sign will be the |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4840 | sign of a. |
| 4841 | |
| 4842 | This operation will fail under the same conditions as integer division |
| 4843 | (that is, if integer division on the same two operands would fail, the |
| 4844 | remainder cannot be calculated). |
| 4845 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4846 | >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4847 | Decimal('-0.9') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4848 | >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4849 | Decimal('-2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4850 | >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4851 | Decimal('1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4852 | >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4853 | Decimal('-1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4854 | >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4855 | Decimal('0.2') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4856 | >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4857 | Decimal('0.1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4858 | >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4859 | Decimal('-0.3') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4860 | """ |
| 4861 | return a.remainder_near(b, context=self) |
| 4862 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4863 | def rotate(self, a, b): |
| 4864 | """Returns a rotated copy of a, b times. |
| 4865 | |
| 4866 | The coefficient of the result is a rotated copy of the digits in |
| 4867 | the coefficient of the first operand. The number of places of |
| 4868 | rotation is taken from the absolute value of the second operand, |
| 4869 | with the rotation being to the left if the second operand is |
| 4870 | positive or to the right otherwise. |
| 4871 | |
| 4872 | >>> ExtendedContext.rotate(Decimal('34'), Decimal('8')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4873 | Decimal('400000003') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4874 | >>> ExtendedContext.rotate(Decimal('12'), Decimal('9')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4875 | Decimal('12') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4876 | >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4877 | Decimal('891234567') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4878 | >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4879 | Decimal('123456789') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4880 | >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4881 | Decimal('345678912') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4882 | """ |
| 4883 | return a.rotate(b, context=self) |
| 4884 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4885 | def same_quantum(self, a, b): |
| 4886 | """Returns True if the two operands have the same exponent. |
| 4887 | |
| 4888 | The result is never affected by either the sign or the coefficient of |
| 4889 | either operand. |
| 4890 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4891 | >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001')) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4892 | False |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4893 | >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01')) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4894 | True |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4895 | >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1')) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4896 | False |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4897 | >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf')) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4898 | True |
| 4899 | """ |
| 4900 | return a.same_quantum(b) |
| 4901 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4902 | def scaleb (self, a, b): |
| 4903 | """Returns the first operand after adding the second value its exp. |
| 4904 | |
| 4905 | >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4906 | Decimal('0.0750') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4907 | >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4908 | Decimal('7.50') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4909 | >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4910 | Decimal('7.50E+3') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4911 | """ |
| 4912 | return a.scaleb (b, context=self) |
| 4913 | |
| 4914 | def shift(self, a, b): |
| 4915 | """Returns a shifted copy of a, b times. |
| 4916 | |
| 4917 | The coefficient of the result is a shifted copy of the digits |
| 4918 | in the coefficient of the first operand. The number of places |
| 4919 | to shift is taken from the absolute value of the second operand, |
| 4920 | with the shift being to the left if the second operand is |
| 4921 | positive or to the right otherwise. Digits shifted into the |
| 4922 | coefficient are zeros. |
| 4923 | |
| 4924 | >>> ExtendedContext.shift(Decimal('34'), Decimal('8')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4925 | Decimal('400000000') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4926 | >>> ExtendedContext.shift(Decimal('12'), Decimal('9')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4927 | Decimal('0') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4928 | >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4929 | Decimal('1234567') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4930 | >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4931 | Decimal('123456789') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4932 | >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4933 | Decimal('345678900') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4934 | """ |
| 4935 | return a.shift(b, context=self) |
| 4936 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4937 | def sqrt(self, a): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 4938 | """Square root of a non-negative number to context precision. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4939 | |
| 4940 | If the result must be inexact, it is rounded using the round-half-even |
| 4941 | algorithm. |
| 4942 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4943 | >>> ExtendedContext.sqrt(Decimal('0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4944 | Decimal('0') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4945 | >>> ExtendedContext.sqrt(Decimal('-0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4946 | Decimal('-0') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4947 | >>> ExtendedContext.sqrt(Decimal('0.39')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4948 | Decimal('0.624499800') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4949 | >>> ExtendedContext.sqrt(Decimal('100')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4950 | Decimal('10') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4951 | >>> ExtendedContext.sqrt(Decimal('1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4952 | Decimal('1') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4953 | >>> ExtendedContext.sqrt(Decimal('1.0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4954 | Decimal('1.0') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4955 | >>> ExtendedContext.sqrt(Decimal('1.00')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4956 | Decimal('1.0') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4957 | >>> ExtendedContext.sqrt(Decimal('7')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4958 | Decimal('2.64575131') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4959 | >>> ExtendedContext.sqrt(Decimal('10')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4960 | Decimal('3.16227766') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4961 | >>> ExtendedContext.prec |
Raymond Hettinger | 6ea4845 | 2004-07-03 12:26:21 +0000 | [diff] [blame] | 4962 | 9 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4963 | """ |
| 4964 | return a.sqrt(context=self) |
| 4965 | |
| 4966 | def subtract(self, a, b): |
Georg Brandl | f33d01d | 2005-08-22 19:35:18 +0000 | [diff] [blame] | 4967 | """Return the difference between the two operands. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4968 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4969 | >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4970 | Decimal('0.23') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4971 | >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4972 | Decimal('0.00') |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 4973 | >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 4974 | Decimal('-0.77') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 4975 | """ |
| 4976 | return a.__sub__(b, context=self) |
| 4977 | |
| 4978 | def to_eng_string(self, a): |
| 4979 | """Converts a number to a string, using scientific notation. |
| 4980 | |
| 4981 | The operation is not affected by the context. |
| 4982 | """ |
| 4983 | return a.to_eng_string(context=self) |
| 4984 | |
| 4985 | def to_sci_string(self, a): |
| 4986 | """Converts a number to a string, using scientific notation. |
| 4987 | |
| 4988 | The operation is not affected by the context. |
| 4989 | """ |
| 4990 | return a.__str__(context=self) |
| 4991 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 4992 | def to_integral_exact(self, a): |
| 4993 | """Rounds to an integer. |
| 4994 | |
| 4995 | When the operand has a negative exponent, the result is the same |
| 4996 | as using the quantize() operation using the given operand as the |
| 4997 | left-hand-operand, 1E+0 as the right-hand-operand, and the precision |
| 4998 | of the operand as the precision setting; Inexact and Rounded flags |
| 4999 | are allowed in this operation. The rounding mode is taken from the |
| 5000 | context. |
| 5001 | |
| 5002 | >>> ExtendedContext.to_integral_exact(Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5003 | Decimal('2') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5004 | >>> ExtendedContext.to_integral_exact(Decimal('100')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5005 | Decimal('100') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5006 | >>> ExtendedContext.to_integral_exact(Decimal('100.0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5007 | Decimal('100') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5008 | >>> ExtendedContext.to_integral_exact(Decimal('101.5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5009 | Decimal('102') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5010 | >>> ExtendedContext.to_integral_exact(Decimal('-101.5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5011 | Decimal('-102') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5012 | >>> ExtendedContext.to_integral_exact(Decimal('10E+5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5013 | Decimal('1.0E+6') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5014 | >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5015 | Decimal('7.89E+77') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5016 | >>> ExtendedContext.to_integral_exact(Decimal('-Inf')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5017 | Decimal('-Infinity') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5018 | """ |
| 5019 | return a.to_integral_exact(context=self) |
| 5020 | |
| 5021 | def to_integral_value(self, a): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5022 | """Rounds to an integer. |
| 5023 | |
| 5024 | When the operand has a negative exponent, the result is the same |
| 5025 | as using the quantize() operation using the given operand as the |
| 5026 | left-hand-operand, 1E+0 as the right-hand-operand, and the precision |
| 5027 | of the operand as the precision setting, except that no flags will |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 5028 | be set. The rounding mode is taken from the context. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5029 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5030 | >>> ExtendedContext.to_integral_value(Decimal('2.1')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5031 | Decimal('2') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5032 | >>> ExtendedContext.to_integral_value(Decimal('100')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5033 | Decimal('100') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5034 | >>> ExtendedContext.to_integral_value(Decimal('100.0')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5035 | Decimal('100') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5036 | >>> ExtendedContext.to_integral_value(Decimal('101.5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5037 | Decimal('102') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5038 | >>> ExtendedContext.to_integral_value(Decimal('-101.5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5039 | Decimal('-102') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5040 | >>> ExtendedContext.to_integral_value(Decimal('10E+5')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5041 | Decimal('1.0E+6') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5042 | >>> ExtendedContext.to_integral_value(Decimal('7.89E+77')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5043 | Decimal('7.89E+77') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5044 | >>> ExtendedContext.to_integral_value(Decimal('-Inf')) |
Christian Heimes | 68f5fbe | 2008-02-14 08:27:37 +0000 | [diff] [blame] | 5045 | Decimal('-Infinity') |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5046 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5047 | return a.to_integral_value(context=self) |
| 5048 | |
| 5049 | # the method name changed, but we provide also the old one, for compatibility |
| 5050 | to_integral = to_integral_value |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5051 | |
| 5052 | class _WorkRep(object): |
| 5053 | __slots__ = ('sign','int','exp') |
Raymond Hettinger | 17931de | 2004-10-27 06:21:46 +0000 | [diff] [blame] | 5054 | # sign: 0 or 1 |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5055 | # int: int |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5056 | # exp: None, int, or string |
| 5057 | |
| 5058 | def __init__(self, value=None): |
| 5059 | if value is None: |
| 5060 | self.sign = None |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 5061 | self.int = 0 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5062 | self.exp = None |
Raymond Hettinger | 17931de | 2004-10-27 06:21:46 +0000 | [diff] [blame] | 5063 | elif isinstance(value, Decimal): |
| 5064 | self.sign = value._sign |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5065 | self.int = int(value._int) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5066 | self.exp = value._exp |
Raymond Hettinger | 17931de | 2004-10-27 06:21:46 +0000 | [diff] [blame] | 5067 | else: |
| 5068 | # assert isinstance(value, tuple) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5069 | self.sign = value[0] |
| 5070 | self.int = value[1] |
| 5071 | self.exp = value[2] |
| 5072 | |
| 5073 | def __repr__(self): |
| 5074 | return "(%r, %r, %r)" % (self.sign, self.int, self.exp) |
| 5075 | |
| 5076 | __str__ = __repr__ |
| 5077 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5078 | |
| 5079 | |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 5080 | def _normalize(op1, op2, prec = 0): |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5081 | """Normalizes op1, op2 to have the same exp and length of coefficient. |
| 5082 | |
| 5083 | Done during addition. |
| 5084 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5085 | if op1.exp < op2.exp: |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5086 | tmp = op2 |
| 5087 | other = op1 |
| 5088 | else: |
| 5089 | tmp = op1 |
| 5090 | other = op2 |
| 5091 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5092 | # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1). |
| 5093 | # Then adding 10**exp to tmp has the same effect (after rounding) |
| 5094 | # as adding any positive quantity smaller than 10**exp; similarly |
| 5095 | # for subtraction. So if other is smaller than 10**exp we replace |
| 5096 | # it with 10**exp. This avoids tmp.exp - other.exp getting too large. |
Christian Heimes | 2c18161 | 2007-12-17 20:04:13 +0000 | [diff] [blame] | 5097 | tmp_len = len(str(tmp.int)) |
| 5098 | other_len = len(str(other.int)) |
| 5099 | exp = tmp.exp + min(-1, tmp_len - prec - 2) |
| 5100 | if other_len + other.exp - 1 < exp: |
| 5101 | other.int = 1 |
| 5102 | other.exp = exp |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 5103 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5104 | tmp.int *= 10 ** (tmp.exp - other.exp) |
| 5105 | tmp.exp = other.exp |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5106 | return op1, op2 |
| 5107 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5108 | ##### Integer arithmetic functions used by ln, log10, exp and __pow__ ##### |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5109 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5110 | # This function from Tim Peters was taken from here: |
| 5111 | # http://mail.python.org/pipermail/python-list/1999-July/007758.html |
| 5112 | # The correction being in the function definition is for speed, and |
| 5113 | # the whole function is not resolved with math.log because of avoiding |
| 5114 | # the use of floats. |
| 5115 | def _nbits(n, correction = { |
| 5116 | '0': 4, '1': 3, '2': 2, '3': 2, |
| 5117 | '4': 1, '5': 1, '6': 1, '7': 1, |
| 5118 | '8': 0, '9': 0, 'a': 0, 'b': 0, |
| 5119 | 'c': 0, 'd': 0, 'e': 0, 'f': 0}): |
| 5120 | """Number of bits in binary representation of the positive integer n, |
| 5121 | or 0 if n == 0. |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5122 | """ |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5123 | if n < 0: |
| 5124 | raise ValueError("The argument to _nbits should be nonnegative.") |
| 5125 | hex_n = "%x" % n |
| 5126 | return 4*len(hex_n) - correction[hex_n[0]] |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5127 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5128 | def _sqrt_nearest(n, a): |
| 5129 | """Closest integer to the square root of the positive integer n. a is |
| 5130 | an initial approximation to the square root. Any positive integer |
| 5131 | will do for a, but the closer a is to the square root of n the |
| 5132 | faster convergence will be. |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 5133 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5134 | """ |
| 5135 | if n <= 0 or a <= 0: |
| 5136 | raise ValueError("Both arguments to _sqrt_nearest should be positive.") |
| 5137 | |
| 5138 | b=0 |
| 5139 | while a != b: |
| 5140 | b, a = a, a--n//a>>1 |
| 5141 | return a |
| 5142 | |
| 5143 | def _rshift_nearest(x, shift): |
| 5144 | """Given an integer x and a nonnegative integer shift, return closest |
| 5145 | integer to x / 2**shift; use round-to-even in case of a tie. |
| 5146 | |
| 5147 | """ |
| 5148 | b, q = 1 << shift, x >> shift |
| 5149 | return q + (2*(x & (b-1)) + (q&1) > b) |
| 5150 | |
| 5151 | def _div_nearest(a, b): |
| 5152 | """Closest integer to a/b, a and b positive integers; rounds to even |
| 5153 | in the case of a tie. |
| 5154 | |
| 5155 | """ |
| 5156 | q, r = divmod(a, b) |
| 5157 | return q + (2*r + (q&1) > b) |
| 5158 | |
| 5159 | def _ilog(x, M, L = 8): |
| 5160 | """Integer approximation to M*log(x/M), with absolute error boundable |
| 5161 | in terms only of x/M. |
| 5162 | |
| 5163 | Given positive integers x and M, return an integer approximation to |
| 5164 | M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference |
| 5165 | between the approximation and the exact result is at most 22. For |
| 5166 | L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In |
| 5167 | both cases these are upper bounds on the error; it will usually be |
| 5168 | much smaller.""" |
| 5169 | |
| 5170 | # The basic algorithm is the following: let log1p be the function |
| 5171 | # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use |
| 5172 | # the reduction |
| 5173 | # |
| 5174 | # log1p(y) = 2*log1p(y/(1+sqrt(1+y))) |
| 5175 | # |
| 5176 | # repeatedly until the argument to log1p is small (< 2**-L in |
| 5177 | # absolute value). For small y we can use the Taylor series |
| 5178 | # expansion |
| 5179 | # |
| 5180 | # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T |
| 5181 | # |
| 5182 | # truncating at T such that y**T is small enough. The whole |
| 5183 | # computation is carried out in a form of fixed-point arithmetic, |
| 5184 | # with a real number z being represented by an integer |
| 5185 | # approximation to z*M. To avoid loss of precision, the y below |
| 5186 | # is actually an integer approximation to 2**R*y*M, where R is the |
| 5187 | # number of reductions performed so far. |
| 5188 | |
| 5189 | y = x-M |
| 5190 | # argument reduction; R = number of reductions performed |
| 5191 | R = 0 |
| 5192 | while (R <= L and abs(y) << L-R >= M or |
| 5193 | R > L and abs(y) >> R-L >= M): |
| 5194 | y = _div_nearest((M*y) << 1, |
| 5195 | M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M)) |
| 5196 | R += 1 |
| 5197 | |
| 5198 | # Taylor series with T terms |
| 5199 | T = -int(-10*len(str(M))//(3*L)) |
| 5200 | yshift = _rshift_nearest(y, R) |
| 5201 | w = _div_nearest(M, T) |
| 5202 | for k in range(T-1, 0, -1): |
| 5203 | w = _div_nearest(M, k) - _div_nearest(yshift*w, M) |
| 5204 | |
| 5205 | return _div_nearest(w*y, M) |
| 5206 | |
| 5207 | def _dlog10(c, e, p): |
| 5208 | """Given integers c, e and p with c > 0, p >= 0, compute an integer |
| 5209 | approximation to 10**p * log10(c*10**e), with an absolute error of |
| 5210 | at most 1. Assumes that c*10**e is not exactly 1.""" |
| 5211 | |
| 5212 | # increase precision by 2; compensate for this by dividing |
| 5213 | # final result by 100 |
| 5214 | p += 2 |
| 5215 | |
| 5216 | # write c*10**e as d*10**f with either: |
| 5217 | # f >= 0 and 1 <= d <= 10, or |
| 5218 | # f <= 0 and 0.1 <= d <= 1. |
| 5219 | # Thus for c*10**e close to 1, f = 0 |
| 5220 | l = len(str(c)) |
| 5221 | f = e+l - (e+l >= 1) |
| 5222 | |
| 5223 | if p > 0: |
| 5224 | M = 10**p |
| 5225 | k = e+p-f |
| 5226 | if k >= 0: |
| 5227 | c *= 10**k |
| 5228 | else: |
| 5229 | c = _div_nearest(c, 10**-k) |
| 5230 | |
| 5231 | log_d = _ilog(c, M) # error < 5 + 22 = 27 |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 5232 | log_10 = _log10_digits(p) # error < 1 |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5233 | log_d = _div_nearest(log_d*M, log_10) |
| 5234 | log_tenpower = f*M # exact |
| 5235 | else: |
| 5236 | log_d = 0 # error < 2.31 |
Neal Norwitz | 2f99b24 | 2008-08-24 05:48:10 +0000 | [diff] [blame] | 5237 | log_tenpower = _div_nearest(f, 10**-p) # error < 0.5 |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5238 | |
| 5239 | return _div_nearest(log_tenpower+log_d, 100) |
| 5240 | |
| 5241 | def _dlog(c, e, p): |
| 5242 | """Given integers c, e and p with c > 0, compute an integer |
| 5243 | approximation to 10**p * log(c*10**e), with an absolute error of |
| 5244 | at most 1. Assumes that c*10**e is not exactly 1.""" |
| 5245 | |
| 5246 | # Increase precision by 2. The precision increase is compensated |
| 5247 | # for at the end with a division by 100. |
| 5248 | p += 2 |
| 5249 | |
| 5250 | # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10, |
| 5251 | # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e) |
| 5252 | # as 10**p * log(d) + 10**p*f * log(10). |
| 5253 | l = len(str(c)) |
| 5254 | f = e+l - (e+l >= 1) |
| 5255 | |
| 5256 | # compute approximation to 10**p*log(d), with error < 27 |
| 5257 | if p > 0: |
| 5258 | k = e+p-f |
| 5259 | if k >= 0: |
| 5260 | c *= 10**k |
| 5261 | else: |
| 5262 | c = _div_nearest(c, 10**-k) # error of <= 0.5 in c |
| 5263 | |
| 5264 | # _ilog magnifies existing error in c by a factor of at most 10 |
| 5265 | log_d = _ilog(c, 10**p) # error < 5 + 22 = 27 |
| 5266 | else: |
| 5267 | # p <= 0: just approximate the whole thing by 0; error < 2.31 |
| 5268 | log_d = 0 |
| 5269 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 5270 | # compute approximation to f*10**p*log(10), with error < 11. |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5271 | if f: |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 5272 | extra = len(str(abs(f)))-1 |
| 5273 | if p + extra >= 0: |
| 5274 | # error in f * _log10_digits(p+extra) < |f| * 1 = |f| |
| 5275 | # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11 |
| 5276 | f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5277 | else: |
| 5278 | f_log_ten = 0 |
| 5279 | else: |
| 5280 | f_log_ten = 0 |
| 5281 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 5282 | # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1 |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5283 | return _div_nearest(f_log_ten + log_d, 100) |
| 5284 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 5285 | class _Log10Memoize(object): |
| 5286 | """Class to compute, store, and allow retrieval of, digits of the |
| 5287 | constant log(10) = 2.302585.... This constant is needed by |
| 5288 | Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__.""" |
| 5289 | def __init__(self): |
| 5290 | self.digits = "23025850929940456840179914546843642076011014886" |
| 5291 | |
| 5292 | def getdigits(self, p): |
| 5293 | """Given an integer p >= 0, return floor(10**p)*log(10). |
| 5294 | |
| 5295 | For example, self.getdigits(3) returns 2302. |
| 5296 | """ |
| 5297 | # digits are stored as a string, for quick conversion to |
| 5298 | # integer in the case that we've already computed enough |
| 5299 | # digits; the stored digits should always be correct |
| 5300 | # (truncated, not rounded to nearest). |
| 5301 | if p < 0: |
| 5302 | raise ValueError("p should be nonnegative") |
| 5303 | |
| 5304 | if p >= len(self.digits): |
| 5305 | # compute p+3, p+6, p+9, ... digits; continue until at |
| 5306 | # least one of the extra digits is nonzero |
| 5307 | extra = 3 |
| 5308 | while True: |
| 5309 | # compute p+extra digits, correct to within 1ulp |
| 5310 | M = 10**(p+extra+2) |
| 5311 | digits = str(_div_nearest(_ilog(10*M, M), 100)) |
| 5312 | if digits[-extra:] != '0'*extra: |
| 5313 | break |
| 5314 | extra += 3 |
| 5315 | # keep all reliable digits so far; remove trailing zeros |
| 5316 | # and next nonzero digit |
| 5317 | self.digits = digits.rstrip('0')[:-1] |
| 5318 | return int(self.digits[:p+1]) |
| 5319 | |
| 5320 | _log10_digits = _Log10Memoize().getdigits |
| 5321 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5322 | def _iexp(x, M, L=8): |
| 5323 | """Given integers x and M, M > 0, such that x/M is small in absolute |
| 5324 | value, compute an integer approximation to M*exp(x/M). For 0 <= |
| 5325 | x/M <= 2.4, the absolute error in the result is bounded by 60 (and |
| 5326 | is usually much smaller).""" |
| 5327 | |
| 5328 | # Algorithm: to compute exp(z) for a real number z, first divide z |
| 5329 | # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then |
| 5330 | # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor |
| 5331 | # series |
| 5332 | # |
| 5333 | # expm1(x) = x + x**2/2! + x**3/3! + ... |
| 5334 | # |
| 5335 | # Now use the identity |
| 5336 | # |
| 5337 | # expm1(2x) = expm1(x)*(expm1(x)+2) |
| 5338 | # |
| 5339 | # R times to compute the sequence expm1(z/2**R), |
| 5340 | # expm1(z/2**(R-1)), ... , exp(z/2), exp(z). |
| 5341 | |
| 5342 | # Find R such that x/2**R/M <= 2**-L |
| 5343 | R = _nbits((x<<L)//M) |
| 5344 | |
| 5345 | # Taylor series. (2**L)**T > M |
| 5346 | T = -int(-10*len(str(M))//(3*L)) |
| 5347 | y = _div_nearest(x, T) |
| 5348 | Mshift = M<<R |
| 5349 | for i in range(T-1, 0, -1): |
| 5350 | y = _div_nearest(x*(Mshift + y), Mshift * i) |
| 5351 | |
| 5352 | # Expansion |
| 5353 | for k in range(R-1, -1, -1): |
| 5354 | Mshift = M<<(k+2) |
| 5355 | y = _div_nearest(y*(y+Mshift), Mshift) |
| 5356 | |
| 5357 | return M+y |
| 5358 | |
| 5359 | def _dexp(c, e, p): |
| 5360 | """Compute an approximation to exp(c*10**e), with p decimal places of |
| 5361 | precision. |
| 5362 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 5363 | Returns integers d, f such that: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5364 | |
| 5365 | 10**(p-1) <= d <= 10**p, and |
| 5366 | (d-1)*10**f < exp(c*10**e) < (d+1)*10**f |
| 5367 | |
| 5368 | In other words, d*10**f is an approximation to exp(c*10**e) with p |
| 5369 | digits of precision, and with an error in d of at most 1. This is |
| 5370 | almost, but not quite, the same as the error being < 1ulp: when d |
| 5371 | = 10**(p-1) the error could be up to 10 ulp.""" |
| 5372 | |
| 5373 | # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision |
| 5374 | p += 2 |
| 5375 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 5376 | # compute log(10) with extra precision = adjusted exponent of c*10**e |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5377 | extra = max(0, e + len(str(c)) - 1) |
| 5378 | q = p + extra |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5379 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 5380 | # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q), |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5381 | # rounding down |
| 5382 | shift = e+q |
| 5383 | if shift >= 0: |
| 5384 | cshift = c*10**shift |
| 5385 | else: |
| 5386 | cshift = c//10**-shift |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 5387 | quot, rem = divmod(cshift, _log10_digits(q)) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5388 | |
| 5389 | # reduce remainder back to original precision |
| 5390 | rem = _div_nearest(rem, 10**extra) |
| 5391 | |
| 5392 | # error in result of _iexp < 120; error after division < 0.62 |
| 5393 | return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3 |
| 5394 | |
| 5395 | def _dpower(xc, xe, yc, ye, p): |
| 5396 | """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and |
| 5397 | y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that: |
| 5398 | |
| 5399 | 10**(p-1) <= c <= 10**p, and |
| 5400 | (c-1)*10**e < x**y < (c+1)*10**e |
| 5401 | |
| 5402 | in other words, c*10**e is an approximation to x**y with p digits |
| 5403 | of precision, and with an error in c of at most 1. (This is |
| 5404 | almost, but not quite, the same as the error being < 1ulp: when c |
| 5405 | == 10**(p-1) we can only guarantee error < 10ulp.) |
| 5406 | |
| 5407 | We assume that: x is positive and not equal to 1, and y is nonzero. |
| 5408 | """ |
| 5409 | |
| 5410 | # Find b such that 10**(b-1) <= |y| <= 10**b |
| 5411 | b = len(str(abs(yc))) + ye |
| 5412 | |
| 5413 | # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point |
| 5414 | lxc = _dlog(xc, xe, p+b+1) |
| 5415 | |
| 5416 | # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1) |
| 5417 | shift = ye-b |
| 5418 | if shift >= 0: |
| 5419 | pc = lxc*yc*10**shift |
| 5420 | else: |
| 5421 | pc = _div_nearest(lxc*yc, 10**-shift) |
| 5422 | |
| 5423 | if pc == 0: |
| 5424 | # we prefer a result that isn't exactly 1; this makes it |
| 5425 | # easier to compute a correctly rounded result in __pow__ |
| 5426 | if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1: |
| 5427 | coeff, exp = 10**(p-1)+1, 1-p |
| 5428 | else: |
| 5429 | coeff, exp = 10**p-1, -p |
| 5430 | else: |
| 5431 | coeff, exp = _dexp(pc, -(p+1), p+1) |
| 5432 | coeff = _div_nearest(coeff, 10) |
| 5433 | exp += 1 |
| 5434 | |
| 5435 | return coeff, exp |
| 5436 | |
| 5437 | def _log10_lb(c, correction = { |
| 5438 | '1': 100, '2': 70, '3': 53, '4': 40, '5': 31, |
| 5439 | '6': 23, '7': 16, '8': 10, '9': 5}): |
| 5440 | """Compute a lower bound for 100*log10(c) for a positive integer c.""" |
| 5441 | if c <= 0: |
| 5442 | raise ValueError("The argument to _log10_lb should be nonnegative.") |
| 5443 | str_c = str(c) |
| 5444 | return 100*len(str_c) - correction[str_c[0]] |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5445 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 5446 | ##### Helper Functions #################################################### |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5447 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5448 | def _convert_other(other, raiseit=False): |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 5449 | """Convert other to Decimal. |
| 5450 | |
| 5451 | Verifies that it's ok to use in an implicit construction. |
| 5452 | """ |
| 5453 | if isinstance(other, Decimal): |
| 5454 | return other |
Walter Dörwald | aa97f04 | 2007-05-03 21:05:51 +0000 | [diff] [blame] | 5455 | if isinstance(other, int): |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 5456 | return Decimal(other) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 5457 | if raiseit: |
| 5458 | raise TypeError("Unable to convert %s to Decimal" % other) |
Raymond Hettinger | 267b868 | 2005-03-27 10:47:39 +0000 | [diff] [blame] | 5459 | return NotImplemented |
Raymond Hettinger | 636a6b1 | 2004-09-19 01:54:09 +0000 | [diff] [blame] | 5460 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 5461 | ##### Setup Specific Contexts ############################################ |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5462 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5463 | # The default context prototype used by Context() |
Raymond Hettinger | fed5296 | 2004-07-14 15:41:57 +0000 | [diff] [blame] | 5464 | # Is mutable, so that new contexts can have different default values |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5465 | |
| 5466 | DefaultContext = Context( |
Raymond Hettinger | 6ea4845 | 2004-07-03 12:26:21 +0000 | [diff] [blame] | 5467 | prec=28, rounding=ROUND_HALF_EVEN, |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 5468 | traps=[DivisionByZero, Overflow, InvalidOperation], |
| 5469 | flags=[], |
Raymond Hettinger | 99148e7 | 2004-07-14 19:56:56 +0000 | [diff] [blame] | 5470 | Emax=999999999, |
| 5471 | Emin=-999999999, |
Raymond Hettinger | e0f1581 | 2004-07-05 05:36:39 +0000 | [diff] [blame] | 5472 | capitals=1 |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5473 | ) |
| 5474 | |
| 5475 | # Pre-made alternate contexts offered by the specification |
| 5476 | # Don't change these; the user should be able to select these |
| 5477 | # contexts and be able to reproduce results from other implementations |
| 5478 | # of the spec. |
| 5479 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 5480 | BasicContext = Context( |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5481 | prec=9, rounding=ROUND_HALF_UP, |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 5482 | traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow], |
| 5483 | flags=[], |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5484 | ) |
| 5485 | |
Raymond Hettinger | 9ec3e3b | 2004-07-03 13:48:56 +0000 | [diff] [blame] | 5486 | ExtendedContext = Context( |
Raymond Hettinger | 6ea4845 | 2004-07-03 12:26:21 +0000 | [diff] [blame] | 5487 | prec=9, rounding=ROUND_HALF_EVEN, |
Raymond Hettinger | bf44069 | 2004-07-10 14:14:37 +0000 | [diff] [blame] | 5488 | traps=[], |
| 5489 | flags=[], |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5490 | ) |
| 5491 | |
| 5492 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5493 | ##### crud for parsing strings ############################################# |
Christian Heimes | 23daade0 | 2008-02-25 12:39:23 +0000 | [diff] [blame] | 5494 | # |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5495 | # Regular expression used for parsing numeric strings. Additional |
| 5496 | # comments: |
| 5497 | # |
| 5498 | # 1. Uncomment the two '\s*' lines to allow leading and/or trailing |
| 5499 | # whitespace. But note that the specification disallows whitespace in |
| 5500 | # a numeric string. |
| 5501 | # |
| 5502 | # 2. For finite numbers (not infinities and NaNs) the body of the |
| 5503 | # number between the optional sign and the optional exponent must have |
| 5504 | # at least one decimal digit, possibly after the decimal point. The |
Mark Dickinson | 8d23829 | 2009-08-02 10:16:33 +0000 | [diff] [blame] | 5505 | # lookahead expression '(?=\d|\.\d)' checks this. |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5506 | |
| 5507 | import re |
Benjamin Peterson | 4118174 | 2008-07-02 20:22:54 +0000 | [diff] [blame] | 5508 | _parser = re.compile(r""" # A numeric string consists of: |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5509 | # \s* |
Benjamin Peterson | 4118174 | 2008-07-02 20:22:54 +0000 | [diff] [blame] | 5510 | (?P<sign>[-+])? # an optional sign, followed by either... |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5511 | ( |
Mark Dickinson | 8d23829 | 2009-08-02 10:16:33 +0000 | [diff] [blame] | 5512 | (?=\d|\.\d) # ...a number (with at least one digit) |
| 5513 | (?P<int>\d*) # having a (possibly empty) integer part |
| 5514 | (\.(?P<frac>\d*))? # followed by an optional fractional part |
| 5515 | (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or... |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5516 | | |
Benjamin Peterson | 4118174 | 2008-07-02 20:22:54 +0000 | [diff] [blame] | 5517 | Inf(inity)? # ...an infinity, or... |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5518 | | |
Benjamin Peterson | 4118174 | 2008-07-02 20:22:54 +0000 | [diff] [blame] | 5519 | (?P<signal>s)? # ...an (optionally signaling) |
| 5520 | NaN # NaN |
Mark Dickinson | 8d23829 | 2009-08-02 10:16:33 +0000 | [diff] [blame] | 5521 | (?P<diag>\d*) # with (possibly empty) diagnostic info. |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5522 | ) |
| 5523 | # \s* |
Christian Heimes | a62da1d | 2008-01-12 19:39:10 +0000 | [diff] [blame] | 5524 | \Z |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5525 | """, re.VERBOSE | re.IGNORECASE).match |
| 5526 | |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 5527 | _all_zeros = re.compile('0*$').match |
| 5528 | _exact_half = re.compile('50*$').match |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5529 | |
| 5530 | ##### PEP3101 support functions ############################################## |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5531 | # The functions in this section have little to do with the Decimal |
| 5532 | # class, and could potentially be reused or adapted for other pure |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5533 | # Python numeric classes that want to implement __format__ |
| 5534 | # |
| 5535 | # A format specifier for Decimal looks like: |
| 5536 | # |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5537 | # [[fill]align][sign][0][minimumwidth][,][.precision][type] |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5538 | |
| 5539 | _parse_format_specifier_regex = re.compile(r"""\A |
| 5540 | (?: |
| 5541 | (?P<fill>.)? |
| 5542 | (?P<align>[<>=^]) |
| 5543 | )? |
| 5544 | (?P<sign>[-+ ])? |
| 5545 | (?P<zeropad>0)? |
| 5546 | (?P<minimumwidth>(?!0)\d+)? |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5547 | (?P<thousands_sep>,)? |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5548 | (?:\.(?P<precision>0|(?!0)\d+))? |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5549 | (?P<type>[eEfFgGn%])? |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5550 | \Z |
| 5551 | """, re.VERBOSE) |
| 5552 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5553 | del re |
| 5554 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5555 | # The locale module is only needed for the 'n' format specifier. The |
| 5556 | # rest of the PEP 3101 code functions quite happily without it, so we |
| 5557 | # don't care too much if locale isn't present. |
| 5558 | try: |
| 5559 | import locale as _locale |
| 5560 | except ImportError: |
| 5561 | pass |
| 5562 | |
| 5563 | def _parse_format_specifier(format_spec, _localeconv=None): |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5564 | """Parse and validate a format specifier. |
| 5565 | |
| 5566 | Turns a standard numeric format specifier into a dict, with the |
| 5567 | following entries: |
| 5568 | |
| 5569 | fill: fill character to pad field to minimum width |
| 5570 | align: alignment type, either '<', '>', '=' or '^' |
| 5571 | sign: either '+', '-' or ' ' |
| 5572 | minimumwidth: nonnegative integer giving minimum width |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5573 | zeropad: boolean, indicating whether to pad with zeros |
| 5574 | thousands_sep: string to use as thousands separator, or '' |
| 5575 | grouping: grouping for thousands separators, in format |
| 5576 | used by localeconv |
| 5577 | decimal_point: string to use for decimal point |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5578 | precision: nonnegative integer giving precision, or None |
| 5579 | type: one of the characters 'eEfFgG%', or None |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5580 | |
| 5581 | """ |
| 5582 | m = _parse_format_specifier_regex.match(format_spec) |
| 5583 | if m is None: |
| 5584 | raise ValueError("Invalid format specifier: " + format_spec) |
| 5585 | |
| 5586 | # get the dictionary |
| 5587 | format_dict = m.groupdict() |
| 5588 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5589 | # zeropad; defaults for fill and alignment. If zero padding |
| 5590 | # is requested, the fill and align fields should be absent. |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5591 | fill = format_dict['fill'] |
| 5592 | align = format_dict['align'] |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5593 | format_dict['zeropad'] = (format_dict['zeropad'] is not None) |
| 5594 | if format_dict['zeropad']: |
| 5595 | if fill is not None: |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5596 | raise ValueError("Fill character conflicts with '0'" |
| 5597 | " in format specifier: " + format_spec) |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5598 | if align is not None: |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5599 | raise ValueError("Alignment conflicts with '0' in " |
| 5600 | "format specifier: " + format_spec) |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5601 | format_dict['fill'] = fill or ' ' |
| 5602 | format_dict['align'] = align or '<' |
| 5603 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5604 | # default sign handling: '-' for negative, '' for positive |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5605 | if format_dict['sign'] is None: |
| 5606 | format_dict['sign'] = '-' |
| 5607 | |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5608 | # minimumwidth defaults to 0; precision remains None if not given |
| 5609 | format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0') |
| 5610 | if format_dict['precision'] is not None: |
| 5611 | format_dict['precision'] = int(format_dict['precision']) |
| 5612 | |
| 5613 | # if format type is 'g' or 'G' then a precision of 0 makes little |
| 5614 | # sense; convert it to 1. Same if format type is unspecified. |
| 5615 | if format_dict['precision'] == 0: |
Mark Dickinson | d496d30 | 2009-09-07 16:23:26 +0000 | [diff] [blame] | 5616 | if format_dict['type'] is None or format_dict['type'] in 'gG': |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5617 | format_dict['precision'] = 1 |
| 5618 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5619 | # determine thousands separator, grouping, and decimal separator, and |
| 5620 | # add appropriate entries to format_dict |
| 5621 | if format_dict['type'] == 'n': |
| 5622 | # apart from separators, 'n' behaves just like 'g' |
| 5623 | format_dict['type'] = 'g' |
| 5624 | if _localeconv is None: |
| 5625 | _localeconv = _locale.localeconv() |
| 5626 | if format_dict['thousands_sep'] is not None: |
| 5627 | raise ValueError("Explicit thousands separator conflicts with " |
| 5628 | "'n' type in format specifier: " + format_spec) |
| 5629 | format_dict['thousands_sep'] = _localeconv['thousands_sep'] |
| 5630 | format_dict['grouping'] = _localeconv['grouping'] |
| 5631 | format_dict['decimal_point'] = _localeconv['decimal_point'] |
| 5632 | else: |
| 5633 | if format_dict['thousands_sep'] is None: |
| 5634 | format_dict['thousands_sep'] = '' |
| 5635 | format_dict['grouping'] = [3, 0] |
| 5636 | format_dict['decimal_point'] = '.' |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5637 | |
| 5638 | return format_dict |
| 5639 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5640 | def _format_align(sign, body, spec): |
| 5641 | """Given an unpadded, non-aligned numeric string 'body' and sign |
| 5642 | string 'sign', add padding and aligment conforming to the given |
| 5643 | format specifier dictionary 'spec' (as produced by |
| 5644 | parse_format_specifier). |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5645 | |
| 5646 | """ |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5647 | # how much extra space do we have to play with? |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5648 | minimumwidth = spec['minimumwidth'] |
| 5649 | fill = spec['fill'] |
| 5650 | padding = fill*(minimumwidth - len(sign) - len(body)) |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5651 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5652 | align = spec['align'] |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5653 | if align == '<': |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5654 | result = sign + body + padding |
Mark Dickinson | ad41634 | 2009-03-17 18:10:15 +0000 | [diff] [blame] | 5655 | elif align == '>': |
| 5656 | result = padding + sign + body |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5657 | elif align == '=': |
| 5658 | result = sign + padding + body |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5659 | elif align == '^': |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5660 | half = len(padding)//2 |
| 5661 | result = padding[:half] + sign + body + padding[half:] |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5662 | else: |
| 5663 | raise ValueError('Unrecognised alignment field') |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5664 | |
Christian Heimes | f16baeb | 2008-02-29 14:57:44 +0000 | [diff] [blame] | 5665 | return result |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 5666 | |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5667 | def _group_lengths(grouping): |
| 5668 | """Convert a localeconv-style grouping into a (possibly infinite) |
| 5669 | iterable of integers representing group lengths. |
| 5670 | |
| 5671 | """ |
| 5672 | # The result from localeconv()['grouping'], and the input to this |
| 5673 | # function, should be a list of integers in one of the |
| 5674 | # following three forms: |
| 5675 | # |
| 5676 | # (1) an empty list, or |
| 5677 | # (2) nonempty list of positive integers + [0] |
| 5678 | # (3) list of positive integers + [locale.CHAR_MAX], or |
| 5679 | |
| 5680 | from itertools import chain, repeat |
| 5681 | if not grouping: |
| 5682 | return [] |
| 5683 | elif grouping[-1] == 0 and len(grouping) >= 2: |
| 5684 | return chain(grouping[:-1], repeat(grouping[-2])) |
| 5685 | elif grouping[-1] == _locale.CHAR_MAX: |
| 5686 | return grouping[:-1] |
| 5687 | else: |
| 5688 | raise ValueError('unrecognised format for grouping') |
| 5689 | |
| 5690 | def _insert_thousands_sep(digits, spec, min_width=1): |
| 5691 | """Insert thousands separators into a digit string. |
| 5692 | |
| 5693 | spec is a dictionary whose keys should include 'thousands_sep' and |
| 5694 | 'grouping'; typically it's the result of parsing the format |
| 5695 | specifier using _parse_format_specifier. |
| 5696 | |
| 5697 | The min_width keyword argument gives the minimum length of the |
| 5698 | result, which will be padded on the left with zeros if necessary. |
| 5699 | |
| 5700 | If necessary, the zero padding adds an extra '0' on the left to |
| 5701 | avoid a leading thousands separator. For example, inserting |
| 5702 | commas every three digits in '123456', with min_width=8, gives |
| 5703 | '0,123,456', even though that has length 9. |
| 5704 | |
| 5705 | """ |
| 5706 | |
| 5707 | sep = spec['thousands_sep'] |
| 5708 | grouping = spec['grouping'] |
| 5709 | |
| 5710 | groups = [] |
| 5711 | for l in _group_lengths(grouping): |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5712 | if l <= 0: |
| 5713 | raise ValueError("group length should be positive") |
| 5714 | # max(..., 1) forces at least 1 digit to the left of a separator |
| 5715 | l = min(max(len(digits), min_width, 1), l) |
| 5716 | groups.append('0'*(l - len(digits)) + digits[-l:]) |
| 5717 | digits = digits[:-l] |
| 5718 | min_width -= l |
| 5719 | if not digits and min_width <= 0: |
| 5720 | break |
Mark Dickinson | 7303b59 | 2009-03-18 08:25:36 +0000 | [diff] [blame] | 5721 | min_width -= len(sep) |
Mark Dickinson | 79f5203 | 2009-03-17 23:12:51 +0000 | [diff] [blame] | 5722 | else: |
| 5723 | l = max(len(digits), min_width, 1) |
| 5724 | groups.append('0'*(l - len(digits)) + digits[-l:]) |
| 5725 | return sep.join(reversed(groups)) |
| 5726 | |
| 5727 | def _format_sign(is_negative, spec): |
| 5728 | """Determine sign character.""" |
| 5729 | |
| 5730 | if is_negative: |
| 5731 | return '-' |
| 5732 | elif spec['sign'] in ' +': |
| 5733 | return spec['sign'] |
| 5734 | else: |
| 5735 | return '' |
| 5736 | |
| 5737 | def _format_number(is_negative, intpart, fracpart, exp, spec): |
| 5738 | """Format a number, given the following data: |
| 5739 | |
| 5740 | is_negative: true if the number is negative, else false |
| 5741 | intpart: string of digits that must appear before the decimal point |
| 5742 | fracpart: string of digits that must come after the point |
| 5743 | exp: exponent, as an integer |
| 5744 | spec: dictionary resulting from parsing the format specifier |
| 5745 | |
| 5746 | This function uses the information in spec to: |
| 5747 | insert separators (decimal separator and thousands separators) |
| 5748 | format the sign |
| 5749 | format the exponent |
| 5750 | add trailing '%' for the '%' type |
| 5751 | zero-pad if necessary |
| 5752 | fill and align if necessary |
| 5753 | """ |
| 5754 | |
| 5755 | sign = _format_sign(is_negative, spec) |
| 5756 | |
| 5757 | if fracpart: |
| 5758 | fracpart = spec['decimal_point'] + fracpart |
| 5759 | |
| 5760 | if exp != 0 or spec['type'] in 'eE': |
| 5761 | echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']] |
| 5762 | fracpart += "{0}{1:+}".format(echar, exp) |
| 5763 | if spec['type'] == '%': |
| 5764 | fracpart += '%' |
| 5765 | |
| 5766 | if spec['zeropad']: |
| 5767 | min_width = spec['minimumwidth'] - len(fracpart) - len(sign) |
| 5768 | else: |
| 5769 | min_width = 0 |
| 5770 | intpart = _insert_thousands_sep(intpart, spec, min_width) |
| 5771 | |
| 5772 | return _format_align(sign, intpart+fracpart, spec) |
| 5773 | |
| 5774 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 5775 | ##### Useful Constants (internal use only) ################################ |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5776 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 5777 | # Reusable defaults |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 5778 | _Infinity = Decimal('Inf') |
| 5779 | _NegativeInfinity = Decimal('-Inf') |
Mark Dickinson | f923641 | 2009-01-02 23:23:21 +0000 | [diff] [blame] | 5780 | _NaN = Decimal('NaN') |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 5781 | _Zero = Decimal(0) |
| 5782 | _One = Decimal(1) |
| 5783 | _NegativeOne = Decimal(-1) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5784 | |
Mark Dickinson | 627cf6a | 2009-01-03 12:11:47 +0000 | [diff] [blame] | 5785 | # _SignedInfinity[sign] is infinity w/ that sign |
| 5786 | _SignedInfinity = (_Infinity, _NegativeInfinity) |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5787 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5788 | |
Raymond Hettinger | 7c85fa4 | 2004-07-01 11:01:35 +0000 | [diff] [blame] | 5789 | |
| 5790 | if __name__ == '__main__': |
| 5791 | import doctest, sys |
| 5792 | doctest.testmod(sys.modules[__name__]) |