blob: 478ee472b214a8cb58e74839c8beba5e36380edf [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
Raymond Hettinger27dbcf22004-08-19 22:39:55 +000010# This module is currently Py2.3 compatible and should be kept that way
11# unless a major compelling advantage arises. IOW, 2.3 compatibility is
12# strongly preferred, but not guaranteed.
13
14# Also, this module should be kept in sync with the latest updates of
15# the IBM specification as it evolves. Those updates will be treated
16# as bug fixes (deviation from the spec is a compatibility, usability
17# bug) and will be backported. At this point the spec is stabilizing
18# and the updates are becoming fewer, smaller, and less significant.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000019
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000020"""
21This is a Py2.3 implementation of decimal floating point arithmetic based on
22the General Decimal Arithmetic Specification:
23
24 www2.hursley.ibm.com/decimal/decarith.html
25
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000026and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000027
28 www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html
29
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030Decimal floating point has finite precision with arbitrarily large bounds.
31
Facundo Batista59c58842007-04-10 12:58:45 +000032The purpose of this module is to support arithmetic using familiar
33"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000034issues associated with binary floating point. The package is especially
35useful for financial applications or for contexts where users have
36expectations that are at odds with binary floating point (for instance,
37in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Raymond Hettingerabe32372008-02-14 02:41:22 +000038of the expected Decimal('0.00') returned by decimal floating point).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000039
40Here are some examples of using the decimal module:
41
42>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000043>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000044>>> Decimal(0)
Raymond Hettingerabe32372008-02-14 02:41:22 +000045Decimal('0')
46>>> Decimal('1')
47Decimal('1')
48>>> Decimal('-.0123')
49Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000050>>> Decimal(123456)
Raymond Hettingerabe32372008-02-14 02:41:22 +000051Decimal('123456')
52>>> Decimal('123.45e12345678901234567890')
53Decimal('1.2345E+12345678901234567892')
54>>> Decimal('1.33') + Decimal('1.27')
55Decimal('2.60')
56>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
57Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000058>>> dig = Decimal(1)
59>>> print dig / Decimal(3)
600.333333333
61>>> getcontext().prec = 18
62>>> print dig / Decimal(3)
630.333333333333333333
64>>> print dig.sqrt()
651
66>>> print Decimal(3).sqrt()
671.73205080756887729
68>>> print Decimal(3) ** 123
694.85192780976896427E+58
70>>> inf = Decimal(1) / Decimal(0)
71>>> print inf
72Infinity
73>>> neginf = Decimal(-1) / Decimal(0)
74>>> print neginf
75-Infinity
76>>> print neginf + inf
77NaN
78>>> print neginf * inf
79-Infinity
80>>> print dig / 0
81Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000082>>> getcontext().traps[DivisionByZero] = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000083>>> print dig / 0
84Traceback (most recent call last):
85 ...
86 ...
87 ...
88DivisionByZero: x / 0
89>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000090>>> c.traps[InvalidOperation] = 0
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000091>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
93>>> c.divide(Decimal(0), Decimal(0))
Raymond Hettingerabe32372008-02-14 02:41:22 +000094Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000095>>> c.traps[InvalidOperation] = 1
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000096>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000971
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000098>>> c.flags[InvalidOperation] = 0
99>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000
101>>> print c.divide(Decimal(0), Decimal(0))
102Traceback (most recent call last):
103 ...
104 ...
105 ...
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000106InvalidOperation: 0 / 0
107>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001081
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000109>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000110>>> c.traps[InvalidOperation] = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000111>>> print c.divide(Decimal(0), Decimal(0))
112NaN
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000113>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001141
115>>>
116"""
117
118__all__ = [
119 # Two major classes
120 'Decimal', 'Context',
121
122 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000123 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000124
125 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000126 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
127 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000128
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000129 # Constants for use in setting up contexts
130 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Facundo Batista353750c2007-09-13 18:13:15 +0000131 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000132
133 # Functions for manipulating contexts
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000134 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000135]
136
Raymond Hettingereb260842005-06-07 18:52:34 +0000137import copy as _copy
Raymond Hettinger45fd4762009-02-03 03:42:07 +0000138import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000139
Raymond Hettinger097a1902008-01-11 02:24:13 +0000140try:
141 from collections import namedtuple as _namedtuple
142 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
143except ImportError:
144 DecimalTuple = lambda *args: args
145
Facundo Batista59c58842007-04-10 12:58:45 +0000146# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000147ROUND_DOWN = 'ROUND_DOWN'
148ROUND_HALF_UP = 'ROUND_HALF_UP'
149ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
150ROUND_CEILING = 'ROUND_CEILING'
151ROUND_FLOOR = 'ROUND_FLOOR'
152ROUND_UP = 'ROUND_UP'
153ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Facundo Batista353750c2007-09-13 18:13:15 +0000154ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000155
Facundo Batista59c58842007-04-10 12:58:45 +0000156# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000157
158class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000159 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000160
161 Used exceptions derive from this.
162 If an exception derives from another exception besides this (such as
163 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
164 called if the others are present. This isn't actually used for
165 anything, though.
166
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000167 handle -- Called when context._raise_error is called and the
168 trap_enabler is set. First argument is self, second is the
169 context. More arguments can be given, those being after
170 the explanation in _raise_error (For example,
171 context._raise_error(NewError, '(-x)!', self._sign) would
172 call NewError().handle(context, self._sign).)
173
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000174 To define a new exception, it should be sufficient to have it derive
175 from DecimalException.
176 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000177 def handle(self, context, *args):
178 pass
179
180
181class Clamped(DecimalException):
182 """Exponent of a 0 changed to fit bounds.
183
184 This occurs and signals clamped if the exponent of a result has been
185 altered in order to fit the constraints of a specific concrete
Facundo Batista59c58842007-04-10 12:58:45 +0000186 representation. This may occur when the exponent of a zero result would
187 be outside the bounds of a representation, or when a large normal
188 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000189 this latter case, the exponent is reduced to fit and the corresponding
190 number of zero digits are appended to the coefficient ("fold-down").
191 """
192
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000193class InvalidOperation(DecimalException):
194 """An invalid operation was performed.
195
196 Various bad things cause this:
197
198 Something creates a signaling NaN
199 -INF + INF
Facundo Batista59c58842007-04-10 12:58:45 +0000200 0 * (+-)INF
201 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000202 x % 0
203 (+-)INF % x
204 x._rescale( non-integer )
205 sqrt(-x) , x > 0
206 0 ** 0
207 x ** (non-integer)
208 x ** (+-)INF
209 An operand is invalid
Facundo Batista353750c2007-09-13 18:13:15 +0000210
211 The result of the operation after these is a quiet positive NaN,
212 except when the cause is a signaling NaN, in which case the result is
213 also a quiet NaN, but with the original sign, and an optional
214 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000215 """
216 def handle(self, context, *args):
217 if args:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000218 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
219 return ans._fix_nan(context)
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000220 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000221
222class ConversionSyntax(InvalidOperation):
223 """Trying to convert badly formed string.
224
225 This occurs and signals invalid-operation if an string is being
226 converted to a number and it does not conform to the numeric string
Facundo Batista59c58842007-04-10 12:58:45 +0000227 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000228 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000229 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000230 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000231
232class DivisionByZero(DecimalException, ZeroDivisionError):
233 """Division by 0.
234
235 This occurs and signals division-by-zero if division of a finite number
236 by zero was attempted (during a divide-integer or divide operation, or a
237 power operation with negative right-hand operand), and the dividend was
238 not zero.
239
240 The result of the operation is [sign,inf], where sign is the exclusive
241 or of the signs of the operands for divide, or is 1 for an odd power of
242 -0, for power.
243 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000244
Facundo Batistacce8df22007-09-18 16:53:18 +0000245 def handle(self, context, sign, *args):
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000246 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000247
248class DivisionImpossible(InvalidOperation):
249 """Cannot perform the division adequately.
250
251 This occurs and signals invalid-operation if the integer result of a
252 divide-integer or remainder operation had too many digits (would be
Facundo Batista59c58842007-04-10 12:58:45 +0000253 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000254 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000255
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000256 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000257 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000258
259class DivisionUndefined(InvalidOperation, ZeroDivisionError):
260 """Undefined result of division.
261
262 This occurs and signals invalid-operation if division by zero was
263 attempted (during a divide-integer, divide, or remainder operation), and
Facundo Batista59c58842007-04-10 12:58:45 +0000264 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000265 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000266
Facundo Batistacce8df22007-09-18 16:53:18 +0000267 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000268 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000269
270class Inexact(DecimalException):
271 """Had to round, losing information.
272
273 This occurs and signals inexact whenever the result of an operation is
274 not exact (that is, it needed to be rounded and any discarded digits
Facundo Batista59c58842007-04-10 12:58:45 +0000275 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000276 result in all cases is unchanged.
277
278 The inexact signal may be tested (or trapped) to determine if a given
279 operation (or sequence of operations) was inexact.
280 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000281
282class InvalidContext(InvalidOperation):
283 """Invalid context. Unknown rounding, for example.
284
285 This occurs and signals invalid-operation if an invalid context was
Facundo Batista59c58842007-04-10 12:58:45 +0000286 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000287 on creation and either the precision exceeds the capability of the
288 underlying concrete representation or an unknown or unsupported rounding
Facundo Batista59c58842007-04-10 12:58:45 +0000289 was specified. These aspects of the context need only be checked when
290 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000291 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000292
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000293 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000294 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000295
296class Rounded(DecimalException):
297 """Number got rounded (not necessarily changed during rounding).
298
299 This occurs and signals rounded whenever the result of an operation is
300 rounded (that is, some zero or non-zero digits were discarded from the
Facundo Batista59c58842007-04-10 12:58:45 +0000301 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000302 result in all cases is unchanged.
303
304 The rounded signal may be tested (or trapped) to determine if a given
305 operation (or sequence of operations) caused a loss of precision.
306 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000307
308class Subnormal(DecimalException):
309 """Exponent < Emin before rounding.
310
311 This occurs and signals subnormal whenever the result of a conversion or
312 operation is subnormal (that is, its adjusted exponent is less than
Facundo Batista59c58842007-04-10 12:58:45 +0000313 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000314
315 The subnormal signal may be tested (or trapped) to determine if a given
316 or operation (or sequence of operations) yielded a subnormal result.
317 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000318
319class Overflow(Inexact, Rounded):
320 """Numerical overflow.
321
322 This occurs and signals overflow if the adjusted exponent of a result
323 (from a conversion or from an operation that is not an attempt to divide
324 by zero), after rounding, would be greater than the largest value that
325 can be handled by the implementation (the value Emax).
326
327 The result depends on the rounding mode:
328
329 For round-half-up and round-half-even (and for round-half-down and
330 round-up, if implemented), the result of the operation is [sign,inf],
Facundo Batista59c58842007-04-10 12:58:45 +0000331 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000332 result is the largest finite number that can be represented in the
Facundo Batista59c58842007-04-10 12:58:45 +0000333 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000334 round-ceiling, the result is the same as for round-down if the sign of
Facundo Batista59c58842007-04-10 12:58:45 +0000335 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000336 the result is the same as for round-down if the sign of the intermediate
Facundo Batista59c58842007-04-10 12:58:45 +0000337 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000338 will also be raised.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000339 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000340
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000341 def handle(self, context, sign, *args):
342 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Facundo Batista353750c2007-09-13 18:13:15 +0000343 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000344 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000345 if sign == 0:
346 if context.rounding == ROUND_CEILING:
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000347 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000348 return _dec_from_triple(sign, '9'*context.prec,
349 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000350 if sign == 1:
351 if context.rounding == ROUND_FLOOR:
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000352 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000353 return _dec_from_triple(sign, '9'*context.prec,
354 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000355
356
357class Underflow(Inexact, Rounded, Subnormal):
358 """Numerical underflow with result rounded to 0.
359
360 This occurs and signals underflow if a result is inexact and the
361 adjusted exponent of the result would be smaller (more negative) than
362 the smallest value that can be handled by the implementation (the value
Facundo Batista59c58842007-04-10 12:58:45 +0000363 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000364
365 The result after an underflow will be a subnormal number rounded, if
Facundo Batista59c58842007-04-10 12:58:45 +0000366 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000367 in 0 with the sign of the intermediate result and an exponent of Etiny.
368
369 In all cases, Inexact, Rounded, and Subnormal will also be raised.
370 """
371
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000372# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000373_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000374 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000375
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000376# Map conditions (per the spec) to signals
377_condition_map = {ConversionSyntax:InvalidOperation,
378 DivisionImpossible:InvalidOperation,
379 DivisionUndefined:InvalidOperation,
380 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000381
Facundo Batista59c58842007-04-10 12:58:45 +0000382##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000383
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000384# The getcontext() and setcontext() function manage access to a thread-local
385# current context. Py2.4 offers direct support for thread locals. If that
386# is not available, use threading.currentThread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000387# work for older Pythons. If threads are not part of the build, create a
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000388# mock threading object with threading.local() returning the module namespace.
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000389
390try:
391 import threading
392except ImportError:
393 # Python was compiled without threads; create a mock object instead
394 import sys
Facundo Batista59c58842007-04-10 12:58:45 +0000395 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000396 def local(self, sys=sys):
397 return sys.modules[__name__]
398 threading = MockThreading()
399 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000400
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000401try:
402 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000403
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000404except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000405
Facundo Batista59c58842007-04-10 12:58:45 +0000406 # To fix reloading, force it to create a new context
407 # Old contexts have different exceptions in their dicts, making problems.
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000408 if hasattr(threading.currentThread(), '__decimal_context__'):
409 del threading.currentThread().__decimal_context__
410
411 def setcontext(context):
412 """Set this thread's context to context."""
413 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000414 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000415 context.clear_flags()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000416 threading.currentThread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000417
418 def getcontext():
419 """Returns this thread's context.
420
421 If this thread does not yet have a context, returns
422 a new context and sets this thread's context.
423 New contexts are copies of DefaultContext.
424 """
425 try:
426 return threading.currentThread().__decimal_context__
427 except AttributeError:
428 context = Context()
429 threading.currentThread().__decimal_context__ = context
430 return context
431
432else:
433
434 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000435 if hasattr(local, '__decimal_context__'):
436 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000437
438 def getcontext(_local=local):
439 """Returns this thread's context.
440
441 If this thread does not yet have a context, returns
442 a new context and sets this thread's context.
443 New contexts are copies of DefaultContext.
444 """
445 try:
446 return _local.__decimal_context__
447 except AttributeError:
448 context = Context()
449 _local.__decimal_context__ = context
450 return context
451
452 def setcontext(context, _local=local):
453 """Set this thread's context to context."""
454 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000455 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000456 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000457 _local.__decimal_context__ = context
458
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000459 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000460
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000461def localcontext(ctx=None):
462 """Return a context manager for a copy of the supplied context
463
464 Uses a copy of the current context if no context is specified
465 The returned context manager creates a local decimal context
466 in a with statement:
467 def sin(x):
468 with localcontext() as ctx:
469 ctx.prec += 2
470 # Rest of sin calculation algorithm
471 # uses a precision 2 greater than normal
Facundo Batista59c58842007-04-10 12:58:45 +0000472 return +s # Convert result to normal precision
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000473
474 def sin(x):
475 with localcontext(ExtendedContext):
476 # Rest of sin calculation algorithm
477 # uses the Extended Context from the
478 # General Decimal Arithmetic Specification
Facundo Batista59c58842007-04-10 12:58:45 +0000479 return +s # Convert result to normal context
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000480
Facundo Batistaee340e52008-05-02 17:39:00 +0000481 >>> setcontext(DefaultContext)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000482 >>> print getcontext().prec
483 28
484 >>> with localcontext():
485 ... ctx = getcontext()
Raymond Hettinger495df472007-02-08 01:42:35 +0000486 ... ctx.prec += 2
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000487 ... print ctx.prec
488 ...
489 30
490 >>> with localcontext(ExtendedContext):
491 ... print getcontext().prec
492 ...
493 9
494 >>> print getcontext().prec
495 28
496 """
Nick Coghlanced12182006-09-02 03:54:17 +0000497 if ctx is None: ctx = getcontext()
498 return _ContextManager(ctx)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000499
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000500
Facundo Batista59c58842007-04-10 12:58:45 +0000501##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000502
503class Decimal(object):
504 """Floating point class for decimal arithmetic."""
505
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000506 __slots__ = ('_exp','_int','_sign', '_is_special')
507 # Generally, the value of the Decimal instance is given by
508 # (-1)**_sign * _int * 10**_exp
509 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000510
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000511 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000512 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000513 """Create a decimal point instance.
514
515 >>> Decimal('3.14') # string input
Raymond Hettingerabe32372008-02-14 02:41:22 +0000516 Decimal('3.14')
Facundo Batista59c58842007-04-10 12:58:45 +0000517 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Raymond Hettingerabe32372008-02-14 02:41:22 +0000518 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000519 >>> Decimal(314) # int or long
Raymond Hettingerabe32372008-02-14 02:41:22 +0000520 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000521 >>> Decimal(Decimal(314)) # another decimal instance
Raymond Hettingerabe32372008-02-14 02:41:22 +0000522 Decimal('314')
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000523 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Raymond Hettingerabe32372008-02-14 02:41:22 +0000524 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000525 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000526
Facundo Batista72bc54f2007-11-23 17:59:00 +0000527 # Note that the coefficient, self._int, is actually stored as
528 # a string rather than as a tuple of digits. This speeds up
529 # the "digits to integer" and "integer to digits" conversions
530 # that are used in almost every arithmetic operation on
531 # Decimals. This is an internal detail: the as_tuple function
532 # and the Decimal constructor still deal with tuples of
533 # digits.
534
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000535 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000536
Facundo Batista0d157a02007-11-30 17:15:25 +0000537 # From a string
538 # REs insist on real strings, so we can too.
539 if isinstance(value, basestring):
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000540 m = _parser(value.strip())
Facundo Batista0d157a02007-11-30 17:15:25 +0000541 if m is None:
542 if context is None:
543 context = getcontext()
544 return context._raise_error(ConversionSyntax,
545 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000546
Facundo Batista0d157a02007-11-30 17:15:25 +0000547 if m.group('sign') == "-":
548 self._sign = 1
549 else:
550 self._sign = 0
551 intpart = m.group('int')
552 if intpart is not None:
553 # finite number
Mark Dickinson9a6e6452009-08-02 11:01:01 +0000554 fracpart = m.group('frac') or ''
Facundo Batista0d157a02007-11-30 17:15:25 +0000555 exp = int(m.group('exp') or '0')
Mark Dickinson9a6e6452009-08-02 11:01:01 +0000556 self._int = str(int(intpart+fracpart))
557 self._exp = exp - len(fracpart)
Facundo Batista0d157a02007-11-30 17:15:25 +0000558 self._is_special = False
559 else:
560 diag = m.group('diag')
561 if diag is not None:
562 # NaN
Mark Dickinson9a6e6452009-08-02 11:01:01 +0000563 self._int = str(int(diag or '0')).lstrip('0')
Facundo Batista0d157a02007-11-30 17:15:25 +0000564 if m.group('signal'):
565 self._exp = 'N'
566 else:
567 self._exp = 'n'
568 else:
569 # infinity
570 self._int = '0'
571 self._exp = 'F'
572 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000573 return self
574
575 # From an integer
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000576 if isinstance(value, (int,long)):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000577 if value >= 0:
578 self._sign = 0
579 else:
580 self._sign = 1
581 self._exp = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +0000582 self._int = str(abs(value))
Facundo Batista0d157a02007-11-30 17:15:25 +0000583 self._is_special = False
584 return self
585
586 # From another decimal
587 if isinstance(value, Decimal):
588 self._exp = value._exp
589 self._sign = value._sign
590 self._int = value._int
591 self._is_special = value._is_special
592 return self
593
594 # From an internal working value
595 if isinstance(value, _WorkRep):
596 self._sign = value.sign
597 self._int = str(value.int)
598 self._exp = int(value.exp)
599 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000600 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000601
602 # tuple/list conversion (possibly from as_tuple())
603 if isinstance(value, (list,tuple)):
604 if len(value) != 3:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000605 raise ValueError('Invalid tuple size in creation of Decimal '
606 'from list or tuple. The list or tuple '
607 'should have exactly three elements.')
608 # process sign. The isinstance test rejects floats
609 if not (isinstance(value[0], (int, long)) and value[0] in (0,1)):
610 raise ValueError("Invalid sign. The first value in the tuple "
611 "should be an integer; either 0 for a "
612 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000613 self._sign = value[0]
Facundo Batista9b5e2312007-10-19 19:25:57 +0000614 if value[2] == 'F':
615 # infinity: value[1] is ignored
Facundo Batista72bc54f2007-11-23 17:59:00 +0000616 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000617 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000618 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000619 else:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000620 # process and validate the digits in value[1]
621 digits = []
622 for digit in value[1]:
623 if isinstance(digit, (int, long)) and 0 <= digit <= 9:
624 # skip leading zeros
625 if digits or digit != 0:
626 digits.append(digit)
627 else:
628 raise ValueError("The second value in the tuple must "
629 "be composed of integers in the range "
630 "0 through 9.")
631 if value[2] in ('n', 'N'):
632 # NaN: digits form the diagnostic
Facundo Batista72bc54f2007-11-23 17:59:00 +0000633 self._int = ''.join(map(str, digits))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000634 self._exp = value[2]
635 self._is_special = True
636 elif isinstance(value[2], (int, long)):
637 # finite number: digits give the coefficient
Facundo Batista72bc54f2007-11-23 17:59:00 +0000638 self._int = ''.join(map(str, digits or [0]))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000639 self._exp = value[2]
640 self._is_special = False
641 else:
642 raise ValueError("The third value in the tuple must "
643 "be an integer, or one of the "
644 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000645 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000646
Raymond Hettingerbf440692004-07-10 14:14:37 +0000647 if isinstance(value, float):
648 raise TypeError("Cannot convert float to Decimal. " +
649 "First convert the float to a string")
650
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000651 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000652
653 def _isnan(self):
654 """Returns whether the number is not actually one.
655
656 0 if a number
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000657 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000658 2 if sNaN
659 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000660 if self._is_special:
661 exp = self._exp
662 if exp == 'n':
663 return 1
664 elif exp == 'N':
665 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000666 return 0
667
668 def _isinfinity(self):
669 """Returns whether the number is infinite
670
671 0 if finite or not a number
672 1 if +INF
673 -1 if -INF
674 """
675 if self._exp == 'F':
676 if self._sign:
677 return -1
678 return 1
679 return 0
680
Facundo Batista353750c2007-09-13 18:13:15 +0000681 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000682 """Returns whether the number is not actually one.
683
684 if self, other are sNaN, signal
685 if self, other are NaN return nan
686 return 0
687
688 Done before operations.
689 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000690
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000691 self_is_nan = self._isnan()
692 if other is None:
693 other_is_nan = False
694 else:
695 other_is_nan = other._isnan()
696
697 if self_is_nan or other_is_nan:
698 if context is None:
699 context = getcontext()
700
701 if self_is_nan == 2:
702 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000703 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000704 if other_is_nan == 2:
705 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000706 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000707 if self_is_nan:
Facundo Batista353750c2007-09-13 18:13:15 +0000708 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000709
Facundo Batista353750c2007-09-13 18:13:15 +0000710 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000711 return 0
712
Mark Dickinson2fc92632008-02-06 22:10:50 +0000713 def _compare_check_nans(self, other, context):
714 """Version of _check_nans used for the signaling comparisons
715 compare_signal, __le__, __lt__, __ge__, __gt__.
716
717 Signal InvalidOperation if either self or other is a (quiet
718 or signaling) NaN. Signaling NaNs take precedence over quiet
719 NaNs.
720
721 Return 0 if neither operand is a NaN.
722
723 """
724 if context is None:
725 context = getcontext()
726
727 if self._is_special or other._is_special:
728 if self.is_snan():
729 return context._raise_error(InvalidOperation,
730 'comparison involving sNaN',
731 self)
732 elif other.is_snan():
733 return context._raise_error(InvalidOperation,
734 'comparison involving sNaN',
735 other)
736 elif self.is_qnan():
737 return context._raise_error(InvalidOperation,
738 'comparison involving NaN',
739 self)
740 elif other.is_qnan():
741 return context._raise_error(InvalidOperation,
742 'comparison involving NaN',
743 other)
744 return 0
745
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000746 def __nonzero__(self):
Facundo Batista1a191df2007-10-02 17:01:24 +0000747 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000748
Facundo Batista1a191df2007-10-02 17:01:24 +0000749 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000750 """
Facundo Batista72bc54f2007-11-23 17:59:00 +0000751 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000752
Mark Dickinson2fc92632008-02-06 22:10:50 +0000753 def _cmp(self, other):
754 """Compare the two non-NaN decimal instances self and other.
755
756 Returns -1 if self < other, 0 if self == other and 1
757 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000758
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000759 if self._is_special or other._is_special:
Mark Dickinson8ec69bc2009-01-25 10:47:45 +0000760 self_inf = self._isinfinity()
761 other_inf = other._isinfinity()
762 if self_inf == other_inf:
763 return 0
764 elif self_inf < other_inf:
765 return -1
766 else:
767 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000768
Mark Dickinson8ec69bc2009-01-25 10:47:45 +0000769 # check for zeros; Decimal('0') == Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +0000770 if not self:
771 if not other:
772 return 0
773 else:
774 return -((-1)**other._sign)
775 if not other:
776 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000777
Facundo Batista59c58842007-04-10 12:58:45 +0000778 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000779 if other._sign < self._sign:
780 return -1
781 if self._sign < other._sign:
782 return 1
783
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000784 self_adjusted = self.adjusted()
785 other_adjusted = other.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +0000786 if self_adjusted == other_adjusted:
Facundo Batista72bc54f2007-11-23 17:59:00 +0000787 self_padded = self._int + '0'*(self._exp - other._exp)
788 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinson8ec69bc2009-01-25 10:47:45 +0000789 if self_padded == other_padded:
790 return 0
791 elif self_padded < other_padded:
792 return -(-1)**self._sign
793 else:
794 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000795 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000796 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000797 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000798 return -((-1)**self._sign)
799
Mark Dickinson2fc92632008-02-06 22:10:50 +0000800 # Note: The Decimal standard doesn't cover rich comparisons for
801 # Decimals. In particular, the specification is silent on the
802 # subject of what should happen for a comparison involving a NaN.
803 # We take the following approach:
804 #
805 # == comparisons involving a NaN always return False
806 # != comparisons involving a NaN always return True
807 # <, >, <= and >= comparisons involving a (quiet or signaling)
808 # NaN signal InvalidOperation, and return False if the
Mark Dickinson3a94ee02008-02-10 15:19:58 +0000809 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000810 #
811 # This behavior is designed to conform as closely as possible to
812 # that specified by IEEE 754.
813
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000814 def __eq__(self, other):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000815 other = _convert_other(other)
816 if other is NotImplemented:
817 return other
818 if self.is_nan() or other.is_nan():
819 return False
820 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000821
822 def __ne__(self, other):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000823 other = _convert_other(other)
824 if other is NotImplemented:
825 return other
826 if self.is_nan() or other.is_nan():
827 return True
828 return self._cmp(other) != 0
829
830 def __lt__(self, other, context=None):
831 other = _convert_other(other)
832 if other is NotImplemented:
833 return other
834 ans = self._compare_check_nans(other, context)
835 if ans:
836 return False
837 return self._cmp(other) < 0
838
839 def __le__(self, other, context=None):
840 other = _convert_other(other)
841 if other is NotImplemented:
842 return other
843 ans = self._compare_check_nans(other, context)
844 if ans:
845 return False
846 return self._cmp(other) <= 0
847
848 def __gt__(self, other, context=None):
849 other = _convert_other(other)
850 if other is NotImplemented:
851 return other
852 ans = self._compare_check_nans(other, context)
853 if ans:
854 return False
855 return self._cmp(other) > 0
856
857 def __ge__(self, other, context=None):
858 other = _convert_other(other)
859 if other is NotImplemented:
860 return other
861 ans = self._compare_check_nans(other, context)
862 if ans:
863 return False
864 return self._cmp(other) >= 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000865
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000866 def compare(self, other, context=None):
867 """Compares one to another.
868
869 -1 => a < b
870 0 => a = b
871 1 => a > b
872 NaN => one is NaN
873 Like __cmp__, but returns Decimal instances.
874 """
Facundo Batista353750c2007-09-13 18:13:15 +0000875 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000876
Facundo Batista59c58842007-04-10 12:58:45 +0000877 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000878 if (self._is_special or other and other._is_special):
879 ans = self._check_nans(other, context)
880 if ans:
881 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000882
Mark Dickinson2fc92632008-02-06 22:10:50 +0000883 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000884
885 def __hash__(self):
886 """x.__hash__() <==> hash(x)"""
887 # Decimal integers must hash the same as the ints
Facundo Batista52b25792008-01-08 12:25:20 +0000888 #
889 # The hash of a nonspecial noninteger Decimal must depend only
890 # on the value of that Decimal, and not on its representation.
Raymond Hettingerabe32372008-02-14 02:41:22 +0000891 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000892 if self._is_special:
893 if self._isnan():
894 raise TypeError('Cannot hash a NaN value.')
895 return hash(str(self))
Facundo Batista8c202442007-09-19 17:53:25 +0000896 if not self:
897 return 0
898 if self._isinteger():
899 op = _WorkRep(self.to_integral_value())
900 # to make computation feasible for Decimals with large
901 # exponent, we use the fact that hash(n) == hash(m) for
902 # any two nonzero integers n and m such that (i) n and m
903 # have the same sign, and (ii) n is congruent to m modulo
904 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
905 # hash((-1)**s*c*pow(10, e, 2**64-1).
906 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Facundo Batista52b25792008-01-08 12:25:20 +0000907 # The value of a nonzero nonspecial Decimal instance is
908 # faithfully represented by the triple consisting of its sign,
909 # its adjusted exponent, and its coefficient with trailing
910 # zeros removed.
911 return hash((self._sign,
912 self._exp+len(self._int),
913 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000914
915 def as_tuple(self):
916 """Represents the number as a triple tuple.
917
918 To show the internals exactly as they are.
919 """
Raymond Hettinger097a1902008-01-11 02:24:13 +0000920 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000921
922 def __repr__(self):
923 """Represents the number as an instance of Decimal."""
924 # Invariant: eval(repr(d)) == d
Raymond Hettingerabe32372008-02-14 02:41:22 +0000925 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000926
Facundo Batista353750c2007-09-13 18:13:15 +0000927 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000928 """Return string representation of the number in scientific notation.
929
930 Captures all of the information in the underlying representation.
931 """
932
Facundo Batista62edb712007-12-03 16:29:52 +0000933 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000934 if self._is_special:
Facundo Batista62edb712007-12-03 16:29:52 +0000935 if self._exp == 'F':
936 return sign + 'Infinity'
937 elif self._exp == 'n':
938 return sign + 'NaN' + self._int
939 else: # self._exp == 'N'
940 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000941
Facundo Batista62edb712007-12-03 16:29:52 +0000942 # number of digits of self._int to left of decimal point
943 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000944
Facundo Batista62edb712007-12-03 16:29:52 +0000945 # dotplace is number of digits of self._int to the left of the
946 # decimal point in the mantissa of the output string (that is,
947 # after adjusting the exponent)
948 if self._exp <= 0 and leftdigits > -6:
949 # no exponent required
950 dotplace = leftdigits
951 elif not eng:
952 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000953 dotplace = 1
Facundo Batista62edb712007-12-03 16:29:52 +0000954 elif self._int == '0':
955 # engineering notation, zero
956 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000957 else:
Facundo Batista62edb712007-12-03 16:29:52 +0000958 # engineering notation, nonzero
959 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000960
Facundo Batista62edb712007-12-03 16:29:52 +0000961 if dotplace <= 0:
962 intpart = '0'
963 fracpart = '.' + '0'*(-dotplace) + self._int
964 elif dotplace >= len(self._int):
965 intpart = self._int+'0'*(dotplace-len(self._int))
966 fracpart = ''
967 else:
968 intpart = self._int[:dotplace]
969 fracpart = '.' + self._int[dotplace:]
970 if leftdigits == dotplace:
971 exp = ''
972 else:
973 if context is None:
974 context = getcontext()
975 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
976
977 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000978
979 def to_eng_string(self, context=None):
980 """Convert to engineering-type string.
981
982 Engineering notation has an exponent which is a multiple of 3, so there
983 are up to 3 digits left of the decimal place.
984
985 Same rules for when in exponential and when as a value as in __str__.
986 """
Facundo Batista353750c2007-09-13 18:13:15 +0000987 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000988
989 def __neg__(self, context=None):
990 """Returns a copy with the sign switched.
991
992 Rounds, if it has reason.
993 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000994 if self._is_special:
995 ans = self._check_nans(context=context)
996 if ans:
997 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000998
999 if not self:
1000 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001001 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001002 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001003 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001004
1005 if context is None:
1006 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001007 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001008
1009 def __pos__(self, context=None):
1010 """Returns a copy, unless it is a sNaN.
1011
1012 Rounds the number (if more then precision digits)
1013 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001014 if self._is_special:
1015 ans = self._check_nans(context=context)
1016 if ans:
1017 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001018
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001019 if not self:
1020 # + (-0) = 0
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001021 ans = self.copy_abs()
Facundo Batista353750c2007-09-13 18:13:15 +00001022 else:
1023 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001024
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001025 if context is None:
1026 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001027 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001028
Facundo Batistae64acfa2007-12-17 14:18:42 +00001029 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001030 """Returns the absolute value of self.
1031
Facundo Batistae64acfa2007-12-17 14:18:42 +00001032 If the keyword argument 'round' is false, do not round. The
1033 expression self.__abs__(round=False) is equivalent to
1034 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001035 """
Facundo Batistae64acfa2007-12-17 14:18:42 +00001036 if not round:
1037 return self.copy_abs()
1038
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001039 if self._is_special:
1040 ans = self._check_nans(context=context)
1041 if ans:
1042 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001043
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001044 if self._sign:
1045 ans = self.__neg__(context=context)
1046 else:
1047 ans = self.__pos__(context=context)
1048
1049 return ans
1050
1051 def __add__(self, other, context=None):
1052 """Returns self + other.
1053
1054 -INF + INF (or the reverse) cause InvalidOperation errors.
1055 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001056 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001057 if other is NotImplemented:
1058 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001059
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001060 if context is None:
1061 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001062
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001063 if self._is_special or other._is_special:
1064 ans = self._check_nans(other, context)
1065 if ans:
1066 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001067
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001068 if self._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001069 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001070 if self._sign != other._sign and other._isinfinity():
1071 return context._raise_error(InvalidOperation, '-INF + INF')
1072 return Decimal(self)
1073 if other._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001074 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001075
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001076 exp = min(self._exp, other._exp)
1077 negativezero = 0
1078 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Facundo Batista59c58842007-04-10 12:58:45 +00001079 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001080 negativezero = 1
1081
1082 if not self and not other:
1083 sign = min(self._sign, other._sign)
1084 if negativezero:
1085 sign = 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00001086 ans = _dec_from_triple(sign, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001087 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001088 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001089 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001090 exp = max(exp, other._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001091 ans = other._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001092 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001093 return ans
1094 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001095 exp = max(exp, self._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001096 ans = self._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001097 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001098 return ans
1099
1100 op1 = _WorkRep(self)
1101 op2 = _WorkRep(other)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001102 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001103
1104 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001105 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001106 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001107 if op1.int == op2.int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001108 ans = _dec_from_triple(negativezero, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001109 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001110 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001111 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001112 op1, op2 = op2, op1
Facundo Batista59c58842007-04-10 12:58:45 +00001113 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001114 if op1.sign == 1:
1115 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001116 op1.sign, op2.sign = op2.sign, op1.sign
1117 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001118 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001119 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001120 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001121 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001122 op1.sign, op2.sign = (0, 0)
1123 else:
1124 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001125 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001126
Raymond Hettinger17931de2004-10-27 06:21:46 +00001127 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001128 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001129 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001130 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001131
1132 result.exp = op1.exp
1133 ans = Decimal(result)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001134 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001135 return ans
1136
1137 __radd__ = __add__
1138
1139 def __sub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001140 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001141 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001142 if other is NotImplemented:
1143 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001144
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001145 if self._is_special or other._is_special:
1146 ans = self._check_nans(other, context=context)
1147 if ans:
1148 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149
Facundo Batista353750c2007-09-13 18:13:15 +00001150 # self - other is computed as self + other.copy_negate()
1151 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001152
1153 def __rsub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001154 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001155 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001156 if other is NotImplemented:
1157 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001158
Facundo Batista353750c2007-09-13 18:13:15 +00001159 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001160
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001161 def __mul__(self, other, context=None):
1162 """Return self * other.
1163
1164 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1165 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001166 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001167 if other is NotImplemented:
1168 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001169
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001170 if context is None:
1171 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001172
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001173 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001174
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001175 if self._is_special or other._is_special:
1176 ans = self._check_nans(other, context)
1177 if ans:
1178 return ans
1179
1180 if self._isinfinity():
1181 if not other:
1182 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001183 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001184
1185 if other._isinfinity():
1186 if not self:
1187 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001188 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001189
1190 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001191
1192 # Special case for multiplying by zero
1193 if not self or not other:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001194 ans = _dec_from_triple(resultsign, '0', resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001195 # Fixing in case the exponent is out of bounds
1196 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001197 return ans
1198
1199 # Special case for multiplying by power of 10
Facundo Batista72bc54f2007-11-23 17:59:00 +00001200 if self._int == '1':
1201 ans = _dec_from_triple(resultsign, other._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001202 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001203 return ans
Facundo Batista72bc54f2007-11-23 17:59:00 +00001204 if other._int == '1':
1205 ans = _dec_from_triple(resultsign, self._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001206 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001207 return ans
1208
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001209 op1 = _WorkRep(self)
1210 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001211
Facundo Batista72bc54f2007-11-23 17:59:00 +00001212 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001213 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001214
1215 return ans
1216 __rmul__ = __mul__
1217
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001218 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001219 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001220 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001221 if other is NotImplemented:
Facundo Batistacce8df22007-09-18 16:53:18 +00001222 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001223
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001224 if context is None:
1225 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001226
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001227 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001228
1229 if self._is_special or other._is_special:
1230 ans = self._check_nans(other, context)
1231 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001232 return ans
1233
1234 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001236
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001237 if self._isinfinity():
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001238 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001239
1240 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001241 context._raise_error(Clamped, 'Division by infinity')
Facundo Batista72bc54f2007-11-23 17:59:00 +00001242 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001243
1244 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001245 if not other:
Facundo Batistacce8df22007-09-18 16:53:18 +00001246 if not self:
1247 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001248 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001249
Facundo Batistacce8df22007-09-18 16:53:18 +00001250 if not self:
1251 exp = self._exp - other._exp
1252 coeff = 0
1253 else:
1254 # OK, so neither = 0, INF or NaN
1255 shift = len(other._int) - len(self._int) + context.prec + 1
1256 exp = self._exp - other._exp - shift
1257 op1 = _WorkRep(self)
1258 op2 = _WorkRep(other)
1259 if shift >= 0:
1260 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1261 else:
1262 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1263 if remainder:
1264 # result is not exact; adjust to ensure correct rounding
1265 if coeff % 5 == 0:
1266 coeff += 1
1267 else:
1268 # result is exact; get as close to ideal exponent as possible
1269 ideal_exp = self._exp - other._exp
1270 while exp < ideal_exp and coeff % 10 == 0:
1271 coeff //= 10
1272 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001273
Facundo Batista72bc54f2007-11-23 17:59:00 +00001274 ans = _dec_from_triple(sign, str(coeff), exp)
Facundo Batistacce8df22007-09-18 16:53:18 +00001275 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001276
Facundo Batistacce8df22007-09-18 16:53:18 +00001277 def _divide(self, other, context):
1278 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001279
Facundo Batistacce8df22007-09-18 16:53:18 +00001280 Assumes that neither self nor other is a NaN, that self is not
1281 infinite and that other is nonzero.
1282 """
1283 sign = self._sign ^ other._sign
1284 if other._isinfinity():
1285 ideal_exp = self._exp
1286 else:
1287 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001288
Facundo Batistacce8df22007-09-18 16:53:18 +00001289 expdiff = self.adjusted() - other.adjusted()
1290 if not self or other._isinfinity() or expdiff <= -2:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001291 return (_dec_from_triple(sign, '0', 0),
Facundo Batistacce8df22007-09-18 16:53:18 +00001292 self._rescale(ideal_exp, context.rounding))
1293 if expdiff <= context.prec:
1294 op1 = _WorkRep(self)
1295 op2 = _WorkRep(other)
1296 if op1.exp >= op2.exp:
1297 op1.int *= 10**(op1.exp - op2.exp)
1298 else:
1299 op2.int *= 10**(op2.exp - op1.exp)
1300 q, r = divmod(op1.int, op2.int)
1301 if q < 10**context.prec:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001302 return (_dec_from_triple(sign, str(q), 0),
1303 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001304
Facundo Batistacce8df22007-09-18 16:53:18 +00001305 # Here the quotient is too large to be representable
1306 ans = context._raise_error(DivisionImpossible,
1307 'quotient too large in //, % or divmod')
1308 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001309
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001310 def __rtruediv__(self, other, context=None):
1311 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001312 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001313 if other is NotImplemented:
1314 return other
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001315 return other.__truediv__(self, context=context)
1316
1317 __div__ = __truediv__
1318 __rdiv__ = __rtruediv__
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001319
1320 def __divmod__(self, other, context=None):
1321 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001322 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001323 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001324 other = _convert_other(other)
1325 if other is NotImplemented:
1326 return other
1327
1328 if context is None:
1329 context = getcontext()
1330
1331 ans = self._check_nans(other, context)
1332 if ans:
1333 return (ans, ans)
1334
1335 sign = self._sign ^ other._sign
1336 if self._isinfinity():
1337 if other._isinfinity():
1338 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1339 return ans, ans
1340 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001341 return (_SignedInfinity[sign],
Facundo Batistacce8df22007-09-18 16:53:18 +00001342 context._raise_error(InvalidOperation, 'INF % x'))
1343
1344 if not other:
1345 if not self:
1346 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1347 return ans, ans
1348 else:
1349 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1350 context._raise_error(InvalidOperation, 'x % 0'))
1351
1352 quotient, remainder = self._divide(other, context)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001353 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001354 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001355
1356 def __rdivmod__(self, other, context=None):
1357 """Swaps self/other and returns __divmod__."""
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
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001361 return other.__divmod__(self, context=context)
1362
1363 def __mod__(self, other, context=None):
1364 """
1365 self % other
1366 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001367 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001368 if other is NotImplemented:
1369 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001370
Facundo Batistacce8df22007-09-18 16:53:18 +00001371 if context is None:
1372 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001373
Facundo Batistacce8df22007-09-18 16:53:18 +00001374 ans = self._check_nans(other, context)
1375 if ans:
1376 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001377
Facundo Batistacce8df22007-09-18 16:53:18 +00001378 if self._isinfinity():
1379 return context._raise_error(InvalidOperation, 'INF % x')
1380 elif not other:
1381 if self:
1382 return context._raise_error(InvalidOperation, 'x % 0')
1383 else:
1384 return context._raise_error(DivisionUndefined, '0 % 0')
1385
1386 remainder = self._divide(other, context)[1]
Facundo Batistae64acfa2007-12-17 14:18:42 +00001387 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001388 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001389
1390 def __rmod__(self, other, context=None):
1391 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001392 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001393 if other is NotImplemented:
1394 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001395 return other.__mod__(self, context=context)
1396
1397 def remainder_near(self, other, context=None):
1398 """
1399 Remainder nearest to 0- abs(remainder-near) <= other/2
1400 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001401 if context is None:
1402 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001403
Facundo Batista353750c2007-09-13 18:13:15 +00001404 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001405
Facundo Batista353750c2007-09-13 18:13:15 +00001406 ans = self._check_nans(other, context)
1407 if ans:
1408 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001409
Facundo Batista353750c2007-09-13 18:13:15 +00001410 # self == +/-infinity -> InvalidOperation
1411 if self._isinfinity():
1412 return context._raise_error(InvalidOperation,
1413 'remainder_near(infinity, x)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001414
Facundo Batista353750c2007-09-13 18:13:15 +00001415 # other == 0 -> either InvalidOperation or DivisionUndefined
1416 if not other:
1417 if self:
1418 return context._raise_error(InvalidOperation,
1419 'remainder_near(x, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001420 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001421 return context._raise_error(DivisionUndefined,
1422 'remainder_near(0, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001423
Facundo Batista353750c2007-09-13 18:13:15 +00001424 # other = +/-infinity -> remainder = self
1425 if other._isinfinity():
1426 ans = Decimal(self)
1427 return ans._fix(context)
1428
1429 # self = 0 -> remainder = self, with ideal exponent
1430 ideal_exponent = min(self._exp, other._exp)
1431 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001432 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001433 return ans._fix(context)
1434
1435 # catch most cases of large or small quotient
1436 expdiff = self.adjusted() - other.adjusted()
1437 if expdiff >= context.prec + 1:
1438 # expdiff >= prec+1 => abs(self/other) > 10**prec
Facundo Batistacce8df22007-09-18 16:53:18 +00001439 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001440 if expdiff <= -2:
1441 # expdiff <= -2 => abs(self/other) < 0.1
1442 ans = self._rescale(ideal_exponent, context.rounding)
1443 return ans._fix(context)
1444
1445 # adjust both arguments to have the same exponent, then divide
1446 op1 = _WorkRep(self)
1447 op2 = _WorkRep(other)
1448 if op1.exp >= op2.exp:
1449 op1.int *= 10**(op1.exp - op2.exp)
1450 else:
1451 op2.int *= 10**(op2.exp - op1.exp)
1452 q, r = divmod(op1.int, op2.int)
1453 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1454 # 10**ideal_exponent. Apply correction to ensure that
1455 # abs(remainder) <= abs(other)/2
1456 if 2*r + (q&1) > op2.int:
1457 r -= op2.int
1458 q += 1
1459
1460 if q >= 10**context.prec:
Facundo Batistacce8df22007-09-18 16:53:18 +00001461 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001462
1463 # result has same sign as self unless r is negative
1464 sign = self._sign
1465 if r < 0:
1466 sign = 1-sign
1467 r = -r
1468
Facundo Batista72bc54f2007-11-23 17:59:00 +00001469 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001470 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001471
1472 def __floordiv__(self, other, context=None):
1473 """self // other"""
Facundo Batistacce8df22007-09-18 16:53:18 +00001474 other = _convert_other(other)
1475 if other is NotImplemented:
1476 return other
1477
1478 if context is None:
1479 context = getcontext()
1480
1481 ans = self._check_nans(other, context)
1482 if ans:
1483 return ans
1484
1485 if self._isinfinity():
1486 if other._isinfinity():
1487 return context._raise_error(InvalidOperation, 'INF // INF')
1488 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001489 return _SignedInfinity[self._sign ^ other._sign]
Facundo Batistacce8df22007-09-18 16:53:18 +00001490
1491 if not other:
1492 if self:
1493 return context._raise_error(DivisionByZero, 'x // 0',
1494 self._sign ^ other._sign)
1495 else:
1496 return context._raise_error(DivisionUndefined, '0 // 0')
1497
1498 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001499
1500 def __rfloordiv__(self, other, context=None):
1501 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001502 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001503 if other is NotImplemented:
1504 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001505 return other.__floordiv__(self, context=context)
1506
1507 def __float__(self):
1508 """Float representation."""
1509 return float(str(self))
1510
1511 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001512 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001513 if self._is_special:
1514 if self._isnan():
Mark Dickinsonc05b7892009-09-08 19:22:18 +00001515 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001516 elif self._isinfinity():
Mark Dickinsonc05b7892009-09-08 19:22:18 +00001517 raise OverflowError("Cannot convert infinity to integer")
Facundo Batista353750c2007-09-13 18:13:15 +00001518 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001519 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001520 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001521 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001522 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001523
Raymond Hettinger5a053642008-01-24 19:05:29 +00001524 __trunc__ = __int__
1525
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001526 def real(self):
1527 return self
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00001528 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001529
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001530 def imag(self):
1531 return Decimal(0)
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00001532 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001533
1534 def conjugate(self):
1535 return self
1536
1537 def __complex__(self):
1538 return complex(float(self))
1539
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001540 def __long__(self):
1541 """Converts to a long.
1542
1543 Equivalent to long(int(self))
1544 """
1545 return long(self.__int__())
1546
Facundo Batista353750c2007-09-13 18:13:15 +00001547 def _fix_nan(self, context):
1548 """Decapitate the payload of a NaN to fit the context"""
1549 payload = self._int
1550
1551 # maximum length of payload is precision if _clamp=0,
1552 # precision-1 if _clamp=1.
1553 max_payload_len = context.prec - context._clamp
1554 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001555 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1556 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001557 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001558
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001559 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001560 """Round if it is necessary to keep self within prec precision.
1561
1562 Rounds and fixes the exponent. Does not raise on a sNaN.
1563
1564 Arguments:
1565 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001566 context - context used.
1567 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001568
Facundo Batista353750c2007-09-13 18:13:15 +00001569 if self._is_special:
1570 if self._isnan():
1571 # decapitate payload if necessary
1572 return self._fix_nan(context)
1573 else:
1574 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001575 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001576
Facundo Batista353750c2007-09-13 18:13:15 +00001577 # if self is zero then exponent should be between Etiny and
1578 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1579 Etiny = context.Etiny()
1580 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001581 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001582 exp_max = [context.Emax, Etop][context._clamp]
1583 new_exp = min(max(self._exp, Etiny), exp_max)
1584 if new_exp != self._exp:
1585 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001586 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001587 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001588 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001589
1590 # exp_min is the smallest allowable exponent of the result,
1591 # equal to max(self.adjusted()-context.prec+1, Etiny)
1592 exp_min = len(self._int) + self._exp - context.prec
1593 if exp_min > Etop:
1594 # overflow: exp_min > Etop iff self.adjusted() > Emax
1595 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001596 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00001597 return context._raise_error(Overflow, 'above Emax', self._sign)
1598 self_is_subnormal = exp_min < Etiny
1599 if self_is_subnormal:
1600 context._raise_error(Subnormal)
1601 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001602
Facundo Batista353750c2007-09-13 18:13:15 +00001603 # round if self has too many digits
1604 if self._exp < exp_min:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001605 context._raise_error(Rounded)
Facundo Batista2ec74152007-12-03 17:55:00 +00001606 digits = len(self._int) + self._exp - exp_min
1607 if digits < 0:
1608 self = _dec_from_triple(self._sign, '1', exp_min-1)
1609 digits = 0
1610 this_function = getattr(self, self._pick_rounding_function[context.rounding])
1611 changed = this_function(digits)
1612 coeff = self._int[:digits] or '0'
1613 if changed == 1:
1614 coeff = str(int(coeff)+1)
1615 ans = _dec_from_triple(self._sign, coeff, exp_min)
1616
1617 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001618 context._raise_error(Inexact)
1619 if self_is_subnormal:
1620 context._raise_error(Underflow)
1621 if not ans:
1622 # raise Clamped on underflow to 0
1623 context._raise_error(Clamped)
1624 elif len(ans._int) == context.prec+1:
1625 # we get here only if rescaling rounds the
1626 # cofficient up to exactly 10**context.prec
1627 if ans._exp < Etop:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001628 ans = _dec_from_triple(ans._sign,
1629 ans._int[:-1], ans._exp+1)
Facundo Batista353750c2007-09-13 18:13:15 +00001630 else:
1631 # Inexact and Rounded have already been raised
1632 ans = context._raise_error(Overflow, 'above Emax',
1633 self._sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001634 return ans
1635
Facundo Batista353750c2007-09-13 18:13:15 +00001636 # fold down if _clamp == 1 and self has too few digits
1637 if context._clamp == 1 and self._exp > Etop:
1638 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001639 self_padded = self._int + '0'*(self._exp - Etop)
1640 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001641
Facundo Batista353750c2007-09-13 18:13:15 +00001642 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001643 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001644
1645 _pick_rounding_function = {}
1646
Facundo Batista353750c2007-09-13 18:13:15 +00001647 # for each of the rounding functions below:
1648 # self is a finite, nonzero Decimal
1649 # prec is an integer satisfying 0 <= prec < len(self._int)
Facundo Batista2ec74152007-12-03 17:55:00 +00001650 #
1651 # each function returns either -1, 0, or 1, as follows:
1652 # 1 indicates that self should be rounded up (away from zero)
1653 # 0 indicates that self should be truncated, and that all the
1654 # digits to be truncated are zeros (so the value is unchanged)
1655 # -1 indicates that there are nonzero digits to be truncated
Facundo Batista353750c2007-09-13 18:13:15 +00001656
1657 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001658 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001659 if _all_zeros(self._int, prec):
1660 return 0
1661 else:
1662 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001663
Facundo Batista353750c2007-09-13 18:13:15 +00001664 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001665 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001666 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001667
Facundo Batista353750c2007-09-13 18:13:15 +00001668 def _round_half_up(self, prec):
1669 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001670 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001671 return 1
1672 elif _all_zeros(self._int, prec):
1673 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001674 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001675 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001676
1677 def _round_half_down(self, prec):
1678 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001679 if _exact_half(self._int, prec):
1680 return -1
1681 else:
1682 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001683
1684 def _round_half_even(self, prec):
1685 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001686 if _exact_half(self._int, prec) and \
1687 (prec == 0 or self._int[prec-1] in '02468'):
1688 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001689 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001690 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001691
1692 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001693 """Rounds up (not away from 0 if negative.)"""
1694 if self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001695 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001696 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001697 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001698
Facundo Batista353750c2007-09-13 18:13:15 +00001699 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001700 """Rounds down (not towards 0 if negative)"""
1701 if not self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001702 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001703 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001704 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001705
Facundo Batista353750c2007-09-13 18:13:15 +00001706 def _round_05up(self, prec):
1707 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001708 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001709 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001710 else:
1711 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001712
Facundo Batista353750c2007-09-13 18:13:15 +00001713 def fma(self, other, third, context=None):
1714 """Fused multiply-add.
1715
1716 Returns self*other+third with no rounding of the intermediate
1717 product self*other.
1718
1719 self and other are multiplied together, with no rounding of
1720 the result. The third operand is then added to the result,
1721 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001722 """
Facundo Batista353750c2007-09-13 18:13:15 +00001723
1724 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001725
1726 # compute product; raise InvalidOperation if either operand is
1727 # a signaling NaN or if the product is zero times infinity.
1728 if self._is_special or other._is_special:
1729 if context is None:
1730 context = getcontext()
1731 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001732 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001733 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001734 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001735 if self._exp == 'n':
1736 product = self
1737 elif other._exp == 'n':
1738 product = other
1739 elif self._exp == 'F':
1740 if not other:
1741 return context._raise_error(InvalidOperation,
1742 'INF * 0 in fma')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001743 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001744 elif other._exp == 'F':
1745 if not self:
1746 return context._raise_error(InvalidOperation,
1747 '0 * INF in fma')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001748 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001749 else:
1750 product = _dec_from_triple(self._sign ^ other._sign,
1751 str(int(self._int) * int(other._int)),
1752 self._exp + other._exp)
1753
Facundo Batista353750c2007-09-13 18:13:15 +00001754 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001755 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001756
Facundo Batista353750c2007-09-13 18:13:15 +00001757 def _power_modulo(self, other, modulo, context=None):
1758 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001759
Facundo Batista353750c2007-09-13 18:13:15 +00001760 # if can't convert other and modulo to Decimal, raise
1761 # TypeError; there's no point returning NotImplemented (no
1762 # equivalent of __rpow__ for three argument pow)
1763 other = _convert_other(other, raiseit=True)
1764 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001765
Facundo Batista353750c2007-09-13 18:13:15 +00001766 if context is None:
1767 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001768
Facundo Batista353750c2007-09-13 18:13:15 +00001769 # deal with NaNs: if there are any sNaNs then first one wins,
1770 # (i.e. behaviour for NaNs is identical to that of fma)
1771 self_is_nan = self._isnan()
1772 other_is_nan = other._isnan()
1773 modulo_is_nan = modulo._isnan()
1774 if self_is_nan or other_is_nan or modulo_is_nan:
1775 if self_is_nan == 2:
1776 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001777 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001778 if other_is_nan == 2:
1779 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001780 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001781 if modulo_is_nan == 2:
1782 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001783 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001784 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001785 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001786 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001787 return other._fix_nan(context)
1788 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001789
Facundo Batista353750c2007-09-13 18:13:15 +00001790 # check inputs: we apply same restrictions as Python's pow()
1791 if not (self._isinteger() and
1792 other._isinteger() and
1793 modulo._isinteger()):
1794 return context._raise_error(InvalidOperation,
1795 'pow() 3rd argument not allowed '
1796 'unless all arguments are integers')
1797 if other < 0:
1798 return context._raise_error(InvalidOperation,
1799 'pow() 2nd argument cannot be '
1800 'negative when 3rd argument specified')
1801 if not modulo:
1802 return context._raise_error(InvalidOperation,
1803 'pow() 3rd argument cannot be 0')
1804
1805 # additional restriction for decimal: the modulus must be less
1806 # than 10**prec in absolute value
1807 if modulo.adjusted() >= context.prec:
1808 return context._raise_error(InvalidOperation,
1809 'insufficient precision: pow() 3rd '
1810 'argument must not have more than '
1811 'precision digits')
1812
1813 # define 0**0 == NaN, for consistency with two-argument pow
1814 # (even though it hurts!)
1815 if not other and not self:
1816 return context._raise_error(InvalidOperation,
1817 'at least one of pow() 1st argument '
1818 'and 2nd argument must be nonzero ;'
1819 '0**0 is not defined')
1820
1821 # compute sign of result
1822 if other._iseven():
1823 sign = 0
1824 else:
1825 sign = self._sign
1826
1827 # convert modulo to a Python integer, and self and other to
1828 # Decimal integers (i.e. force their exponents to be >= 0)
1829 modulo = abs(int(modulo))
1830 base = _WorkRep(self.to_integral_value())
1831 exponent = _WorkRep(other.to_integral_value())
1832
1833 # compute result using integer pow()
1834 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1835 for i in xrange(exponent.exp):
1836 base = pow(base, 10, modulo)
1837 base = pow(base, exponent.int, modulo)
1838
Facundo Batista72bc54f2007-11-23 17:59:00 +00001839 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001840
1841 def _power_exact(self, other, p):
1842 """Attempt to compute self**other exactly.
1843
1844 Given Decimals self and other and an integer p, attempt to
1845 compute an exact result for the power self**other, with p
1846 digits of precision. Return None if self**other is not
1847 exactly representable in p digits.
1848
1849 Assumes that elimination of special cases has already been
1850 performed: self and other must both be nonspecial; self must
1851 be positive and not numerically equal to 1; other must be
1852 nonzero. For efficiency, other._exp should not be too large,
1853 so that 10**abs(other._exp) is a feasible calculation."""
1854
1855 # In the comments below, we write x for the value of self and
1856 # y for the value of other. Write x = xc*10**xe and y =
1857 # yc*10**ye.
1858
1859 # The main purpose of this method is to identify the *failure*
1860 # of x**y to be exactly representable with as little effort as
1861 # possible. So we look for cheap and easy tests that
1862 # eliminate the possibility of x**y being exact. Only if all
1863 # these tests are passed do we go on to actually compute x**y.
1864
1865 # Here's the main idea. First normalize both x and y. We
1866 # express y as a rational m/n, with m and n relatively prime
1867 # and n>0. Then for x**y to be exactly representable (at
1868 # *any* precision), xc must be the nth power of a positive
1869 # integer and xe must be divisible by n. If m is negative
1870 # then additionally xc must be a power of either 2 or 5, hence
1871 # a power of 2**n or 5**n.
1872 #
1873 # There's a limit to how small |y| can be: if y=m/n as above
1874 # then:
1875 #
1876 # (1) if xc != 1 then for the result to be representable we
1877 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1878 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1879 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1880 # representable.
1881 #
1882 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1883 # |y| < 1/|xe| then the result is not representable.
1884 #
1885 # Note that since x is not equal to 1, at least one of (1) and
1886 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1887 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1888 #
1889 # There's also a limit to how large y can be, at least if it's
1890 # positive: the normalized result will have coefficient xc**y,
1891 # so if it's representable then xc**y < 10**p, and y <
1892 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1893 # not exactly representable.
1894
1895 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1896 # so |y| < 1/xe and the result is not representable.
1897 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1898 # < 1/nbits(xc).
1899
1900 x = _WorkRep(self)
1901 xc, xe = x.int, x.exp
1902 while xc % 10 == 0:
1903 xc //= 10
1904 xe += 1
1905
1906 y = _WorkRep(other)
1907 yc, ye = y.int, y.exp
1908 while yc % 10 == 0:
1909 yc //= 10
1910 ye += 1
1911
1912 # case where xc == 1: result is 10**(xe*y), with xe*y
1913 # required to be an integer
1914 if xc == 1:
1915 if ye >= 0:
1916 exponent = xe*yc*10**ye
1917 else:
1918 exponent, remainder = divmod(xe*yc, 10**-ye)
1919 if remainder:
1920 return None
1921 if y.sign == 1:
1922 exponent = -exponent
1923 # if other is a nonnegative integer, use ideal exponent
1924 if other._isinteger() and other._sign == 0:
1925 ideal_exponent = self._exp*int(other)
1926 zeros = min(exponent-ideal_exponent, p-1)
1927 else:
1928 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00001929 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00001930
1931 # case where y is negative: xc must be either a power
1932 # of 2 or a power of 5.
1933 if y.sign == 1:
1934 last_digit = xc % 10
1935 if last_digit in (2,4,6,8):
1936 # quick test for power of 2
1937 if xc & -xc != xc:
1938 return None
1939 # now xc is a power of 2; e is its exponent
1940 e = _nbits(xc)-1
1941 # find e*y and xe*y; both must be integers
1942 if ye >= 0:
1943 y_as_int = yc*10**ye
1944 e = e*y_as_int
1945 xe = xe*y_as_int
1946 else:
1947 ten_pow = 10**-ye
1948 e, remainder = divmod(e*yc, ten_pow)
1949 if remainder:
1950 return None
1951 xe, remainder = divmod(xe*yc, ten_pow)
1952 if remainder:
1953 return None
1954
1955 if e*65 >= p*93: # 93/65 > log(10)/log(5)
1956 return None
1957 xc = 5**e
1958
1959 elif last_digit == 5:
1960 # e >= log_5(xc) if xc is a power of 5; we have
1961 # equality all the way up to xc=5**2658
1962 e = _nbits(xc)*28//65
1963 xc, remainder = divmod(5**e, xc)
1964 if remainder:
1965 return None
1966 while xc % 5 == 0:
1967 xc //= 5
1968 e -= 1
1969 if ye >= 0:
1970 y_as_integer = yc*10**ye
1971 e = e*y_as_integer
1972 xe = xe*y_as_integer
1973 else:
1974 ten_pow = 10**-ye
1975 e, remainder = divmod(e*yc, ten_pow)
1976 if remainder:
1977 return None
1978 xe, remainder = divmod(xe*yc, ten_pow)
1979 if remainder:
1980 return None
1981 if e*3 >= p*10: # 10/3 > log(10)/log(2)
1982 return None
1983 xc = 2**e
1984 else:
1985 return None
1986
1987 if xc >= 10**p:
1988 return None
1989 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00001990 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00001991
1992 # now y is positive; find m and n such that y = m/n
1993 if ye >= 0:
1994 m, n = yc*10**ye, 1
1995 else:
1996 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
1997 return None
1998 xc_bits = _nbits(xc)
1999 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2000 return None
2001 m, n = yc, 10**(-ye)
2002 while m % 2 == n % 2 == 0:
2003 m //= 2
2004 n //= 2
2005 while m % 5 == n % 5 == 0:
2006 m //= 5
2007 n //= 5
2008
2009 # compute nth root of xc*10**xe
2010 if n > 1:
2011 # if 1 < xc < 2**n then xc isn't an nth power
2012 if xc != 1 and xc_bits <= n:
2013 return None
2014
2015 xe, rem = divmod(xe, n)
2016 if rem != 0:
2017 return None
2018
2019 # compute nth root of xc using Newton's method
2020 a = 1L << -(-_nbits(xc)//n) # initial estimate
2021 while True:
2022 q, r = divmod(xc, a**(n-1))
2023 if a <= q:
2024 break
2025 else:
2026 a = (a*(n-1) + q)//n
2027 if not (a == q and r == 0):
2028 return None
2029 xc = a
2030
2031 # now xc*10**xe is the nth root of the original xc*10**xe
2032 # compute mth power of xc*10**xe
2033
2034 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2035 # 10**p and the result is not representable.
2036 if xc > 1 and m > p*100//_log10_lb(xc):
2037 return None
2038 xc = xc**m
2039 xe *= m
2040 if xc > 10**p:
2041 return None
2042
2043 # by this point the result *is* exactly representable
2044 # adjust the exponent to get as close as possible to the ideal
2045 # exponent, if necessary
2046 str_xc = str(xc)
2047 if other._isinteger() and other._sign == 0:
2048 ideal_exponent = self._exp*int(other)
2049 zeros = min(xe-ideal_exponent, p-len(str_xc))
2050 else:
2051 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002052 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002053
2054 def __pow__(self, other, modulo=None, context=None):
2055 """Return self ** other [ % modulo].
2056
2057 With two arguments, compute self**other.
2058
2059 With three arguments, compute (self**other) % modulo. For the
2060 three argument form, the following restrictions on the
2061 arguments hold:
2062
2063 - all three arguments must be integral
2064 - other must be nonnegative
2065 - either self or other (or both) must be nonzero
2066 - modulo must be nonzero and must have at most p digits,
2067 where p is the context precision.
2068
2069 If any of these restrictions is violated the InvalidOperation
2070 flag is raised.
2071
2072 The result of pow(self, other, modulo) is identical to the
2073 result that would be obtained by computing (self**other) %
2074 modulo with unbounded precision, but is computed more
2075 efficiently. It is always exact.
2076 """
2077
2078 if modulo is not None:
2079 return self._power_modulo(other, modulo, context)
2080
2081 other = _convert_other(other)
2082 if other is NotImplemented:
2083 return other
2084
2085 if context is None:
2086 context = getcontext()
2087
2088 # either argument is a NaN => result is NaN
2089 ans = self._check_nans(other, context)
2090 if ans:
2091 return ans
2092
2093 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2094 if not other:
2095 if not self:
2096 return context._raise_error(InvalidOperation, '0 ** 0')
2097 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002098 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002099
2100 # result has sign 1 iff self._sign is 1 and other is an odd integer
2101 result_sign = 0
2102 if self._sign == 1:
2103 if other._isinteger():
2104 if not other._iseven():
2105 result_sign = 1
2106 else:
2107 # -ve**noninteger = NaN
2108 # (-0)**noninteger = 0**noninteger
2109 if self:
2110 return context._raise_error(InvalidOperation,
2111 'x ** y with x negative and y not an integer')
2112 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002113 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002114
2115 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2116 if not self:
2117 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002118 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002119 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002120 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002121
2122 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002123 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002124 if other._sign == 0:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002125 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002126 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002127 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002128
Facundo Batista353750c2007-09-13 18:13:15 +00002129 # 1**other = 1, but the choice of exponent and the flags
2130 # depend on the exponent of self, and on whether other is a
2131 # positive integer, a negative integer, or neither
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002132 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002133 if other._isinteger():
2134 # exp = max(self._exp*max(int(other), 0),
2135 # 1-context.prec) but evaluating int(other) directly
2136 # is dangerous until we know other is small (other
2137 # could be 1e999999999)
2138 if other._sign == 1:
2139 multiplier = 0
2140 elif other > context.prec:
2141 multiplier = context.prec
2142 else:
2143 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002144
Facundo Batista353750c2007-09-13 18:13:15 +00002145 exp = self._exp * multiplier
2146 if exp < 1-context.prec:
2147 exp = 1-context.prec
2148 context._raise_error(Rounded)
2149 else:
2150 context._raise_error(Inexact)
2151 context._raise_error(Rounded)
2152 exp = 1-context.prec
2153
Facundo Batista72bc54f2007-11-23 17:59:00 +00002154 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002155
2156 # compute adjusted exponent of self
2157 self_adj = self.adjusted()
2158
2159 # self ** infinity is infinity if self > 1, 0 if self < 1
2160 # self ** -infinity is infinity if self < 1, 0 if self > 1
2161 if other._isinfinity():
2162 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002163 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002164 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002165 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002166
2167 # from here on, the result always goes through the call
2168 # to _fix at the end of this function.
2169 ans = None
2170
2171 # crude test to catch cases of extreme overflow/underflow. If
2172 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2173 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2174 # self**other >= 10**(Emax+1), so overflow occurs. The test
2175 # for underflow is similar.
2176 bound = self._log10_exp_bound() + other.adjusted()
2177 if (self_adj >= 0) == (other._sign == 0):
2178 # self > 1 and other +ve, or self < 1 and other -ve
2179 # possibility of overflow
2180 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002181 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002182 else:
2183 # self > 1 and other -ve, or self < 1 and other +ve
2184 # possibility of underflow to 0
2185 Etiny = context.Etiny()
2186 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002187 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002188
2189 # try for an exact result with precision +1
2190 if ans is None:
2191 ans = self._power_exact(other, context.prec + 1)
2192 if ans is not None and result_sign == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002193 ans = _dec_from_triple(1, ans._int, ans._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002194
2195 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2196 if ans is None:
2197 p = context.prec
2198 x = _WorkRep(self)
2199 xc, xe = x.int, x.exp
2200 y = _WorkRep(other)
2201 yc, ye = y.int, y.exp
2202 if y.sign == 1:
2203 yc = -yc
2204
2205 # compute correctly rounded result: start with precision +3,
2206 # then increase precision until result is unambiguously roundable
2207 extra = 3
2208 while True:
2209 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2210 if coeff % (5*10**(len(str(coeff))-p-1)):
2211 break
2212 extra += 3
2213
Facundo Batista72bc54f2007-11-23 17:59:00 +00002214 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002215
2216 # the specification says that for non-integer other we need to
2217 # raise Inexact, even when the result is actually exact. In
2218 # the same way, we need to raise Underflow here if the result
2219 # is subnormal. (The call to _fix will take care of raising
2220 # Rounded and Subnormal, as usual.)
2221 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002222 context._raise_error(Inexact)
Facundo Batista353750c2007-09-13 18:13:15 +00002223 # pad with zeros up to length context.prec+1 if necessary
2224 if len(ans._int) <= context.prec:
2225 expdiff = context.prec+1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002226 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2227 ans._exp-expdiff)
Facundo Batista353750c2007-09-13 18:13:15 +00002228 if ans.adjusted() < context.Emin:
2229 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002230
Facundo Batista353750c2007-09-13 18:13:15 +00002231 # unlike exp, ln and log10, the power function respects the
2232 # rounding mode; no need to use ROUND_HALF_EVEN here
2233 ans = ans._fix(context)
2234 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002235
2236 def __rpow__(self, other, context=None):
2237 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002238 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002239 if other is NotImplemented:
2240 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002241 return other.__pow__(self, context=context)
2242
2243 def normalize(self, context=None):
2244 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002245
Facundo Batista353750c2007-09-13 18:13:15 +00002246 if context is None:
2247 context = getcontext()
2248
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002249 if self._is_special:
2250 ans = self._check_nans(context=context)
2251 if ans:
2252 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002253
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002254 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002255 if dup._isinfinity():
2256 return dup
2257
2258 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002259 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002260 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002261 end = len(dup._int)
2262 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002263 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002264 exp += 1
2265 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002266 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002267
Facundo Batistabd2fe832007-09-13 18:42:09 +00002268 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002269 """Quantize self so its exponent is the same as that of exp.
2270
2271 Similar to self._rescale(exp._exp) but with error checking.
2272 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002273 exp = _convert_other(exp, raiseit=True)
2274
Facundo Batista353750c2007-09-13 18:13:15 +00002275 if context is None:
2276 context = getcontext()
2277 if rounding is None:
2278 rounding = context.rounding
2279
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002280 if self._is_special or exp._is_special:
2281 ans = self._check_nans(exp, context)
2282 if ans:
2283 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002284
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002285 if exp._isinfinity() or self._isinfinity():
2286 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002287 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002288 return context._raise_error(InvalidOperation,
2289 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002290
Facundo Batistabd2fe832007-09-13 18:42:09 +00002291 # if we're not watching exponents, do a simple rescale
2292 if not watchexp:
2293 ans = self._rescale(exp._exp, rounding)
2294 # raise Inexact and Rounded where appropriate
2295 if ans._exp > self._exp:
2296 context._raise_error(Rounded)
2297 if ans != self:
2298 context._raise_error(Inexact)
2299 return ans
2300
Facundo Batista353750c2007-09-13 18:13:15 +00002301 # exp._exp should be between Etiny and Emax
2302 if not (context.Etiny() <= exp._exp <= context.Emax):
2303 return context._raise_error(InvalidOperation,
2304 'target exponent out of bounds in quantize')
2305
2306 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002307 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002308 return ans._fix(context)
2309
2310 self_adjusted = self.adjusted()
2311 if self_adjusted > context.Emax:
2312 return context._raise_error(InvalidOperation,
2313 'exponent of quantize result too large for current context')
2314 if self_adjusted - exp._exp + 1 > context.prec:
2315 return context._raise_error(InvalidOperation,
2316 'quantize result has too many digits for current context')
2317
2318 ans = self._rescale(exp._exp, rounding)
2319 if ans.adjusted() > context.Emax:
2320 return context._raise_error(InvalidOperation,
2321 'exponent of quantize result too large for current context')
2322 if len(ans._int) > context.prec:
2323 return context._raise_error(InvalidOperation,
2324 'quantize result has too many digits for current context')
2325
2326 # raise appropriate flags
2327 if ans._exp > self._exp:
2328 context._raise_error(Rounded)
2329 if ans != self:
2330 context._raise_error(Inexact)
2331 if ans and ans.adjusted() < context.Emin:
2332 context._raise_error(Subnormal)
2333
2334 # call to fix takes care of any necessary folddown
2335 ans = ans._fix(context)
2336 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002337
2338 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002339 """Return True if self and other have the same exponent; otherwise
2340 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002341
Facundo Batista1a191df2007-10-02 17:01:24 +00002342 If either operand is a special value, the following rules are used:
2343 * return True if both operands are infinities
2344 * return True if both operands are NaNs
2345 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002346 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002347 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002348 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002349 return (self.is_nan() and other.is_nan() or
2350 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002351 return self._exp == other._exp
2352
Facundo Batista353750c2007-09-13 18:13:15 +00002353 def _rescale(self, exp, rounding):
2354 """Rescale self so that the exponent is exp, either by padding with zeros
2355 or by truncating digits, using the given rounding mode.
2356
2357 Specials are returned without change. This operation is
2358 quiet: it raises no flags, and uses no information from the
2359 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002360
2361 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002362 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002363 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002364 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002365 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002366 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002367 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002368
Facundo Batista353750c2007-09-13 18:13:15 +00002369 if self._exp >= exp:
2370 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002371 return _dec_from_triple(self._sign,
2372 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002373
Facundo Batista353750c2007-09-13 18:13:15 +00002374 # too many digits; round and lose data. If self.adjusted() <
2375 # exp-1, replace self by 10**(exp-1) before rounding
2376 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002377 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002378 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002379 digits = 0
2380 this_function = getattr(self, self._pick_rounding_function[rounding])
Facundo Batista2ec74152007-12-03 17:55:00 +00002381 changed = this_function(digits)
2382 coeff = self._int[:digits] or '0'
2383 if changed == 1:
2384 coeff = str(int(coeff)+1)
2385 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002386
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002387 def _round(self, places, rounding):
2388 """Round a nonzero, nonspecial Decimal to a fixed number of
2389 significant figures, using the given rounding mode.
2390
2391 Infinities, NaNs and zeros are returned unaltered.
2392
2393 This operation is quiet: it raises no flags, and uses no
2394 information from the context.
2395
2396 """
2397 if places <= 0:
2398 raise ValueError("argument should be at least 1 in _round")
2399 if self._is_special or not self:
2400 return Decimal(self)
2401 ans = self._rescale(self.adjusted()+1-places, rounding)
2402 # it can happen that the rescale alters the adjusted exponent;
2403 # for example when rounding 99.97 to 3 significant figures.
2404 # When this happens we end up with an extra 0 at the end of
2405 # the number; a second rescale fixes this.
2406 if ans.adjusted() != self.adjusted():
2407 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2408 return ans
2409
Facundo Batista353750c2007-09-13 18:13:15 +00002410 def to_integral_exact(self, rounding=None, context=None):
2411 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002412
Facundo Batista353750c2007-09-13 18:13:15 +00002413 If no rounding mode is specified, take the rounding mode from
2414 the context. This method raises the Rounded and Inexact flags
2415 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002416
Facundo Batista353750c2007-09-13 18:13:15 +00002417 See also: to_integral_value, which does exactly the same as
2418 this method except that it doesn't raise Inexact or Rounded.
2419 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002420 if self._is_special:
2421 ans = self._check_nans(context=context)
2422 if ans:
2423 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002424 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002425 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002426 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002427 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002428 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002429 if context is None:
2430 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002431 if rounding is None:
2432 rounding = context.rounding
2433 context._raise_error(Rounded)
2434 ans = self._rescale(0, rounding)
2435 if ans != self:
2436 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002437 return ans
2438
Facundo Batista353750c2007-09-13 18:13:15 +00002439 def to_integral_value(self, rounding=None, context=None):
2440 """Rounds to the nearest integer, without raising inexact, rounded."""
2441 if context is None:
2442 context = getcontext()
2443 if rounding is None:
2444 rounding = context.rounding
2445 if self._is_special:
2446 ans = self._check_nans(context=context)
2447 if ans:
2448 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002449 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002450 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002451 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002452 else:
2453 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002454
Facundo Batista353750c2007-09-13 18:13:15 +00002455 # the method name changed, but we provide also the old one, for compatibility
2456 to_integral = to_integral_value
2457
2458 def sqrt(self, context=None):
2459 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002460 if context is None:
2461 context = getcontext()
2462
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002463 if self._is_special:
2464 ans = self._check_nans(context=context)
2465 if ans:
2466 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002467
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002468 if self._isinfinity() and self._sign == 0:
2469 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002470
2471 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002472 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002473 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002474 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002475
2476 if self._sign == 1:
2477 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2478
Facundo Batista353750c2007-09-13 18:13:15 +00002479 # At this point self represents a positive number. Let p be
2480 # the desired precision and express self in the form c*100**e
2481 # with c a positive real number and e an integer, c and e
2482 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2483 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2484 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2485 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2486 # the closest integer to sqrt(c) with the even integer chosen
2487 # in the case of a tie.
2488 #
2489 # To ensure correct rounding in all cases, we use the
2490 # following trick: we compute the square root to an extra
2491 # place (precision p+1 instead of precision p), rounding down.
2492 # Then, if the result is inexact and its last digit is 0 or 5,
2493 # we increase the last digit to 1 or 6 respectively; if it's
2494 # exact we leave the last digit alone. Now the final round to
2495 # p places (or fewer in the case of underflow) will round
2496 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002497
Facundo Batista353750c2007-09-13 18:13:15 +00002498 # use an extra digit of precision
2499 prec = context.prec+1
2500
2501 # write argument in the form c*100**e where e = self._exp//2
2502 # is the 'ideal' exponent, to be used if the square root is
2503 # exactly representable. l is the number of 'digits' of c in
2504 # base 100, so that 100**(l-1) <= c < 100**l.
2505 op = _WorkRep(self)
2506 e = op.exp >> 1
2507 if op.exp & 1:
2508 c = op.int * 10
2509 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002510 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002511 c = op.int
2512 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002513
Facundo Batista353750c2007-09-13 18:13:15 +00002514 # rescale so that c has exactly prec base 100 'digits'
2515 shift = prec-l
2516 if shift >= 0:
2517 c *= 100**shift
2518 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002519 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002520 c, remainder = divmod(c, 100**-shift)
2521 exact = not remainder
2522 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002523
Facundo Batista353750c2007-09-13 18:13:15 +00002524 # find n = floor(sqrt(c)) using Newton's method
2525 n = 10**prec
2526 while True:
2527 q = c//n
2528 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002529 break
Facundo Batista353750c2007-09-13 18:13:15 +00002530 else:
2531 n = n + q >> 1
2532 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002533
Facundo Batista353750c2007-09-13 18:13:15 +00002534 if exact:
2535 # result is exact; rescale to use ideal exponent e
2536 if shift >= 0:
2537 # assert n % 10**shift == 0
2538 n //= 10**shift
2539 else:
2540 n *= 10**-shift
2541 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002542 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002543 # result is not exact; fix last digit as described above
2544 if n % 5 == 0:
2545 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002546
Facundo Batista72bc54f2007-11-23 17:59:00 +00002547 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002548
Facundo Batista353750c2007-09-13 18:13:15 +00002549 # round, and fit to current context
2550 context = context._shallow_copy()
2551 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002552 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002553 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002554
Facundo Batista353750c2007-09-13 18:13:15 +00002555 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002556
2557 def max(self, other, context=None):
2558 """Returns the larger value.
2559
Facundo Batista353750c2007-09-13 18:13:15 +00002560 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002561 NaN (and signals if one is sNaN). Also rounds.
2562 """
Facundo Batista353750c2007-09-13 18:13:15 +00002563 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002564
Facundo Batista6c398da2007-09-17 17:30:13 +00002565 if context is None:
2566 context = getcontext()
2567
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002568 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002569 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002570 # number is always returned
2571 sn = self._isnan()
2572 on = other._isnan()
2573 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00002574 if on == 1 and sn == 0:
2575 return self._fix(context)
2576 if sn == 1 and on == 0:
2577 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002578 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002579
Mark Dickinson2fc92632008-02-06 22:10:50 +00002580 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002581 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002582 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002583 # then an ordering is applied:
2584 #
Facundo Batista59c58842007-04-10 12:58:45 +00002585 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002586 # positive sign and min returns the operand with the negative sign
2587 #
Facundo Batista59c58842007-04-10 12:58:45 +00002588 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002589 # the result. This is exactly the ordering used in compare_total.
2590 c = self.compare_total(other)
2591
2592 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002593 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002594 else:
2595 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002596
Facundo Batistae64acfa2007-12-17 14:18:42 +00002597 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002598
2599 def min(self, other, context=None):
2600 """Returns the smaller value.
2601
Facundo Batista59c58842007-04-10 12:58:45 +00002602 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002603 NaN (and signals if one is sNaN). Also rounds.
2604 """
Facundo Batista353750c2007-09-13 18:13:15 +00002605 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002606
Facundo Batista6c398da2007-09-17 17:30:13 +00002607 if context is None:
2608 context = getcontext()
2609
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002610 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002611 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002612 # number is always returned
2613 sn = self._isnan()
2614 on = other._isnan()
2615 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00002616 if on == 1 and sn == 0:
2617 return self._fix(context)
2618 if sn == 1 and on == 0:
2619 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002620 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002621
Mark Dickinson2fc92632008-02-06 22:10:50 +00002622 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002623 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002624 c = self.compare_total(other)
2625
2626 if c == -1:
2627 ans = self
2628 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002629 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002630
Facundo Batistae64acfa2007-12-17 14:18:42 +00002631 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002632
2633 def _isinteger(self):
2634 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002635 if self._is_special:
2636 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002637 if self._exp >= 0:
2638 return True
2639 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002640 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002641
2642 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002643 """Returns True if self is even. Assumes self is an integer."""
2644 if not self or self._exp > 0:
2645 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002646 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002647
2648 def adjusted(self):
2649 """Return the adjusted exponent of self"""
2650 try:
2651 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002652 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002653 except TypeError:
2654 return 0
2655
Facundo Batista353750c2007-09-13 18:13:15 +00002656 def canonical(self, context=None):
2657 """Returns the same Decimal object.
2658
2659 As we do not have different encodings for the same number, the
2660 received object already is in its canonical form.
2661 """
2662 return self
2663
2664 def compare_signal(self, other, context=None):
2665 """Compares self to the other operand numerically.
2666
2667 It's pretty much like compare(), but all NaNs signal, with signaling
2668 NaNs taking precedence over quiet NaNs.
2669 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002670 other = _convert_other(other, raiseit = True)
2671 ans = self._compare_check_nans(other, context)
2672 if ans:
2673 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002674 return self.compare(other, context=context)
2675
2676 def compare_total(self, other):
2677 """Compares self to other using the abstract representations.
2678
2679 This is not like the standard compare, which use their numerical
2680 value. Note that a total ordering is defined for all possible abstract
2681 representations.
2682 """
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00002683 other = _convert_other(other, raiseit=True)
2684
Facundo Batista353750c2007-09-13 18:13:15 +00002685 # if one is negative and the other is positive, it's easy
2686 if self._sign and not other._sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002687 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002688 if not self._sign and other._sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002689 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002690 sign = self._sign
2691
2692 # let's handle both NaN types
2693 self_nan = self._isnan()
2694 other_nan = other._isnan()
2695 if self_nan or other_nan:
2696 if self_nan == other_nan:
Mark Dickinson7f265b72009-08-28 13:35:02 +00002697 # compare payloads as though they're integers
2698 self_key = len(self._int), self._int
2699 other_key = len(other._int), other._int
2700 if self_key < other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002701 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002702 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002703 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002704 return _NegativeOne
Mark Dickinson7f265b72009-08-28 13:35:02 +00002705 if self_key > other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002706 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002707 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002708 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002709 return _One
2710 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002711
2712 if sign:
2713 if self_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002714 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002715 if other_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002716 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002717 if self_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002718 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002719 if other_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002720 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002721 else:
2722 if self_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002723 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002724 if other_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002725 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002726 if self_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002727 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002728 if other_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002729 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002730
2731 if self < other:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002732 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002733 if self > other:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002734 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002735
2736 if self._exp < other._exp:
2737 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002738 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002739 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002740 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002741 if self._exp > other._exp:
2742 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002743 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002744 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002745 return _One
2746 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002747
2748
2749 def compare_total_mag(self, other):
2750 """Compares self to other using abstract repr., ignoring sign.
2751
2752 Like compare_total, but with operand's sign ignored and assumed to be 0.
2753 """
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00002754 other = _convert_other(other, raiseit=True)
2755
Facundo Batista353750c2007-09-13 18:13:15 +00002756 s = self.copy_abs()
2757 o = other.copy_abs()
2758 return s.compare_total(o)
2759
2760 def copy_abs(self):
2761 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002762 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002763
2764 def copy_negate(self):
2765 """Returns a copy with the sign inverted."""
2766 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002767 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002768 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002769 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002770
2771 def copy_sign(self, other):
2772 """Returns self with the sign of other."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002773 return _dec_from_triple(other._sign, self._int,
2774 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002775
2776 def exp(self, context=None):
2777 """Returns e ** self."""
2778
2779 if context is None:
2780 context = getcontext()
2781
2782 # exp(NaN) = NaN
2783 ans = self._check_nans(context=context)
2784 if ans:
2785 return ans
2786
2787 # exp(-Infinity) = 0
2788 if self._isinfinity() == -1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002789 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002790
2791 # exp(0) = 1
2792 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002793 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002794
2795 # exp(Infinity) = Infinity
2796 if self._isinfinity() == 1:
2797 return Decimal(self)
2798
2799 # the result is now guaranteed to be inexact (the true
2800 # mathematical result is transcendental). There's no need to
2801 # raise Rounded and Inexact here---they'll always be raised as
2802 # a result of the call to _fix.
2803 p = context.prec
2804 adj = self.adjusted()
2805
2806 # we only need to do any computation for quite a small range
2807 # of adjusted exponents---for example, -29 <= adj <= 10 for
2808 # the default context. For smaller exponent the result is
2809 # indistinguishable from 1 at the given precision, while for
2810 # larger exponent the result either overflows or underflows.
2811 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2812 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002813 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002814 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2815 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002816 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002817 elif self._sign == 0 and adj < -p:
2818 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002819 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002820 elif self._sign == 1 and adj < -p-1:
2821 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002822 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002823 # general case
2824 else:
2825 op = _WorkRep(self)
2826 c, e = op.int, op.exp
2827 if op.sign == 1:
2828 c = -c
2829
2830 # compute correctly rounded result: increase precision by
2831 # 3 digits at a time until we get an unambiguously
2832 # roundable result
2833 extra = 3
2834 while True:
2835 coeff, exp = _dexp(c, e, p+extra)
2836 if coeff % (5*10**(len(str(coeff))-p-1)):
2837 break
2838 extra += 3
2839
Facundo Batista72bc54f2007-11-23 17:59:00 +00002840 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002841
2842 # at this stage, ans should round correctly with *any*
2843 # rounding mode, not just with ROUND_HALF_EVEN
2844 context = context._shallow_copy()
2845 rounding = context._set_rounding(ROUND_HALF_EVEN)
2846 ans = ans._fix(context)
2847 context.rounding = rounding
2848
2849 return ans
2850
2851 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002852 """Return True if self is canonical; otherwise return False.
2853
2854 Currently, the encoding of a Decimal instance is always
2855 canonical, so this method returns True for any Decimal.
2856 """
2857 return True
Facundo Batista353750c2007-09-13 18:13:15 +00002858
2859 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002860 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00002861
Facundo Batista1a191df2007-10-02 17:01:24 +00002862 A Decimal instance is considered finite if it is neither
2863 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00002864 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002865 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00002866
2867 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002868 """Return True if self is infinite; otherwise return False."""
2869 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00002870
2871 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002872 """Return True if self is a qNaN or sNaN; otherwise return False."""
2873 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00002874
2875 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002876 """Return True if self is a normal number; otherwise return False."""
2877 if self._is_special or not self:
2878 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002879 if context is None:
2880 context = getcontext()
Mark Dickinson20a7cfc2009-10-27 18:27:53 +00002881 return context.Emin <= self.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +00002882
2883 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002884 """Return True if self is a quiet NaN; otherwise return False."""
2885 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00002886
2887 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002888 """Return True if self is negative; otherwise return False."""
2889 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00002890
2891 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002892 """Return True if self is a signaling NaN; otherwise return False."""
2893 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00002894
2895 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002896 """Return True if self is subnormal; otherwise return False."""
2897 if self._is_special or not self:
2898 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002899 if context is None:
2900 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002901 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00002902
2903 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002904 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002905 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00002906
2907 def _ln_exp_bound(self):
2908 """Compute a lower bound for the adjusted exponent of self.ln().
2909 In other words, compute r such that self.ln() >= 10**r. Assumes
2910 that self is finite and positive and that self != 1.
2911 """
2912
2913 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
2914 adj = self._exp + len(self._int) - 1
2915 if adj >= 1:
2916 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
2917 return len(str(adj*23//10)) - 1
2918 if adj <= -2:
2919 # argument <= 0.1
2920 return len(str((-1-adj)*23//10)) - 1
2921 op = _WorkRep(self)
2922 c, e = op.int, op.exp
2923 if adj == 0:
2924 # 1 < self < 10
2925 num = str(c-10**-e)
2926 den = str(c)
2927 return len(num) - len(den) - (num < den)
2928 # adj == -1, 0.1 <= self < 1
2929 return e + len(str(10**-e - c)) - 1
2930
2931
2932 def ln(self, context=None):
2933 """Returns the natural (base e) logarithm of self."""
2934
2935 if context is None:
2936 context = getcontext()
2937
2938 # ln(NaN) = NaN
2939 ans = self._check_nans(context=context)
2940 if ans:
2941 return ans
2942
2943 # ln(0.0) == -Infinity
2944 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002945 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00002946
2947 # ln(Infinity) = Infinity
2948 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002949 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00002950
2951 # ln(1.0) == 0.0
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002952 if self == _One:
2953 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002954
2955 # ln(negative) raises InvalidOperation
2956 if self._sign == 1:
2957 return context._raise_error(InvalidOperation,
2958 'ln of a negative value')
2959
2960 # result is irrational, so necessarily inexact
2961 op = _WorkRep(self)
2962 c, e = op.int, op.exp
2963 p = context.prec
2964
2965 # correctly rounded result: repeatedly increase precision by 3
2966 # until we get an unambiguously roundable result
2967 places = p - self._ln_exp_bound() + 2 # at least p+3 places
2968 while True:
2969 coeff = _dlog(c, e, places)
2970 # assert len(str(abs(coeff)))-p >= 1
2971 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
2972 break
2973 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00002974 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00002975
2976 context = context._shallow_copy()
2977 rounding = context._set_rounding(ROUND_HALF_EVEN)
2978 ans = ans._fix(context)
2979 context.rounding = rounding
2980 return ans
2981
2982 def _log10_exp_bound(self):
2983 """Compute a lower bound for the adjusted exponent of self.log10().
2984 In other words, find r such that self.log10() >= 10**r.
2985 Assumes that self is finite and positive and that self != 1.
2986 """
2987
2988 # For x >= 10 or x < 0.1 we only need a bound on the integer
2989 # part of log10(self), and this comes directly from the
2990 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
2991 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
2992 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
2993
2994 adj = self._exp + len(self._int) - 1
2995 if adj >= 1:
2996 # self >= 10
2997 return len(str(adj))-1
2998 if adj <= -2:
2999 # self < 0.1
3000 return len(str(-1-adj))-1
3001 op = _WorkRep(self)
3002 c, e = op.int, op.exp
3003 if adj == 0:
3004 # 1 < self < 10
3005 num = str(c-10**-e)
3006 den = str(231*c)
3007 return len(num) - len(den) - (num < den) + 2
3008 # adj == -1, 0.1 <= self < 1
3009 num = str(10**-e-c)
3010 return len(num) + e - (num < "231") - 1
3011
3012 def log10(self, context=None):
3013 """Returns the base 10 logarithm of self."""
3014
3015 if context is None:
3016 context = getcontext()
3017
3018 # log10(NaN) = NaN
3019 ans = self._check_nans(context=context)
3020 if ans:
3021 return ans
3022
3023 # log10(0.0) == -Infinity
3024 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003025 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003026
3027 # log10(Infinity) = Infinity
3028 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003029 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003030
3031 # log10(negative or -Infinity) raises InvalidOperation
3032 if self._sign == 1:
3033 return context._raise_error(InvalidOperation,
3034 'log10 of a negative value')
3035
3036 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003037 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003038 # answer may need rounding
3039 ans = Decimal(self._exp + len(self._int) - 1)
3040 else:
3041 # result is irrational, so necessarily inexact
3042 op = _WorkRep(self)
3043 c, e = op.int, op.exp
3044 p = context.prec
3045
3046 # correctly rounded result: repeatedly increase precision
3047 # until result is unambiguously roundable
3048 places = p-self._log10_exp_bound()+2
3049 while True:
3050 coeff = _dlog10(c, e, places)
3051 # assert len(str(abs(coeff)))-p >= 1
3052 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3053 break
3054 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003055 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003056
3057 context = context._shallow_copy()
3058 rounding = context._set_rounding(ROUND_HALF_EVEN)
3059 ans = ans._fix(context)
3060 context.rounding = rounding
3061 return ans
3062
3063 def logb(self, context=None):
3064 """ Returns the exponent of the magnitude of self's MSD.
3065
3066 The result is the integer which is the exponent of the magnitude
3067 of the most significant digit of self (as though it were truncated
3068 to a single digit while maintaining the value of that digit and
3069 without limiting the resulting exponent).
3070 """
3071 # logb(NaN) = NaN
3072 ans = self._check_nans(context=context)
3073 if ans:
3074 return ans
3075
3076 if context is None:
3077 context = getcontext()
3078
3079 # logb(+/-Inf) = +Inf
3080 if self._isinfinity():
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003081 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003082
3083 # logb(0) = -Inf, DivisionByZero
3084 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003085 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003086
3087 # otherwise, simply return the adjusted exponent of self, as a
3088 # Decimal. Note that no attempt is made to fit the result
3089 # into the current context.
Mark Dickinson5e672d02009-10-27 16:54:45 +00003090 ans = Decimal(self.adjusted())
3091 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003092
3093 def _islogical(self):
3094 """Return True if self is a logical operand.
3095
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003096 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003097 an exponent of 0, and a coefficient whose digits must all be
3098 either 0 or 1.
3099 """
3100 if self._sign != 0 or self._exp != 0:
3101 return False
3102 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003103 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003104 return False
3105 return True
3106
3107 def _fill_logical(self, context, opa, opb):
3108 dif = context.prec - len(opa)
3109 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003110 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003111 elif dif < 0:
3112 opa = opa[-context.prec:]
3113 dif = context.prec - len(opb)
3114 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003115 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003116 elif dif < 0:
3117 opb = opb[-context.prec:]
3118 return opa, opb
3119
3120 def logical_and(self, other, context=None):
3121 """Applies an 'and' operation between self and other's digits."""
3122 if context is None:
3123 context = getcontext()
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003124
3125 other = _convert_other(other, raiseit=True)
3126
Facundo Batista353750c2007-09-13 18:13:15 +00003127 if not self._islogical() or not other._islogical():
3128 return context._raise_error(InvalidOperation)
3129
3130 # fill to context.prec
3131 (opa, opb) = self._fill_logical(context, self._int, other._int)
3132
3133 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003134 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3135 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003136
3137 def logical_invert(self, context=None):
3138 """Invert all its digits."""
3139 if context is None:
3140 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003141 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3142 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003143
3144 def logical_or(self, other, context=None):
3145 """Applies an 'or' operation between self and other's digits."""
3146 if context is None:
3147 context = getcontext()
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003148
3149 other = _convert_other(other, raiseit=True)
3150
Facundo Batista353750c2007-09-13 18:13:15 +00003151 if not self._islogical() or not other._islogical():
3152 return context._raise_error(InvalidOperation)
3153
3154 # fill to context.prec
3155 (opa, opb) = self._fill_logical(context, self._int, other._int)
3156
3157 # make the operation, and clean starting zeroes
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00003158 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003159 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003160
3161 def logical_xor(self, other, context=None):
3162 """Applies an 'xor' operation between self and other's digits."""
3163 if context is None:
3164 context = getcontext()
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003165
3166 other = _convert_other(other, raiseit=True)
3167
Facundo Batista353750c2007-09-13 18:13:15 +00003168 if not self._islogical() or not other._islogical():
3169 return context._raise_error(InvalidOperation)
3170
3171 # fill to context.prec
3172 (opa, opb) = self._fill_logical(context, self._int, other._int)
3173
3174 # make the operation, and clean starting zeroes
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00003175 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003176 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003177
3178 def max_mag(self, other, context=None):
3179 """Compares the values numerically with their sign ignored."""
3180 other = _convert_other(other, raiseit=True)
3181
Facundo Batista6c398da2007-09-17 17:30:13 +00003182 if context is None:
3183 context = getcontext()
3184
Facundo Batista353750c2007-09-13 18:13:15 +00003185 if self._is_special or other._is_special:
3186 # If one operand is a quiet NaN and the other is number, then the
3187 # number is always returned
3188 sn = self._isnan()
3189 on = other._isnan()
3190 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00003191 if on == 1 and sn == 0:
3192 return self._fix(context)
3193 if sn == 1 and on == 0:
3194 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003195 return self._check_nans(other, context)
3196
Mark Dickinson2fc92632008-02-06 22:10:50 +00003197 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003198 if c == 0:
3199 c = self.compare_total(other)
3200
3201 if c == -1:
3202 ans = other
3203 else:
3204 ans = self
3205
Facundo Batistae64acfa2007-12-17 14:18:42 +00003206 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003207
3208 def min_mag(self, other, context=None):
3209 """Compares the values numerically with their sign ignored."""
3210 other = _convert_other(other, raiseit=True)
3211
Facundo Batista6c398da2007-09-17 17:30:13 +00003212 if context is None:
3213 context = getcontext()
3214
Facundo Batista353750c2007-09-13 18:13:15 +00003215 if self._is_special or other._is_special:
3216 # If one operand is a quiet NaN and the other is number, then the
3217 # number is always returned
3218 sn = self._isnan()
3219 on = other._isnan()
3220 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00003221 if on == 1 and sn == 0:
3222 return self._fix(context)
3223 if sn == 1 and on == 0:
3224 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003225 return self._check_nans(other, context)
3226
Mark Dickinson2fc92632008-02-06 22:10:50 +00003227 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003228 if c == 0:
3229 c = self.compare_total(other)
3230
3231 if c == -1:
3232 ans = self
3233 else:
3234 ans = other
3235
Facundo Batistae64acfa2007-12-17 14:18:42 +00003236 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003237
3238 def next_minus(self, context=None):
3239 """Returns the largest representable number smaller than itself."""
3240 if context is None:
3241 context = getcontext()
3242
3243 ans = self._check_nans(context=context)
3244 if ans:
3245 return ans
3246
3247 if self._isinfinity() == -1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003248 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003249 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003250 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003251
3252 context = context.copy()
3253 context._set_rounding(ROUND_FLOOR)
3254 context._ignore_all_flags()
3255 new_self = self._fix(context)
3256 if new_self != self:
3257 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003258 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3259 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003260
3261 def next_plus(self, context=None):
3262 """Returns the smallest representable number larger than itself."""
3263 if context is None:
3264 context = getcontext()
3265
3266 ans = self._check_nans(context=context)
3267 if ans:
3268 return ans
3269
3270 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003271 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003272 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003273 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003274
3275 context = context.copy()
3276 context._set_rounding(ROUND_CEILING)
3277 context._ignore_all_flags()
3278 new_self = self._fix(context)
3279 if new_self != self:
3280 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003281 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3282 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003283
3284 def next_toward(self, other, context=None):
3285 """Returns the number closest to self, in the direction towards other.
3286
3287 The result is the closest representable number to self
3288 (excluding self) that is in the direction towards other,
3289 unless both have the same value. If the two operands are
3290 numerically equal, then the result is a copy of self with the
3291 sign set to be the same as the sign of other.
3292 """
3293 other = _convert_other(other, raiseit=True)
3294
3295 if context is None:
3296 context = getcontext()
3297
3298 ans = self._check_nans(other, context)
3299 if ans:
3300 return ans
3301
Mark Dickinson2fc92632008-02-06 22:10:50 +00003302 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003303 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003304 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003305
3306 if comparison == -1:
3307 ans = self.next_plus(context)
3308 else: # comparison == 1
3309 ans = self.next_minus(context)
3310
3311 # decide which flags to raise using value of ans
3312 if ans._isinfinity():
3313 context._raise_error(Overflow,
3314 'Infinite result from next_toward',
3315 ans._sign)
3316 context._raise_error(Rounded)
3317 context._raise_error(Inexact)
3318 elif ans.adjusted() < context.Emin:
3319 context._raise_error(Underflow)
3320 context._raise_error(Subnormal)
3321 context._raise_error(Rounded)
3322 context._raise_error(Inexact)
3323 # if precision == 1 then we don't raise Clamped for a
3324 # result 0E-Etiny.
3325 if not ans:
3326 context._raise_error(Clamped)
3327
3328 return ans
3329
3330 def number_class(self, context=None):
3331 """Returns an indication of the class of self.
3332
3333 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003334 sNaN
3335 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003336 -Infinity
3337 -Normal
3338 -Subnormal
3339 -Zero
3340 +Zero
3341 +Subnormal
3342 +Normal
3343 +Infinity
3344 """
3345 if self.is_snan():
3346 return "sNaN"
3347 if self.is_qnan():
3348 return "NaN"
3349 inf = self._isinfinity()
3350 if inf == 1:
3351 return "+Infinity"
3352 if inf == -1:
3353 return "-Infinity"
3354 if self.is_zero():
3355 if self._sign:
3356 return "-Zero"
3357 else:
3358 return "+Zero"
3359 if context is None:
3360 context = getcontext()
3361 if self.is_subnormal(context=context):
3362 if self._sign:
3363 return "-Subnormal"
3364 else:
3365 return "+Subnormal"
3366 # just a normal, regular, boring number, :)
3367 if self._sign:
3368 return "-Normal"
3369 else:
3370 return "+Normal"
3371
3372 def radix(self):
3373 """Just returns 10, as this is Decimal, :)"""
3374 return Decimal(10)
3375
3376 def rotate(self, other, context=None):
3377 """Returns a rotated copy of self, value-of-other times."""
3378 if context is None:
3379 context = getcontext()
3380
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003381 other = _convert_other(other, raiseit=True)
3382
Facundo Batista353750c2007-09-13 18:13:15 +00003383 ans = self._check_nans(other, context)
3384 if ans:
3385 return ans
3386
3387 if other._exp != 0:
3388 return context._raise_error(InvalidOperation)
3389 if not (-context.prec <= int(other) <= context.prec):
3390 return context._raise_error(InvalidOperation)
3391
3392 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003393 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003394
3395 # get values, pad if necessary
3396 torot = int(other)
3397 rotdig = self._int
3398 topad = context.prec - len(rotdig)
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003399 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003400 rotdig = '0'*topad + rotdig
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003401 elif topad < 0:
3402 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003403
3404 # let's rotate!
3405 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003406 return _dec_from_triple(self._sign,
3407 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003408
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003409 def scaleb(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00003410 """Returns self operand after adding the second value to its exp."""
3411 if context is None:
3412 context = getcontext()
3413
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003414 other = _convert_other(other, raiseit=True)
3415
Facundo Batista353750c2007-09-13 18:13:15 +00003416 ans = self._check_nans(other, context)
3417 if ans:
3418 return ans
3419
3420 if other._exp != 0:
3421 return context._raise_error(InvalidOperation)
3422 liminf = -2 * (context.Emax + context.prec)
3423 limsup = 2 * (context.Emax + context.prec)
3424 if not (liminf <= int(other) <= limsup):
3425 return context._raise_error(InvalidOperation)
3426
3427 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003428 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003429
Facundo Batista72bc54f2007-11-23 17:59:00 +00003430 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003431 d = d._fix(context)
3432 return d
3433
3434 def shift(self, other, context=None):
3435 """Returns a shifted copy of self, value-of-other times."""
3436 if context is None:
3437 context = getcontext()
3438
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003439 other = _convert_other(other, raiseit=True)
3440
Facundo Batista353750c2007-09-13 18:13:15 +00003441 ans = self._check_nans(other, context)
3442 if ans:
3443 return ans
3444
3445 if other._exp != 0:
3446 return context._raise_error(InvalidOperation)
3447 if not (-context.prec <= int(other) <= context.prec):
3448 return context._raise_error(InvalidOperation)
3449
3450 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003451 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003452
3453 # get values, pad if necessary
3454 torot = int(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003455 rotdig = self._int
3456 topad = context.prec - len(rotdig)
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003457 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003458 rotdig = '0'*topad + rotdig
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003459 elif topad < 0:
3460 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003461
3462 # let's shift!
3463 if torot < 0:
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003464 shifted = rotdig[:torot]
Facundo Batista353750c2007-09-13 18:13:15 +00003465 else:
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003466 shifted = rotdig + '0'*torot
3467 shifted = shifted[-context.prec:]
Facundo Batista353750c2007-09-13 18:13:15 +00003468
Facundo Batista72bc54f2007-11-23 17:59:00 +00003469 return _dec_from_triple(self._sign,
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003470 shifted.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003471
Facundo Batista59c58842007-04-10 12:58:45 +00003472 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003473 def __reduce__(self):
3474 return (self.__class__, (str(self),))
3475
3476 def __copy__(self):
3477 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003478 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003479 return self.__class__(str(self))
3480
3481 def __deepcopy__(self, memo):
3482 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003483 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003484 return self.__class__(str(self))
3485
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003486 # PEP 3101 support. See also _parse_format_specifier and _format_align
3487 def __format__(self, specifier, context=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003488 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003489
3490 The specifier should be a standard format specifier, with the
3491 form described in PEP 3101. Formatting types 'e', 'E', 'f',
3492 'F', 'g', 'G', and '%' are supported. If the formatting type
3493 is omitted it defaults to 'g' or 'G', depending on the value
3494 of context.capitals.
3495
3496 At this time the 'n' format specifier type (which is supposed
3497 to use the current locale) is not supported.
3498 """
3499
3500 # Note: PEP 3101 says that if the type is not present then
3501 # there should be at least one digit after the decimal point.
3502 # We take the liberty of ignoring this requirement for
3503 # Decimal---it's presumably there to make sure that
3504 # format(float, '') behaves similarly to str(float).
3505 if context is None:
3506 context = getcontext()
3507
3508 spec = _parse_format_specifier(specifier)
3509
3510 # special values don't care about the type or precision...
3511 if self._is_special:
3512 return _format_align(str(self), spec)
3513
3514 # a type of None defaults to 'g' or 'G', depending on context
3515 # if type is '%', adjust exponent of self accordingly
3516 if spec['type'] is None:
3517 spec['type'] = ['g', 'G'][context.capitals]
3518 elif spec['type'] == '%':
3519 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3520
3521 # round if necessary, taking rounding mode from the context
3522 rounding = context.rounding
3523 precision = spec['precision']
3524 if precision is not None:
3525 if spec['type'] in 'eE':
3526 self = self._round(precision+1, rounding)
3527 elif spec['type'] in 'gG':
3528 if len(self._int) > precision:
3529 self = self._round(precision, rounding)
3530 elif spec['type'] in 'fF%':
3531 self = self._rescale(-precision, rounding)
3532 # special case: zeros with a positive exponent can't be
3533 # represented in fixed point; rescale them to 0e0.
3534 elif not self and self._exp > 0 and spec['type'] in 'fF%':
3535 self = self._rescale(0, rounding)
3536
3537 # figure out placement of the decimal point
3538 leftdigits = self._exp + len(self._int)
3539 if spec['type'] in 'fF%':
3540 dotplace = leftdigits
3541 elif spec['type'] in 'eE':
3542 if not self and precision is not None:
3543 dotplace = 1 - precision
3544 else:
3545 dotplace = 1
3546 elif spec['type'] in 'gG':
3547 if self._exp <= 0 and leftdigits > -6:
3548 dotplace = leftdigits
3549 else:
3550 dotplace = 1
3551
3552 # figure out main part of numeric string...
3553 if dotplace <= 0:
3554 num = '0.' + '0'*(-dotplace) + self._int
3555 elif dotplace >= len(self._int):
3556 # make sure we're not padding a '0' with extra zeros on the right
3557 assert dotplace==len(self._int) or self._int != '0'
3558 num = self._int + '0'*(dotplace-len(self._int))
3559 else:
3560 num = self._int[:dotplace] + '.' + self._int[dotplace:]
3561
3562 # ...then the trailing exponent, or trailing '%'
3563 if leftdigits != dotplace or spec['type'] in 'eE':
3564 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
3565 num = num + "{0}{1:+}".format(echar, leftdigits-dotplace)
3566 elif spec['type'] == '%':
3567 num = num + '%'
3568
3569 # add sign
3570 if self._sign == 1:
3571 num = '-' + num
3572 return _format_align(num, spec)
3573
3574
Facundo Batista72bc54f2007-11-23 17:59:00 +00003575def _dec_from_triple(sign, coefficient, exponent, special=False):
3576 """Create a decimal instance directly, without any validation,
3577 normalization (e.g. removal of leading zeros) or argument
3578 conversion.
3579
3580 This function is for *internal use only*.
3581 """
3582
3583 self = object.__new__(Decimal)
3584 self._sign = sign
3585 self._int = coefficient
3586 self._exp = exponent
3587 self._is_special = special
3588
3589 return self
3590
Raymond Hettinger45fd4762009-02-03 03:42:07 +00003591# Register Decimal as a kind of Number (an abstract base class).
3592# However, do not register it as Real (because Decimals are not
3593# interoperable with floats).
3594_numbers.Number.register(Decimal)
3595
3596
Facundo Batista59c58842007-04-10 12:58:45 +00003597##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003598
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003599
3600# get rounding method function:
Facundo Batista59c58842007-04-10 12:58:45 +00003601rounding_functions = [name for name in Decimal.__dict__.keys()
3602 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003603for name in rounding_functions:
Facundo Batista59c58842007-04-10 12:58:45 +00003604 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003605 globalname = name[1:].upper()
3606 val = globals()[globalname]
3607 Decimal._pick_rounding_function[val] = name
3608
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003609del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003610
Nick Coghlanced12182006-09-02 03:54:17 +00003611class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003612 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003613
Nick Coghlanced12182006-09-02 03:54:17 +00003614 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003615 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003616 """
3617 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003618 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003619 def __enter__(self):
3620 self.saved_context = getcontext()
3621 setcontext(self.new_context)
3622 return self.new_context
3623 def __exit__(self, t, v, tb):
3624 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003625
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003626class Context(object):
3627 """Contains the context for a Decimal instance.
3628
3629 Contains:
3630 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003631 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003632 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003633 raised when it is caused. Otherwise, a value is
3634 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003635 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003636 (Whether or not the trap_enabler is set)
3637 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003638 Emin - Minimum exponent
3639 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003640 capitals - If 1, 1*10^1 is printed as 1E+1.
3641 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003642 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003643 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003644
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003645 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003646 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003647 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003648 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003649 _ignored_flags=None):
3650 if flags is None:
3651 flags = []
3652 if _ignored_flags is None:
3653 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003654 if not isinstance(flags, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003655 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003656 del s
Raymond Hettingerbf440692004-07-10 14:14:37 +00003657 if traps is not None and not isinstance(traps, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003658 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003659 del s
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003660 for name, val in locals().items():
3661 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003662 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003663 else:
3664 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003665 del self.self
3666
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003667 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003668 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003669 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003670 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3671 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3672 % vars(self))
3673 names = [f.__name__ for f, v in self.flags.items() if v]
3674 s.append('flags=[' + ', '.join(names) + ']')
3675 names = [t.__name__ for t, v in self.traps.items() if v]
3676 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003677 return ', '.join(s) + ')'
3678
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003679 def clear_flags(self):
3680 """Reset all flags to zero"""
3681 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003682 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003683
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003684 def _shallow_copy(self):
3685 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003686 nc = Context(self.prec, self.rounding, self.traps,
3687 self.flags, self.Emin, self.Emax,
3688 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003689 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003690
3691 def copy(self):
3692 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003693 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003694 self.flags.copy(), self.Emin, self.Emax,
3695 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003696 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003697 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003698
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003699 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003700 """Handles an error
3701
3702 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003703 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003704 trap_enabler is set, it reaises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003705 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003706 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003707 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003708 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003709 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003710 return error().handle(self, *args)
3711
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003712 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003713 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003714 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003715 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003716
3717 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003718 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003719 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003720
3721 def _ignore_all_flags(self):
3722 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003723 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003724
3725 def _ignore_flags(self, *flags):
3726 """Ignore the flags, if they are raised"""
3727 # Do not mutate-- This way, copies of a context leave the original
3728 # alone.
3729 self._ignored_flags = (self._ignored_flags + list(flags))
3730 return list(flags)
3731
3732 def _regard_flags(self, *flags):
3733 """Stop ignoring the flags, if they are raised"""
3734 if flags and isinstance(flags[0], (tuple,list)):
3735 flags = flags[0]
3736 for flag in flags:
3737 self._ignored_flags.remove(flag)
3738
Nick Coghlan53663a62008-07-15 14:27:37 +00003739 # We inherit object.__hash__, so we must deny this explicitly
3740 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003741
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003742 def Etiny(self):
3743 """Returns Etiny (= Emin - prec + 1)"""
3744 return int(self.Emin - self.prec + 1)
3745
3746 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003747 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003748 return int(self.Emax - self.prec + 1)
3749
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003750 def _set_rounding(self, type):
3751 """Sets the rounding type.
3752
3753 Sets the rounding type, and returns the current (previous)
3754 rounding type. Often used like:
3755
3756 context = context.copy()
3757 # so you don't change the calling context
3758 # if an error occurs in the middle.
3759 rounding = context._set_rounding(ROUND_UP)
3760 val = self.__sub__(other, context=context)
3761 context._set_rounding(rounding)
3762
3763 This will make it round up for that operation.
3764 """
3765 rounding = self.rounding
3766 self.rounding= type
3767 return rounding
3768
Raymond Hettingerfed52962004-07-14 15:41:57 +00003769 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003770 """Creates a new Decimal instance but using self as context.
3771
3772 This method implements the to-number operation of the
3773 IBM Decimal specification."""
3774
3775 if isinstance(num, basestring) and num != num.strip():
3776 return self._raise_error(ConversionSyntax,
3777 "no trailing or leading whitespace is "
3778 "permitted.")
3779
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003780 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003781 if d._isnan() and len(d._int) > self.prec - self._clamp:
3782 return self._raise_error(ConversionSyntax,
3783 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003784 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003785
Facundo Batista59c58842007-04-10 12:58:45 +00003786 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003787 def abs(self, a):
3788 """Returns the absolute value of the operand.
3789
3790 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003791 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003792 the plus operation on the operand.
3793
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003794 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003795 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003796 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003797 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003798 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003799 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003800 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003801 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003802 """
3803 return a.__abs__(context=self)
3804
3805 def add(self, a, b):
3806 """Return the sum of the two operands.
3807
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003808 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003809 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003810 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003811 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003812 """
3813 return a.__add__(b, context=self)
3814
3815 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003816 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003817
Facundo Batista353750c2007-09-13 18:13:15 +00003818 def canonical(self, a):
3819 """Returns the same Decimal object.
3820
3821 As we do not have different encodings for the same number, the
3822 received object already is in its canonical form.
3823
3824 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003825 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003826 """
3827 return a.canonical(context=self)
3828
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003829 def compare(self, a, b):
3830 """Compares values numerically.
3831
3832 If the signs of the operands differ, a value representing each operand
3833 ('-1' if the operand is less than zero, '0' if the operand is zero or
3834 negative zero, or '1' if the operand is greater than zero) is used in
3835 place of that operand for the comparison instead of the actual
3836 operand.
3837
3838 The comparison is then effected by subtracting the second operand from
3839 the first and then returning a value according to the result of the
3840 subtraction: '-1' if the result is less than zero, '0' if the result is
3841 zero or negative zero, or '1' if the result is greater than zero.
3842
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003843 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003844 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003845 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003846 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003847 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003848 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003849 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003850 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003851 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003852 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003853 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003854 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003855 """
3856 return a.compare(b, context=self)
3857
Facundo Batista353750c2007-09-13 18:13:15 +00003858 def compare_signal(self, a, b):
3859 """Compares the values of the two operands numerically.
3860
3861 It's pretty much like compare(), but all NaNs signal, with signaling
3862 NaNs taking precedence over quiet NaNs.
3863
3864 >>> c = ExtendedContext
3865 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003866 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003867 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003868 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003869 >>> c.flags[InvalidOperation] = 0
3870 >>> print c.flags[InvalidOperation]
3871 0
3872 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003873 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003874 >>> print c.flags[InvalidOperation]
3875 1
3876 >>> c.flags[InvalidOperation] = 0
3877 >>> print c.flags[InvalidOperation]
3878 0
3879 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003880 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003881 >>> print c.flags[InvalidOperation]
3882 1
3883 """
3884 return a.compare_signal(b, context=self)
3885
3886 def compare_total(self, a, b):
3887 """Compares two operands using their abstract representation.
3888
3889 This is not like the standard compare, which use their numerical
3890 value. Note that a total ordering is defined for all possible abstract
3891 representations.
3892
3893 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003894 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003895 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003896 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003897 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003898 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003899 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003900 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003901 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003902 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00003903 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003904 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003905 """
3906 return a.compare_total(b)
3907
3908 def compare_total_mag(self, a, b):
3909 """Compares two operands using their abstract representation ignoring sign.
3910
3911 Like compare_total, but with operand's sign ignored and assumed to be 0.
3912 """
3913 return a.compare_total_mag(b)
3914
3915 def copy_abs(self, a):
3916 """Returns a copy of the operand with the sign set to 0.
3917
3918 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003919 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003920 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003921 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00003922 """
3923 return a.copy_abs()
3924
3925 def copy_decimal(self, a):
3926 """Returns a copy of the decimal objet.
3927
3928 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003929 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003930 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003931 Decimal('-1.00')
Facundo Batista353750c2007-09-13 18:13:15 +00003932 """
Facundo Batista6c398da2007-09-17 17:30:13 +00003933 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00003934
3935 def copy_negate(self, a):
3936 """Returns a copy of the operand with the sign inverted.
3937
3938 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003939 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003940 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003941 Decimal('101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003942 """
3943 return a.copy_negate()
3944
3945 def copy_sign(self, a, b):
3946 """Copies the second operand's sign to the first one.
3947
3948 In detail, it returns a copy of the first operand with the sign
3949 equal to the sign of the second operand.
3950
3951 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003952 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003953 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003954 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003955 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003956 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003957 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003958 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003959 """
3960 return a.copy_sign(b)
3961
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003962 def divide(self, a, b):
3963 """Decimal division in a specified context.
3964
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003965 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003966 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003967 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003968 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003969 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003970 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003971 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003972 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003973 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003974 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003975 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003976 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003977 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003978 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003979 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003980 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003981 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003982 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003983 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003984 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003985 """
3986 return a.__div__(b, context=self)
3987
3988 def divide_int(self, a, b):
3989 """Divides two numbers and returns the integer part of the result.
3990
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003991 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003992 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003993 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003994 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003995 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003996 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003997 """
3998 return a.__floordiv__(b, context=self)
3999
4000 def divmod(self, a, b):
4001 return a.__divmod__(b, context=self)
4002
Facundo Batista353750c2007-09-13 18:13:15 +00004003 def exp(self, a):
4004 """Returns e ** a.
4005
4006 >>> c = ExtendedContext.copy()
4007 >>> c.Emin = -999
4008 >>> c.Emax = 999
4009 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004010 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004011 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004012 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00004013 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004014 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004015 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004016 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00004017 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004018 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004019 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004020 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004021 """
4022 return a.exp(context=self)
4023
4024 def fma(self, a, b, c):
4025 """Returns a multiplied by b, plus c.
4026
4027 The first two operands are multiplied together, using multiply,
4028 the third operand is then added to the result of that
4029 multiplication, using add, all with only one final rounding.
4030
4031 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004032 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004033 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004034 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004035 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004036 Decimal('1.38435736E+12')
Facundo Batista353750c2007-09-13 18:13:15 +00004037 """
4038 return a.fma(b, c, context=self)
4039
4040 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004041 """Return True if the operand is canonical; otherwise return False.
4042
4043 Currently, the encoding of a Decimal instance is always
4044 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004045
4046 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004047 True
Facundo Batista353750c2007-09-13 18:13:15 +00004048 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004049 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004050
4051 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004052 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004053
Facundo Batista1a191df2007-10-02 17:01:24 +00004054 A Decimal instance is considered finite if it is neither
4055 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004056
4057 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004058 True
Facundo Batista353750c2007-09-13 18:13:15 +00004059 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004060 True
Facundo Batista353750c2007-09-13 18:13:15 +00004061 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004062 True
Facundo Batista353750c2007-09-13 18:13:15 +00004063 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004064 False
Facundo Batista353750c2007-09-13 18:13:15 +00004065 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004066 False
Facundo Batista353750c2007-09-13 18:13:15 +00004067 """
4068 return a.is_finite()
4069
4070 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004071 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004072
4073 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004074 False
Facundo Batista353750c2007-09-13 18:13:15 +00004075 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004076 True
Facundo Batista353750c2007-09-13 18:13:15 +00004077 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004078 False
Facundo Batista353750c2007-09-13 18:13:15 +00004079 """
4080 return a.is_infinite()
4081
4082 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004083 """Return True if the operand is a qNaN or sNaN;
4084 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004085
4086 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004087 False
Facundo Batista353750c2007-09-13 18:13:15 +00004088 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004089 True
Facundo Batista353750c2007-09-13 18:13:15 +00004090 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004091 True
Facundo Batista353750c2007-09-13 18:13:15 +00004092 """
4093 return a.is_nan()
4094
4095 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004096 """Return True if the operand is a normal number;
4097 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004098
4099 >>> c = ExtendedContext.copy()
4100 >>> c.Emin = -999
4101 >>> c.Emax = 999
4102 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004103 True
Facundo Batista353750c2007-09-13 18:13:15 +00004104 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004105 False
Facundo Batista353750c2007-09-13 18:13:15 +00004106 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004107 False
Facundo Batista353750c2007-09-13 18:13:15 +00004108 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004109 False
Facundo Batista353750c2007-09-13 18:13:15 +00004110 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004111 False
Facundo Batista353750c2007-09-13 18:13:15 +00004112 """
4113 return a.is_normal(context=self)
4114
4115 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004116 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004117
4118 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004119 False
Facundo Batista353750c2007-09-13 18:13:15 +00004120 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004121 True
Facundo Batista353750c2007-09-13 18:13:15 +00004122 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004123 False
Facundo Batista353750c2007-09-13 18:13:15 +00004124 """
4125 return a.is_qnan()
4126
4127 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004128 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004129
4130 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004131 False
Facundo Batista353750c2007-09-13 18:13:15 +00004132 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004133 True
Facundo Batista353750c2007-09-13 18:13:15 +00004134 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004135 True
Facundo Batista353750c2007-09-13 18:13:15 +00004136 """
4137 return a.is_signed()
4138
4139 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004140 """Return True if the operand is a signaling NaN;
4141 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004142
4143 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004144 False
Facundo Batista353750c2007-09-13 18:13:15 +00004145 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004146 False
Facundo Batista353750c2007-09-13 18:13:15 +00004147 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004148 True
Facundo Batista353750c2007-09-13 18:13:15 +00004149 """
4150 return a.is_snan()
4151
4152 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004153 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004154
4155 >>> c = ExtendedContext.copy()
4156 >>> c.Emin = -999
4157 >>> c.Emax = 999
4158 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004159 False
Facundo Batista353750c2007-09-13 18:13:15 +00004160 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004161 True
Facundo Batista353750c2007-09-13 18:13:15 +00004162 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004163 False
Facundo Batista353750c2007-09-13 18:13:15 +00004164 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004165 False
Facundo Batista353750c2007-09-13 18:13:15 +00004166 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004167 False
Facundo Batista353750c2007-09-13 18:13:15 +00004168 """
4169 return a.is_subnormal(context=self)
4170
4171 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004172 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004173
4174 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004175 True
Facundo Batista353750c2007-09-13 18:13:15 +00004176 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004177 False
Facundo Batista353750c2007-09-13 18:13:15 +00004178 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004179 True
Facundo Batista353750c2007-09-13 18:13:15 +00004180 """
4181 return a.is_zero()
4182
4183 def ln(self, a):
4184 """Returns the natural (base e) logarithm of the operand.
4185
4186 >>> c = ExtendedContext.copy()
4187 >>> c.Emin = -999
4188 >>> c.Emax = 999
4189 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004190 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004191 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004192 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004193 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004194 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004195 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004196 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004197 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004198 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004199 """
4200 return a.ln(context=self)
4201
4202 def log10(self, a):
4203 """Returns the base 10 logarithm of the operand.
4204
4205 >>> c = ExtendedContext.copy()
4206 >>> c.Emin = -999
4207 >>> c.Emax = 999
4208 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004209 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004210 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004211 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004212 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004213 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004214 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004215 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004216 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004217 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004218 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004219 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004220 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004221 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004222 """
4223 return a.log10(context=self)
4224
4225 def logb(self, a):
4226 """ Returns the exponent of the magnitude of the operand's MSD.
4227
4228 The result is the integer which is the exponent of the magnitude
4229 of the most significant digit of the operand (as though the
4230 operand were truncated to a single digit while maintaining the
4231 value of that digit and without limiting the resulting exponent).
4232
4233 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004234 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004235 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004236 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004237 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004238 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004239 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004240 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004241 """
4242 return a.logb(context=self)
4243
4244 def logical_and(self, a, b):
4245 """Applies the logical operation 'and' between each operand's digits.
4246
4247 The operands must be both logical numbers.
4248
4249 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004250 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004251 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004252 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004253 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004254 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004255 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004256 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004257 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004258 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004259 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004260 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004261 """
4262 return a.logical_and(b, context=self)
4263
4264 def logical_invert(self, a):
4265 """Invert all the digits in the operand.
4266
4267 The operand must be a logical number.
4268
4269 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004270 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004271 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004272 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004273 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004274 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004275 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004276 Decimal('10101010')
Facundo Batista353750c2007-09-13 18:13:15 +00004277 """
4278 return a.logical_invert(context=self)
4279
4280 def logical_or(self, a, b):
4281 """Applies the logical operation 'or' between each operand's digits.
4282
4283 The operands must be both logical numbers.
4284
4285 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004286 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004287 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004288 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004289 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004290 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004291 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004292 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004293 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004294 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004295 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004296 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004297 """
4298 return a.logical_or(b, context=self)
4299
4300 def logical_xor(self, a, b):
4301 """Applies the logical operation 'xor' between each operand's digits.
4302
4303 The operands must be both logical numbers.
4304
4305 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004306 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004307 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004308 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004309 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004310 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004311 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004312 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004313 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004314 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004315 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004316 Decimal('1101')
Facundo Batista353750c2007-09-13 18:13:15 +00004317 """
4318 return a.logical_xor(b, context=self)
4319
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004320 def max(self, a,b):
4321 """max compares two values numerically and returns the maximum.
4322
4323 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004324 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004325 operation. If they are numerically equal then the left-hand operand
4326 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004327 infinity) of the two operands is chosen as the result.
4328
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004329 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004330 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004331 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004332 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004333 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004334 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004335 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004336 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004337 """
4338 return a.max(b, context=self)
4339
Facundo Batista353750c2007-09-13 18:13:15 +00004340 def max_mag(self, a, b):
4341 """Compares the values numerically with their sign ignored."""
4342 return a.max_mag(b, context=self)
4343
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004344 def min(self, a,b):
4345 """min compares two values numerically and returns the minimum.
4346
4347 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004348 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004349 operation. If they are numerically equal then the left-hand operand
4350 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004351 infinity) of the two operands is chosen as the result.
4352
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004353 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004354 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004355 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004356 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004357 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004358 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004359 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004360 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004361 """
4362 return a.min(b, context=self)
4363
Facundo Batista353750c2007-09-13 18:13:15 +00004364 def min_mag(self, a, b):
4365 """Compares the values numerically with their sign ignored."""
4366 return a.min_mag(b, context=self)
4367
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004368 def minus(self, a):
4369 """Minus corresponds to unary prefix minus in Python.
4370
4371 The operation is evaluated using the same rules as subtract; the
4372 operation minus(a) is calculated as subtract('0', a) where the '0'
4373 has the same exponent as the operand.
4374
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004375 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004376 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004377 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004378 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004379 """
4380 return a.__neg__(context=self)
4381
4382 def multiply(self, a, b):
4383 """multiply multiplies two operands.
4384
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004385 If either operand is a special value then the general rules apply.
4386 Otherwise, the operands are multiplied together ('long multiplication'),
4387 resulting in a number which may be as long as the sum of the lengths
4388 of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004389
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004390 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004391 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004392 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004393 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004394 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004395 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004396 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004397 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004398 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004399 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004400 """
4401 return a.__mul__(b, context=self)
4402
Facundo Batista353750c2007-09-13 18:13:15 +00004403 def next_minus(self, a):
4404 """Returns the largest representable number smaller than a.
4405
4406 >>> c = ExtendedContext.copy()
4407 >>> c.Emin = -999
4408 >>> c.Emax = 999
4409 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004410 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004411 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004412 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004413 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004414 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004415 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004416 Decimal('9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004417 """
4418 return a.next_minus(context=self)
4419
4420 def next_plus(self, a):
4421 """Returns the smallest representable number larger than a.
4422
4423 >>> c = ExtendedContext.copy()
4424 >>> c.Emin = -999
4425 >>> c.Emax = 999
4426 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004427 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004428 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004429 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004430 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004431 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004432 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004433 Decimal('-9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004434 """
4435 return a.next_plus(context=self)
4436
4437 def next_toward(self, a, b):
4438 """Returns the number closest to a, in direction towards b.
4439
4440 The result is the closest representable number from the first
4441 operand (but not the first operand) that is in the direction
4442 towards the second operand, unless the operands have the same
4443 value.
4444
4445 >>> c = ExtendedContext.copy()
4446 >>> c.Emin = -999
4447 >>> c.Emax = 999
4448 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004449 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004450 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004451 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004452 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004453 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004454 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004455 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004456 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004457 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004458 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004459 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004460 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004461 Decimal('-0.00')
Facundo Batista353750c2007-09-13 18:13:15 +00004462 """
4463 return a.next_toward(b, context=self)
4464
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004465 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004466 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004467
4468 Essentially a plus operation with all trailing zeros removed from the
4469 result.
4470
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004471 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004472 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004473 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004474 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004475 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004476 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004477 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004478 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004479 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004480 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004481 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004482 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004483 """
4484 return a.normalize(context=self)
4485
Facundo Batista353750c2007-09-13 18:13:15 +00004486 def number_class(self, a):
4487 """Returns an indication of the class of the operand.
4488
4489 The class is one of the following strings:
4490 -sNaN
4491 -NaN
4492 -Infinity
4493 -Normal
4494 -Subnormal
4495 -Zero
4496 +Zero
4497 +Subnormal
4498 +Normal
4499 +Infinity
4500
4501 >>> c = Context(ExtendedContext)
4502 >>> c.Emin = -999
4503 >>> c.Emax = 999
4504 >>> c.number_class(Decimal('Infinity'))
4505 '+Infinity'
4506 >>> c.number_class(Decimal('1E-10'))
4507 '+Normal'
4508 >>> c.number_class(Decimal('2.50'))
4509 '+Normal'
4510 >>> c.number_class(Decimal('0.1E-999'))
4511 '+Subnormal'
4512 >>> c.number_class(Decimal('0'))
4513 '+Zero'
4514 >>> c.number_class(Decimal('-0'))
4515 '-Zero'
4516 >>> c.number_class(Decimal('-0.1E-999'))
4517 '-Subnormal'
4518 >>> c.number_class(Decimal('-1E-10'))
4519 '-Normal'
4520 >>> c.number_class(Decimal('-2.50'))
4521 '-Normal'
4522 >>> c.number_class(Decimal('-Infinity'))
4523 '-Infinity'
4524 >>> c.number_class(Decimal('NaN'))
4525 'NaN'
4526 >>> c.number_class(Decimal('-NaN'))
4527 'NaN'
4528 >>> c.number_class(Decimal('sNaN'))
4529 'sNaN'
4530 """
4531 return a.number_class(context=self)
4532
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004533 def plus(self, a):
4534 """Plus corresponds to unary prefix plus in Python.
4535
4536 The operation is evaluated using the same rules as add; the
4537 operation plus(a) is calculated as add('0', a) where the '0'
4538 has the same exponent as the operand.
4539
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004540 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004541 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004542 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004543 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004544 """
4545 return a.__pos__(context=self)
4546
4547 def power(self, a, b, modulo=None):
4548 """Raises a to the power of b, to modulo if given.
4549
Facundo Batista353750c2007-09-13 18:13:15 +00004550 With two arguments, compute a**b. If a is negative then b
4551 must be integral. The result will be inexact unless b is
4552 integral and the result is finite and can be expressed exactly
4553 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004554
Facundo Batista353750c2007-09-13 18:13:15 +00004555 With three arguments, compute (a**b) % modulo. For the
4556 three argument form, the following restrictions on the
4557 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004558
Facundo Batista353750c2007-09-13 18:13:15 +00004559 - all three arguments must be integral
4560 - b must be nonnegative
4561 - at least one of a or b must be nonzero
4562 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004563
Facundo Batista353750c2007-09-13 18:13:15 +00004564 The result of pow(a, b, modulo) is identical to the result
4565 that would be obtained by computing (a**b) % modulo with
4566 unbounded precision, but is computed more efficiently. It is
4567 always exact.
4568
4569 >>> c = ExtendedContext.copy()
4570 >>> c.Emin = -999
4571 >>> c.Emax = 999
4572 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004573 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004574 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004575 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004576 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004577 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004578 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004579 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004580 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004581 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004582 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004583 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004584 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004585 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004586 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004587 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004588 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004589 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004590 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004591 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004592 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004593 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004594 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004595 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004596 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004597 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004598
4599 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004600 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004601 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004602 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00004603 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004604 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004605 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004606 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004607 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004608 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00004609 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004610 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004611 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004612 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004613 """
4614 return a.__pow__(b, modulo, context=self)
4615
4616 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00004617 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004618
4619 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00004620 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004621 exponent is being increased), multiplied by a positive power of ten (if
4622 the exponent is being decreased), or is unchanged (if the exponent is
4623 already equal to that of the right-hand operand).
4624
4625 Unlike other operations, if the length of the coefficient after the
4626 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00004627 operation condition is raised. This guarantees that, unless there is
4628 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004629 equal to that of the right-hand operand.
4630
4631 Also unlike other operations, quantize will never raise Underflow, even
4632 if the result is subnormal and inexact.
4633
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004634 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004635 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004636 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004637 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004638 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004639 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004640 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004641 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004642 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004643 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004644 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004645 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004646 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004647 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004648 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004649 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004650 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004651 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004652 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004653 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004654 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004655 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004656 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004657 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004658 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004659 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004660 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004661 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004662 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004663 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004664 """
4665 return a.quantize(b, context=self)
4666
Facundo Batista353750c2007-09-13 18:13:15 +00004667 def radix(self):
4668 """Just returns 10, as this is Decimal, :)
4669
4670 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00004671 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004672 """
4673 return Decimal(10)
4674
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004675 def remainder(self, a, b):
4676 """Returns the remainder from integer division.
4677
4678 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00004679 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00004680 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00004681 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004682
4683 This operation will fail under the same conditions as integer division
4684 (that is, if integer division on the same two operands would fail, the
4685 remainder cannot be calculated).
4686
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004687 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004688 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004689 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004690 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004691 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004692 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004693 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004694 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004695 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004696 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004697 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004698 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004699 """
4700 return a.__mod__(b, context=self)
4701
4702 def remainder_near(self, a, b):
4703 """Returns to be "a - b * n", where n is the integer nearest the exact
4704 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00004705 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004706 sign of a.
4707
4708 This operation will fail under the same conditions as integer division
4709 (that is, if integer division on the same two operands would fail, the
4710 remainder cannot be calculated).
4711
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004712 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004713 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004714 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004715 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004716 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004717 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004718 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004719 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004720 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004721 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004722 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004723 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004724 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004725 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004726 """
4727 return a.remainder_near(b, context=self)
4728
Facundo Batista353750c2007-09-13 18:13:15 +00004729 def rotate(self, a, b):
4730 """Returns a rotated copy of a, b times.
4731
4732 The coefficient of the result is a rotated copy of the digits in
4733 the coefficient of the first operand. The number of places of
4734 rotation is taken from the absolute value of the second operand,
4735 with the rotation being to the left if the second operand is
4736 positive or to the right otherwise.
4737
4738 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004739 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00004740 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004741 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00004742 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004743 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004744 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004745 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004746 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004747 Decimal('345678912')
Facundo Batista353750c2007-09-13 18:13:15 +00004748 """
4749 return a.rotate(b, context=self)
4750
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004751 def same_quantum(self, a, b):
4752 """Returns True if the two operands have the same exponent.
4753
4754 The result is never affected by either the sign or the coefficient of
4755 either operand.
4756
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004757 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004758 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004759 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004760 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004761 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004762 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004763 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004764 True
4765 """
4766 return a.same_quantum(b)
4767
Facundo Batista353750c2007-09-13 18:13:15 +00004768 def scaleb (self, a, b):
4769 """Returns the first operand after adding the second value its exp.
4770
4771 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004772 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00004773 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004774 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004775 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004776 Decimal('7.50E+3')
Facundo Batista353750c2007-09-13 18:13:15 +00004777 """
4778 return a.scaleb (b, context=self)
4779
4780 def shift(self, a, b):
4781 """Returns a shifted copy of a, b times.
4782
4783 The coefficient of the result is a shifted copy of the digits
4784 in the coefficient of the first operand. The number of places
4785 to shift is taken from the absolute value of the second operand,
4786 with the shift being to the left if the second operand is
4787 positive or to the right otherwise. Digits shifted into the
4788 coefficient are zeros.
4789
4790 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004791 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004792 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004793 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004794 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004795 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004796 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004797 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004798 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004799 Decimal('345678900')
Facundo Batista353750c2007-09-13 18:13:15 +00004800 """
4801 return a.shift(b, context=self)
4802
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004803 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00004804 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004805
4806 If the result must be inexact, it is rounded using the round-half-even
4807 algorithm.
4808
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004809 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004810 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004811 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004812 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004813 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004814 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004815 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004816 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004817 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004818 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004819 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004820 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004821 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004822 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004823 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004824 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004825 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004826 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004827 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00004828 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004829 """
4830 return a.sqrt(context=self)
4831
4832 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00004833 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004834
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004835 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004836 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004837 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004838 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004839 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004840 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004841 """
4842 return a.__sub__(b, context=self)
4843
4844 def to_eng_string(self, a):
4845 """Converts a number to a string, using scientific notation.
4846
4847 The operation is not affected by the context.
4848 """
4849 return a.to_eng_string(context=self)
4850
4851 def to_sci_string(self, a):
4852 """Converts a number to a string, using scientific notation.
4853
4854 The operation is not affected by the context.
4855 """
4856 return a.__str__(context=self)
4857
Facundo Batista353750c2007-09-13 18:13:15 +00004858 def to_integral_exact(self, a):
4859 """Rounds to an integer.
4860
4861 When the operand has a negative exponent, the result is the same
4862 as using the quantize() operation using the given operand as the
4863 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4864 of the operand as the precision setting; Inexact and Rounded flags
4865 are allowed in this operation. The rounding mode is taken from the
4866 context.
4867
4868 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004869 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004870 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004871 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004872 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004873 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004874 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004875 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004876 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004877 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004878 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004879 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004880 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004881 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004882 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004883 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004884 """
4885 return a.to_integral_exact(context=self)
4886
4887 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004888 """Rounds to an integer.
4889
4890 When the operand has a negative exponent, the result is the same
4891 as using the quantize() operation using the given operand as the
4892 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4893 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00004894 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004895
Facundo Batista353750c2007-09-13 18:13:15 +00004896 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004897 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004898 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004899 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004900 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004901 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004902 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004903 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004904 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004905 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004906 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004907 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004908 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004909 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004910 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004911 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004912 """
Facundo Batista353750c2007-09-13 18:13:15 +00004913 return a.to_integral_value(context=self)
4914
4915 # the method name changed, but we provide also the old one, for compatibility
4916 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004917
4918class _WorkRep(object):
4919 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00004920 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004921 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004922 # exp: None, int, or string
4923
4924 def __init__(self, value=None):
4925 if value is None:
4926 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004927 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004928 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00004929 elif isinstance(value, Decimal):
4930 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00004931 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004932 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00004933 else:
4934 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004935 self.sign = value[0]
4936 self.int = value[1]
4937 self.exp = value[2]
4938
4939 def __repr__(self):
4940 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
4941
4942 __str__ = __repr__
4943
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004944
4945
Facundo Batistae64acfa2007-12-17 14:18:42 +00004946def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004947 """Normalizes op1, op2 to have the same exp and length of coefficient.
4948
4949 Done during addition.
4950 """
Facundo Batista353750c2007-09-13 18:13:15 +00004951 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004952 tmp = op2
4953 other = op1
4954 else:
4955 tmp = op1
4956 other = op2
4957
Facundo Batista353750c2007-09-13 18:13:15 +00004958 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
4959 # Then adding 10**exp to tmp has the same effect (after rounding)
4960 # as adding any positive quantity smaller than 10**exp; similarly
4961 # for subtraction. So if other is smaller than 10**exp we replace
4962 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00004963 tmp_len = len(str(tmp.int))
4964 other_len = len(str(other.int))
4965 exp = tmp.exp + min(-1, tmp_len - prec - 2)
4966 if other_len + other.exp - 1 < exp:
4967 other.int = 1
4968 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004969
Facundo Batista353750c2007-09-13 18:13:15 +00004970 tmp.int *= 10 ** (tmp.exp - other.exp)
4971 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004972 return op1, op2
4973
Facundo Batista353750c2007-09-13 18:13:15 +00004974##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
4975
4976# This function from Tim Peters was taken from here:
4977# http://mail.python.org/pipermail/python-list/1999-July/007758.html
4978# The correction being in the function definition is for speed, and
4979# the whole function is not resolved with math.log because of avoiding
4980# the use of floats.
4981def _nbits(n, correction = {
4982 '0': 4, '1': 3, '2': 2, '3': 2,
4983 '4': 1, '5': 1, '6': 1, '7': 1,
4984 '8': 0, '9': 0, 'a': 0, 'b': 0,
4985 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
4986 """Number of bits in binary representation of the positive integer n,
4987 or 0 if n == 0.
4988 """
4989 if n < 0:
4990 raise ValueError("The argument to _nbits should be nonnegative.")
4991 hex_n = "%x" % n
4992 return 4*len(hex_n) - correction[hex_n[0]]
4993
4994def _sqrt_nearest(n, a):
4995 """Closest integer to the square root of the positive integer n. a is
4996 an initial approximation to the square root. Any positive integer
4997 will do for a, but the closer a is to the square root of n the
4998 faster convergence will be.
4999
5000 """
5001 if n <= 0 or a <= 0:
5002 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5003
5004 b=0
5005 while a != b:
5006 b, a = a, a--n//a>>1
5007 return a
5008
5009def _rshift_nearest(x, shift):
5010 """Given an integer x and a nonnegative integer shift, return closest
5011 integer to x / 2**shift; use round-to-even in case of a tie.
5012
5013 """
5014 b, q = 1L << shift, x >> shift
5015 return q + (2*(x & (b-1)) + (q&1) > b)
5016
5017def _div_nearest(a, b):
5018 """Closest integer to a/b, a and b positive integers; rounds to even
5019 in the case of a tie.
5020
5021 """
5022 q, r = divmod(a, b)
5023 return q + (2*r + (q&1) > b)
5024
5025def _ilog(x, M, L = 8):
5026 """Integer approximation to M*log(x/M), with absolute error boundable
5027 in terms only of x/M.
5028
5029 Given positive integers x and M, return an integer approximation to
5030 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5031 between the approximation and the exact result is at most 22. For
5032 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5033 both cases these are upper bounds on the error; it will usually be
5034 much smaller."""
5035
5036 # The basic algorithm is the following: let log1p be the function
5037 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5038 # the reduction
5039 #
5040 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5041 #
5042 # repeatedly until the argument to log1p is small (< 2**-L in
5043 # absolute value). For small y we can use the Taylor series
5044 # expansion
5045 #
5046 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5047 #
5048 # truncating at T such that y**T is small enough. The whole
5049 # computation is carried out in a form of fixed-point arithmetic,
5050 # with a real number z being represented by an integer
5051 # approximation to z*M. To avoid loss of precision, the y below
5052 # is actually an integer approximation to 2**R*y*M, where R is the
5053 # number of reductions performed so far.
5054
5055 y = x-M
5056 # argument reduction; R = number of reductions performed
5057 R = 0
5058 while (R <= L and long(abs(y)) << L-R >= M or
5059 R > L and abs(y) >> R-L >= M):
5060 y = _div_nearest(long(M*y) << 1,
5061 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5062 R += 1
5063
5064 # Taylor series with T terms
5065 T = -int(-10*len(str(M))//(3*L))
5066 yshift = _rshift_nearest(y, R)
5067 w = _div_nearest(M, T)
5068 for k in xrange(T-1, 0, -1):
5069 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5070
5071 return _div_nearest(w*y, M)
5072
5073def _dlog10(c, e, p):
5074 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5075 approximation to 10**p * log10(c*10**e), with an absolute error of
5076 at most 1. Assumes that c*10**e is not exactly 1."""
5077
5078 # increase precision by 2; compensate for this by dividing
5079 # final result by 100
5080 p += 2
5081
5082 # write c*10**e as d*10**f with either:
5083 # f >= 0 and 1 <= d <= 10, or
5084 # f <= 0 and 0.1 <= d <= 1.
5085 # Thus for c*10**e close to 1, f = 0
5086 l = len(str(c))
5087 f = e+l - (e+l >= 1)
5088
5089 if p > 0:
5090 M = 10**p
5091 k = e+p-f
5092 if k >= 0:
5093 c *= 10**k
5094 else:
5095 c = _div_nearest(c, 10**-k)
5096
5097 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005098 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005099 log_d = _div_nearest(log_d*M, log_10)
5100 log_tenpower = f*M # exact
5101 else:
5102 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005103 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005104
5105 return _div_nearest(log_tenpower+log_d, 100)
5106
5107def _dlog(c, e, p):
5108 """Given integers c, e and p with c > 0, compute an integer
5109 approximation to 10**p * log(c*10**e), with an absolute error of
5110 at most 1. Assumes that c*10**e is not exactly 1."""
5111
5112 # Increase precision by 2. The precision increase is compensated
5113 # for at the end with a division by 100.
5114 p += 2
5115
5116 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5117 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5118 # as 10**p * log(d) + 10**p*f * log(10).
5119 l = len(str(c))
5120 f = e+l - (e+l >= 1)
5121
5122 # compute approximation to 10**p*log(d), with error < 27
5123 if p > 0:
5124 k = e+p-f
5125 if k >= 0:
5126 c *= 10**k
5127 else:
5128 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5129
5130 # _ilog magnifies existing error in c by a factor of at most 10
5131 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5132 else:
5133 # p <= 0: just approximate the whole thing by 0; error < 2.31
5134 log_d = 0
5135
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005136 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005137 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005138 extra = len(str(abs(f)))-1
5139 if p + extra >= 0:
5140 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5141 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5142 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005143 else:
5144 f_log_ten = 0
5145 else:
5146 f_log_ten = 0
5147
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005148 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005149 return _div_nearest(f_log_ten + log_d, 100)
5150
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005151class _Log10Memoize(object):
5152 """Class to compute, store, and allow retrieval of, digits of the
5153 constant log(10) = 2.302585.... This constant is needed by
5154 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5155 def __init__(self):
5156 self.digits = "23025850929940456840179914546843642076011014886"
5157
5158 def getdigits(self, p):
5159 """Given an integer p >= 0, return floor(10**p)*log(10).
5160
5161 For example, self.getdigits(3) returns 2302.
5162 """
5163 # digits are stored as a string, for quick conversion to
5164 # integer in the case that we've already computed enough
5165 # digits; the stored digits should always be correct
5166 # (truncated, not rounded to nearest).
5167 if p < 0:
5168 raise ValueError("p should be nonnegative")
5169
5170 if p >= len(self.digits):
5171 # compute p+3, p+6, p+9, ... digits; continue until at
5172 # least one of the extra digits is nonzero
5173 extra = 3
5174 while True:
5175 # compute p+extra digits, correct to within 1ulp
5176 M = 10**(p+extra+2)
5177 digits = str(_div_nearest(_ilog(10*M, M), 100))
5178 if digits[-extra:] != '0'*extra:
5179 break
5180 extra += 3
5181 # keep all reliable digits so far; remove trailing zeros
5182 # and next nonzero digit
5183 self.digits = digits.rstrip('0')[:-1]
5184 return int(self.digits[:p+1])
5185
5186_log10_digits = _Log10Memoize().getdigits
5187
Facundo Batista353750c2007-09-13 18:13:15 +00005188def _iexp(x, M, L=8):
5189 """Given integers x and M, M > 0, such that x/M is small in absolute
5190 value, compute an integer approximation to M*exp(x/M). For 0 <=
5191 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5192 is usually much smaller)."""
5193
5194 # Algorithm: to compute exp(z) for a real number z, first divide z
5195 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5196 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5197 # series
5198 #
5199 # expm1(x) = x + x**2/2! + x**3/3! + ...
5200 #
5201 # Now use the identity
5202 #
5203 # expm1(2x) = expm1(x)*(expm1(x)+2)
5204 #
5205 # R times to compute the sequence expm1(z/2**R),
5206 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5207
5208 # Find R such that x/2**R/M <= 2**-L
5209 R = _nbits((long(x)<<L)//M)
5210
5211 # Taylor series. (2**L)**T > M
5212 T = -int(-10*len(str(M))//(3*L))
5213 y = _div_nearest(x, T)
5214 Mshift = long(M)<<R
5215 for i in xrange(T-1, 0, -1):
5216 y = _div_nearest(x*(Mshift + y), Mshift * i)
5217
5218 # Expansion
5219 for k in xrange(R-1, -1, -1):
5220 Mshift = long(M)<<(k+2)
5221 y = _div_nearest(y*(y+Mshift), Mshift)
5222
5223 return M+y
5224
5225def _dexp(c, e, p):
5226 """Compute an approximation to exp(c*10**e), with p decimal places of
5227 precision.
5228
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005229 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005230
5231 10**(p-1) <= d <= 10**p, and
5232 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5233
5234 In other words, d*10**f is an approximation to exp(c*10**e) with p
5235 digits of precision, and with an error in d of at most 1. This is
5236 almost, but not quite, the same as the error being < 1ulp: when d
5237 = 10**(p-1) the error could be up to 10 ulp."""
5238
5239 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5240 p += 2
5241
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005242 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005243 extra = max(0, e + len(str(c)) - 1)
5244 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005245
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005246 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005247 # rounding down
5248 shift = e+q
5249 if shift >= 0:
5250 cshift = c*10**shift
5251 else:
5252 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005253 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005254
5255 # reduce remainder back to original precision
5256 rem = _div_nearest(rem, 10**extra)
5257
5258 # error in result of _iexp < 120; error after division < 0.62
5259 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5260
5261def _dpower(xc, xe, yc, ye, p):
5262 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5263 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5264
5265 10**(p-1) <= c <= 10**p, and
5266 (c-1)*10**e < x**y < (c+1)*10**e
5267
5268 in other words, c*10**e is an approximation to x**y with p digits
5269 of precision, and with an error in c of at most 1. (This is
5270 almost, but not quite, the same as the error being < 1ulp: when c
5271 == 10**(p-1) we can only guarantee error < 10ulp.)
5272
5273 We assume that: x is positive and not equal to 1, and y is nonzero.
5274 """
5275
5276 # Find b such that 10**(b-1) <= |y| <= 10**b
5277 b = len(str(abs(yc))) + ye
5278
5279 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5280 lxc = _dlog(xc, xe, p+b+1)
5281
5282 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5283 shift = ye-b
5284 if shift >= 0:
5285 pc = lxc*yc*10**shift
5286 else:
5287 pc = _div_nearest(lxc*yc, 10**-shift)
5288
5289 if pc == 0:
5290 # we prefer a result that isn't exactly 1; this makes it
5291 # easier to compute a correctly rounded result in __pow__
5292 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5293 coeff, exp = 10**(p-1)+1, 1-p
5294 else:
5295 coeff, exp = 10**p-1, -p
5296 else:
5297 coeff, exp = _dexp(pc, -(p+1), p+1)
5298 coeff = _div_nearest(coeff, 10)
5299 exp += 1
5300
5301 return coeff, exp
5302
5303def _log10_lb(c, correction = {
5304 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5305 '6': 23, '7': 16, '8': 10, '9': 5}):
5306 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5307 if c <= 0:
5308 raise ValueError("The argument to _log10_lb should be nonnegative.")
5309 str_c = str(c)
5310 return 100*len(str_c) - correction[str_c[0]]
5311
Facundo Batista59c58842007-04-10 12:58:45 +00005312##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005313
Facundo Batista353750c2007-09-13 18:13:15 +00005314def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005315 """Convert other to Decimal.
5316
5317 Verifies that it's ok to use in an implicit construction.
5318 """
5319 if isinstance(other, Decimal):
5320 return other
5321 if isinstance(other, (int, long)):
5322 return Decimal(other)
Facundo Batista353750c2007-09-13 18:13:15 +00005323 if raiseit:
5324 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005325 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005326
Facundo Batista59c58842007-04-10 12:58:45 +00005327##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005328
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005329# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005330# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005331
5332DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005333 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005334 traps=[DivisionByZero, Overflow, InvalidOperation],
5335 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005336 Emax=999999999,
5337 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005338 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005339)
5340
5341# Pre-made alternate contexts offered by the specification
5342# Don't change these; the user should be able to select these
5343# contexts and be able to reproduce results from other implementations
5344# of the spec.
5345
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005346BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005347 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005348 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5349 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005350)
5351
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005352ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005353 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005354 traps=[],
5355 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005356)
5357
5358
Facundo Batista72bc54f2007-11-23 17:59:00 +00005359##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005360#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005361# Regular expression used for parsing numeric strings. Additional
5362# comments:
5363#
5364# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5365# whitespace. But note that the specification disallows whitespace in
5366# a numeric string.
5367#
5368# 2. For finite numbers (not infinities and NaNs) the body of the
5369# number between the optional sign and the optional exponent must have
5370# at least one decimal digit, possibly after the decimal point. The
5371# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005372
5373import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005374_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005375# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005376 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005377 (
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005378 (?=\d|\.\d) # ...a number (with at least one digit)
5379 (?P<int>\d*) # having a (possibly empty) integer part
5380 (\.(?P<frac>\d*))? # followed by an optional fractional part
5381 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005382 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005383 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005384 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005385 (?P<signal>s)? # ...an (optionally signaling)
5386 NaN # NaN
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005387 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005388 )
5389# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005390 \Z
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005391""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005392
Facundo Batista2ec74152007-12-03 17:55:00 +00005393_all_zeros = re.compile('0*$').match
5394_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005395
5396##### PEP3101 support functions ##############################################
5397# The functions parse_format_specifier and format_align have little to do
5398# with the Decimal class, and could potentially be reused for other pure
5399# Python numeric classes that want to implement __format__
5400#
5401# A format specifier for Decimal looks like:
5402#
5403# [[fill]align][sign][0][minimumwidth][.precision][type]
5404#
5405
5406_parse_format_specifier_regex = re.compile(r"""\A
5407(?:
5408 (?P<fill>.)?
5409 (?P<align>[<>=^])
5410)?
5411(?P<sign>[-+ ])?
5412(?P<zeropad>0)?
5413(?P<minimumwidth>(?!0)\d+)?
5414(?:\.(?P<precision>0|(?!0)\d+))?
5415(?P<type>[eEfFgG%])?
5416\Z
5417""", re.VERBOSE)
5418
Facundo Batista72bc54f2007-11-23 17:59:00 +00005419del re
5420
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005421def _parse_format_specifier(format_spec):
5422 """Parse and validate a format specifier.
5423
5424 Turns a standard numeric format specifier into a dict, with the
5425 following entries:
5426
5427 fill: fill character to pad field to minimum width
5428 align: alignment type, either '<', '>', '=' or '^'
5429 sign: either '+', '-' or ' '
5430 minimumwidth: nonnegative integer giving minimum width
5431 precision: nonnegative integer giving precision, or None
5432 type: one of the characters 'eEfFgG%', or None
5433 unicode: either True or False (always True for Python 3.x)
5434
5435 """
5436 m = _parse_format_specifier_regex.match(format_spec)
5437 if m is None:
5438 raise ValueError("Invalid format specifier: " + format_spec)
5439
5440 # get the dictionary
5441 format_dict = m.groupdict()
5442
5443 # defaults for fill and alignment
5444 fill = format_dict['fill']
5445 align = format_dict['align']
5446 if format_dict.pop('zeropad') is not None:
5447 # in the face of conflict, refuse the temptation to guess
5448 if fill is not None and fill != '0':
5449 raise ValueError("Fill character conflicts with '0'"
5450 " in format specifier: " + format_spec)
5451 if align is not None and align != '=':
5452 raise ValueError("Alignment conflicts with '0' in "
5453 "format specifier: " + format_spec)
5454 fill = '0'
5455 align = '='
5456 format_dict['fill'] = fill or ' '
5457 format_dict['align'] = align or '<'
5458
5459 if format_dict['sign'] is None:
5460 format_dict['sign'] = '-'
5461
5462 # turn minimumwidth and precision entries into integers.
5463 # minimumwidth defaults to 0; precision remains None if not given
5464 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5465 if format_dict['precision'] is not None:
5466 format_dict['precision'] = int(format_dict['precision'])
5467
5468 # if format type is 'g' or 'G' then a precision of 0 makes little
5469 # sense; convert it to 1. Same if format type is unspecified.
5470 if format_dict['precision'] == 0:
Mark Dickinsonc3c112d2009-09-07 16:19:35 +00005471 if format_dict['type'] is None or format_dict['type'] in 'gG':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005472 format_dict['precision'] = 1
5473
5474 # record whether return type should be str or unicode
5475 format_dict['unicode'] = isinstance(format_spec, unicode)
5476
5477 return format_dict
5478
5479def _format_align(body, spec_dict):
5480 """Given an unpadded, non-aligned numeric string, add padding and
5481 aligment to conform with the given format specifier dictionary (as
5482 output from parse_format_specifier).
5483
5484 It's assumed that if body is negative then it starts with '-'.
5485 Any leading sign ('-' or '+') is stripped from the body before
5486 applying the alignment and padding rules, and replaced in the
5487 appropriate position.
5488
5489 """
5490 # figure out the sign; we only examine the first character, so if
5491 # body has leading whitespace the results may be surprising.
5492 if len(body) > 0 and body[0] in '-+':
5493 sign = body[0]
5494 body = body[1:]
5495 else:
5496 sign = ''
5497
5498 if sign != '-':
5499 if spec_dict['sign'] in ' +':
5500 sign = spec_dict['sign']
5501 else:
5502 sign = ''
5503
5504 # how much extra space do we have to play with?
5505 minimumwidth = spec_dict['minimumwidth']
5506 fill = spec_dict['fill']
5507 padding = fill*(max(minimumwidth - (len(sign+body)), 0))
5508
5509 align = spec_dict['align']
5510 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005511 result = sign + body + padding
Mark Dickinson71416822009-03-17 18:07:41 +00005512 elif align == '>':
5513 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005514 elif align == '=':
5515 result = sign + padding + body
5516 else: #align == '^'
5517 half = len(padding)//2
5518 result = padding[:half] + sign + body + padding[half:]
5519
5520 # make sure that result is unicode if necessary
5521 if spec_dict['unicode']:
5522 result = unicode(result)
5523
5524 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00005525
Facundo Batista59c58842007-04-10 12:58:45 +00005526##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005527
Facundo Batista59c58842007-04-10 12:58:45 +00005528# Reusable defaults
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005529_Infinity = Decimal('Inf')
5530_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonfd6032d2009-01-02 23:16:51 +00005531_NaN = Decimal('NaN')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005532_Zero = Decimal(0)
5533_One = Decimal(1)
5534_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005535
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005536# _SignedInfinity[sign] is infinity w/ that sign
5537_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005538
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005539
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005540
5541if __name__ == '__main__':
5542 import doctest, sys
5543 doctest.testmod(sys.modules[__name__])