blob: 29ce39838f399647ec2d92ecf4f5b1b263748ba7 [file] [log] [blame]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001# 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 Drake1f34eb12004-07-01 14:28:36 +00007# and Aahz <aahz at pobox.com>
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00008# and Tim Peters
9
Facundo Batista6ab24792009-02-16 15:41:37 +000010# 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 Hettinger27dbcf22004-08-19 22:39:55 +000012# 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 Hettinger7c85fa42004-07-01 11:01:35 +000015
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000016"""
Facundo Batista6ab24792009-02-16 15:41:37 +000017This is an implementation of decimal floating point arithmetic based on
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000018the General Decimal Arithmetic Specification:
19
Raymond Hettinger960dc362009-04-21 03:43:15 +000020 http://speleotrove.com/decimal/decarith.html
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000021
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000022and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000023
24 www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html
25
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000026Decimal floating point has finite precision with arbitrarily large bounds.
27
Guido van Rossumd8faa362007-04-27 19:54:29 +000028The purpose of this module is to support arithmetic using familiar
29"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030issues associated with binary floating point. The package is especially
31useful for financial applications or for contexts where users have
32expectations that are at odds with binary floating point (for instance,
33in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Christian Heimes68f5fbe2008-02-14 08:27:37 +000034of the expected Decimal('0.00') returned by decimal floating point).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000035
36Here are some examples of using the decimal module:
37
38>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000039>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000040>>> Decimal(0)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000041Decimal('0')
42>>> Decimal('1')
43Decimal('1')
44>>> Decimal('-.0123')
45Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000046>>> Decimal(123456)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000047Decimal('123456')
48>>> Decimal('123.45e12345678901234567890')
49Decimal('1.2345E+12345678901234567892')
50>>> Decimal('1.33') + Decimal('1.27')
51Decimal('2.60')
52>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
53Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000054>>> dig = Decimal(1)
Guido van Rossum7131f842007-02-09 20:13:25 +000055>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000560.333333333
57>>> getcontext().prec = 18
Guido van Rossum7131f842007-02-09 20:13:25 +000058>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000590.333333333333333333
Guido van Rossum7131f842007-02-09 20:13:25 +000060>>> print(dig.sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000611
Guido van Rossum7131f842007-02-09 20:13:25 +000062>>> print(Decimal(3).sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000631.73205080756887729
Guido van Rossum7131f842007-02-09 20:13:25 +000064>>> print(Decimal(3) ** 123)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000654.85192780976896427E+58
66>>> inf = Decimal(1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000067>>> print(inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000068Infinity
69>>> neginf = Decimal(-1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000070>>> print(neginf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000071-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000072>>> print(neginf + inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000073NaN
Guido van Rossum7131f842007-02-09 20:13:25 +000074>>> print(neginf * inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000075-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000076>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000077Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000078>>> getcontext().traps[DivisionByZero] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000079>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000080Traceback (most recent call last):
81 ...
82 ...
83 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +000084decimal.DivisionByZero: x / 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000085>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000086>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000087>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000880
89>>> c.divide(Decimal(0), Decimal(0))
Christian Heimes68f5fbe2008-02-14 08:27:37 +000090Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000091>>> c.traps[InvalidOperation] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000092>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000931
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000094>>> c.flags[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000095>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000960
Guido van Rossum7131f842007-02-09 20:13:25 +000097>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000098Traceback (most recent call last):
99 ...
100 ...
101 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +0000102decimal.InvalidOperation: 0 / 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000103>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001041
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000105>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000106>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000107>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000108NaN
Guido van Rossum7131f842007-02-09 20:13:25 +0000109>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001101
111>>>
112"""
113
114__all__ = [
115 # Two major classes
116 'Decimal', 'Context',
117
118 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000119 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000120
121 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000122 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
123 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000124
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000125 # Constants for use in setting up contexts
126 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000127 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000128
129 # Functions for manipulating contexts
Thomas Wouters89f507f2006-12-13 04:49:30 +0000130 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000131]
132
Raymond Hettinger960dc362009-04-21 03:43:15 +0000133__version__ = '1.70' # Highest version of the spec this complies with
134
Raymond Hettingereb260842005-06-07 18:52:34 +0000135import copy as _copy
Raymond Hettinger771ed762009-01-03 19:20:32 +0000136import math as _math
Raymond Hettinger82417ca2009-02-03 03:54:28 +0000137import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000138
Christian Heimes25bb7832008-01-11 16:17:00 +0000139try:
140 from collections import namedtuple as _namedtuple
141 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
142except ImportError:
143 DecimalTuple = lambda *args: args
144
Guido van Rossumd8faa362007-04-27 19:54:29 +0000145# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000146ROUND_DOWN = 'ROUND_DOWN'
147ROUND_HALF_UP = 'ROUND_HALF_UP'
148ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
149ROUND_CEILING = 'ROUND_CEILING'
150ROUND_FLOOR = 'ROUND_FLOOR'
151ROUND_UP = 'ROUND_UP'
152ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000153ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000154
Guido van Rossumd8faa362007-04-27 19:54:29 +0000155# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000156
157class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000158 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000159
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 Hettinger7c85fa42004-07-01 11:01:35 +0000166 handle -- Called when context._raise_error is called and the
Stefan Krah2eb4a072010-05-19 15:52:31 +0000167 trap_enabler is not set. First argument is self, second is the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000168 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 Hettinger7c85fa42004-07-01 11:01:35 +0000176 def handle(self, context, *args):
177 pass
178
179
180class 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 Rossumd8faa362007-04-27 19:54:29 +0000185 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 Hettinger7c85fa42004-07-01 11:01:35 +0000188 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 Hettinger7c85fa42004-07-01 11:01:35 +0000192class 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 Rossumd8faa362007-04-27 19:54:29 +0000199 0 * (+-)INF
200 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000201 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 Wouters1b7f8912007-09-19 03:06:30 +0000209
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 Hettinger7c85fa42004-07-01 11:01:35 +0000214 """
215 def handle(self, context, *args):
216 if args:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000217 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
218 return ans._fix_nan(context)
Mark Dickinsonf9236412009-01-02 23:23:21 +0000219 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000220
221class 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 Rossumd8faa362007-04-27 19:54:29 +0000226 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000227 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000228 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000229 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000230
231class 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 Wouters1b7f8912007-09-19 03:06:30 +0000244 def handle(self, context, sign, *args):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000245 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000246
247class 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 Rossumd8faa362007-04-27 19:54:29 +0000252 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000253 """
254
255 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000256 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000257
258class 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 Rossumd8faa362007-04-27 19:54:29 +0000263 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000264 """
265
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000266 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000267 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000268
269class 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 Rossumd8faa362007-04-27 19:54:29 +0000274 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000275 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 Hettinger7c85fa42004-07-01 11:01:35 +0000280
281class InvalidContext(InvalidOperation):
282 """Invalid context. Unknown rounding, for example.
283
284 This occurs and signals invalid-operation if an invalid context was
Guido van Rossumd8faa362007-04-27 19:54:29 +0000285 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000286 on creation and either the precision exceeds the capability of the
287 underlying concrete representation or an unknown or unsupported rounding
Guido van Rossumd8faa362007-04-27 19:54:29 +0000288 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 Hettinger7c85fa42004-07-01 11:01:35 +0000290 """
291
292 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000293 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000294
295class 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 Rossumd8faa362007-04-27 19:54:29 +0000300 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000301 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 Hettinger7c85fa42004-07-01 11:01:35 +0000306
307class 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 Rossumd8faa362007-04-27 19:54:29 +0000312 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000313
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 Hettinger7c85fa42004-07-01 11:01:35 +0000317
318class 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 Rossumd8faa362007-04-27 19:54:29 +0000330 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000331 result is the largest finite number that can be represented in the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000332 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000333 round-ceiling, the result is the same as for round-down if the sign of
Guido van Rossumd8faa362007-04-27 19:54:29 +0000334 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000335 the result is the same as for round-down if the sign of the intermediate
Guido van Rossumd8faa362007-04-27 19:54:29 +0000336 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000337 will also be raised.
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000338 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000339
340 def handle(self, context, sign, *args):
341 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000342 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000343 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000344 if sign == 0:
345 if context.rounding == ROUND_CEILING:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000346 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000347 return _dec_from_triple(sign, '9'*context.prec,
348 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000349 if sign == 1:
350 if context.rounding == ROUND_FLOOR:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000351 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000352 return _dec_from_triple(sign, '9'*context.prec,
353 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000354
355
356class 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 Rossumd8faa362007-04-27 19:54:29 +0000362 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000363
364 The result after an underflow will be a subnormal number rounded, if
Guido van Rossumd8faa362007-04-27 19:54:29 +0000365 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000366 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 Hettinger5aa478b2004-07-09 10:02:53 +0000371# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000372_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000373 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000374
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000375# Map conditions (per the spec) to signals
376_condition_map = {ConversionSyntax:InvalidOperation,
377 DivisionImpossible:InvalidOperation,
378 DivisionUndefined:InvalidOperation,
379 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000380
Guido van Rossumd8faa362007-04-27 19:54:29 +0000381##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000382
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000383# 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 Brandlf9926402008-06-13 06:32:25 +0000385# is not available, use threading.current_thread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000386# 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
389try:
390 import threading
391except ImportError:
392 # Python was compiled without threads; create a mock object instead
393 import sys
Guido van Rossumd8faa362007-04-27 19:54:29 +0000394 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000395 def local(self, sys=sys):
396 return sys.modules[__name__]
397 threading = MockThreading()
398 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000399
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000400try:
401 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000402
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000403except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000404
Guido van Rossumd8faa362007-04-27 19:54:29 +0000405 # To fix reloading, force it to create a new context
406 # Old contexts have different exceptions in their dicts, making problems.
Georg Brandlf9926402008-06-13 06:32:25 +0000407 if hasattr(threading.current_thread(), '__decimal_context__'):
408 del threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000409
410 def setcontext(context):
411 """Set this thread's context to context."""
412 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000413 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000414 context.clear_flags()
Georg Brandlf9926402008-06-13 06:32:25 +0000415 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000416
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 Brandlf9926402008-06-13 06:32:25 +0000425 return threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000426 except AttributeError:
427 context = Context()
Georg Brandlf9926402008-06-13 06:32:25 +0000428 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000429 return context
430
431else:
432
433 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000434 if hasattr(local, '__decimal_context__'):
435 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000436
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 Hettinger9fce44b2004-08-08 04:03:24 +0000454 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000455 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000456 _local.__decimal_context__ = context
457
458 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000459
Thomas Wouters89f507f2006-12-13 04:49:30 +0000460def 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 Rossumd8faa362007-04-27 19:54:29 +0000471 return +s # Convert result to normal precision
Thomas Wouters89f507f2006-12-13 04:49:30 +0000472
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 Rossumd8faa362007-04-27 19:54:29 +0000478 return +s # Convert result to normal context
Thomas Wouters89f507f2006-12-13 04:49:30 +0000479
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000480 >>> setcontext(DefaultContext)
Guido van Rossum7131f842007-02-09 20:13:25 +0000481 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000482 28
483 >>> with localcontext():
484 ... ctx = getcontext()
Thomas Wouterscf297e42007-02-23 15:07:44 +0000485 ... ctx.prec += 2
Guido van Rossum7131f842007-02-09 20:13:25 +0000486 ... print(ctx.prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000487 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000488 30
489 >>> with localcontext(ExtendedContext):
Guido van Rossum7131f842007-02-09 20:13:25 +0000490 ... print(getcontext().prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000491 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000492 9
Guido van Rossum7131f842007-02-09 20:13:25 +0000493 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000494 28
495 """
496 if ctx is None: ctx = getcontext()
497 return _ContextManager(ctx)
498
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000499
Guido van Rossumd8faa362007-04-27 19:54:29 +0000500##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000501
Raymond Hettingera0fd8882009-01-20 07:24:44 +0000502# 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
506class Decimal(object):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000507 """Floating point class for decimal arithmetic."""
508
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000509 __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 Hettinger7c85fa42004-07-01 11:01:35 +0000513
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000514 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000515 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000516 """Create a decimal point instance.
517
518 >>> Decimal('3.14') # string input
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000519 Decimal('3.14')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000520 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000521 Decimal('3.14')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000522 >>> Decimal(314) # int
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000523 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000524 >>> Decimal(Decimal(314)) # another decimal instance
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000525 Decimal('314')
Christian Heimesa62da1d2008-01-12 19:39:10 +0000526 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000527 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000528 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000529
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000530 # 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 Hettinger636a6b12004-09-19 01:54:09 +0000538 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000539
Christian Heimesd59c64c2007-11-30 19:27:20 +0000540 # From a string
541 # REs insist on real strings, so we can too.
542 if isinstance(value, str):
Christian Heimesa62da1d2008-01-12 19:39:10 +0000543 m = _parser(value.strip())
Christian Heimesd59c64c2007-11-30 19:27:20 +0000544 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 Hettinger636a6b12004-09-19 01:54:09 +0000549
Christian Heimesd59c64c2007-11-30 19:27:20 +0000550 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 Dickinson345adc42009-08-02 10:14:23 +0000557 fracpart = m.group('frac') or ''
Christian Heimesd59c64c2007-11-30 19:27:20 +0000558 exp = int(m.group('exp') or '0')
Mark Dickinson345adc42009-08-02 10:14:23 +0000559 self._int = str(int(intpart+fracpart))
560 self._exp = exp - len(fracpart)
Christian Heimesd59c64c2007-11-30 19:27:20 +0000561 self._is_special = False
562 else:
563 diag = m.group('diag')
564 if diag is not None:
565 # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +0000566 self._int = str(int(diag or '0')).lstrip('0')
Christian Heimesd59c64c2007-11-30 19:27:20 +0000567 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 Hettinger636a6b12004-09-19 01:54:09 +0000576 return self
577
578 # From an integer
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000579 if isinstance(value, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000580 if value >= 0:
581 self._sign = 0
582 else:
583 self._sign = 1
584 self._exp = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000585 self._int = str(abs(value))
Christian Heimesd59c64c2007-11-30 19:27:20 +0000586 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 Hettinger636a6b12004-09-19 01:54:09 +0000603 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000604
605 # tuple/list conversion (possibly from as_tuple())
606 if isinstance(value, (list,tuple)):
607 if len(value) != 3:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000608 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 Hettinger7c85fa42004-07-01 11:01:35 +0000616 self._sign = value[0]
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000617 if value[2] == 'F':
618 # infinity: value[1] is ignored
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000619 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000620 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000621 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000622 else:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000623 # 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 Rossum0d3fb8a2007-11-26 23:23:18 +0000636 self._int = ''.join(map(str, digits))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000637 self._exp = value[2]
638 self._is_special = True
639 elif isinstance(value[2], int):
640 # finite number: digits give the coefficient
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000641 self._int = ''.join(map(str, digits or [0]))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000642 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 Hettinger636a6b12004-09-19 01:54:09 +0000648 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000649
Raymond Hettingerbf440692004-07-10 14:14:37 +0000650 if isinstance(value, float):
Raymond Hettinger96798592010-04-02 16:58:27 +0000651 value = Decimal.from_float(value)
652 self._exp = value._exp
653 self._sign = value._sign
654 self._int = value._int
655 self._is_special = value._is_special
656 return self
Raymond Hettingerbf440692004-07-10 14:14:37 +0000657
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000658 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000659
Mark Dickinsonba298e42009-01-04 21:17:43 +0000660 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
661 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000662 def from_float(cls, f):
663 """Converts a float to a decimal number, exactly.
664
665 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
666 Since 0.1 is not exactly representable in binary floating point, the
667 value is stored as the nearest representable value which is
668 0x1.999999999999ap-4. The exact equivalent of the value in decimal
669 is 0.1000000000000000055511151231257827021181583404541015625.
670
671 >>> Decimal.from_float(0.1)
672 Decimal('0.1000000000000000055511151231257827021181583404541015625')
673 >>> Decimal.from_float(float('nan'))
674 Decimal('NaN')
675 >>> Decimal.from_float(float('inf'))
676 Decimal('Infinity')
677 >>> Decimal.from_float(-float('inf'))
678 Decimal('-Infinity')
679 >>> Decimal.from_float(-0.0)
680 Decimal('-0')
681
682 """
683 if isinstance(f, int): # handle integer inputs
684 return cls(f)
685 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
686 return cls(repr(f))
Mark Dickinsonba298e42009-01-04 21:17:43 +0000687 if _math.copysign(1.0, f) == 1.0:
688 sign = 0
689 else:
690 sign = 1
Raymond Hettinger771ed762009-01-03 19:20:32 +0000691 n, d = abs(f).as_integer_ratio()
692 k = d.bit_length() - 1
693 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinsonba298e42009-01-04 21:17:43 +0000694 if cls is Decimal:
695 return result
696 else:
697 return cls(result)
698 from_float = classmethod(from_float)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000699
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000700 def _isnan(self):
701 """Returns whether the number is not actually one.
702
703 0 if a number
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000704 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000705 2 if sNaN
706 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000707 if self._is_special:
708 exp = self._exp
709 if exp == 'n':
710 return 1
711 elif exp == 'N':
712 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000713 return 0
714
715 def _isinfinity(self):
716 """Returns whether the number is infinite
717
718 0 if finite or not a number
719 1 if +INF
720 -1 if -INF
721 """
722 if self._exp == 'F':
723 if self._sign:
724 return -1
725 return 1
726 return 0
727
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000728 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000729 """Returns whether the number is not actually one.
730
731 if self, other are sNaN, signal
732 if self, other are NaN return nan
733 return 0
734
735 Done before operations.
736 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000737
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000738 self_is_nan = self._isnan()
739 if other is None:
740 other_is_nan = False
741 else:
742 other_is_nan = other._isnan()
743
744 if self_is_nan or other_is_nan:
745 if context is None:
746 context = getcontext()
747
748 if self_is_nan == 2:
749 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000750 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000751 if other_is_nan == 2:
752 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000753 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000754 if self_is_nan:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000755 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000756
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000757 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000758 return 0
759
Christian Heimes77c02eb2008-02-09 02:18:51 +0000760 def _compare_check_nans(self, other, context):
761 """Version of _check_nans used for the signaling comparisons
762 compare_signal, __le__, __lt__, __ge__, __gt__.
763
764 Signal InvalidOperation if either self or other is a (quiet
765 or signaling) NaN. Signaling NaNs take precedence over quiet
766 NaNs.
767
768 Return 0 if neither operand is a NaN.
769
770 """
771 if context is None:
772 context = getcontext()
773
774 if self._is_special or other._is_special:
775 if self.is_snan():
776 return context._raise_error(InvalidOperation,
777 'comparison involving sNaN',
778 self)
779 elif other.is_snan():
780 return context._raise_error(InvalidOperation,
781 'comparison involving sNaN',
782 other)
783 elif self.is_qnan():
784 return context._raise_error(InvalidOperation,
785 'comparison involving NaN',
786 self)
787 elif other.is_qnan():
788 return context._raise_error(InvalidOperation,
789 'comparison involving NaN',
790 other)
791 return 0
792
Jack Diederich4dafcc42006-11-28 19:15:13 +0000793 def __bool__(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000794 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000795
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000796 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000797 """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000798 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000799
Christian Heimes77c02eb2008-02-09 02:18:51 +0000800 def _cmp(self, other):
801 """Compare the two non-NaN decimal instances self and other.
802
803 Returns -1 if self < other, 0 if self == other and 1
804 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000805
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000806 if self._is_special or other._is_special:
Mark Dickinsone6aad752009-01-25 10:48:51 +0000807 self_inf = self._isinfinity()
808 other_inf = other._isinfinity()
809 if self_inf == other_inf:
810 return 0
811 elif self_inf < other_inf:
812 return -1
813 else:
814 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000815
Mark Dickinsone6aad752009-01-25 10:48:51 +0000816 # check for zeros; Decimal('0') == Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000817 if not self:
818 if not other:
819 return 0
820 else:
821 return -((-1)**other._sign)
822 if not other:
823 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000824
Guido van Rossumd8faa362007-04-27 19:54:29 +0000825 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000826 if other._sign < self._sign:
827 return -1
828 if self._sign < other._sign:
829 return 1
830
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000831 self_adjusted = self.adjusted()
832 other_adjusted = other.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000833 if self_adjusted == other_adjusted:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000834 self_padded = self._int + '0'*(self._exp - other._exp)
835 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone6aad752009-01-25 10:48:51 +0000836 if self_padded == other_padded:
837 return 0
838 elif self_padded < other_padded:
839 return -(-1)**self._sign
840 else:
841 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000842 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000843 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000844 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000845 return -((-1)**self._sign)
846
Christian Heimes77c02eb2008-02-09 02:18:51 +0000847 # Note: The Decimal standard doesn't cover rich comparisons for
848 # Decimals. In particular, the specification is silent on the
849 # subject of what should happen for a comparison involving a NaN.
850 # We take the following approach:
851 #
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000852 # == comparisons involving a quiet NaN always return False
853 # != comparisons involving a quiet NaN always return True
854 # == or != comparisons involving a signaling NaN signal
855 # InvalidOperation, and return False or True as above if the
856 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000857 # <, >, <= and >= comparisons involving a (quiet or signaling)
858 # NaN signal InvalidOperation, and return False if the
Christian Heimes3feef612008-02-11 06:19:17 +0000859 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000860 #
861 # This behavior is designed to conform as closely as possible to
862 # that specified by IEEE 754.
863
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000864 def __eq__(self, other, context=None):
Mark Dickinsondc787d22010-05-23 13:33:13 +0000865 other = _convert_other(other, allow_float = True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000866 if other is NotImplemented:
867 return other
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000868 if self._check_nans(other, context):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000869 return False
870 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000871
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000872 def __ne__(self, other, context=None):
Mark Dickinsondc787d22010-05-23 13:33:13 +0000873 other = _convert_other(other, allow_float = True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000874 if other is NotImplemented:
875 return other
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000876 if self._check_nans(other, context):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000877 return True
878 return self._cmp(other) != 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000879
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000880
Christian Heimes77c02eb2008-02-09 02:18:51 +0000881 def __lt__(self, other, context=None):
Mark Dickinsondc787d22010-05-23 13:33:13 +0000882 other = _convert_other(other, allow_float = True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000883 if other is NotImplemented:
884 return other
885 ans = self._compare_check_nans(other, context)
886 if ans:
887 return False
888 return self._cmp(other) < 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000889
Christian Heimes77c02eb2008-02-09 02:18:51 +0000890 def __le__(self, other, context=None):
Mark Dickinsondc787d22010-05-23 13:33:13 +0000891 other = _convert_other(other, allow_float = True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000892 if other is NotImplemented:
893 return other
894 ans = self._compare_check_nans(other, context)
895 if ans:
896 return False
897 return self._cmp(other) <= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000898
Christian Heimes77c02eb2008-02-09 02:18:51 +0000899 def __gt__(self, other, context=None):
Mark Dickinsondc787d22010-05-23 13:33:13 +0000900 other = _convert_other(other, allow_float = True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000901 if other is NotImplemented:
902 return other
903 ans = self._compare_check_nans(other, context)
904 if ans:
905 return False
906 return self._cmp(other) > 0
907
908 def __ge__(self, other, context=None):
Mark Dickinsondc787d22010-05-23 13:33:13 +0000909 other = _convert_other(other, allow_float = True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000910 if other is NotImplemented:
911 return other
912 ans = self._compare_check_nans(other, context)
913 if ans:
914 return False
915 return self._cmp(other) >= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000916
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000917 def compare(self, other, context=None):
918 """Compares one to another.
919
920 -1 => a < b
921 0 => a = b
922 1 => a > b
923 NaN => one is NaN
924 Like __cmp__, but returns Decimal instances.
925 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000926 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000927
Guido van Rossumd8faa362007-04-27 19:54:29 +0000928 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000929 if (self._is_special or other and other._is_special):
930 ans = self._check_nans(other, context)
931 if ans:
932 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000933
Christian Heimes77c02eb2008-02-09 02:18:51 +0000934 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000935
936 def __hash__(self):
937 """x.__hash__() <==> hash(x)"""
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000938
Mark Dickinsondc787d22010-05-23 13:33:13 +0000939 # In order to make sure that the hash of a Decimal instance
940 # agrees with the hash of a numerically equal integer, float
941 # or Fraction, we follow the rules for numeric hashes outlined
942 # in the documentation. (See library docs, 'Built-in Types').
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000943 if self._is_special:
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000944 if self.is_snan():
945 raise TypeError('Cannot hash a signaling NaN value.')
946 elif self.is_nan():
Mark Dickinsondc787d22010-05-23 13:33:13 +0000947 return _PyHASH_NAN
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000948 else:
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000949 if self._sign:
Mark Dickinsondc787d22010-05-23 13:33:13 +0000950 return -_PyHASH_INF
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000951 else:
Mark Dickinsondc787d22010-05-23 13:33:13 +0000952 return _PyHASH_INF
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000953
Mark Dickinsondc787d22010-05-23 13:33:13 +0000954 if self._exp >= 0:
955 exp_hash = pow(10, self._exp, _PyHASH_MODULUS)
956 else:
957 exp_hash = pow(_PyHASH_10INV, -self._exp, _PyHASH_MODULUS)
958 hash_ = int(self._int) * exp_hash % _PyHASH_MODULUS
959 return hash_ if self >= 0 else -hash_
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000960
961 def as_tuple(self):
962 """Represents the number as a triple tuple.
963
964 To show the internals exactly as they are.
965 """
Christian Heimes25bb7832008-01-11 16:17:00 +0000966 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000967
968 def __repr__(self):
969 """Represents the number as an instance of Decimal."""
970 # Invariant: eval(repr(d)) == d
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000971 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000972
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000973 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000974 """Return string representation of the number in scientific notation.
975
976 Captures all of the information in the underlying representation.
977 """
978
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000979 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000980 if self._is_special:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000981 if self._exp == 'F':
982 return sign + 'Infinity'
983 elif self._exp == 'n':
984 return sign + 'NaN' + self._int
985 else: # self._exp == 'N'
986 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000987
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000988 # number of digits of self._int to left of decimal point
989 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000990
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000991 # dotplace is number of digits of self._int to the left of the
992 # decimal point in the mantissa of the output string (that is,
993 # after adjusting the exponent)
994 if self._exp <= 0 and leftdigits > -6:
995 # no exponent required
996 dotplace = leftdigits
997 elif not eng:
998 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000999 dotplace = 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001000 elif self._int == '0':
1001 # engineering notation, zero
1002 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001003 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001004 # engineering notation, nonzero
1005 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001006
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001007 if dotplace <= 0:
1008 intpart = '0'
1009 fracpart = '.' + '0'*(-dotplace) + self._int
1010 elif dotplace >= len(self._int):
1011 intpart = self._int+'0'*(dotplace-len(self._int))
1012 fracpart = ''
1013 else:
1014 intpart = self._int[:dotplace]
1015 fracpart = '.' + self._int[dotplace:]
1016 if leftdigits == dotplace:
1017 exp = ''
1018 else:
1019 if context is None:
1020 context = getcontext()
1021 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1022
1023 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001024
1025 def to_eng_string(self, context=None):
1026 """Convert to engineering-type string.
1027
1028 Engineering notation has an exponent which is a multiple of 3, so there
1029 are up to 3 digits left of the decimal place.
1030
1031 Same rules for when in exponential and when as a value as in __str__.
1032 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001033 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001034
1035 def __neg__(self, context=None):
1036 """Returns a copy with the sign switched.
1037
1038 Rounds, if it has reason.
1039 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001040 if self._is_special:
1041 ans = self._check_nans(context=context)
1042 if ans:
1043 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001044
1045 if not self:
1046 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001047 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001048 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001049 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001050
1051 if context is None:
1052 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001053 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001054
1055 def __pos__(self, context=None):
1056 """Returns a copy, unless it is a sNaN.
1057
1058 Rounds the number (if more then precision digits)
1059 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001060 if self._is_special:
1061 ans = self._check_nans(context=context)
1062 if ans:
1063 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001064
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001065 if not self:
1066 # + (-0) = 0
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001067 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001068 else:
1069 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001070
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001071 if context is None:
1072 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001073 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001074
Christian Heimes2c181612007-12-17 20:04:13 +00001075 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001076 """Returns the absolute value of self.
1077
Christian Heimes2c181612007-12-17 20:04:13 +00001078 If the keyword argument 'round' is false, do not round. The
1079 expression self.__abs__(round=False) is equivalent to
1080 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001081 """
Christian Heimes2c181612007-12-17 20:04:13 +00001082 if not round:
1083 return self.copy_abs()
1084
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001085 if self._is_special:
1086 ans = self._check_nans(context=context)
1087 if ans:
1088 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001089
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001090 if self._sign:
1091 ans = self.__neg__(context=context)
1092 else:
1093 ans = self.__pos__(context=context)
1094
1095 return ans
1096
1097 def __add__(self, other, context=None):
1098 """Returns self + other.
1099
1100 -INF + INF (or the reverse) cause InvalidOperation errors.
1101 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001102 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001103 if other is NotImplemented:
1104 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001105
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001106 if context is None:
1107 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001108
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001109 if self._is_special or other._is_special:
1110 ans = self._check_nans(other, context)
1111 if ans:
1112 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001113
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001114 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001115 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001116 if self._sign != other._sign and other._isinfinity():
1117 return context._raise_error(InvalidOperation, '-INF + INF')
1118 return Decimal(self)
1119 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001120 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001121
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001122 exp = min(self._exp, other._exp)
1123 negativezero = 0
1124 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001125 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001126 negativezero = 1
1127
1128 if not self and not other:
1129 sign = min(self._sign, other._sign)
1130 if negativezero:
1131 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001132 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001133 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001134 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001135 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001136 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001137 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001138 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001139 return ans
1140 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001141 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001142 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001143 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001144 return ans
1145
1146 op1 = _WorkRep(self)
1147 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001148 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149
1150 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001151 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001152 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001153 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001154 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001155 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001156 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001157 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001158 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001159 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001160 if op1.sign == 1:
1161 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001162 op1.sign, op2.sign = op2.sign, op1.sign
1163 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001164 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001165 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001166 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001167 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001168 op1.sign, op2.sign = (0, 0)
1169 else:
1170 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001171 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001172
Raymond Hettinger17931de2004-10-27 06:21:46 +00001173 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001174 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001175 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001176 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001177
1178 result.exp = op1.exp
1179 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001180 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001181 return ans
1182
1183 __radd__ = __add__
1184
1185 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001186 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001187 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001188 if other is NotImplemented:
1189 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001190
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001191 if self._is_special or other._is_special:
1192 ans = self._check_nans(other, context=context)
1193 if ans:
1194 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001195
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001196 # self - other is computed as self + other.copy_negate()
1197 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001198
1199 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001200 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001201 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001202 if other is NotImplemented:
1203 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001205 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001206
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001207 def __mul__(self, other, context=None):
1208 """Return self * other.
1209
1210 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1211 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001212 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001213 if other is NotImplemented:
1214 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001215
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001216 if context is None:
1217 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001218
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001219 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001220
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001221 if self._is_special or other._is_special:
1222 ans = self._check_nans(other, context)
1223 if ans:
1224 return ans
1225
1226 if self._isinfinity():
1227 if not other:
1228 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001229 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001230
1231 if other._isinfinity():
1232 if not self:
1233 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001234 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235
1236 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001237
1238 # Special case for multiplying by zero
1239 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001240 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001241 # Fixing in case the exponent is out of bounds
1242 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001243 return ans
1244
1245 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001246 if self._int == '1':
1247 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001248 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001249 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001250 if other._int == '1':
1251 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001252 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001253 return ans
1254
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001255 op1 = _WorkRep(self)
1256 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001257
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001258 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001259 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001260
1261 return ans
1262 __rmul__ = __mul__
1263
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001264 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001265 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001266 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001267 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001268 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001269
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001270 if context is None:
1271 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001272
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001273 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001274
1275 if self._is_special or other._is_special:
1276 ans = self._check_nans(other, context)
1277 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001278 return ans
1279
1280 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001281 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001282
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001283 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001284 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001285
1286 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001287 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001288 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001289
1290 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001291 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001292 if not self:
1293 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001294 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001295
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001296 if not self:
1297 exp = self._exp - other._exp
1298 coeff = 0
1299 else:
1300 # OK, so neither = 0, INF or NaN
1301 shift = len(other._int) - len(self._int) + context.prec + 1
1302 exp = self._exp - other._exp - shift
1303 op1 = _WorkRep(self)
1304 op2 = _WorkRep(other)
1305 if shift >= 0:
1306 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1307 else:
1308 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1309 if remainder:
1310 # result is not exact; adjust to ensure correct rounding
1311 if coeff % 5 == 0:
1312 coeff += 1
1313 else:
1314 # result is exact; get as close to ideal exponent as possible
1315 ideal_exp = self._exp - other._exp
1316 while exp < ideal_exp and coeff % 10 == 0:
1317 coeff //= 10
1318 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001319
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001320 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001321 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001322
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001323 def _divide(self, other, context):
1324 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001325
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001326 Assumes that neither self nor other is a NaN, that self is not
1327 infinite and that other is nonzero.
1328 """
1329 sign = self._sign ^ other._sign
1330 if other._isinfinity():
1331 ideal_exp = self._exp
1332 else:
1333 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001334
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001335 expdiff = self.adjusted() - other.adjusted()
1336 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001337 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001338 self._rescale(ideal_exp, context.rounding))
1339 if expdiff <= context.prec:
1340 op1 = _WorkRep(self)
1341 op2 = _WorkRep(other)
1342 if op1.exp >= op2.exp:
1343 op1.int *= 10**(op1.exp - op2.exp)
1344 else:
1345 op2.int *= 10**(op2.exp - op1.exp)
1346 q, r = divmod(op1.int, op2.int)
1347 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001348 return (_dec_from_triple(sign, str(q), 0),
1349 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001350
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001351 # Here the quotient is too large to be representable
1352 ans = context._raise_error(DivisionImpossible,
1353 'quotient too large in //, % or divmod')
1354 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001355
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001356 def __rtruediv__(self, other, context=None):
1357 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001358 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001359 if other is NotImplemented:
1360 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001361 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001362
1363 def __divmod__(self, other, context=None):
1364 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001365 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001366 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001367 other = _convert_other(other)
1368 if other is NotImplemented:
1369 return other
1370
1371 if context is None:
1372 context = getcontext()
1373
1374 ans = self._check_nans(other, context)
1375 if ans:
1376 return (ans, ans)
1377
1378 sign = self._sign ^ other._sign
1379 if self._isinfinity():
1380 if other._isinfinity():
1381 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1382 return ans, ans
1383 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001384 return (_SignedInfinity[sign],
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001385 context._raise_error(InvalidOperation, 'INF % x'))
1386
1387 if not other:
1388 if not self:
1389 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1390 return ans, ans
1391 else:
1392 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1393 context._raise_error(InvalidOperation, 'x % 0'))
1394
1395 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001396 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001397 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001398
1399 def __rdivmod__(self, other, context=None):
1400 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001401 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001402 if other is NotImplemented:
1403 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001404 return other.__divmod__(self, context=context)
1405
1406 def __mod__(self, other, context=None):
1407 """
1408 self % other
1409 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001410 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001411 if other is NotImplemented:
1412 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001413
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001414 if context is None:
1415 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001416
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001417 ans = self._check_nans(other, context)
1418 if ans:
1419 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001420
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001421 if self._isinfinity():
1422 return context._raise_error(InvalidOperation, 'INF % x')
1423 elif not other:
1424 if self:
1425 return context._raise_error(InvalidOperation, 'x % 0')
1426 else:
1427 return context._raise_error(DivisionUndefined, '0 % 0')
1428
1429 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001430 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001431 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001432
1433 def __rmod__(self, other, context=None):
1434 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001435 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001436 if other is NotImplemented:
1437 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001438 return other.__mod__(self, context=context)
1439
1440 def remainder_near(self, other, context=None):
1441 """
1442 Remainder nearest to 0- abs(remainder-near) <= other/2
1443 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001444 if context is None:
1445 context = getcontext()
1446
1447 other = _convert_other(other, raiseit=True)
1448
1449 ans = self._check_nans(other, context)
1450 if ans:
1451 return ans
1452
1453 # self == +/-infinity -> InvalidOperation
1454 if self._isinfinity():
1455 return context._raise_error(InvalidOperation,
1456 'remainder_near(infinity, x)')
1457
1458 # other == 0 -> either InvalidOperation or DivisionUndefined
1459 if not other:
1460 if self:
1461 return context._raise_error(InvalidOperation,
1462 'remainder_near(x, 0)')
1463 else:
1464 return context._raise_error(DivisionUndefined,
1465 'remainder_near(0, 0)')
1466
1467 # other = +/-infinity -> remainder = self
1468 if other._isinfinity():
1469 ans = Decimal(self)
1470 return ans._fix(context)
1471
1472 # self = 0 -> remainder = self, with ideal exponent
1473 ideal_exponent = min(self._exp, other._exp)
1474 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001475 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001476 return ans._fix(context)
1477
1478 # catch most cases of large or small quotient
1479 expdiff = self.adjusted() - other.adjusted()
1480 if expdiff >= context.prec + 1:
1481 # expdiff >= prec+1 => abs(self/other) > 10**prec
1482 return context._raise_error(DivisionImpossible)
1483 if expdiff <= -2:
1484 # expdiff <= -2 => abs(self/other) < 0.1
1485 ans = self._rescale(ideal_exponent, context.rounding)
1486 return ans._fix(context)
1487
1488 # adjust both arguments to have the same exponent, then divide
1489 op1 = _WorkRep(self)
1490 op2 = _WorkRep(other)
1491 if op1.exp >= op2.exp:
1492 op1.int *= 10**(op1.exp - op2.exp)
1493 else:
1494 op2.int *= 10**(op2.exp - op1.exp)
1495 q, r = divmod(op1.int, op2.int)
1496 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1497 # 10**ideal_exponent. Apply correction to ensure that
1498 # abs(remainder) <= abs(other)/2
1499 if 2*r + (q&1) > op2.int:
1500 r -= op2.int
1501 q += 1
1502
1503 if q >= 10**context.prec:
1504 return context._raise_error(DivisionImpossible)
1505
1506 # result has same sign as self unless r is negative
1507 sign = self._sign
1508 if r < 0:
1509 sign = 1-sign
1510 r = -r
1511
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001512 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001513 return ans._fix(context)
1514
1515 def __floordiv__(self, other, context=None):
1516 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001517 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001518 if other is NotImplemented:
1519 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001520
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001521 if context is None:
1522 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001523
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001524 ans = self._check_nans(other, context)
1525 if ans:
1526 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001527
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001528 if self._isinfinity():
1529 if other._isinfinity():
1530 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001531 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001532 return _SignedInfinity[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001533
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001534 if not other:
1535 if self:
1536 return context._raise_error(DivisionByZero, 'x // 0',
1537 self._sign ^ other._sign)
1538 else:
1539 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001540
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001541 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001542
1543 def __rfloordiv__(self, other, context=None):
1544 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001545 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001546 if other is NotImplemented:
1547 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001548 return other.__floordiv__(self, context=context)
1549
1550 def __float__(self):
1551 """Float representation."""
1552 return float(str(self))
1553
1554 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001555 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001556 if self._is_special:
1557 if self._isnan():
Mark Dickinson825fce32009-09-07 18:08:12 +00001558 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001559 elif self._isinfinity():
Mark Dickinson825fce32009-09-07 18:08:12 +00001560 raise OverflowError("Cannot convert infinity to integer")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001561 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001562 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001563 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001564 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001565 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001566
Christian Heimes969fe572008-01-25 11:23:10 +00001567 __trunc__ = __int__
1568
Christian Heimes0bd4e112008-02-12 22:59:25 +00001569 def real(self):
1570 return self
Mark Dickinson315a20a2009-01-04 21:34:18 +00001571 real = property(real)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001572
Christian Heimes0bd4e112008-02-12 22:59:25 +00001573 def imag(self):
1574 return Decimal(0)
Mark Dickinson315a20a2009-01-04 21:34:18 +00001575 imag = property(imag)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001576
1577 def conjugate(self):
1578 return self
1579
1580 def __complex__(self):
1581 return complex(float(self))
1582
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001583 def _fix_nan(self, context):
1584 """Decapitate the payload of a NaN to fit the context"""
1585 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001586
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001587 # maximum length of payload is precision if clamp=0,
1588 # precision-1 if clamp=1.
1589 max_payload_len = context.prec - context.clamp
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001590 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001591 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1592 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001593 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001594
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001595 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001596 """Round if it is necessary to keep self within prec precision.
1597
1598 Rounds and fixes the exponent. Does not raise on a sNaN.
1599
1600 Arguments:
1601 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001602 context - context used.
1603 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001604
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001605 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001606 if self._isnan():
1607 # decapitate payload if necessary
1608 return self._fix_nan(context)
1609 else:
1610 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001611 return Decimal(self)
1612
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001613 # if self is zero then exponent should be between Etiny and
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001614 # Emax if clamp==0, and between Etiny and Etop if clamp==1.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001615 Etiny = context.Etiny()
1616 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001617 if not self:
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001618 exp_max = [context.Emax, Etop][context.clamp]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001619 new_exp = min(max(self._exp, Etiny), exp_max)
1620 if new_exp != self._exp:
1621 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001622 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001623 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001624 return Decimal(self)
1625
1626 # exp_min is the smallest allowable exponent of the result,
1627 # equal to max(self.adjusted()-context.prec+1, Etiny)
1628 exp_min = len(self._int) + self._exp - context.prec
1629 if exp_min > Etop:
1630 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001631 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001632 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001633 context._raise_error(Rounded)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001634 return ans
1635
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001636 self_is_subnormal = exp_min < Etiny
1637 if self_is_subnormal:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001638 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001639
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001640 # round if self has too many digits
1641 if self._exp < exp_min:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001642 digits = len(self._int) + self._exp - exp_min
1643 if digits < 0:
1644 self = _dec_from_triple(self._sign, '1', exp_min-1)
1645 digits = 0
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001646 rounding_method = self._pick_rounding_function[context.rounding]
1647 changed = getattr(self, rounding_method)(digits)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001648 coeff = self._int[:digits] or '0'
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001649 if changed > 0:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001650 coeff = str(int(coeff)+1)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001651 if len(coeff) > context.prec:
1652 coeff = coeff[:-1]
1653 exp_min += 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001654
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001655 # check whether the rounding pushed the exponent out of range
1656 if exp_min > Etop:
1657 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1658 else:
1659 ans = _dec_from_triple(self._sign, coeff, exp_min)
1660
1661 # raise the appropriate signals, taking care to respect
1662 # the precedence described in the specification
1663 if changed and self_is_subnormal:
1664 context._raise_error(Underflow)
1665 if self_is_subnormal:
1666 context._raise_error(Subnormal)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001667 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001668 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001669 context._raise_error(Rounded)
1670 if not ans:
1671 # raise Clamped on underflow to 0
1672 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001673 return ans
1674
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001675 if self_is_subnormal:
1676 context._raise_error(Subnormal)
1677
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001678 # fold down if clamp == 1 and self has too few digits
1679 if context.clamp == 1 and self._exp > Etop:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001680 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001681 self_padded = self._int + '0'*(self._exp - Etop)
1682 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001683
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001684 # here self was representable to begin with; return unchanged
1685 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001686
1687 _pick_rounding_function = {}
1688
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001689 # for each of the rounding functions below:
1690 # self is a finite, nonzero Decimal
1691 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001692 #
1693 # each function returns either -1, 0, or 1, as follows:
1694 # 1 indicates that self should be rounded up (away from zero)
1695 # 0 indicates that self should be truncated, and that all the
1696 # digits to be truncated are zeros (so the value is unchanged)
1697 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001698
1699 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001700 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001701 if _all_zeros(self._int, prec):
1702 return 0
1703 else:
1704 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001705
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001706 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001707 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001708 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001709
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001710 def _round_half_up(self, prec):
1711 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001712 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001713 return 1
1714 elif _all_zeros(self._int, prec):
1715 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001716 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001717 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001718
1719 def _round_half_down(self, prec):
1720 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001721 if _exact_half(self._int, prec):
1722 return -1
1723 else:
1724 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001725
1726 def _round_half_even(self, prec):
1727 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001728 if _exact_half(self._int, prec) and \
1729 (prec == 0 or self._int[prec-1] in '02468'):
1730 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001731 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001732 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001733
1734 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001735 """Rounds up (not away from 0 if negative.)"""
1736 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001737 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001738 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001739 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001740
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001741 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001742 """Rounds down (not towards 0 if negative)"""
1743 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001744 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001745 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001746 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001747
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001748 def _round_05up(self, prec):
1749 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001750 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001751 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001752 else:
1753 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001754
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001755 def __round__(self, n=None):
1756 """Round self to the nearest integer, or to a given precision.
1757
1758 If only one argument is supplied, round a finite Decimal
1759 instance self to the nearest integer. If self is infinite or
1760 a NaN then a Python exception is raised. If self is finite
1761 and lies exactly halfway between two integers then it is
1762 rounded to the integer with even last digit.
1763
1764 >>> round(Decimal('123.456'))
1765 123
1766 >>> round(Decimal('-456.789'))
1767 -457
1768 >>> round(Decimal('-3.0'))
1769 -3
1770 >>> round(Decimal('2.5'))
1771 2
1772 >>> round(Decimal('3.5'))
1773 4
1774 >>> round(Decimal('Inf'))
1775 Traceback (most recent call last):
1776 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001777 OverflowError: cannot round an infinity
1778 >>> round(Decimal('NaN'))
1779 Traceback (most recent call last):
1780 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001781 ValueError: cannot round a NaN
1782
1783 If a second argument n is supplied, self is rounded to n
1784 decimal places using the rounding mode for the current
1785 context.
1786
1787 For an integer n, round(self, -n) is exactly equivalent to
1788 self.quantize(Decimal('1En')).
1789
1790 >>> round(Decimal('123.456'), 0)
1791 Decimal('123')
1792 >>> round(Decimal('123.456'), 2)
1793 Decimal('123.46')
1794 >>> round(Decimal('123.456'), -2)
1795 Decimal('1E+2')
1796 >>> round(Decimal('-Infinity'), 37)
1797 Decimal('NaN')
1798 >>> round(Decimal('sNaN123'), 0)
1799 Decimal('NaN123')
1800
1801 """
1802 if n is not None:
1803 # two-argument form: use the equivalent quantize call
1804 if not isinstance(n, int):
1805 raise TypeError('Second argument to round should be integral')
1806 exp = _dec_from_triple(0, '1', -n)
1807 return self.quantize(exp)
1808
1809 # one-argument form
1810 if self._is_special:
1811 if self.is_nan():
1812 raise ValueError("cannot round a NaN")
1813 else:
1814 raise OverflowError("cannot round an infinity")
1815 return int(self._rescale(0, ROUND_HALF_EVEN))
1816
1817 def __floor__(self):
1818 """Return the floor of self, as an integer.
1819
1820 For a finite Decimal instance self, return the greatest
1821 integer n such that n <= self. If self is infinite or a NaN
1822 then a Python exception is raised.
1823
1824 """
1825 if self._is_special:
1826 if self.is_nan():
1827 raise ValueError("cannot round a NaN")
1828 else:
1829 raise OverflowError("cannot round an infinity")
1830 return int(self._rescale(0, ROUND_FLOOR))
1831
1832 def __ceil__(self):
1833 """Return the ceiling of self, as an integer.
1834
1835 For a finite Decimal instance self, return the least integer n
1836 such that n >= self. If self is infinite or a NaN then a
1837 Python exception is raised.
1838
1839 """
1840 if self._is_special:
1841 if self.is_nan():
1842 raise ValueError("cannot round a NaN")
1843 else:
1844 raise OverflowError("cannot round an infinity")
1845 return int(self._rescale(0, ROUND_CEILING))
1846
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001847 def fma(self, other, third, context=None):
1848 """Fused multiply-add.
1849
1850 Returns self*other+third with no rounding of the intermediate
1851 product self*other.
1852
1853 self and other are multiplied together, with no rounding of
1854 the result. The third operand is then added to the result,
1855 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001856 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001857
1858 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001859
1860 # compute product; raise InvalidOperation if either operand is
1861 # a signaling NaN or if the product is zero times infinity.
1862 if self._is_special or other._is_special:
1863 if context is None:
1864 context = getcontext()
1865 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001866 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001867 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001868 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001869 if self._exp == 'n':
1870 product = self
1871 elif other._exp == 'n':
1872 product = other
1873 elif self._exp == 'F':
1874 if not other:
1875 return context._raise_error(InvalidOperation,
1876 'INF * 0 in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001877 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001878 elif other._exp == 'F':
1879 if not self:
1880 return context._raise_error(InvalidOperation,
1881 '0 * INF in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001882 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001883 else:
1884 product = _dec_from_triple(self._sign ^ other._sign,
1885 str(int(self._int) * int(other._int)),
1886 self._exp + other._exp)
1887
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001888 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001889 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001890
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001891 def _power_modulo(self, other, modulo, context=None):
1892 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001893
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001894 # if can't convert other and modulo to Decimal, raise
1895 # TypeError; there's no point returning NotImplemented (no
1896 # equivalent of __rpow__ for three argument pow)
1897 other = _convert_other(other, raiseit=True)
1898 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001899
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001900 if context is None:
1901 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001902
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001903 # deal with NaNs: if there are any sNaNs then first one wins,
1904 # (i.e. behaviour for NaNs is identical to that of fma)
1905 self_is_nan = self._isnan()
1906 other_is_nan = other._isnan()
1907 modulo_is_nan = modulo._isnan()
1908 if self_is_nan or other_is_nan or modulo_is_nan:
1909 if self_is_nan == 2:
1910 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001911 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001912 if other_is_nan == 2:
1913 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001914 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001915 if modulo_is_nan == 2:
1916 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001917 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001918 if self_is_nan:
1919 return self._fix_nan(context)
1920 if other_is_nan:
1921 return other._fix_nan(context)
1922 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001923
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001924 # check inputs: we apply same restrictions as Python's pow()
1925 if not (self._isinteger() and
1926 other._isinteger() and
1927 modulo._isinteger()):
1928 return context._raise_error(InvalidOperation,
1929 'pow() 3rd argument not allowed '
1930 'unless all arguments are integers')
1931 if other < 0:
1932 return context._raise_error(InvalidOperation,
1933 'pow() 2nd argument cannot be '
1934 'negative when 3rd argument specified')
1935 if not modulo:
1936 return context._raise_error(InvalidOperation,
1937 'pow() 3rd argument cannot be 0')
1938
1939 # additional restriction for decimal: the modulus must be less
1940 # than 10**prec in absolute value
1941 if modulo.adjusted() >= context.prec:
1942 return context._raise_error(InvalidOperation,
1943 'insufficient precision: pow() 3rd '
1944 'argument must not have more than '
1945 'precision digits')
1946
1947 # define 0**0 == NaN, for consistency with two-argument pow
1948 # (even though it hurts!)
1949 if not other and not self:
1950 return context._raise_error(InvalidOperation,
1951 'at least one of pow() 1st argument '
1952 'and 2nd argument must be nonzero ;'
1953 '0**0 is not defined')
1954
1955 # compute sign of result
1956 if other._iseven():
1957 sign = 0
1958 else:
1959 sign = self._sign
1960
1961 # convert modulo to a Python integer, and self and other to
1962 # Decimal integers (i.e. force their exponents to be >= 0)
1963 modulo = abs(int(modulo))
1964 base = _WorkRep(self.to_integral_value())
1965 exponent = _WorkRep(other.to_integral_value())
1966
1967 # compute result using integer pow()
1968 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1969 for i in range(exponent.exp):
1970 base = pow(base, 10, modulo)
1971 base = pow(base, exponent.int, modulo)
1972
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001973 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001974
1975 def _power_exact(self, other, p):
1976 """Attempt to compute self**other exactly.
1977
1978 Given Decimals self and other and an integer p, attempt to
1979 compute an exact result for the power self**other, with p
1980 digits of precision. Return None if self**other is not
1981 exactly representable in p digits.
1982
1983 Assumes that elimination of special cases has already been
1984 performed: self and other must both be nonspecial; self must
1985 be positive and not numerically equal to 1; other must be
1986 nonzero. For efficiency, other._exp should not be too large,
1987 so that 10**abs(other._exp) is a feasible calculation."""
1988
1989 # In the comments below, we write x for the value of self and
1990 # y for the value of other. Write x = xc*10**xe and y =
1991 # yc*10**ye.
1992
1993 # The main purpose of this method is to identify the *failure*
1994 # of x**y to be exactly representable with as little effort as
1995 # possible. So we look for cheap and easy tests that
1996 # eliminate the possibility of x**y being exact. Only if all
1997 # these tests are passed do we go on to actually compute x**y.
1998
1999 # Here's the main idea. First normalize both x and y. We
2000 # express y as a rational m/n, with m and n relatively prime
2001 # and n>0. Then for x**y to be exactly representable (at
2002 # *any* precision), xc must be the nth power of a positive
2003 # integer and xe must be divisible by n. If m is negative
2004 # then additionally xc must be a power of either 2 or 5, hence
2005 # a power of 2**n or 5**n.
2006 #
2007 # There's a limit to how small |y| can be: if y=m/n as above
2008 # then:
2009 #
2010 # (1) if xc != 1 then for the result to be representable we
2011 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
2012 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
2013 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
2014 # representable.
2015 #
2016 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
2017 # |y| < 1/|xe| then the result is not representable.
2018 #
2019 # Note that since x is not equal to 1, at least one of (1) and
2020 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
2021 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
2022 #
2023 # There's also a limit to how large y can be, at least if it's
2024 # positive: the normalized result will have coefficient xc**y,
2025 # so if it's representable then xc**y < 10**p, and y <
2026 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
2027 # not exactly representable.
2028
2029 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
2030 # so |y| < 1/xe and the result is not representable.
2031 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
2032 # < 1/nbits(xc).
2033
2034 x = _WorkRep(self)
2035 xc, xe = x.int, x.exp
2036 while xc % 10 == 0:
2037 xc //= 10
2038 xe += 1
2039
2040 y = _WorkRep(other)
2041 yc, ye = y.int, y.exp
2042 while yc % 10 == 0:
2043 yc //= 10
2044 ye += 1
2045
2046 # case where xc == 1: result is 10**(xe*y), with xe*y
2047 # required to be an integer
2048 if xc == 1:
2049 if ye >= 0:
2050 exponent = xe*yc*10**ye
2051 else:
2052 exponent, remainder = divmod(xe*yc, 10**-ye)
2053 if remainder:
2054 return None
2055 if y.sign == 1:
2056 exponent = -exponent
2057 # if other is a nonnegative integer, use ideal exponent
2058 if other._isinteger() and other._sign == 0:
2059 ideal_exponent = self._exp*int(other)
2060 zeros = min(exponent-ideal_exponent, p-1)
2061 else:
2062 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002063 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002064
2065 # case where y is negative: xc must be either a power
2066 # of 2 or a power of 5.
2067 if y.sign == 1:
2068 last_digit = xc % 10
2069 if last_digit in (2,4,6,8):
2070 # quick test for power of 2
2071 if xc & -xc != xc:
2072 return None
2073 # now xc is a power of 2; e is its exponent
2074 e = _nbits(xc)-1
2075 # find e*y and xe*y; both must be integers
2076 if ye >= 0:
2077 y_as_int = yc*10**ye
2078 e = e*y_as_int
2079 xe = xe*y_as_int
2080 else:
2081 ten_pow = 10**-ye
2082 e, remainder = divmod(e*yc, ten_pow)
2083 if remainder:
2084 return None
2085 xe, remainder = divmod(xe*yc, ten_pow)
2086 if remainder:
2087 return None
2088
2089 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2090 return None
2091 xc = 5**e
2092
2093 elif last_digit == 5:
2094 # e >= log_5(xc) if xc is a power of 5; we have
2095 # equality all the way up to xc=5**2658
2096 e = _nbits(xc)*28//65
2097 xc, remainder = divmod(5**e, xc)
2098 if remainder:
2099 return None
2100 while xc % 5 == 0:
2101 xc //= 5
2102 e -= 1
2103 if ye >= 0:
2104 y_as_integer = yc*10**ye
2105 e = e*y_as_integer
2106 xe = xe*y_as_integer
2107 else:
2108 ten_pow = 10**-ye
2109 e, remainder = divmod(e*yc, ten_pow)
2110 if remainder:
2111 return None
2112 xe, remainder = divmod(xe*yc, ten_pow)
2113 if remainder:
2114 return None
2115 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2116 return None
2117 xc = 2**e
2118 else:
2119 return None
2120
2121 if xc >= 10**p:
2122 return None
2123 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002124 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002125
2126 # now y is positive; find m and n such that y = m/n
2127 if ye >= 0:
2128 m, n = yc*10**ye, 1
2129 else:
2130 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2131 return None
2132 xc_bits = _nbits(xc)
2133 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2134 return None
2135 m, n = yc, 10**(-ye)
2136 while m % 2 == n % 2 == 0:
2137 m //= 2
2138 n //= 2
2139 while m % 5 == n % 5 == 0:
2140 m //= 5
2141 n //= 5
2142
2143 # compute nth root of xc*10**xe
2144 if n > 1:
2145 # if 1 < xc < 2**n then xc isn't an nth power
2146 if xc != 1 and xc_bits <= n:
2147 return None
2148
2149 xe, rem = divmod(xe, n)
2150 if rem != 0:
2151 return None
2152
2153 # compute nth root of xc using Newton's method
2154 a = 1 << -(-_nbits(xc)//n) # initial estimate
2155 while True:
2156 q, r = divmod(xc, a**(n-1))
2157 if a <= q:
2158 break
2159 else:
2160 a = (a*(n-1) + q)//n
2161 if not (a == q and r == 0):
2162 return None
2163 xc = a
2164
2165 # now xc*10**xe is the nth root of the original xc*10**xe
2166 # compute mth power of xc*10**xe
2167
2168 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2169 # 10**p and the result is not representable.
2170 if xc > 1 and m > p*100//_log10_lb(xc):
2171 return None
2172 xc = xc**m
2173 xe *= m
2174 if xc > 10**p:
2175 return None
2176
2177 # by this point the result *is* exactly representable
2178 # adjust the exponent to get as close as possible to the ideal
2179 # exponent, if necessary
2180 str_xc = str(xc)
2181 if other._isinteger() and other._sign == 0:
2182 ideal_exponent = self._exp*int(other)
2183 zeros = min(xe-ideal_exponent, p-len(str_xc))
2184 else:
2185 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002186 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002187
2188 def __pow__(self, other, modulo=None, context=None):
2189 """Return self ** other [ % modulo].
2190
2191 With two arguments, compute self**other.
2192
2193 With three arguments, compute (self**other) % modulo. For the
2194 three argument form, the following restrictions on the
2195 arguments hold:
2196
2197 - all three arguments must be integral
2198 - other must be nonnegative
2199 - either self or other (or both) must be nonzero
2200 - modulo must be nonzero and must have at most p digits,
2201 where p is the context precision.
2202
2203 If any of these restrictions is violated the InvalidOperation
2204 flag is raised.
2205
2206 The result of pow(self, other, modulo) is identical to the
2207 result that would be obtained by computing (self**other) %
2208 modulo with unbounded precision, but is computed more
2209 efficiently. It is always exact.
2210 """
2211
2212 if modulo is not None:
2213 return self._power_modulo(other, modulo, context)
2214
2215 other = _convert_other(other)
2216 if other is NotImplemented:
2217 return other
2218
2219 if context is None:
2220 context = getcontext()
2221
2222 # either argument is a NaN => result is NaN
2223 ans = self._check_nans(other, context)
2224 if ans:
2225 return ans
2226
2227 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2228 if not other:
2229 if not self:
2230 return context._raise_error(InvalidOperation, '0 ** 0')
2231 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002232 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002233
2234 # result has sign 1 iff self._sign is 1 and other is an odd integer
2235 result_sign = 0
2236 if self._sign == 1:
2237 if other._isinteger():
2238 if not other._iseven():
2239 result_sign = 1
2240 else:
2241 # -ve**noninteger = NaN
2242 # (-0)**noninteger = 0**noninteger
2243 if self:
2244 return context._raise_error(InvalidOperation,
2245 'x ** y with x negative and y not an integer')
2246 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002247 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002248
2249 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2250 if not self:
2251 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002252 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002253 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002254 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002255
2256 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002257 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002258 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002259 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002260 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002261 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002262
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002263 # 1**other = 1, but the choice of exponent and the flags
2264 # depend on the exponent of self, and on whether other is a
2265 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002266 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002267 if other._isinteger():
2268 # exp = max(self._exp*max(int(other), 0),
2269 # 1-context.prec) but evaluating int(other) directly
2270 # is dangerous until we know other is small (other
2271 # could be 1e999999999)
2272 if other._sign == 1:
2273 multiplier = 0
2274 elif other > context.prec:
2275 multiplier = context.prec
2276 else:
2277 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002278
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002279 exp = self._exp * multiplier
2280 if exp < 1-context.prec:
2281 exp = 1-context.prec
2282 context._raise_error(Rounded)
2283 else:
2284 context._raise_error(Inexact)
2285 context._raise_error(Rounded)
2286 exp = 1-context.prec
2287
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002288 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002289
2290 # compute adjusted exponent of self
2291 self_adj = self.adjusted()
2292
2293 # self ** infinity is infinity if self > 1, 0 if self < 1
2294 # self ** -infinity is infinity if self < 1, 0 if self > 1
2295 if other._isinfinity():
2296 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002297 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002298 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002299 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002300
2301 # from here on, the result always goes through the call
2302 # to _fix at the end of this function.
2303 ans = None
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002304 exact = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002305
2306 # crude test to catch cases of extreme overflow/underflow. If
2307 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2308 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2309 # self**other >= 10**(Emax+1), so overflow occurs. The test
2310 # for underflow is similar.
2311 bound = self._log10_exp_bound() + other.adjusted()
2312 if (self_adj >= 0) == (other._sign == 0):
2313 # self > 1 and other +ve, or self < 1 and other -ve
2314 # possibility of overflow
2315 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002316 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002317 else:
2318 # self > 1 and other -ve, or self < 1 and other +ve
2319 # possibility of underflow to 0
2320 Etiny = context.Etiny()
2321 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002322 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002323
2324 # try for an exact result with precision +1
2325 if ans is None:
2326 ans = self._power_exact(other, context.prec + 1)
2327 if ans is not None and result_sign == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002328 ans = _dec_from_triple(1, ans._int, ans._exp)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002329 exact = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002330
2331 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2332 if ans is None:
2333 p = context.prec
2334 x = _WorkRep(self)
2335 xc, xe = x.int, x.exp
2336 y = _WorkRep(other)
2337 yc, ye = y.int, y.exp
2338 if y.sign == 1:
2339 yc = -yc
2340
2341 # compute correctly rounded result: start with precision +3,
2342 # then increase precision until result is unambiguously roundable
2343 extra = 3
2344 while True:
2345 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2346 if coeff % (5*10**(len(str(coeff))-p-1)):
2347 break
2348 extra += 3
2349
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002350 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002351
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002352 # unlike exp, ln and log10, the power function respects the
2353 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2354
2355 # There's a difficulty here when 'other' is not an integer and
2356 # the result is exact. In this case, the specification
2357 # requires that the Inexact flag be raised (in spite of
2358 # exactness), but since the result is exact _fix won't do this
2359 # for us. (Correspondingly, the Underflow signal should also
2360 # be raised for subnormal results.) We can't directly raise
2361 # these signals either before or after calling _fix, since
2362 # that would violate the precedence for signals. So we wrap
2363 # the ._fix call in a temporary context, and reraise
2364 # afterwards.
2365 if exact and not other._isinteger():
2366 # pad with zeros up to length context.prec+1 if necessary; this
2367 # ensures that the Rounded signal will be raised.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002368 if len(ans._int) <= context.prec:
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002369 expdiff = context.prec + 1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002370 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2371 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002372
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002373 # create a copy of the current context, with cleared flags/traps
2374 newcontext = context.copy()
2375 newcontext.clear_flags()
2376 for exception in _signals:
2377 newcontext.traps[exception] = 0
2378
2379 # round in the new context
2380 ans = ans._fix(newcontext)
2381
2382 # raise Inexact, and if necessary, Underflow
2383 newcontext._raise_error(Inexact)
2384 if newcontext.flags[Subnormal]:
2385 newcontext._raise_error(Underflow)
2386
2387 # propagate signals to the original context; _fix could
2388 # have raised any of Overflow, Underflow, Subnormal,
2389 # Inexact, Rounded, Clamped. Overflow needs the correct
2390 # arguments. Note that the order of the exceptions is
2391 # important here.
2392 if newcontext.flags[Overflow]:
2393 context._raise_error(Overflow, 'above Emax', ans._sign)
2394 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2395 if newcontext.flags[exception]:
2396 context._raise_error(exception)
2397
2398 else:
2399 ans = ans._fix(context)
2400
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002401 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002402
2403 def __rpow__(self, other, context=None):
2404 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002405 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002406 if other is NotImplemented:
2407 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002408 return other.__pow__(self, context=context)
2409
2410 def normalize(self, context=None):
2411 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002412
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002413 if context is None:
2414 context = getcontext()
2415
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002416 if self._is_special:
2417 ans = self._check_nans(context=context)
2418 if ans:
2419 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002420
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002421 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002422 if dup._isinfinity():
2423 return dup
2424
2425 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002426 return _dec_from_triple(dup._sign, '0', 0)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00002427 exp_max = [context.Emax, context.Etop()][context.clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002428 end = len(dup._int)
2429 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002430 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002431 exp += 1
2432 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002433 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002434
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002435 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002436 """Quantize self so its exponent is the same as that of exp.
2437
2438 Similar to self._rescale(exp._exp) but with error checking.
2439 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002440 exp = _convert_other(exp, raiseit=True)
2441
2442 if context is None:
2443 context = getcontext()
2444 if rounding is None:
2445 rounding = context.rounding
2446
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002447 if self._is_special or exp._is_special:
2448 ans = self._check_nans(exp, context)
2449 if ans:
2450 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002451
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002452 if exp._isinfinity() or self._isinfinity():
2453 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002454 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002455 return context._raise_error(InvalidOperation,
2456 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002457
2458 # if we're not watching exponents, do a simple rescale
2459 if not watchexp:
2460 ans = self._rescale(exp._exp, rounding)
2461 # raise Inexact and Rounded where appropriate
2462 if ans._exp > self._exp:
2463 context._raise_error(Rounded)
2464 if ans != self:
2465 context._raise_error(Inexact)
2466 return ans
2467
2468 # exp._exp should be between Etiny and Emax
2469 if not (context.Etiny() <= exp._exp <= context.Emax):
2470 return context._raise_error(InvalidOperation,
2471 'target exponent out of bounds in quantize')
2472
2473 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002474 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002475 return ans._fix(context)
2476
2477 self_adjusted = self.adjusted()
2478 if self_adjusted > context.Emax:
2479 return context._raise_error(InvalidOperation,
2480 'exponent of quantize result too large for current context')
2481 if self_adjusted - exp._exp + 1 > context.prec:
2482 return context._raise_error(InvalidOperation,
2483 'quantize result has too many digits for current context')
2484
2485 ans = self._rescale(exp._exp, rounding)
2486 if ans.adjusted() > context.Emax:
2487 return context._raise_error(InvalidOperation,
2488 'exponent of quantize result too large for current context')
2489 if len(ans._int) > context.prec:
2490 return context._raise_error(InvalidOperation,
2491 'quantize result has too many digits for current context')
2492
2493 # raise appropriate flags
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002494 if ans and ans.adjusted() < context.Emin:
2495 context._raise_error(Subnormal)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002496 if ans._exp > self._exp:
2497 if ans != self:
2498 context._raise_error(Inexact)
2499 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002500
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002501 # call to fix takes care of any necessary folddown, and
2502 # signals Clamped if necessary
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002503 ans = ans._fix(context)
2504 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002505
2506 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002507 """Return True if self and other have the same exponent; otherwise
2508 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002509
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002510 If either operand is a special value, the following rules are used:
2511 * return True if both operands are infinities
2512 * return True if both operands are NaNs
2513 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002514 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002515 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002516 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002517 return (self.is_nan() and other.is_nan() or
2518 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002519 return self._exp == other._exp
2520
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002521 def _rescale(self, exp, rounding):
2522 """Rescale self so that the exponent is exp, either by padding with zeros
2523 or by truncating digits, using the given rounding mode.
2524
2525 Specials are returned without change. This operation is
2526 quiet: it raises no flags, and uses no information from the
2527 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002528
2529 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002530 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002531 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002532 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002533 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002534 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002535 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002536
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002537 if self._exp >= exp:
2538 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002539 return _dec_from_triple(self._sign,
2540 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002541
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002542 # too many digits; round and lose data. If self.adjusted() <
2543 # exp-1, replace self by 10**(exp-1) before rounding
2544 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002545 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002546 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002547 digits = 0
2548 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002549 changed = this_function(digits)
2550 coeff = self._int[:digits] or '0'
2551 if changed == 1:
2552 coeff = str(int(coeff)+1)
2553 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002554
Christian Heimesf16baeb2008-02-29 14:57:44 +00002555 def _round(self, places, rounding):
2556 """Round a nonzero, nonspecial Decimal to a fixed number of
2557 significant figures, using the given rounding mode.
2558
2559 Infinities, NaNs and zeros are returned unaltered.
2560
2561 This operation is quiet: it raises no flags, and uses no
2562 information from the context.
2563
2564 """
2565 if places <= 0:
2566 raise ValueError("argument should be at least 1 in _round")
2567 if self._is_special or not self:
2568 return Decimal(self)
2569 ans = self._rescale(self.adjusted()+1-places, rounding)
2570 # it can happen that the rescale alters the adjusted exponent;
2571 # for example when rounding 99.97 to 3 significant figures.
2572 # When this happens we end up with an extra 0 at the end of
2573 # the number; a second rescale fixes this.
2574 if ans.adjusted() != self.adjusted():
2575 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2576 return ans
2577
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002578 def to_integral_exact(self, rounding=None, context=None):
2579 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002580
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002581 If no rounding mode is specified, take the rounding mode from
2582 the context. This method raises the Rounded and Inexact flags
2583 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002584
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002585 See also: to_integral_value, which does exactly the same as
2586 this method except that it doesn't raise Inexact or Rounded.
2587 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002588 if self._is_special:
2589 ans = self._check_nans(context=context)
2590 if ans:
2591 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002592 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002593 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002594 return Decimal(self)
2595 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002596 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002597 if context is None:
2598 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002599 if rounding is None:
2600 rounding = context.rounding
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002601 ans = self._rescale(0, rounding)
2602 if ans != self:
2603 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002604 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002605 return ans
2606
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002607 def to_integral_value(self, rounding=None, context=None):
2608 """Rounds to the nearest integer, without raising inexact, rounded."""
2609 if context is None:
2610 context = getcontext()
2611 if rounding is None:
2612 rounding = context.rounding
2613 if self._is_special:
2614 ans = self._check_nans(context=context)
2615 if ans:
2616 return ans
2617 return Decimal(self)
2618 if self._exp >= 0:
2619 return Decimal(self)
2620 else:
2621 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002622
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002623 # the method name changed, but we provide also the old one, for compatibility
2624 to_integral = to_integral_value
2625
2626 def sqrt(self, context=None):
2627 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002628 if context is None:
2629 context = getcontext()
2630
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002631 if self._is_special:
2632 ans = self._check_nans(context=context)
2633 if ans:
2634 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002635
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002636 if self._isinfinity() and self._sign == 0:
2637 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002638
2639 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002640 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002641 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002642 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002643
2644 if self._sign == 1:
2645 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2646
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002647 # At this point self represents a positive number. Let p be
2648 # the desired precision and express self in the form c*100**e
2649 # with c a positive real number and e an integer, c and e
2650 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2651 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2652 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2653 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2654 # the closest integer to sqrt(c) with the even integer chosen
2655 # in the case of a tie.
2656 #
2657 # To ensure correct rounding in all cases, we use the
2658 # following trick: we compute the square root to an extra
2659 # place (precision p+1 instead of precision p), rounding down.
2660 # Then, if the result is inexact and its last digit is 0 or 5,
2661 # we increase the last digit to 1 or 6 respectively; if it's
2662 # exact we leave the last digit alone. Now the final round to
2663 # p places (or fewer in the case of underflow) will round
2664 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002665
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002666 # use an extra digit of precision
2667 prec = context.prec+1
2668
2669 # write argument in the form c*100**e where e = self._exp//2
2670 # is the 'ideal' exponent, to be used if the square root is
2671 # exactly representable. l is the number of 'digits' of c in
2672 # base 100, so that 100**(l-1) <= c < 100**l.
2673 op = _WorkRep(self)
2674 e = op.exp >> 1
2675 if op.exp & 1:
2676 c = op.int * 10
2677 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002678 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002679 c = op.int
2680 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002681
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002682 # rescale so that c has exactly prec base 100 'digits'
2683 shift = prec-l
2684 if shift >= 0:
2685 c *= 100**shift
2686 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002687 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002688 c, remainder = divmod(c, 100**-shift)
2689 exact = not remainder
2690 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002691
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002692 # find n = floor(sqrt(c)) using Newton's method
2693 n = 10**prec
2694 while True:
2695 q = c//n
2696 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002697 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002698 else:
2699 n = n + q >> 1
2700 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002701
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002702 if exact:
2703 # result is exact; rescale to use ideal exponent e
2704 if shift >= 0:
2705 # assert n % 10**shift == 0
2706 n //= 10**shift
2707 else:
2708 n *= 10**-shift
2709 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002710 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002711 # result is not exact; fix last digit as described above
2712 if n % 5 == 0:
2713 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002714
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002715 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002716
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002717 # round, and fit to current context
2718 context = context._shallow_copy()
2719 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002720 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002721 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002722
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002723 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002724
2725 def max(self, other, context=None):
2726 """Returns the larger value.
2727
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002728 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002729 NaN (and signals if one is sNaN). Also rounds.
2730 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002731 other = _convert_other(other, raiseit=True)
2732
2733 if context is None:
2734 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002735
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002736 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002737 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002738 # number is always returned
2739 sn = self._isnan()
2740 on = other._isnan()
2741 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002742 if on == 1 and sn == 0:
2743 return self._fix(context)
2744 if sn == 1 and on == 0:
2745 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002746 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002747
Christian Heimes77c02eb2008-02-09 02:18:51 +00002748 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002749 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002750 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002751 # then an ordering is applied:
2752 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002753 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002754 # positive sign and min returns the operand with the negative sign
2755 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002756 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002757 # the result. This is exactly the ordering used in compare_total.
2758 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002759
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002760 if c == -1:
2761 ans = other
2762 else:
2763 ans = self
2764
Christian Heimes2c181612007-12-17 20:04:13 +00002765 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002766
2767 def min(self, other, context=None):
2768 """Returns the smaller value.
2769
Guido van Rossumd8faa362007-04-27 19:54:29 +00002770 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002771 NaN (and signals if one is sNaN). Also rounds.
2772 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002773 other = _convert_other(other, raiseit=True)
2774
2775 if context is None:
2776 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002777
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002778 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002779 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002780 # number is always returned
2781 sn = self._isnan()
2782 on = other._isnan()
2783 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002784 if on == 1 and sn == 0:
2785 return self._fix(context)
2786 if sn == 1 and on == 0:
2787 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002788 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002789
Christian Heimes77c02eb2008-02-09 02:18:51 +00002790 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002791 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002792 c = self.compare_total(other)
2793
2794 if c == -1:
2795 ans = self
2796 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002797 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002798
Christian Heimes2c181612007-12-17 20:04:13 +00002799 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002800
2801 def _isinteger(self):
2802 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002803 if self._is_special:
2804 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002805 if self._exp >= 0:
2806 return True
2807 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002808 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002809
2810 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002811 """Returns True if self is even. Assumes self is an integer."""
2812 if not self or self._exp > 0:
2813 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002814 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002815
2816 def adjusted(self):
2817 """Return the adjusted exponent of self"""
2818 try:
2819 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002820 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002821 except TypeError:
2822 return 0
2823
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002824 def canonical(self, context=None):
2825 """Returns the same Decimal object.
2826
2827 As we do not have different encodings for the same number, the
2828 received object already is in its canonical form.
2829 """
2830 return self
2831
2832 def compare_signal(self, other, context=None):
2833 """Compares self to the other operand numerically.
2834
2835 It's pretty much like compare(), but all NaNs signal, with signaling
2836 NaNs taking precedence over quiet NaNs.
2837 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002838 other = _convert_other(other, raiseit = True)
2839 ans = self._compare_check_nans(other, context)
2840 if ans:
2841 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002842 return self.compare(other, context=context)
2843
2844 def compare_total(self, other):
2845 """Compares self to other using the abstract representations.
2846
2847 This is not like the standard compare, which use their numerical
2848 value. Note that a total ordering is defined for all possible abstract
2849 representations.
2850 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002851 other = _convert_other(other, raiseit=True)
2852
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002853 # if one is negative and the other is positive, it's easy
2854 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002855 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002856 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002857 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002858 sign = self._sign
2859
2860 # let's handle both NaN types
2861 self_nan = self._isnan()
2862 other_nan = other._isnan()
2863 if self_nan or other_nan:
2864 if self_nan == other_nan:
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002865 # compare payloads as though they're integers
2866 self_key = len(self._int), self._int
2867 other_key = len(other._int), other._int
2868 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002869 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002870 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002871 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002872 return _NegativeOne
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002873 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002874 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002875 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002876 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002877 return _One
2878 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002879
2880 if sign:
2881 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002882 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002883 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002884 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002885 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002886 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002887 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002888 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002889 else:
2890 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002891 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002892 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002893 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002894 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002895 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002896 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002897 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002898
2899 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002900 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002901 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002902 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002903
2904 if self._exp < other._exp:
2905 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002906 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002907 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002908 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002909 if self._exp > other._exp:
2910 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002911 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002912 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002913 return _One
2914 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002915
2916
2917 def compare_total_mag(self, other):
2918 """Compares self to other using abstract repr., ignoring sign.
2919
2920 Like compare_total, but with operand's sign ignored and assumed to be 0.
2921 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002922 other = _convert_other(other, raiseit=True)
2923
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002924 s = self.copy_abs()
2925 o = other.copy_abs()
2926 return s.compare_total(o)
2927
2928 def copy_abs(self):
2929 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002930 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002931
2932 def copy_negate(self):
2933 """Returns a copy with the sign inverted."""
2934 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002935 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002936 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002937 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002938
2939 def copy_sign(self, other):
2940 """Returns self with the sign of other."""
Mark Dickinson84230a12010-02-18 14:49:50 +00002941 other = _convert_other(other, raiseit=True)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002942 return _dec_from_triple(other._sign, self._int,
2943 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002944
2945 def exp(self, context=None):
2946 """Returns e ** self."""
2947
2948 if context is None:
2949 context = getcontext()
2950
2951 # exp(NaN) = NaN
2952 ans = self._check_nans(context=context)
2953 if ans:
2954 return ans
2955
2956 # exp(-Infinity) = 0
2957 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002958 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002959
2960 # exp(0) = 1
2961 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002962 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002963
2964 # exp(Infinity) = Infinity
2965 if self._isinfinity() == 1:
2966 return Decimal(self)
2967
2968 # the result is now guaranteed to be inexact (the true
2969 # mathematical result is transcendental). There's no need to
2970 # raise Rounded and Inexact here---they'll always be raised as
2971 # a result of the call to _fix.
2972 p = context.prec
2973 adj = self.adjusted()
2974
2975 # we only need to do any computation for quite a small range
2976 # of adjusted exponents---for example, -29 <= adj <= 10 for
2977 # the default context. For smaller exponent the result is
2978 # indistinguishable from 1 at the given precision, while for
2979 # larger exponent the result either overflows or underflows.
2980 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2981 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002982 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002983 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2984 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002985 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002986 elif self._sign == 0 and adj < -p:
2987 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002988 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002989 elif self._sign == 1 and adj < -p-1:
2990 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002991 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002992 # general case
2993 else:
2994 op = _WorkRep(self)
2995 c, e = op.int, op.exp
2996 if op.sign == 1:
2997 c = -c
2998
2999 # compute correctly rounded result: increase precision by
3000 # 3 digits at a time until we get an unambiguously
3001 # roundable result
3002 extra = 3
3003 while True:
3004 coeff, exp = _dexp(c, e, p+extra)
3005 if coeff % (5*10**(len(str(coeff))-p-1)):
3006 break
3007 extra += 3
3008
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003009 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003010
3011 # at this stage, ans should round correctly with *any*
3012 # rounding mode, not just with ROUND_HALF_EVEN
3013 context = context._shallow_copy()
3014 rounding = context._set_rounding(ROUND_HALF_EVEN)
3015 ans = ans._fix(context)
3016 context.rounding = rounding
3017
3018 return ans
3019
3020 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003021 """Return True if self is canonical; otherwise return False.
3022
3023 Currently, the encoding of a Decimal instance is always
3024 canonical, so this method returns True for any Decimal.
3025 """
3026 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003027
3028 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003029 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003030
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003031 A Decimal instance is considered finite if it is neither
3032 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003033 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003034 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003035
3036 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003037 """Return True if self is infinite; otherwise return False."""
3038 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003039
3040 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003041 """Return True if self is a qNaN or sNaN; otherwise return False."""
3042 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003043
3044 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003045 """Return True if self is a normal number; otherwise return False."""
3046 if self._is_special or not self:
3047 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003048 if context is None:
3049 context = getcontext()
Mark Dickinson06bb6742009-10-20 13:38:04 +00003050 return context.Emin <= self.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003051
3052 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003053 """Return True if self is a quiet NaN; otherwise return False."""
3054 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003055
3056 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003057 """Return True if self is negative; otherwise return False."""
3058 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003059
3060 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003061 """Return True if self is a signaling NaN; otherwise return False."""
3062 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003063
3064 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003065 """Return True if self is subnormal; otherwise return False."""
3066 if self._is_special or not self:
3067 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003068 if context is None:
3069 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003070 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003071
3072 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003073 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003074 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003075
3076 def _ln_exp_bound(self):
3077 """Compute a lower bound for the adjusted exponent of self.ln().
3078 In other words, compute r such that self.ln() >= 10**r. Assumes
3079 that self is finite and positive and that self != 1.
3080 """
3081
3082 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3083 adj = self._exp + len(self._int) - 1
3084 if adj >= 1:
3085 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3086 return len(str(adj*23//10)) - 1
3087 if adj <= -2:
3088 # argument <= 0.1
3089 return len(str((-1-adj)*23//10)) - 1
3090 op = _WorkRep(self)
3091 c, e = op.int, op.exp
3092 if adj == 0:
3093 # 1 < self < 10
3094 num = str(c-10**-e)
3095 den = str(c)
3096 return len(num) - len(den) - (num < den)
3097 # adj == -1, 0.1 <= self < 1
3098 return e + len(str(10**-e - c)) - 1
3099
3100
3101 def ln(self, context=None):
3102 """Returns the natural (base e) logarithm of self."""
3103
3104 if context is None:
3105 context = getcontext()
3106
3107 # ln(NaN) = NaN
3108 ans = self._check_nans(context=context)
3109 if ans:
3110 return ans
3111
3112 # ln(0.0) == -Infinity
3113 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003114 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003115
3116 # ln(Infinity) = Infinity
3117 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003118 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003119
3120 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003121 if self == _One:
3122 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003123
3124 # ln(negative) raises InvalidOperation
3125 if self._sign == 1:
3126 return context._raise_error(InvalidOperation,
3127 'ln of a negative value')
3128
3129 # result is irrational, so necessarily inexact
3130 op = _WorkRep(self)
3131 c, e = op.int, op.exp
3132 p = context.prec
3133
3134 # correctly rounded result: repeatedly increase precision by 3
3135 # until we get an unambiguously roundable result
3136 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3137 while True:
3138 coeff = _dlog(c, e, places)
3139 # assert len(str(abs(coeff)))-p >= 1
3140 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3141 break
3142 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003143 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003144
3145 context = context._shallow_copy()
3146 rounding = context._set_rounding(ROUND_HALF_EVEN)
3147 ans = ans._fix(context)
3148 context.rounding = rounding
3149 return ans
3150
3151 def _log10_exp_bound(self):
3152 """Compute a lower bound for the adjusted exponent of self.log10().
3153 In other words, find r such that self.log10() >= 10**r.
3154 Assumes that self is finite and positive and that self != 1.
3155 """
3156
3157 # For x >= 10 or x < 0.1 we only need a bound on the integer
3158 # part of log10(self), and this comes directly from the
3159 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3160 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3161 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3162
3163 adj = self._exp + len(self._int) - 1
3164 if adj >= 1:
3165 # self >= 10
3166 return len(str(adj))-1
3167 if adj <= -2:
3168 # self < 0.1
3169 return len(str(-1-adj))-1
3170 op = _WorkRep(self)
3171 c, e = op.int, op.exp
3172 if adj == 0:
3173 # 1 < self < 10
3174 num = str(c-10**-e)
3175 den = str(231*c)
3176 return len(num) - len(den) - (num < den) + 2
3177 # adj == -1, 0.1 <= self < 1
3178 num = str(10**-e-c)
3179 return len(num) + e - (num < "231") - 1
3180
3181 def log10(self, context=None):
3182 """Returns the base 10 logarithm of self."""
3183
3184 if context is None:
3185 context = getcontext()
3186
3187 # log10(NaN) = NaN
3188 ans = self._check_nans(context=context)
3189 if ans:
3190 return ans
3191
3192 # log10(0.0) == -Infinity
3193 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003194 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003195
3196 # log10(Infinity) = Infinity
3197 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003198 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003199
3200 # log10(negative or -Infinity) raises InvalidOperation
3201 if self._sign == 1:
3202 return context._raise_error(InvalidOperation,
3203 'log10 of a negative value')
3204
3205 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003206 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003207 # answer may need rounding
3208 ans = Decimal(self._exp + len(self._int) - 1)
3209 else:
3210 # result is irrational, so necessarily inexact
3211 op = _WorkRep(self)
3212 c, e = op.int, op.exp
3213 p = context.prec
3214
3215 # correctly rounded result: repeatedly increase precision
3216 # until result is unambiguously roundable
3217 places = p-self._log10_exp_bound()+2
3218 while True:
3219 coeff = _dlog10(c, e, places)
3220 # assert len(str(abs(coeff)))-p >= 1
3221 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3222 break
3223 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003224 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003225
3226 context = context._shallow_copy()
3227 rounding = context._set_rounding(ROUND_HALF_EVEN)
3228 ans = ans._fix(context)
3229 context.rounding = rounding
3230 return ans
3231
3232 def logb(self, context=None):
3233 """ Returns the exponent of the magnitude of self's MSD.
3234
3235 The result is the integer which is the exponent of the magnitude
3236 of the most significant digit of self (as though it were truncated
3237 to a single digit while maintaining the value of that digit and
3238 without limiting the resulting exponent).
3239 """
3240 # logb(NaN) = NaN
3241 ans = self._check_nans(context=context)
3242 if ans:
3243 return ans
3244
3245 if context is None:
3246 context = getcontext()
3247
3248 # logb(+/-Inf) = +Inf
3249 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003250 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003251
3252 # logb(0) = -Inf, DivisionByZero
3253 if not self:
3254 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3255
3256 # otherwise, simply return the adjusted exponent of self, as a
3257 # Decimal. Note that no attempt is made to fit the result
3258 # into the current context.
Mark Dickinson56df8872009-10-07 19:23:50 +00003259 ans = Decimal(self.adjusted())
3260 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003261
3262 def _islogical(self):
3263 """Return True if self is a logical operand.
3264
Christian Heimes679db4a2008-01-18 09:56:22 +00003265 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003266 an exponent of 0, and a coefficient whose digits must all be
3267 either 0 or 1.
3268 """
3269 if self._sign != 0 or self._exp != 0:
3270 return False
3271 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003272 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003273 return False
3274 return True
3275
3276 def _fill_logical(self, context, opa, opb):
3277 dif = context.prec - len(opa)
3278 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003279 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003280 elif dif < 0:
3281 opa = opa[-context.prec:]
3282 dif = context.prec - len(opb)
3283 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003284 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003285 elif dif < 0:
3286 opb = opb[-context.prec:]
3287 return opa, opb
3288
3289 def logical_and(self, other, context=None):
3290 """Applies an 'and' operation between self and other's digits."""
3291 if context is None:
3292 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003293
3294 other = _convert_other(other, raiseit=True)
3295
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003296 if not self._islogical() or not other._islogical():
3297 return context._raise_error(InvalidOperation)
3298
3299 # fill to context.prec
3300 (opa, opb) = self._fill_logical(context, self._int, other._int)
3301
3302 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003303 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3304 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003305
3306 def logical_invert(self, context=None):
3307 """Invert all its digits."""
3308 if context is None:
3309 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003310 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3311 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003312
3313 def logical_or(self, other, context=None):
3314 """Applies an 'or' operation between self and other's digits."""
3315 if context is None:
3316 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003317
3318 other = _convert_other(other, raiseit=True)
3319
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003320 if not self._islogical() or not other._islogical():
3321 return context._raise_error(InvalidOperation)
3322
3323 # fill to context.prec
3324 (opa, opb) = self._fill_logical(context, self._int, other._int)
3325
3326 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003327 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003328 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003329
3330 def logical_xor(self, other, context=None):
3331 """Applies an 'xor' operation between self and other's digits."""
3332 if context is None:
3333 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003334
3335 other = _convert_other(other, raiseit=True)
3336
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003337 if not self._islogical() or not other._islogical():
3338 return context._raise_error(InvalidOperation)
3339
3340 # fill to context.prec
3341 (opa, opb) = self._fill_logical(context, self._int, other._int)
3342
3343 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003344 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003345 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003346
3347 def max_mag(self, other, context=None):
3348 """Compares the values numerically with their sign ignored."""
3349 other = _convert_other(other, raiseit=True)
3350
3351 if context is None:
3352 context = getcontext()
3353
3354 if self._is_special or other._is_special:
3355 # If one operand is a quiet NaN and the other is number, then the
3356 # number is always returned
3357 sn = self._isnan()
3358 on = other._isnan()
3359 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003360 if on == 1 and sn == 0:
3361 return self._fix(context)
3362 if sn == 1 and on == 0:
3363 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003364 return self._check_nans(other, context)
3365
Christian Heimes77c02eb2008-02-09 02:18:51 +00003366 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003367 if c == 0:
3368 c = self.compare_total(other)
3369
3370 if c == -1:
3371 ans = other
3372 else:
3373 ans = self
3374
Christian Heimes2c181612007-12-17 20:04:13 +00003375 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003376
3377 def min_mag(self, other, context=None):
3378 """Compares the values numerically with their sign ignored."""
3379 other = _convert_other(other, raiseit=True)
3380
3381 if context is None:
3382 context = getcontext()
3383
3384 if self._is_special or other._is_special:
3385 # If one operand is a quiet NaN and the other is number, then the
3386 # number is always returned
3387 sn = self._isnan()
3388 on = other._isnan()
3389 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003390 if on == 1 and sn == 0:
3391 return self._fix(context)
3392 if sn == 1 and on == 0:
3393 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003394 return self._check_nans(other, context)
3395
Christian Heimes77c02eb2008-02-09 02:18:51 +00003396 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003397 if c == 0:
3398 c = self.compare_total(other)
3399
3400 if c == -1:
3401 ans = self
3402 else:
3403 ans = other
3404
Christian Heimes2c181612007-12-17 20:04:13 +00003405 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003406
3407 def next_minus(self, context=None):
3408 """Returns the largest representable number smaller than itself."""
3409 if context is None:
3410 context = getcontext()
3411
3412 ans = self._check_nans(context=context)
3413 if ans:
3414 return ans
3415
3416 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003417 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003418 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003419 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003420
3421 context = context.copy()
3422 context._set_rounding(ROUND_FLOOR)
3423 context._ignore_all_flags()
3424 new_self = self._fix(context)
3425 if new_self != self:
3426 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003427 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3428 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003429
3430 def next_plus(self, context=None):
3431 """Returns the smallest representable number larger than itself."""
3432 if context is None:
3433 context = getcontext()
3434
3435 ans = self._check_nans(context=context)
3436 if ans:
3437 return ans
3438
3439 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003440 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003441 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003442 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003443
3444 context = context.copy()
3445 context._set_rounding(ROUND_CEILING)
3446 context._ignore_all_flags()
3447 new_self = self._fix(context)
3448 if new_self != self:
3449 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003450 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3451 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003452
3453 def next_toward(self, other, context=None):
3454 """Returns the number closest to self, in the direction towards other.
3455
3456 The result is the closest representable number to self
3457 (excluding self) that is in the direction towards other,
3458 unless both have the same value. If the two operands are
3459 numerically equal, then the result is a copy of self with the
3460 sign set to be the same as the sign of other.
3461 """
3462 other = _convert_other(other, raiseit=True)
3463
3464 if context is None:
3465 context = getcontext()
3466
3467 ans = self._check_nans(other, context)
3468 if ans:
3469 return ans
3470
Christian Heimes77c02eb2008-02-09 02:18:51 +00003471 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003472 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003473 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003474
3475 if comparison == -1:
3476 ans = self.next_plus(context)
3477 else: # comparison == 1
3478 ans = self.next_minus(context)
3479
3480 # decide which flags to raise using value of ans
3481 if ans._isinfinity():
3482 context._raise_error(Overflow,
3483 'Infinite result from next_toward',
3484 ans._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003485 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003486 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003487 elif ans.adjusted() < context.Emin:
3488 context._raise_error(Underflow)
3489 context._raise_error(Subnormal)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003490 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003491 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003492 # if precision == 1 then we don't raise Clamped for a
3493 # result 0E-Etiny.
3494 if not ans:
3495 context._raise_error(Clamped)
3496
3497 return ans
3498
3499 def number_class(self, context=None):
3500 """Returns an indication of the class of self.
3501
3502 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003503 sNaN
3504 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003505 -Infinity
3506 -Normal
3507 -Subnormal
3508 -Zero
3509 +Zero
3510 +Subnormal
3511 +Normal
3512 +Infinity
3513 """
3514 if self.is_snan():
3515 return "sNaN"
3516 if self.is_qnan():
3517 return "NaN"
3518 inf = self._isinfinity()
3519 if inf == 1:
3520 return "+Infinity"
3521 if inf == -1:
3522 return "-Infinity"
3523 if self.is_zero():
3524 if self._sign:
3525 return "-Zero"
3526 else:
3527 return "+Zero"
3528 if context is None:
3529 context = getcontext()
3530 if self.is_subnormal(context=context):
3531 if self._sign:
3532 return "-Subnormal"
3533 else:
3534 return "+Subnormal"
3535 # just a normal, regular, boring number, :)
3536 if self._sign:
3537 return "-Normal"
3538 else:
3539 return "+Normal"
3540
3541 def radix(self):
3542 """Just returns 10, as this is Decimal, :)"""
3543 return Decimal(10)
3544
3545 def rotate(self, other, context=None):
3546 """Returns a rotated copy of self, value-of-other times."""
3547 if context is None:
3548 context = getcontext()
3549
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003550 other = _convert_other(other, raiseit=True)
3551
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003552 ans = self._check_nans(other, context)
3553 if ans:
3554 return ans
3555
3556 if other._exp != 0:
3557 return context._raise_error(InvalidOperation)
3558 if not (-context.prec <= int(other) <= context.prec):
3559 return context._raise_error(InvalidOperation)
3560
3561 if self._isinfinity():
3562 return Decimal(self)
3563
3564 # get values, pad if necessary
3565 torot = int(other)
3566 rotdig = self._int
3567 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003568 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003569 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003570 elif topad < 0:
3571 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003572
3573 # let's rotate!
3574 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003575 return _dec_from_triple(self._sign,
3576 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003577
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003578 def scaleb(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003579 """Returns self operand after adding the second value to its exp."""
3580 if context is None:
3581 context = getcontext()
3582
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003583 other = _convert_other(other, raiseit=True)
3584
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003585 ans = self._check_nans(other, context)
3586 if ans:
3587 return ans
3588
3589 if other._exp != 0:
3590 return context._raise_error(InvalidOperation)
3591 liminf = -2 * (context.Emax + context.prec)
3592 limsup = 2 * (context.Emax + context.prec)
3593 if not (liminf <= int(other) <= limsup):
3594 return context._raise_error(InvalidOperation)
3595
3596 if self._isinfinity():
3597 return Decimal(self)
3598
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003599 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003600 d = d._fix(context)
3601 return d
3602
3603 def shift(self, other, context=None):
3604 """Returns a shifted copy of self, value-of-other times."""
3605 if context is None:
3606 context = getcontext()
3607
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003608 other = _convert_other(other, raiseit=True)
3609
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003610 ans = self._check_nans(other, context)
3611 if ans:
3612 return ans
3613
3614 if other._exp != 0:
3615 return context._raise_error(InvalidOperation)
3616 if not (-context.prec <= int(other) <= context.prec):
3617 return context._raise_error(InvalidOperation)
3618
3619 if self._isinfinity():
3620 return Decimal(self)
3621
3622 # get values, pad if necessary
3623 torot = int(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003624 rotdig = self._int
3625 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003626 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003627 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003628 elif topad < 0:
3629 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003630
3631 # let's shift!
3632 if torot < 0:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003633 shifted = rotdig[:torot]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003634 else:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003635 shifted = rotdig + '0'*torot
3636 shifted = shifted[-context.prec:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003637
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003638 return _dec_from_triple(self._sign,
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003639 shifted.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003640
Guido van Rossumd8faa362007-04-27 19:54:29 +00003641 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003642 def __reduce__(self):
3643 return (self.__class__, (str(self),))
3644
3645 def __copy__(self):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003646 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003647 return self # I'm immutable; therefore I am my own clone
3648 return self.__class__(str(self))
3649
3650 def __deepcopy__(self, memo):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003651 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003652 return self # My components are also immutable
3653 return self.__class__(str(self))
3654
Mark Dickinson79f52032009-03-17 23:12:51 +00003655 # PEP 3101 support. the _localeconv keyword argument should be
3656 # considered private: it's provided for ease of testing only.
3657 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003658 """Format a Decimal instance according to the given specifier.
3659
3660 The specifier should be a standard format specifier, with the
3661 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003662 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3663 type is omitted it defaults to 'g' or 'G', depending on the
3664 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003665 """
3666
3667 # Note: PEP 3101 says that if the type is not present then
3668 # there should be at least one digit after the decimal point.
3669 # We take the liberty of ignoring this requirement for
3670 # Decimal---it's presumably there to make sure that
3671 # format(float, '') behaves similarly to str(float).
3672 if context is None:
3673 context = getcontext()
3674
Mark Dickinson79f52032009-03-17 23:12:51 +00003675 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003676
Mark Dickinson79f52032009-03-17 23:12:51 +00003677 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003678 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003679 sign = _format_sign(self._sign, spec)
3680 body = str(self.copy_abs())
3681 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003682
3683 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003684 if spec['type'] is None:
3685 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003686
3687 # if type is '%', adjust exponent of self accordingly
3688 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003689 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3690
3691 # round if necessary, taking rounding mode from the context
3692 rounding = context.rounding
3693 precision = spec['precision']
3694 if precision is not None:
3695 if spec['type'] in 'eE':
3696 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003697 elif spec['type'] in 'fF%':
3698 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003699 elif spec['type'] in 'gG' and len(self._int) > precision:
3700 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003701 # special case: zeros with a positive exponent can't be
3702 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003703 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003704 self = self._rescale(0, rounding)
3705
3706 # figure out placement of the decimal point
3707 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003708 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003709 if not self and precision is not None:
3710 dotplace = 1 - precision
3711 else:
3712 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003713 elif spec['type'] in 'fF%':
3714 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003715 elif spec['type'] in 'gG':
3716 if self._exp <= 0 and leftdigits > -6:
3717 dotplace = leftdigits
3718 else:
3719 dotplace = 1
3720
Mark Dickinson79f52032009-03-17 23:12:51 +00003721 # find digits before and after decimal point, and get exponent
3722 if dotplace < 0:
3723 intpart = '0'
3724 fracpart = '0'*(-dotplace) + self._int
3725 elif dotplace > len(self._int):
3726 intpart = self._int + '0'*(dotplace-len(self._int))
3727 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003728 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003729 intpart = self._int[:dotplace] or '0'
3730 fracpart = self._int[dotplace:]
3731 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003732
Mark Dickinson79f52032009-03-17 23:12:51 +00003733 # done with the decimal-specific stuff; hand over the rest
3734 # of the formatting to the _format_number function
3735 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003736
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003737def _dec_from_triple(sign, coefficient, exponent, special=False):
3738 """Create a decimal instance directly, without any validation,
3739 normalization (e.g. removal of leading zeros) or argument
3740 conversion.
3741
3742 This function is for *internal use only*.
3743 """
3744
3745 self = object.__new__(Decimal)
3746 self._sign = sign
3747 self._int = coefficient
3748 self._exp = exponent
3749 self._is_special = special
3750
3751 return self
3752
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003753# Register Decimal as a kind of Number (an abstract base class).
3754# However, do not register it as Real (because Decimals are not
3755# interoperable with floats).
3756_numbers.Number.register(Decimal)
3757
3758
Guido van Rossumd8faa362007-04-27 19:54:29 +00003759##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003760
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003761
3762# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003763rounding_functions = [name for name in Decimal.__dict__.keys()
3764 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003765for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003766 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003767 globalname = name[1:].upper()
3768 val = globals()[globalname]
3769 Decimal._pick_rounding_function[val] = name
3770
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003771del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003772
Thomas Wouters89f507f2006-12-13 04:49:30 +00003773class _ContextManager(object):
3774 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003775
Thomas Wouters89f507f2006-12-13 04:49:30 +00003776 Sets a copy of the supplied context in __enter__() and restores
3777 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003778 """
3779 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003780 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003781 def __enter__(self):
3782 self.saved_context = getcontext()
3783 setcontext(self.new_context)
3784 return self.new_context
3785 def __exit__(self, t, v, tb):
3786 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003787
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003788class Context(object):
3789 """Contains the context for a Decimal instance.
3790
3791 Contains:
3792 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003793 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003794 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003795 raised when it is caused. Otherwise, a value is
3796 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003797 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003798 (Whether or not the trap_enabler is set)
3799 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003800 Emin - Minimum exponent
3801 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003802 capitals - If 1, 1*10^1 is printed as 1E+1.
3803 If 0, printed as 1e1
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003804 clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003805 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003806
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003807 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003808 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003809 Emin=None, Emax=None,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003810 capitals=None, clamp=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003811 _ignored_flags=None):
3812 if flags is None:
3813 flags = []
3814 if _ignored_flags is None:
3815 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003816 if not isinstance(flags, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003817 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerbf440692004-07-10 14:14:37 +00003818 if traps is not None and not isinstance(traps, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003819 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003820 for name, val in locals().items():
3821 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003822 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003823 else:
3824 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003825 del self.self
3826
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003827 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003828 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003829 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003830 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003831 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d, '
3832 'clamp=%(clamp)d'
Guido van Rossumd8faa362007-04-27 19:54:29 +00003833 % vars(self))
3834 names = [f.__name__ for f, v in self.flags.items() if v]
3835 s.append('flags=[' + ', '.join(names) + ']')
3836 names = [t.__name__ for t, v in self.traps.items() if v]
3837 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003838 return ', '.join(s) + ')'
3839
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003840 def clear_flags(self):
3841 """Reset all flags to zero"""
3842 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003843 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003844
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003845 def _shallow_copy(self):
3846 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003847 nc = Context(self.prec, self.rounding, self.traps,
3848 self.flags, self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003849 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003850 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003851
3852 def copy(self):
3853 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003854 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003855 self.flags.copy(), self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003856 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003857 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003858 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003859
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003860 # _clamp is provided for backwards compatibility with third-party
3861 # code. May be removed in Python >= 3.3.
3862 def _get_clamp(self):
3863 "_clamp mirrors the clamp attribute. Its use is deprecated."
3864 import warnings
3865 warnings.warn('Use of the _clamp attribute is deprecated. '
3866 'Please use clamp instead.',
3867 DeprecationWarning)
3868 return self.clamp
3869
3870 def _set_clamp(self, clamp):
3871 "_clamp mirrors the clamp attribute. Its use is deprecated."
3872 import warnings
3873 warnings.warn('Use of the _clamp attribute is deprecated. '
3874 'Please use clamp instead.',
3875 DeprecationWarning)
3876 self.clamp = clamp
3877
3878 # don't bother with _del_clamp; no sane 3rd party code should
3879 # be deleting the _clamp attribute
3880 _clamp = property(_get_clamp, _set_clamp)
3881
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003882 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003883 """Handles an error
3884
3885 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003886 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah2eb4a072010-05-19 15:52:31 +00003887 trap_enabler is set, it reraises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003888 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003889 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003890 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003891 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003892 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003893 return error().handle(self, *args)
3894
Raymond Hettinger86173da2008-02-01 20:38:12 +00003895 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003896 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003897 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003898 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003899
3900 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003901 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003902 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003903
3904 def _ignore_all_flags(self):
3905 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003906 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003907
3908 def _ignore_flags(self, *flags):
3909 """Ignore the flags, if they are raised"""
3910 # Do not mutate-- This way, copies of a context leave the original
3911 # alone.
3912 self._ignored_flags = (self._ignored_flags + list(flags))
3913 return list(flags)
3914
3915 def _regard_flags(self, *flags):
3916 """Stop ignoring the flags, if they are raised"""
3917 if flags and isinstance(flags[0], (tuple,list)):
3918 flags = flags[0]
3919 for flag in flags:
3920 self._ignored_flags.remove(flag)
3921
Nick Coghland1abd252008-07-15 15:46:38 +00003922 # We inherit object.__hash__, so we must deny this explicitly
3923 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003924
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003925 def Etiny(self):
3926 """Returns Etiny (= Emin - prec + 1)"""
3927 return int(self.Emin - self.prec + 1)
3928
3929 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003930 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003931 return int(self.Emax - self.prec + 1)
3932
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003933 def _set_rounding(self, type):
3934 """Sets the rounding type.
3935
3936 Sets the rounding type, and returns the current (previous)
3937 rounding type. Often used like:
3938
3939 context = context.copy()
3940 # so you don't change the calling context
3941 # if an error occurs in the middle.
3942 rounding = context._set_rounding(ROUND_UP)
3943 val = self.__sub__(other, context=context)
3944 context._set_rounding(rounding)
3945
3946 This will make it round up for that operation.
3947 """
3948 rounding = self.rounding
3949 self.rounding= type
3950 return rounding
3951
Raymond Hettingerfed52962004-07-14 15:41:57 +00003952 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003953 """Creates a new Decimal instance but using self as context.
3954
3955 This method implements the to-number operation of the
3956 IBM Decimal specification."""
3957
3958 if isinstance(num, str) and num != num.strip():
3959 return self._raise_error(ConversionSyntax,
3960 "no trailing or leading whitespace is "
3961 "permitted.")
3962
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003963 d = Decimal(num, context=self)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003964 if d._isnan() and len(d._int) > self.prec - self.clamp:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003965 return self._raise_error(ConversionSyntax,
3966 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003967 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003968
Raymond Hettinger771ed762009-01-03 19:20:32 +00003969 def create_decimal_from_float(self, f):
3970 """Creates a new Decimal instance from a float but rounding using self
3971 as the context.
3972
3973 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3974 >>> context.create_decimal_from_float(3.1415926535897932)
3975 Decimal('3.1415')
3976 >>> context = Context(prec=5, traps=[Inexact])
3977 >>> context.create_decimal_from_float(3.1415926535897932)
3978 Traceback (most recent call last):
3979 ...
3980 decimal.Inexact: None
3981
3982 """
3983 d = Decimal.from_float(f) # An exact conversion
3984 return d._fix(self) # Apply the context rounding
3985
Guido van Rossumd8faa362007-04-27 19:54:29 +00003986 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003987 def abs(self, a):
3988 """Returns the absolute value of the operand.
3989
3990 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00003991 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003992 the plus operation on the operand.
3993
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003994 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003995 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003996 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003997 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003998 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003999 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004000 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004001 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004002 >>> ExtendedContext.abs(-1)
4003 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004004 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004005 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004006 return a.__abs__(context=self)
4007
4008 def add(self, a, b):
4009 """Return the sum of the two operands.
4010
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004011 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004012 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004013 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004014 Decimal('1.02E+4')
Mark Dickinson84230a12010-02-18 14:49:50 +00004015 >>> ExtendedContext.add(1, Decimal(2))
4016 Decimal('3')
4017 >>> ExtendedContext.add(Decimal(8), 5)
4018 Decimal('13')
4019 >>> ExtendedContext.add(5, 5)
4020 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004021 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004022 a = _convert_other(a, raiseit=True)
4023 r = a.__add__(b, context=self)
4024 if r is NotImplemented:
4025 raise TypeError("Unable to convert %s to Decimal" % b)
4026 else:
4027 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004028
4029 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00004030 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004031
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004032 def canonical(self, a):
4033 """Returns the same Decimal object.
4034
4035 As we do not have different encodings for the same number, the
4036 received object already is in its canonical form.
4037
4038 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004039 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004040 """
4041 return a.canonical(context=self)
4042
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004043 def compare(self, a, b):
4044 """Compares values numerically.
4045
4046 If the signs of the operands differ, a value representing each operand
4047 ('-1' if the operand is less than zero, '0' if the operand is zero or
4048 negative zero, or '1' if the operand is greater than zero) is used in
4049 place of that operand for the comparison instead of the actual
4050 operand.
4051
4052 The comparison is then effected by subtracting the second operand from
4053 the first and then returning a value according to the result of the
4054 subtraction: '-1' if the result is less than zero, '0' if the result is
4055 zero or negative zero, or '1' if the result is greater than zero.
4056
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004057 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004058 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004059 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004060 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004061 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004062 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004063 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004064 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004065 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004066 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004067 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004068 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004069 >>> ExtendedContext.compare(1, 2)
4070 Decimal('-1')
4071 >>> ExtendedContext.compare(Decimal(1), 2)
4072 Decimal('-1')
4073 >>> ExtendedContext.compare(1, Decimal(2))
4074 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004075 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004076 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004077 return a.compare(b, context=self)
4078
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004079 def compare_signal(self, a, b):
4080 """Compares the values of the two operands numerically.
4081
4082 It's pretty much like compare(), but all NaNs signal, with signaling
4083 NaNs taking precedence over quiet NaNs.
4084
4085 >>> c = ExtendedContext
4086 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004087 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004088 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004089 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004090 >>> c.flags[InvalidOperation] = 0
4091 >>> print(c.flags[InvalidOperation])
4092 0
4093 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004094 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004095 >>> print(c.flags[InvalidOperation])
4096 1
4097 >>> c.flags[InvalidOperation] = 0
4098 >>> print(c.flags[InvalidOperation])
4099 0
4100 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004101 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004102 >>> print(c.flags[InvalidOperation])
4103 1
Mark Dickinson84230a12010-02-18 14:49:50 +00004104 >>> c.compare_signal(-1, 2)
4105 Decimal('-1')
4106 >>> c.compare_signal(Decimal(-1), 2)
4107 Decimal('-1')
4108 >>> c.compare_signal(-1, Decimal(2))
4109 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004110 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004111 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004112 return a.compare_signal(b, context=self)
4113
4114 def compare_total(self, a, b):
4115 """Compares two operands using their abstract representation.
4116
4117 This is not like the standard compare, which use their numerical
4118 value. Note that a total ordering is defined for all possible abstract
4119 representations.
4120
4121 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004122 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004123 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004124 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004125 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004126 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004127 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004128 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004129 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004130 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004131 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004132 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004133 >>> ExtendedContext.compare_total(1, 2)
4134 Decimal('-1')
4135 >>> ExtendedContext.compare_total(Decimal(1), 2)
4136 Decimal('-1')
4137 >>> ExtendedContext.compare_total(1, Decimal(2))
4138 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004139 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004140 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004141 return a.compare_total(b)
4142
4143 def compare_total_mag(self, a, b):
4144 """Compares two operands using their abstract representation ignoring sign.
4145
4146 Like compare_total, but with operand's sign ignored and assumed to be 0.
4147 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004148 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004149 return a.compare_total_mag(b)
4150
4151 def copy_abs(self, a):
4152 """Returns a copy of the operand with the sign set to 0.
4153
4154 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004155 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004156 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004157 Decimal('100')
Mark Dickinson84230a12010-02-18 14:49:50 +00004158 >>> ExtendedContext.copy_abs(-1)
4159 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004160 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004161 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004162 return a.copy_abs()
4163
4164 def copy_decimal(self, a):
Mark Dickinson84230a12010-02-18 14:49:50 +00004165 """Returns a copy of the decimal object.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004166
4167 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004168 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004169 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004170 Decimal('-1.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004171 >>> ExtendedContext.copy_decimal(1)
4172 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004173 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004174 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004175 return Decimal(a)
4176
4177 def copy_negate(self, a):
4178 """Returns a copy of the operand with the sign inverted.
4179
4180 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004181 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004182 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004183 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004184 >>> ExtendedContext.copy_negate(1)
4185 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004186 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004187 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004188 return a.copy_negate()
4189
4190 def copy_sign(self, a, b):
4191 """Copies the second operand's sign to the first one.
4192
4193 In detail, it returns a copy of the first operand with the sign
4194 equal to the sign of the second operand.
4195
4196 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004197 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004198 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004199 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004200 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004201 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004202 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004203 Decimal('-1.50')
Mark Dickinson84230a12010-02-18 14:49:50 +00004204 >>> ExtendedContext.copy_sign(1, -2)
4205 Decimal('-1')
4206 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4207 Decimal('-1')
4208 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4209 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004210 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004211 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004212 return a.copy_sign(b)
4213
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004214 def divide(self, a, b):
4215 """Decimal division in a specified context.
4216
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004217 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004218 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004219 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004220 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004221 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004222 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004223 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004224 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004225 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004226 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004227 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004228 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004229 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004230 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004231 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004232 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004233 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004234 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004235 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004236 Decimal('1.20E+6')
Mark Dickinson84230a12010-02-18 14:49:50 +00004237 >>> ExtendedContext.divide(5, 5)
4238 Decimal('1')
4239 >>> ExtendedContext.divide(Decimal(5), 5)
4240 Decimal('1')
4241 >>> ExtendedContext.divide(5, Decimal(5))
4242 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004243 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004244 a = _convert_other(a, raiseit=True)
4245 r = a.__truediv__(b, context=self)
4246 if r is NotImplemented:
4247 raise TypeError("Unable to convert %s to Decimal" % b)
4248 else:
4249 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004250
4251 def divide_int(self, a, b):
4252 """Divides two numbers and returns the integer part of the result.
4253
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004254 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004255 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004256 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004257 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004258 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004259 Decimal('3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004260 >>> ExtendedContext.divide_int(10, 3)
4261 Decimal('3')
4262 >>> ExtendedContext.divide_int(Decimal(10), 3)
4263 Decimal('3')
4264 >>> ExtendedContext.divide_int(10, Decimal(3))
4265 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004266 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004267 a = _convert_other(a, raiseit=True)
4268 r = a.__floordiv__(b, context=self)
4269 if r is NotImplemented:
4270 raise TypeError("Unable to convert %s to Decimal" % b)
4271 else:
4272 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004273
4274 def divmod(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004275 """Return (a // b, a % b).
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004276
4277 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4278 (Decimal('2'), Decimal('2'))
4279 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4280 (Decimal('2'), Decimal('0'))
Mark Dickinson84230a12010-02-18 14:49:50 +00004281 >>> ExtendedContext.divmod(8, 4)
4282 (Decimal('2'), Decimal('0'))
4283 >>> ExtendedContext.divmod(Decimal(8), 4)
4284 (Decimal('2'), Decimal('0'))
4285 >>> ExtendedContext.divmod(8, Decimal(4))
4286 (Decimal('2'), Decimal('0'))
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004287 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004288 a = _convert_other(a, raiseit=True)
4289 r = a.__divmod__(b, context=self)
4290 if r is NotImplemented:
4291 raise TypeError("Unable to convert %s to Decimal" % b)
4292 else:
4293 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004294
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004295 def exp(self, a):
4296 """Returns e ** a.
4297
4298 >>> c = ExtendedContext.copy()
4299 >>> c.Emin = -999
4300 >>> c.Emax = 999
4301 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004302 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004303 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004304 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004305 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004306 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004307 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004308 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004309 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004310 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004311 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004312 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004313 >>> c.exp(10)
4314 Decimal('22026.4658')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004315 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004316 a =_convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004317 return a.exp(context=self)
4318
4319 def fma(self, a, b, c):
4320 """Returns a multiplied by b, plus c.
4321
4322 The first two operands are multiplied together, using multiply,
4323 the third operand is then added to the result of that
4324 multiplication, using add, all with only one final rounding.
4325
4326 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004327 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004328 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004329 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004330 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004331 Decimal('1.38435736E+12')
Mark Dickinson84230a12010-02-18 14:49:50 +00004332 >>> ExtendedContext.fma(1, 3, 4)
4333 Decimal('7')
4334 >>> ExtendedContext.fma(1, Decimal(3), 4)
4335 Decimal('7')
4336 >>> ExtendedContext.fma(1, 3, Decimal(4))
4337 Decimal('7')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004338 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004339 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004340 return a.fma(b, c, context=self)
4341
4342 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004343 """Return True if the operand is canonical; otherwise return False.
4344
4345 Currently, the encoding of a Decimal instance is always
4346 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004347
4348 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004349 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004350 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004351 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004352
4353 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004354 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004355
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004356 A Decimal instance is considered finite if it is neither
4357 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004358
4359 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004360 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004361 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004362 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004363 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004364 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004365 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004366 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004367 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004368 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004369 >>> ExtendedContext.is_finite(1)
4370 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004371 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004372 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004373 return a.is_finite()
4374
4375 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004376 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004377
4378 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004379 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004380 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004381 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004382 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004383 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004384 >>> ExtendedContext.is_infinite(1)
4385 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004386 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004387 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004388 return a.is_infinite()
4389
4390 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004391 """Return True if the operand is a qNaN or sNaN;
4392 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004393
4394 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004395 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004396 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004397 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004398 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004399 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004400 >>> ExtendedContext.is_nan(1)
4401 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004402 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004403 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004404 return a.is_nan()
4405
4406 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004407 """Return True if the operand is a normal number;
4408 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004409
4410 >>> c = ExtendedContext.copy()
4411 >>> c.Emin = -999
4412 >>> c.Emax = 999
4413 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004414 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004415 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004416 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004417 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004418 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004419 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004420 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004421 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004422 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004423 >>> c.is_normal(1)
4424 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004425 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004426 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004427 return a.is_normal(context=self)
4428
4429 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004430 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004431
4432 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004433 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004434 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004435 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004436 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004437 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004438 >>> ExtendedContext.is_qnan(1)
4439 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004440 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004441 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004442 return a.is_qnan()
4443
4444 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004445 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004446
4447 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004448 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004449 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004450 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004451 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004452 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004453 >>> ExtendedContext.is_signed(8)
4454 False
4455 >>> ExtendedContext.is_signed(-8)
4456 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004457 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004458 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004459 return a.is_signed()
4460
4461 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004462 """Return True if the operand is a signaling NaN;
4463 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004464
4465 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004466 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004467 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004468 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004469 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004470 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004471 >>> ExtendedContext.is_snan(1)
4472 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004473 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004474 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004475 return a.is_snan()
4476
4477 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004478 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004479
4480 >>> c = ExtendedContext.copy()
4481 >>> c.Emin = -999
4482 >>> c.Emax = 999
4483 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004484 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004485 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004486 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004487 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004488 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004489 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004490 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004491 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004492 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004493 >>> c.is_subnormal(1)
4494 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004495 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004496 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004497 return a.is_subnormal(context=self)
4498
4499 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004500 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004501
4502 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004503 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004504 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004505 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004506 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004507 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004508 >>> ExtendedContext.is_zero(1)
4509 False
4510 >>> ExtendedContext.is_zero(0)
4511 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004512 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004513 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004514 return a.is_zero()
4515
4516 def ln(self, a):
4517 """Returns the natural (base e) logarithm of the operand.
4518
4519 >>> c = ExtendedContext.copy()
4520 >>> c.Emin = -999
4521 >>> c.Emax = 999
4522 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004523 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004524 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004525 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004526 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004527 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004528 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004529 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004530 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004531 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004532 >>> c.ln(1)
4533 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004534 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004535 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004536 return a.ln(context=self)
4537
4538 def log10(self, a):
4539 """Returns the base 10 logarithm of the operand.
4540
4541 >>> c = ExtendedContext.copy()
4542 >>> c.Emin = -999
4543 >>> c.Emax = 999
4544 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004545 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004546 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004547 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004548 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004549 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004550 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004551 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004552 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004553 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004554 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004555 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004556 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004557 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004558 >>> c.log10(0)
4559 Decimal('-Infinity')
4560 >>> c.log10(1)
4561 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004562 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004563 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004564 return a.log10(context=self)
4565
4566 def logb(self, a):
4567 """ Returns the exponent of the magnitude of the operand's MSD.
4568
4569 The result is the integer which is the exponent of the magnitude
4570 of the most significant digit of the operand (as though the
4571 operand were truncated to a single digit while maintaining the
4572 value of that digit and without limiting the resulting exponent).
4573
4574 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004575 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004576 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004577 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004578 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004579 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004580 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004581 Decimal('-Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004582 >>> ExtendedContext.logb(1)
4583 Decimal('0')
4584 >>> ExtendedContext.logb(10)
4585 Decimal('1')
4586 >>> ExtendedContext.logb(100)
4587 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004588 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004589 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004590 return a.logb(context=self)
4591
4592 def logical_and(self, a, b):
4593 """Applies the logical operation 'and' between each operand's digits.
4594
4595 The operands must be both logical numbers.
4596
4597 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004598 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004599 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004600 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004601 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004602 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004603 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004604 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004605 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004606 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004607 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004608 Decimal('10')
Mark Dickinson84230a12010-02-18 14:49:50 +00004609 >>> ExtendedContext.logical_and(110, 1101)
4610 Decimal('100')
4611 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4612 Decimal('100')
4613 >>> ExtendedContext.logical_and(110, Decimal(1101))
4614 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004615 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004616 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004617 return a.logical_and(b, context=self)
4618
4619 def logical_invert(self, a):
4620 """Invert all the digits in the operand.
4621
4622 The operand must be a logical number.
4623
4624 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004625 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004626 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004627 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004628 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004629 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004630 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004631 Decimal('10101010')
Mark Dickinson84230a12010-02-18 14:49:50 +00004632 >>> ExtendedContext.logical_invert(1101)
4633 Decimal('111110010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004634 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004635 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004636 return a.logical_invert(context=self)
4637
4638 def logical_or(self, a, b):
4639 """Applies the logical operation 'or' between each operand's digits.
4640
4641 The operands must be both logical numbers.
4642
4643 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004644 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004645 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004646 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004647 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004648 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004649 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004650 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004651 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004652 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004653 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004654 Decimal('1110')
Mark Dickinson84230a12010-02-18 14:49:50 +00004655 >>> ExtendedContext.logical_or(110, 1101)
4656 Decimal('1111')
4657 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4658 Decimal('1111')
4659 >>> ExtendedContext.logical_or(110, Decimal(1101))
4660 Decimal('1111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004661 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004662 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004663 return a.logical_or(b, context=self)
4664
4665 def logical_xor(self, a, b):
4666 """Applies the logical operation 'xor' between each operand's digits.
4667
4668 The operands must be both logical numbers.
4669
4670 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004671 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004672 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004673 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004674 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004675 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004676 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004677 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004678 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004679 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004680 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004681 Decimal('1101')
Mark Dickinson84230a12010-02-18 14:49:50 +00004682 >>> ExtendedContext.logical_xor(110, 1101)
4683 Decimal('1011')
4684 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4685 Decimal('1011')
4686 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4687 Decimal('1011')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004688 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004689 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004690 return a.logical_xor(b, context=self)
4691
Mark Dickinson84230a12010-02-18 14:49:50 +00004692 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004693 """max compares two values numerically and returns the maximum.
4694
4695 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004696 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004697 operation. If they are numerically equal then the left-hand operand
4698 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004699 infinity) of the two operands is chosen as the result.
4700
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004701 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004702 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004703 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004704 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004705 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004706 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004707 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004708 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004709 >>> ExtendedContext.max(1, 2)
4710 Decimal('2')
4711 >>> ExtendedContext.max(Decimal(1), 2)
4712 Decimal('2')
4713 >>> ExtendedContext.max(1, Decimal(2))
4714 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004715 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004716 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004717 return a.max(b, context=self)
4718
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004719 def max_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004720 """Compares the values numerically with their sign ignored.
4721
4722 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4723 Decimal('7')
4724 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4725 Decimal('-10')
4726 >>> ExtendedContext.max_mag(1, -2)
4727 Decimal('-2')
4728 >>> ExtendedContext.max_mag(Decimal(1), -2)
4729 Decimal('-2')
4730 >>> ExtendedContext.max_mag(1, Decimal(-2))
4731 Decimal('-2')
4732 """
4733 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004734 return a.max_mag(b, context=self)
4735
Mark Dickinson84230a12010-02-18 14:49:50 +00004736 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004737 """min compares two values numerically and returns the minimum.
4738
4739 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004740 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004741 operation. If they are numerically equal then the left-hand operand
4742 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004743 infinity) of the two operands is chosen as the result.
4744
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004745 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004746 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004747 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004748 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004749 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004750 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004751 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004752 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004753 >>> ExtendedContext.min(1, 2)
4754 Decimal('1')
4755 >>> ExtendedContext.min(Decimal(1), 2)
4756 Decimal('1')
4757 >>> ExtendedContext.min(1, Decimal(29))
4758 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004759 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004760 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004761 return a.min(b, context=self)
4762
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004763 def min_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004764 """Compares the values numerically with their sign ignored.
4765
4766 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4767 Decimal('-2')
4768 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4769 Decimal('-3')
4770 >>> ExtendedContext.min_mag(1, -2)
4771 Decimal('1')
4772 >>> ExtendedContext.min_mag(Decimal(1), -2)
4773 Decimal('1')
4774 >>> ExtendedContext.min_mag(1, Decimal(-2))
4775 Decimal('1')
4776 """
4777 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004778 return a.min_mag(b, context=self)
4779
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004780 def minus(self, a):
4781 """Minus corresponds to unary prefix minus in Python.
4782
4783 The operation is evaluated using the same rules as subtract; the
4784 operation minus(a) is calculated as subtract('0', a) where the '0'
4785 has the same exponent as the operand.
4786
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004787 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004788 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004789 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004790 Decimal('1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004791 >>> ExtendedContext.minus(1)
4792 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004793 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004794 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004795 return a.__neg__(context=self)
4796
4797 def multiply(self, a, b):
4798 """multiply multiplies two operands.
4799
4800 If either operand is a special value then the general rules apply.
Mark Dickinson84230a12010-02-18 14:49:50 +00004801 Otherwise, the operands are multiplied together
4802 ('long multiplication'), resulting in a number which may be as long as
4803 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004804
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004805 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004806 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004807 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004808 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004809 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004810 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004811 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004812 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004813 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004814 Decimal('4.28135971E+11')
Mark Dickinson84230a12010-02-18 14:49:50 +00004815 >>> ExtendedContext.multiply(7, 7)
4816 Decimal('49')
4817 >>> ExtendedContext.multiply(Decimal(7), 7)
4818 Decimal('49')
4819 >>> ExtendedContext.multiply(7, Decimal(7))
4820 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004821 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004822 a = _convert_other(a, raiseit=True)
4823 r = a.__mul__(b, context=self)
4824 if r is NotImplemented:
4825 raise TypeError("Unable to convert %s to Decimal" % b)
4826 else:
4827 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004828
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004829 def next_minus(self, a):
4830 """Returns the largest representable number smaller than a.
4831
4832 >>> c = ExtendedContext.copy()
4833 >>> c.Emin = -999
4834 >>> c.Emax = 999
4835 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004836 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004837 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004838 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004839 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004840 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004841 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004842 Decimal('9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004843 >>> c.next_minus(1)
4844 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004845 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004846 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004847 return a.next_minus(context=self)
4848
4849 def next_plus(self, a):
4850 """Returns the smallest representable number larger than a.
4851
4852 >>> c = ExtendedContext.copy()
4853 >>> c.Emin = -999
4854 >>> c.Emax = 999
4855 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004856 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004857 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004858 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004859 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004860 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004861 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004862 Decimal('-9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004863 >>> c.next_plus(1)
4864 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004865 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004866 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004867 return a.next_plus(context=self)
4868
4869 def next_toward(self, a, b):
4870 """Returns the number closest to a, in direction towards b.
4871
4872 The result is the closest representable number from the first
4873 operand (but not the first operand) that is in the direction
4874 towards the second operand, unless the operands have the same
4875 value.
4876
4877 >>> c = ExtendedContext.copy()
4878 >>> c.Emin = -999
4879 >>> c.Emax = 999
4880 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004881 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004882 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004883 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004884 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004885 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004886 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004887 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004888 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004889 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004890 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004891 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004892 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004893 Decimal('-0.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004894 >>> c.next_toward(0, 1)
4895 Decimal('1E-1007')
4896 >>> c.next_toward(Decimal(0), 1)
4897 Decimal('1E-1007')
4898 >>> c.next_toward(0, Decimal(1))
4899 Decimal('1E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004900 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004901 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004902 return a.next_toward(b, context=self)
4903
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004904 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004905 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004906
4907 Essentially a plus operation with all trailing zeros removed from the
4908 result.
4909
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004910 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004911 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004912 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004913 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004914 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004915 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004916 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004917 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004918 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004919 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004920 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004921 Decimal('0')
Mark Dickinson84230a12010-02-18 14:49:50 +00004922 >>> ExtendedContext.normalize(6)
4923 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004924 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004925 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004926 return a.normalize(context=self)
4927
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004928 def number_class(self, a):
4929 """Returns an indication of the class of the operand.
4930
4931 The class is one of the following strings:
4932 -sNaN
4933 -NaN
4934 -Infinity
4935 -Normal
4936 -Subnormal
4937 -Zero
4938 +Zero
4939 +Subnormal
4940 +Normal
4941 +Infinity
4942
4943 >>> c = Context(ExtendedContext)
4944 >>> c.Emin = -999
4945 >>> c.Emax = 999
4946 >>> c.number_class(Decimal('Infinity'))
4947 '+Infinity'
4948 >>> c.number_class(Decimal('1E-10'))
4949 '+Normal'
4950 >>> c.number_class(Decimal('2.50'))
4951 '+Normal'
4952 >>> c.number_class(Decimal('0.1E-999'))
4953 '+Subnormal'
4954 >>> c.number_class(Decimal('0'))
4955 '+Zero'
4956 >>> c.number_class(Decimal('-0'))
4957 '-Zero'
4958 >>> c.number_class(Decimal('-0.1E-999'))
4959 '-Subnormal'
4960 >>> c.number_class(Decimal('-1E-10'))
4961 '-Normal'
4962 >>> c.number_class(Decimal('-2.50'))
4963 '-Normal'
4964 >>> c.number_class(Decimal('-Infinity'))
4965 '-Infinity'
4966 >>> c.number_class(Decimal('NaN'))
4967 'NaN'
4968 >>> c.number_class(Decimal('-NaN'))
4969 'NaN'
4970 >>> c.number_class(Decimal('sNaN'))
4971 'sNaN'
Mark Dickinson84230a12010-02-18 14:49:50 +00004972 >>> c.number_class(123)
4973 '+Normal'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004974 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004975 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004976 return a.number_class(context=self)
4977
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004978 def plus(self, a):
4979 """Plus corresponds to unary prefix plus in Python.
4980
4981 The operation is evaluated using the same rules as add; the
4982 operation plus(a) is calculated as add('0', a) where the '0'
4983 has the same exponent as the operand.
4984
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004985 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004986 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004987 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004988 Decimal('-1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004989 >>> ExtendedContext.plus(-1)
4990 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004991 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004992 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004993 return a.__pos__(context=self)
4994
4995 def power(self, a, b, modulo=None):
4996 """Raises a to the power of b, to modulo if given.
4997
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004998 With two arguments, compute a**b. If a is negative then b
4999 must be integral. The result will be inexact unless b is
5000 integral and the result is finite and can be expressed exactly
5001 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005002
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005003 With three arguments, compute (a**b) % modulo. For the
5004 three argument form, the following restrictions on the
5005 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005006
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005007 - all three arguments must be integral
5008 - b must be nonnegative
5009 - at least one of a or b must be nonzero
5010 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005011
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005012 The result of pow(a, b, modulo) is identical to the result
5013 that would be obtained by computing (a**b) % modulo with
5014 unbounded precision, but is computed more efficiently. It is
5015 always exact.
5016
5017 >>> c = ExtendedContext.copy()
5018 >>> c.Emin = -999
5019 >>> c.Emax = 999
5020 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005021 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005022 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005023 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005024 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005025 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005026 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005027 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005028 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005029 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005030 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005031 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005032 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005033 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005034 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005035 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005036 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005037 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005038 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005039 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005040 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005041 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005042 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005043 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005044 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005045 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005046
5047 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005048 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005049 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005050 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005051 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005052 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005053 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005054 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005055 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005056 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005057 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005058 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005059 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005060 Decimal('1')
Mark Dickinson84230a12010-02-18 14:49:50 +00005061 >>> ExtendedContext.power(7, 7)
5062 Decimal('823543')
5063 >>> ExtendedContext.power(Decimal(7), 7)
5064 Decimal('823543')
5065 >>> ExtendedContext.power(7, Decimal(7), 2)
5066 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005067 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005068 a = _convert_other(a, raiseit=True)
5069 r = a.__pow__(b, modulo, context=self)
5070 if r is NotImplemented:
5071 raise TypeError("Unable to convert %s to Decimal" % b)
5072 else:
5073 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005074
5075 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005076 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005077
5078 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00005079 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005080 exponent is being increased), multiplied by a positive power of ten (if
5081 the exponent is being decreased), or is unchanged (if the exponent is
5082 already equal to that of the right-hand operand).
5083
5084 Unlike other operations, if the length of the coefficient after the
5085 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00005086 operation condition is raised. This guarantees that, unless there is
5087 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005088 equal to that of the right-hand operand.
5089
5090 Also unlike other operations, quantize will never raise Underflow, even
5091 if the result is subnormal and inexact.
5092
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005093 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005094 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005095 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005096 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005097 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005098 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005099 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005100 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005101 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005102 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005103 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005104 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005105 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005106 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005107 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005108 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005109 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005110 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005111 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005112 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005113 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005114 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005115 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005116 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005117 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005118 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005119 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005120 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005121 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005122 Decimal('2E+2')
Mark Dickinson84230a12010-02-18 14:49:50 +00005123 >>> ExtendedContext.quantize(1, 2)
5124 Decimal('1')
5125 >>> ExtendedContext.quantize(Decimal(1), 2)
5126 Decimal('1')
5127 >>> ExtendedContext.quantize(1, Decimal(2))
5128 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005129 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005130 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005131 return a.quantize(b, context=self)
5132
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005133 def radix(self):
5134 """Just returns 10, as this is Decimal, :)
5135
5136 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005137 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005138 """
5139 return Decimal(10)
5140
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005141 def remainder(self, a, b):
5142 """Returns the remainder from integer division.
5143
5144 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00005145 calculating integer division as described for divide-integer, rounded
5146 to precision digits if necessary. The sign of the result, if
5147 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005148
5149 This operation will fail under the same conditions as integer division
5150 (that is, if integer division on the same two operands would fail, the
5151 remainder cannot be calculated).
5152
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005153 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005154 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005155 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005156 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005157 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005158 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005159 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005160 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005161 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005162 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005163 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005164 Decimal('1.0')
Mark Dickinson84230a12010-02-18 14:49:50 +00005165 >>> ExtendedContext.remainder(22, 6)
5166 Decimal('4')
5167 >>> ExtendedContext.remainder(Decimal(22), 6)
5168 Decimal('4')
5169 >>> ExtendedContext.remainder(22, Decimal(6))
5170 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005171 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005172 a = _convert_other(a, raiseit=True)
5173 r = a.__mod__(b, context=self)
5174 if r is NotImplemented:
5175 raise TypeError("Unable to convert %s to Decimal" % b)
5176 else:
5177 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005178
5179 def remainder_near(self, a, b):
5180 """Returns to be "a - b * n", where n is the integer nearest the exact
5181 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00005182 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005183 sign of a.
5184
5185 This operation will fail under the same conditions as integer division
5186 (that is, if integer division on the same two operands would fail, the
5187 remainder cannot be calculated).
5188
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005189 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005190 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005191 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005192 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005193 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005194 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005195 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005196 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005197 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005198 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005199 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005200 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005201 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005202 Decimal('-0.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005203 >>> ExtendedContext.remainder_near(3, 11)
5204 Decimal('3')
5205 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5206 Decimal('3')
5207 >>> ExtendedContext.remainder_near(3, Decimal(11))
5208 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005209 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005210 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005211 return a.remainder_near(b, context=self)
5212
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005213 def rotate(self, a, b):
5214 """Returns a rotated copy of a, b times.
5215
5216 The coefficient of the result is a rotated copy of the digits in
5217 the coefficient of the first operand. The number of places of
5218 rotation is taken from the absolute value of the second operand,
5219 with the rotation being to the left if the second operand is
5220 positive or to the right otherwise.
5221
5222 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005223 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005224 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005225 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005226 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005227 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005228 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005229 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005230 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005231 Decimal('345678912')
Mark Dickinson84230a12010-02-18 14:49:50 +00005232 >>> ExtendedContext.rotate(1333333, 1)
5233 Decimal('13333330')
5234 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5235 Decimal('13333330')
5236 >>> ExtendedContext.rotate(1333333, Decimal(1))
5237 Decimal('13333330')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005238 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005239 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005240 return a.rotate(b, context=self)
5241
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005242 def same_quantum(self, a, b):
5243 """Returns True if the two operands have the same exponent.
5244
5245 The result is never affected by either the sign or the coefficient of
5246 either operand.
5247
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005248 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005249 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005250 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005251 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005252 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005253 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005254 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005255 True
Mark Dickinson84230a12010-02-18 14:49:50 +00005256 >>> ExtendedContext.same_quantum(10000, -1)
5257 True
5258 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5259 True
5260 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5261 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005262 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005263 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005264 return a.same_quantum(b)
5265
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005266 def scaleb (self, a, b):
5267 """Returns the first operand after adding the second value its exp.
5268
5269 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005270 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005271 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005272 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005273 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005274 Decimal('7.50E+3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005275 >>> ExtendedContext.scaleb(1, 4)
5276 Decimal('1E+4')
5277 >>> ExtendedContext.scaleb(Decimal(1), 4)
5278 Decimal('1E+4')
5279 >>> ExtendedContext.scaleb(1, Decimal(4))
5280 Decimal('1E+4')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005281 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005282 a = _convert_other(a, raiseit=True)
5283 return a.scaleb(b, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005284
5285 def shift(self, a, b):
5286 """Returns a shifted copy of a, b times.
5287
5288 The coefficient of the result is a shifted copy of the digits
5289 in the coefficient of the first operand. The number of places
5290 to shift is taken from the absolute value of the second operand,
5291 with the shift being to the left if the second operand is
5292 positive or to the right otherwise. Digits shifted into the
5293 coefficient are zeros.
5294
5295 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005296 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005297 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005298 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005299 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005300 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005301 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005302 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005303 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005304 Decimal('345678900')
Mark Dickinson84230a12010-02-18 14:49:50 +00005305 >>> ExtendedContext.shift(88888888, 2)
5306 Decimal('888888800')
5307 >>> ExtendedContext.shift(Decimal(88888888), 2)
5308 Decimal('888888800')
5309 >>> ExtendedContext.shift(88888888, Decimal(2))
5310 Decimal('888888800')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005311 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005312 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005313 return a.shift(b, context=self)
5314
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005315 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005316 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005317
5318 If the result must be inexact, it is rounded using the round-half-even
5319 algorithm.
5320
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005321 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005322 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005323 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005324 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005325 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005326 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005327 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005328 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005329 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005330 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005331 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005332 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005333 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005334 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005335 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005336 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005337 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005338 Decimal('3.16227766')
Mark Dickinson84230a12010-02-18 14:49:50 +00005339 >>> ExtendedContext.sqrt(2)
5340 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005341 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005342 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005343 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005344 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005345 return a.sqrt(context=self)
5346
5347 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005348 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005349
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005350 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005351 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005352 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005353 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005354 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005355 Decimal('-0.77')
Mark Dickinson84230a12010-02-18 14:49:50 +00005356 >>> ExtendedContext.subtract(8, 5)
5357 Decimal('3')
5358 >>> ExtendedContext.subtract(Decimal(8), 5)
5359 Decimal('3')
5360 >>> ExtendedContext.subtract(8, Decimal(5))
5361 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005362 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005363 a = _convert_other(a, raiseit=True)
5364 r = a.__sub__(b, context=self)
5365 if r is NotImplemented:
5366 raise TypeError("Unable to convert %s to Decimal" % b)
5367 else:
5368 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005369
5370 def to_eng_string(self, a):
5371 """Converts a number to a string, using scientific notation.
5372
5373 The operation is not affected by the context.
5374 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005375 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005376 return a.to_eng_string(context=self)
5377
5378 def to_sci_string(self, a):
5379 """Converts a number to a string, using scientific notation.
5380
5381 The operation is not affected by the context.
5382 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005383 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005384 return a.__str__(context=self)
5385
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005386 def to_integral_exact(self, a):
5387 """Rounds to an integer.
5388
5389 When the operand has a negative exponent, the result is the same
5390 as using the quantize() operation using the given operand as the
5391 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5392 of the operand as the precision setting; Inexact and Rounded flags
5393 are allowed in this operation. The rounding mode is taken from the
5394 context.
5395
5396 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005397 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005398 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005399 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005400 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005401 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005402 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005403 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005404 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005405 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005406 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005407 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005408 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005409 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005410 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005411 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005412 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005413 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005414 return a.to_integral_exact(context=self)
5415
5416 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005417 """Rounds to an integer.
5418
5419 When the operand has a negative exponent, the result is the same
5420 as using the quantize() operation using the given operand as the
5421 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5422 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00005423 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005424
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005425 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005426 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005427 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005428 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005429 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005430 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005431 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005432 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005433 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005434 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005435 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005436 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005437 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005438 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005439 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005440 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005441 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005442 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005443 return a.to_integral_value(context=self)
5444
5445 # the method name changed, but we provide also the old one, for compatibility
5446 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005447
5448class _WorkRep(object):
5449 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005450 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005451 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005452 # exp: None, int, or string
5453
5454 def __init__(self, value=None):
5455 if value is None:
5456 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005457 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005458 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005459 elif isinstance(value, Decimal):
5460 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005461 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005462 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005463 else:
5464 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005465 self.sign = value[0]
5466 self.int = value[1]
5467 self.exp = value[2]
5468
5469 def __repr__(self):
5470 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5471
5472 __str__ = __repr__
5473
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005474
5475
Christian Heimes2c181612007-12-17 20:04:13 +00005476def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005477 """Normalizes op1, op2 to have the same exp and length of coefficient.
5478
5479 Done during addition.
5480 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005481 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005482 tmp = op2
5483 other = op1
5484 else:
5485 tmp = op1
5486 other = op2
5487
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005488 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5489 # Then adding 10**exp to tmp has the same effect (after rounding)
5490 # as adding any positive quantity smaller than 10**exp; similarly
5491 # for subtraction. So if other is smaller than 10**exp we replace
5492 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00005493 tmp_len = len(str(tmp.int))
5494 other_len = len(str(other.int))
5495 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5496 if other_len + other.exp - 1 < exp:
5497 other.int = 1
5498 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005499
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005500 tmp.int *= 10 ** (tmp.exp - other.exp)
5501 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005502 return op1, op2
5503
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005504##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005505
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005506# This function from Tim Peters was taken from here:
5507# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5508# The correction being in the function definition is for speed, and
5509# the whole function is not resolved with math.log because of avoiding
5510# the use of floats.
5511def _nbits(n, correction = {
5512 '0': 4, '1': 3, '2': 2, '3': 2,
5513 '4': 1, '5': 1, '6': 1, '7': 1,
5514 '8': 0, '9': 0, 'a': 0, 'b': 0,
5515 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5516 """Number of bits in binary representation of the positive integer n,
5517 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005518 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005519 if n < 0:
5520 raise ValueError("The argument to _nbits should be nonnegative.")
5521 hex_n = "%x" % n
5522 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005523
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005524def _sqrt_nearest(n, a):
5525 """Closest integer to the square root of the positive integer n. a is
5526 an initial approximation to the square root. Any positive integer
5527 will do for a, but the closer a is to the square root of n the
5528 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005529
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005530 """
5531 if n <= 0 or a <= 0:
5532 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5533
5534 b=0
5535 while a != b:
5536 b, a = a, a--n//a>>1
5537 return a
5538
5539def _rshift_nearest(x, shift):
5540 """Given an integer x and a nonnegative integer shift, return closest
5541 integer to x / 2**shift; use round-to-even in case of a tie.
5542
5543 """
5544 b, q = 1 << shift, x >> shift
5545 return q + (2*(x & (b-1)) + (q&1) > b)
5546
5547def _div_nearest(a, b):
5548 """Closest integer to a/b, a and b positive integers; rounds to even
5549 in the case of a tie.
5550
5551 """
5552 q, r = divmod(a, b)
5553 return q + (2*r + (q&1) > b)
5554
5555def _ilog(x, M, L = 8):
5556 """Integer approximation to M*log(x/M), with absolute error boundable
5557 in terms only of x/M.
5558
5559 Given positive integers x and M, return an integer approximation to
5560 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5561 between the approximation and the exact result is at most 22. For
5562 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5563 both cases these are upper bounds on the error; it will usually be
5564 much smaller."""
5565
5566 # The basic algorithm is the following: let log1p be the function
5567 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5568 # the reduction
5569 #
5570 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5571 #
5572 # repeatedly until the argument to log1p is small (< 2**-L in
5573 # absolute value). For small y we can use the Taylor series
5574 # expansion
5575 #
5576 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5577 #
5578 # truncating at T such that y**T is small enough. The whole
5579 # computation is carried out in a form of fixed-point arithmetic,
5580 # with a real number z being represented by an integer
5581 # approximation to z*M. To avoid loss of precision, the y below
5582 # is actually an integer approximation to 2**R*y*M, where R is the
5583 # number of reductions performed so far.
5584
5585 y = x-M
5586 # argument reduction; R = number of reductions performed
5587 R = 0
5588 while (R <= L and abs(y) << L-R >= M or
5589 R > L and abs(y) >> R-L >= M):
5590 y = _div_nearest((M*y) << 1,
5591 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5592 R += 1
5593
5594 # Taylor series with T terms
5595 T = -int(-10*len(str(M))//(3*L))
5596 yshift = _rshift_nearest(y, R)
5597 w = _div_nearest(M, T)
5598 for k in range(T-1, 0, -1):
5599 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5600
5601 return _div_nearest(w*y, M)
5602
5603def _dlog10(c, e, p):
5604 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5605 approximation to 10**p * log10(c*10**e), with an absolute error of
5606 at most 1. Assumes that c*10**e is not exactly 1."""
5607
5608 # increase precision by 2; compensate for this by dividing
5609 # final result by 100
5610 p += 2
5611
5612 # write c*10**e as d*10**f with either:
5613 # f >= 0 and 1 <= d <= 10, or
5614 # f <= 0 and 0.1 <= d <= 1.
5615 # Thus for c*10**e close to 1, f = 0
5616 l = len(str(c))
5617 f = e+l - (e+l >= 1)
5618
5619 if p > 0:
5620 M = 10**p
5621 k = e+p-f
5622 if k >= 0:
5623 c *= 10**k
5624 else:
5625 c = _div_nearest(c, 10**-k)
5626
5627 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005628 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005629 log_d = _div_nearest(log_d*M, log_10)
5630 log_tenpower = f*M # exact
5631 else:
5632 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005633 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005634
5635 return _div_nearest(log_tenpower+log_d, 100)
5636
5637def _dlog(c, e, p):
5638 """Given integers c, e and p with c > 0, compute an integer
5639 approximation to 10**p * log(c*10**e), with an absolute error of
5640 at most 1. Assumes that c*10**e is not exactly 1."""
5641
5642 # Increase precision by 2. The precision increase is compensated
5643 # for at the end with a division by 100.
5644 p += 2
5645
5646 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5647 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5648 # as 10**p * log(d) + 10**p*f * log(10).
5649 l = len(str(c))
5650 f = e+l - (e+l >= 1)
5651
5652 # compute approximation to 10**p*log(d), with error < 27
5653 if p > 0:
5654 k = e+p-f
5655 if k >= 0:
5656 c *= 10**k
5657 else:
5658 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5659
5660 # _ilog magnifies existing error in c by a factor of at most 10
5661 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5662 else:
5663 # p <= 0: just approximate the whole thing by 0; error < 2.31
5664 log_d = 0
5665
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005666 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005667 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005668 extra = len(str(abs(f)))-1
5669 if p + extra >= 0:
5670 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5671 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5672 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005673 else:
5674 f_log_ten = 0
5675 else:
5676 f_log_ten = 0
5677
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005678 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005679 return _div_nearest(f_log_ten + log_d, 100)
5680
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005681class _Log10Memoize(object):
5682 """Class to compute, store, and allow retrieval of, digits of the
5683 constant log(10) = 2.302585.... This constant is needed by
5684 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5685 def __init__(self):
5686 self.digits = "23025850929940456840179914546843642076011014886"
5687
5688 def getdigits(self, p):
5689 """Given an integer p >= 0, return floor(10**p)*log(10).
5690
5691 For example, self.getdigits(3) returns 2302.
5692 """
5693 # digits are stored as a string, for quick conversion to
5694 # integer in the case that we've already computed enough
5695 # digits; the stored digits should always be correct
5696 # (truncated, not rounded to nearest).
5697 if p < 0:
5698 raise ValueError("p should be nonnegative")
5699
5700 if p >= len(self.digits):
5701 # compute p+3, p+6, p+9, ... digits; continue until at
5702 # least one of the extra digits is nonzero
5703 extra = 3
5704 while True:
5705 # compute p+extra digits, correct to within 1ulp
5706 M = 10**(p+extra+2)
5707 digits = str(_div_nearest(_ilog(10*M, M), 100))
5708 if digits[-extra:] != '0'*extra:
5709 break
5710 extra += 3
5711 # keep all reliable digits so far; remove trailing zeros
5712 # and next nonzero digit
5713 self.digits = digits.rstrip('0')[:-1]
5714 return int(self.digits[:p+1])
5715
5716_log10_digits = _Log10Memoize().getdigits
5717
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005718def _iexp(x, M, L=8):
5719 """Given integers x and M, M > 0, such that x/M is small in absolute
5720 value, compute an integer approximation to M*exp(x/M). For 0 <=
5721 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5722 is usually much smaller)."""
5723
5724 # Algorithm: to compute exp(z) for a real number z, first divide z
5725 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5726 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5727 # series
5728 #
5729 # expm1(x) = x + x**2/2! + x**3/3! + ...
5730 #
5731 # Now use the identity
5732 #
5733 # expm1(2x) = expm1(x)*(expm1(x)+2)
5734 #
5735 # R times to compute the sequence expm1(z/2**R),
5736 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5737
5738 # Find R such that x/2**R/M <= 2**-L
5739 R = _nbits((x<<L)//M)
5740
5741 # Taylor series. (2**L)**T > M
5742 T = -int(-10*len(str(M))//(3*L))
5743 y = _div_nearest(x, T)
5744 Mshift = M<<R
5745 for i in range(T-1, 0, -1):
5746 y = _div_nearest(x*(Mshift + y), Mshift * i)
5747
5748 # Expansion
5749 for k in range(R-1, -1, -1):
5750 Mshift = M<<(k+2)
5751 y = _div_nearest(y*(y+Mshift), Mshift)
5752
5753 return M+y
5754
5755def _dexp(c, e, p):
5756 """Compute an approximation to exp(c*10**e), with p decimal places of
5757 precision.
5758
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005759 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005760
5761 10**(p-1) <= d <= 10**p, and
5762 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5763
5764 In other words, d*10**f is an approximation to exp(c*10**e) with p
5765 digits of precision, and with an error in d of at most 1. This is
5766 almost, but not quite, the same as the error being < 1ulp: when d
5767 = 10**(p-1) the error could be up to 10 ulp."""
5768
5769 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5770 p += 2
5771
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005772 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005773 extra = max(0, e + len(str(c)) - 1)
5774 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005775
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005776 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005777 # rounding down
5778 shift = e+q
5779 if shift >= 0:
5780 cshift = c*10**shift
5781 else:
5782 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005783 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005784
5785 # reduce remainder back to original precision
5786 rem = _div_nearest(rem, 10**extra)
5787
5788 # error in result of _iexp < 120; error after division < 0.62
5789 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5790
5791def _dpower(xc, xe, yc, ye, p):
5792 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5793 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5794
5795 10**(p-1) <= c <= 10**p, and
5796 (c-1)*10**e < x**y < (c+1)*10**e
5797
5798 in other words, c*10**e is an approximation to x**y with p digits
5799 of precision, and with an error in c of at most 1. (This is
5800 almost, but not quite, the same as the error being < 1ulp: when c
5801 == 10**(p-1) we can only guarantee error < 10ulp.)
5802
5803 We assume that: x is positive and not equal to 1, and y is nonzero.
5804 """
5805
5806 # Find b such that 10**(b-1) <= |y| <= 10**b
5807 b = len(str(abs(yc))) + ye
5808
5809 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5810 lxc = _dlog(xc, xe, p+b+1)
5811
5812 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5813 shift = ye-b
5814 if shift >= 0:
5815 pc = lxc*yc*10**shift
5816 else:
5817 pc = _div_nearest(lxc*yc, 10**-shift)
5818
5819 if pc == 0:
5820 # we prefer a result that isn't exactly 1; this makes it
5821 # easier to compute a correctly rounded result in __pow__
5822 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5823 coeff, exp = 10**(p-1)+1, 1-p
5824 else:
5825 coeff, exp = 10**p-1, -p
5826 else:
5827 coeff, exp = _dexp(pc, -(p+1), p+1)
5828 coeff = _div_nearest(coeff, 10)
5829 exp += 1
5830
5831 return coeff, exp
5832
5833def _log10_lb(c, correction = {
5834 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5835 '6': 23, '7': 16, '8': 10, '9': 5}):
5836 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5837 if c <= 0:
5838 raise ValueError("The argument to _log10_lb should be nonnegative.")
5839 str_c = str(c)
5840 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005841
Guido van Rossumd8faa362007-04-27 19:54:29 +00005842##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005843
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005844def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005845 """Convert other to Decimal.
5846
5847 Verifies that it's ok to use in an implicit construction.
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005848 If allow_float is true, allow conversion from float; this
5849 is used in the comparison methods (__eq__ and friends).
5850
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005851 """
5852 if isinstance(other, Decimal):
5853 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005854 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005855 return Decimal(other)
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005856 if allow_float and isinstance(other, float):
5857 return Decimal.from_float(other)
5858
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005859 if raiseit:
5860 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005861 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005862
Guido van Rossumd8faa362007-04-27 19:54:29 +00005863##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005864
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005865# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005866# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005867
5868DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005869 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005870 traps=[DivisionByZero, Overflow, InvalidOperation],
5871 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005872 Emax=999999999,
5873 Emin=-999999999,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00005874 capitals=1,
5875 clamp=0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005876)
5877
5878# Pre-made alternate contexts offered by the specification
5879# Don't change these; the user should be able to select these
5880# contexts and be able to reproduce results from other implementations
5881# of the spec.
5882
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005883BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005884 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005885 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5886 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005887)
5888
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005889ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005890 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005891 traps=[],
5892 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005893)
5894
5895
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005896##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005897#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005898# Regular expression used for parsing numeric strings. Additional
5899# comments:
5900#
5901# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5902# whitespace. But note that the specification disallows whitespace in
5903# a numeric string.
5904#
5905# 2. For finite numbers (not infinities and NaNs) the body of the
5906# number between the optional sign and the optional exponent must have
5907# at least one decimal digit, possibly after the decimal point. The
Mark Dickinson345adc42009-08-02 10:14:23 +00005908# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005909
5910import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005911_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005912# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005913 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005914 (
Mark Dickinson345adc42009-08-02 10:14:23 +00005915 (?=\d|\.\d) # ...a number (with at least one digit)
5916 (?P<int>\d*) # having a (possibly empty) integer part
5917 (\.(?P<frac>\d*))? # followed by an optional fractional part
5918 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005919 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005920 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005921 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005922 (?P<signal>s)? # ...an (optionally signaling)
5923 NaN # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +00005924 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005925 )
5926# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005927 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005928""", re.VERBOSE | re.IGNORECASE).match
5929
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005930_all_zeros = re.compile('0*$').match
5931_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005932
5933##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005934# The functions in this section have little to do with the Decimal
5935# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005936# Python numeric classes that want to implement __format__
5937#
5938# A format specifier for Decimal looks like:
5939#
Mark Dickinson79f52032009-03-17 23:12:51 +00005940# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005941
5942_parse_format_specifier_regex = re.compile(r"""\A
5943(?:
5944 (?P<fill>.)?
5945 (?P<align>[<>=^])
5946)?
5947(?P<sign>[-+ ])?
5948(?P<zeropad>0)?
5949(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00005950(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005951(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00005952(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005953\Z
5954""", re.VERBOSE)
5955
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005956del re
5957
Mark Dickinson79f52032009-03-17 23:12:51 +00005958# The locale module is only needed for the 'n' format specifier. The
5959# rest of the PEP 3101 code functions quite happily without it, so we
5960# don't care too much if locale isn't present.
5961try:
5962 import locale as _locale
5963except ImportError:
5964 pass
5965
5966def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00005967 """Parse and validate a format specifier.
5968
5969 Turns a standard numeric format specifier into a dict, with the
5970 following entries:
5971
5972 fill: fill character to pad field to minimum width
5973 align: alignment type, either '<', '>', '=' or '^'
5974 sign: either '+', '-' or ' '
5975 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00005976 zeropad: boolean, indicating whether to pad with zeros
5977 thousands_sep: string to use as thousands separator, or ''
5978 grouping: grouping for thousands separators, in format
5979 used by localeconv
5980 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00005981 precision: nonnegative integer giving precision, or None
5982 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00005983
5984 """
5985 m = _parse_format_specifier_regex.match(format_spec)
5986 if m is None:
5987 raise ValueError("Invalid format specifier: " + format_spec)
5988
5989 # get the dictionary
5990 format_dict = m.groupdict()
5991
Mark Dickinson79f52032009-03-17 23:12:51 +00005992 # zeropad; defaults for fill and alignment. If zero padding
5993 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00005994 fill = format_dict['fill']
5995 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00005996 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5997 if format_dict['zeropad']:
5998 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005999 raise ValueError("Fill character conflicts with '0'"
6000 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00006001 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006002 raise ValueError("Alignment conflicts with '0' in "
6003 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00006004 format_dict['fill'] = fill or ' '
Mark Dickinson46ab5d02009-09-08 20:22:46 +00006005 # PEP 3101 originally specified that the default alignment should
6006 # be left; it was later agreed that right-aligned makes more sense
6007 # for numeric types. See http://bugs.python.org/issue6857.
6008 format_dict['align'] = align or '>'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006009
Mark Dickinson79f52032009-03-17 23:12:51 +00006010 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00006011 if format_dict['sign'] is None:
6012 format_dict['sign'] = '-'
6013
Christian Heimesf16baeb2008-02-29 14:57:44 +00006014 # minimumwidth defaults to 0; precision remains None if not given
6015 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
6016 if format_dict['precision'] is not None:
6017 format_dict['precision'] = int(format_dict['precision'])
6018
6019 # if format type is 'g' or 'G' then a precision of 0 makes little
6020 # sense; convert it to 1. Same if format type is unspecified.
6021 if format_dict['precision'] == 0:
Mark Dickinson7718d2b2009-09-07 16:21:56 +00006022 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006023 format_dict['precision'] = 1
6024
Mark Dickinson79f52032009-03-17 23:12:51 +00006025 # determine thousands separator, grouping, and decimal separator, and
6026 # add appropriate entries to format_dict
6027 if format_dict['type'] == 'n':
6028 # apart from separators, 'n' behaves just like 'g'
6029 format_dict['type'] = 'g'
6030 if _localeconv is None:
6031 _localeconv = _locale.localeconv()
6032 if format_dict['thousands_sep'] is not None:
6033 raise ValueError("Explicit thousands separator conflicts with "
6034 "'n' type in format specifier: " + format_spec)
6035 format_dict['thousands_sep'] = _localeconv['thousands_sep']
6036 format_dict['grouping'] = _localeconv['grouping']
6037 format_dict['decimal_point'] = _localeconv['decimal_point']
6038 else:
6039 if format_dict['thousands_sep'] is None:
6040 format_dict['thousands_sep'] = ''
6041 format_dict['grouping'] = [3, 0]
6042 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006043
6044 return format_dict
6045
Mark Dickinson79f52032009-03-17 23:12:51 +00006046def _format_align(sign, body, spec):
6047 """Given an unpadded, non-aligned numeric string 'body' and sign
6048 string 'sign', add padding and aligment conforming to the given
6049 format specifier dictionary 'spec' (as produced by
6050 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00006051
6052 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00006053 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00006054 minimumwidth = spec['minimumwidth']
6055 fill = spec['fill']
6056 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00006057
Mark Dickinson79f52032009-03-17 23:12:51 +00006058 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00006059 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006060 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00006061 elif align == '>':
6062 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00006063 elif align == '=':
6064 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00006065 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006066 half = len(padding)//2
6067 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00006068 else:
6069 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00006070
Christian Heimesf16baeb2008-02-29 14:57:44 +00006071 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00006072
Mark Dickinson79f52032009-03-17 23:12:51 +00006073def _group_lengths(grouping):
6074 """Convert a localeconv-style grouping into a (possibly infinite)
6075 iterable of integers representing group lengths.
6076
6077 """
6078 # The result from localeconv()['grouping'], and the input to this
6079 # function, should be a list of integers in one of the
6080 # following three forms:
6081 #
6082 # (1) an empty list, or
6083 # (2) nonempty list of positive integers + [0]
6084 # (3) list of positive integers + [locale.CHAR_MAX], or
6085
6086 from itertools import chain, repeat
6087 if not grouping:
6088 return []
6089 elif grouping[-1] == 0 and len(grouping) >= 2:
6090 return chain(grouping[:-1], repeat(grouping[-2]))
6091 elif grouping[-1] == _locale.CHAR_MAX:
6092 return grouping[:-1]
6093 else:
6094 raise ValueError('unrecognised format for grouping')
6095
6096def _insert_thousands_sep(digits, spec, min_width=1):
6097 """Insert thousands separators into a digit string.
6098
6099 spec is a dictionary whose keys should include 'thousands_sep' and
6100 'grouping'; typically it's the result of parsing the format
6101 specifier using _parse_format_specifier.
6102
6103 The min_width keyword argument gives the minimum length of the
6104 result, which will be padded on the left with zeros if necessary.
6105
6106 If necessary, the zero padding adds an extra '0' on the left to
6107 avoid a leading thousands separator. For example, inserting
6108 commas every three digits in '123456', with min_width=8, gives
6109 '0,123,456', even though that has length 9.
6110
6111 """
6112
6113 sep = spec['thousands_sep']
6114 grouping = spec['grouping']
6115
6116 groups = []
6117 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00006118 if l <= 0:
6119 raise ValueError("group length should be positive")
6120 # max(..., 1) forces at least 1 digit to the left of a separator
6121 l = min(max(len(digits), min_width, 1), l)
6122 groups.append('0'*(l - len(digits)) + digits[-l:])
6123 digits = digits[:-l]
6124 min_width -= l
6125 if not digits and min_width <= 0:
6126 break
Mark Dickinson7303b592009-03-18 08:25:36 +00006127 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00006128 else:
6129 l = max(len(digits), min_width, 1)
6130 groups.append('0'*(l - len(digits)) + digits[-l:])
6131 return sep.join(reversed(groups))
6132
6133def _format_sign(is_negative, spec):
6134 """Determine sign character."""
6135
6136 if is_negative:
6137 return '-'
6138 elif spec['sign'] in ' +':
6139 return spec['sign']
6140 else:
6141 return ''
6142
6143def _format_number(is_negative, intpart, fracpart, exp, spec):
6144 """Format a number, given the following data:
6145
6146 is_negative: true if the number is negative, else false
6147 intpart: string of digits that must appear before the decimal point
6148 fracpart: string of digits that must come after the point
6149 exp: exponent, as an integer
6150 spec: dictionary resulting from parsing the format specifier
6151
6152 This function uses the information in spec to:
6153 insert separators (decimal separator and thousands separators)
6154 format the sign
6155 format the exponent
6156 add trailing '%' for the '%' type
6157 zero-pad if necessary
6158 fill and align if necessary
6159 """
6160
6161 sign = _format_sign(is_negative, spec)
6162
6163 if fracpart:
6164 fracpart = spec['decimal_point'] + fracpart
6165
6166 if exp != 0 or spec['type'] in 'eE':
6167 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6168 fracpart += "{0}{1:+}".format(echar, exp)
6169 if spec['type'] == '%':
6170 fracpart += '%'
6171
6172 if spec['zeropad']:
6173 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6174 else:
6175 min_width = 0
6176 intpart = _insert_thousands_sep(intpart, spec, min_width)
6177
6178 return _format_align(sign, intpart+fracpart, spec)
6179
6180
Guido van Rossumd8faa362007-04-27 19:54:29 +00006181##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006182
Guido van Rossumd8faa362007-04-27 19:54:29 +00006183# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006184_Infinity = Decimal('Inf')
6185_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00006186_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006187_Zero = Decimal(0)
6188_One = Decimal(1)
6189_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006190
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006191# _SignedInfinity[sign] is infinity w/ that sign
6192_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006193
Mark Dickinsondc787d22010-05-23 13:33:13 +00006194# Constants related to the hash implementation; hash(x) is based
6195# on the reduction of x modulo _PyHASH_MODULUS
6196import sys
6197_PyHASH_MODULUS = sys.hash_info.modulus
6198# hash values to use for positive and negative infinities, and nans
6199_PyHASH_INF = sys.hash_info.inf
6200_PyHASH_NAN = sys.hash_info.nan
6201del sys
6202
6203# _PyHASH_10INV is the inverse of 10 modulo the prime _PyHASH_MODULUS
6204_PyHASH_10INV = pow(10, _PyHASH_MODULUS - 2, _PyHASH_MODULUS)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006205
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006206
6207if __name__ == '__main__':
6208 import doctest, sys
6209 doctest.testmod(sys.modules[__name__])