blob: ffc0fe8179d8edc9099b2bfd60affb1133cec007 [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():
1515 context = getcontext()
1516 return context._raise_error(InvalidContext)
1517 elif self._isinfinity():
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001518 raise OverflowError("Cannot convert infinity to int")
Facundo Batista353750c2007-09-13 18:13:15 +00001519 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001520 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001521 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001522 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001523 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001524
Raymond Hettinger5a053642008-01-24 19:05:29 +00001525 __trunc__ = __int__
1526
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001527 def real(self):
1528 return self
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00001529 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001530
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001531 def imag(self):
1532 return Decimal(0)
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00001533 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001534
1535 def conjugate(self):
1536 return self
1537
1538 def __complex__(self):
1539 return complex(float(self))
1540
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001541 def __long__(self):
1542 """Converts to a long.
1543
1544 Equivalent to long(int(self))
1545 """
1546 return long(self.__int__())
1547
Facundo Batista353750c2007-09-13 18:13:15 +00001548 def _fix_nan(self, context):
1549 """Decapitate the payload of a NaN to fit the context"""
1550 payload = self._int
1551
1552 # maximum length of payload is precision if _clamp=0,
1553 # precision-1 if _clamp=1.
1554 max_payload_len = context.prec - context._clamp
1555 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001556 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1557 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001558 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001559
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001560 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001561 """Round if it is necessary to keep self within prec precision.
1562
1563 Rounds and fixes the exponent. Does not raise on a sNaN.
1564
1565 Arguments:
1566 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001567 context - context used.
1568 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001569
Facundo Batista353750c2007-09-13 18:13:15 +00001570 if self._is_special:
1571 if self._isnan():
1572 # decapitate payload if necessary
1573 return self._fix_nan(context)
1574 else:
1575 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001576 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001577
Facundo Batista353750c2007-09-13 18:13:15 +00001578 # if self is zero then exponent should be between Etiny and
1579 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1580 Etiny = context.Etiny()
1581 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001582 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001583 exp_max = [context.Emax, Etop][context._clamp]
1584 new_exp = min(max(self._exp, Etiny), exp_max)
1585 if new_exp != self._exp:
1586 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001587 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001588 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001589 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001590
1591 # exp_min is the smallest allowable exponent of the result,
1592 # equal to max(self.adjusted()-context.prec+1, Etiny)
1593 exp_min = len(self._int) + self._exp - context.prec
1594 if exp_min > Etop:
1595 # overflow: exp_min > Etop iff self.adjusted() > Emax
1596 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001597 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00001598 return context._raise_error(Overflow, 'above Emax', self._sign)
1599 self_is_subnormal = exp_min < Etiny
1600 if self_is_subnormal:
1601 context._raise_error(Subnormal)
1602 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001603
Facundo Batista353750c2007-09-13 18:13:15 +00001604 # round if self has too many digits
1605 if self._exp < exp_min:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001606 context._raise_error(Rounded)
Facundo Batista2ec74152007-12-03 17:55:00 +00001607 digits = len(self._int) + self._exp - exp_min
1608 if digits < 0:
1609 self = _dec_from_triple(self._sign, '1', exp_min-1)
1610 digits = 0
1611 this_function = getattr(self, self._pick_rounding_function[context.rounding])
1612 changed = this_function(digits)
1613 coeff = self._int[:digits] or '0'
1614 if changed == 1:
1615 coeff = str(int(coeff)+1)
1616 ans = _dec_from_triple(self._sign, coeff, exp_min)
1617
1618 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001619 context._raise_error(Inexact)
1620 if self_is_subnormal:
1621 context._raise_error(Underflow)
1622 if not ans:
1623 # raise Clamped on underflow to 0
1624 context._raise_error(Clamped)
1625 elif len(ans._int) == context.prec+1:
1626 # we get here only if rescaling rounds the
1627 # cofficient up to exactly 10**context.prec
1628 if ans._exp < Etop:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001629 ans = _dec_from_triple(ans._sign,
1630 ans._int[:-1], ans._exp+1)
Facundo Batista353750c2007-09-13 18:13:15 +00001631 else:
1632 # Inexact and Rounded have already been raised
1633 ans = context._raise_error(Overflow, 'above Emax',
1634 self._sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001635 return ans
1636
Facundo Batista353750c2007-09-13 18:13:15 +00001637 # fold down if _clamp == 1 and self has too few digits
1638 if context._clamp == 1 and self._exp > Etop:
1639 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001640 self_padded = self._int + '0'*(self._exp - Etop)
1641 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001642
Facundo Batista353750c2007-09-13 18:13:15 +00001643 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001644 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001645
1646 _pick_rounding_function = {}
1647
Facundo Batista353750c2007-09-13 18:13:15 +00001648 # for each of the rounding functions below:
1649 # self is a finite, nonzero Decimal
1650 # prec is an integer satisfying 0 <= prec < len(self._int)
Facundo Batista2ec74152007-12-03 17:55:00 +00001651 #
1652 # each function returns either -1, 0, or 1, as follows:
1653 # 1 indicates that self should be rounded up (away from zero)
1654 # 0 indicates that self should be truncated, and that all the
1655 # digits to be truncated are zeros (so the value is unchanged)
1656 # -1 indicates that there are nonzero digits to be truncated
Facundo Batista353750c2007-09-13 18:13:15 +00001657
1658 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001659 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001660 if _all_zeros(self._int, prec):
1661 return 0
1662 else:
1663 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001664
Facundo Batista353750c2007-09-13 18:13:15 +00001665 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001666 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001667 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001668
Facundo Batista353750c2007-09-13 18:13:15 +00001669 def _round_half_up(self, prec):
1670 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001671 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001672 return 1
1673 elif _all_zeros(self._int, prec):
1674 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001675 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001676 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001677
1678 def _round_half_down(self, prec):
1679 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001680 if _exact_half(self._int, prec):
1681 return -1
1682 else:
1683 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001684
1685 def _round_half_even(self, prec):
1686 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001687 if _exact_half(self._int, prec) and \
1688 (prec == 0 or self._int[prec-1] in '02468'):
1689 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001690 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001691 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001692
1693 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001694 """Rounds up (not away from 0 if negative.)"""
1695 if self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001696 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001697 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001698 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001699
Facundo Batista353750c2007-09-13 18:13:15 +00001700 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001701 """Rounds down (not towards 0 if negative)"""
1702 if not self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001703 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001704 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001705 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001706
Facundo Batista353750c2007-09-13 18:13:15 +00001707 def _round_05up(self, prec):
1708 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001709 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001710 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001711 else:
1712 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001713
Facundo Batista353750c2007-09-13 18:13:15 +00001714 def fma(self, other, third, context=None):
1715 """Fused multiply-add.
1716
1717 Returns self*other+third with no rounding of the intermediate
1718 product self*other.
1719
1720 self and other are multiplied together, with no rounding of
1721 the result. The third operand is then added to the result,
1722 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001723 """
Facundo Batista353750c2007-09-13 18:13:15 +00001724
1725 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001726
1727 # compute product; raise InvalidOperation if either operand is
1728 # a signaling NaN or if the product is zero times infinity.
1729 if self._is_special or other._is_special:
1730 if context is None:
1731 context = getcontext()
1732 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001733 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001734 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001735 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001736 if self._exp == 'n':
1737 product = self
1738 elif other._exp == 'n':
1739 product = other
1740 elif self._exp == 'F':
1741 if not other:
1742 return context._raise_error(InvalidOperation,
1743 'INF * 0 in fma')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001744 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001745 elif other._exp == 'F':
1746 if not self:
1747 return context._raise_error(InvalidOperation,
1748 '0 * INF in fma')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001749 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001750 else:
1751 product = _dec_from_triple(self._sign ^ other._sign,
1752 str(int(self._int) * int(other._int)),
1753 self._exp + other._exp)
1754
Facundo Batista353750c2007-09-13 18:13:15 +00001755 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001756 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001757
Facundo Batista353750c2007-09-13 18:13:15 +00001758 def _power_modulo(self, other, modulo, context=None):
1759 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001760
Facundo Batista353750c2007-09-13 18:13:15 +00001761 # if can't convert other and modulo to Decimal, raise
1762 # TypeError; there's no point returning NotImplemented (no
1763 # equivalent of __rpow__ for three argument pow)
1764 other = _convert_other(other, raiseit=True)
1765 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001766
Facundo Batista353750c2007-09-13 18:13:15 +00001767 if context is None:
1768 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001769
Facundo Batista353750c2007-09-13 18:13:15 +00001770 # deal with NaNs: if there are any sNaNs then first one wins,
1771 # (i.e. behaviour for NaNs is identical to that of fma)
1772 self_is_nan = self._isnan()
1773 other_is_nan = other._isnan()
1774 modulo_is_nan = modulo._isnan()
1775 if self_is_nan or other_is_nan or modulo_is_nan:
1776 if self_is_nan == 2:
1777 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001778 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001779 if other_is_nan == 2:
1780 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001781 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001782 if modulo_is_nan == 2:
1783 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001784 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001785 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001786 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001787 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001788 return other._fix_nan(context)
1789 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001790
Facundo Batista353750c2007-09-13 18:13:15 +00001791 # check inputs: we apply same restrictions as Python's pow()
1792 if not (self._isinteger() and
1793 other._isinteger() and
1794 modulo._isinteger()):
1795 return context._raise_error(InvalidOperation,
1796 'pow() 3rd argument not allowed '
1797 'unless all arguments are integers')
1798 if other < 0:
1799 return context._raise_error(InvalidOperation,
1800 'pow() 2nd argument cannot be '
1801 'negative when 3rd argument specified')
1802 if not modulo:
1803 return context._raise_error(InvalidOperation,
1804 'pow() 3rd argument cannot be 0')
1805
1806 # additional restriction for decimal: the modulus must be less
1807 # than 10**prec in absolute value
1808 if modulo.adjusted() >= context.prec:
1809 return context._raise_error(InvalidOperation,
1810 'insufficient precision: pow() 3rd '
1811 'argument must not have more than '
1812 'precision digits')
1813
1814 # define 0**0 == NaN, for consistency with two-argument pow
1815 # (even though it hurts!)
1816 if not other and not self:
1817 return context._raise_error(InvalidOperation,
1818 'at least one of pow() 1st argument '
1819 'and 2nd argument must be nonzero ;'
1820 '0**0 is not defined')
1821
1822 # compute sign of result
1823 if other._iseven():
1824 sign = 0
1825 else:
1826 sign = self._sign
1827
1828 # convert modulo to a Python integer, and self and other to
1829 # Decimal integers (i.e. force their exponents to be >= 0)
1830 modulo = abs(int(modulo))
1831 base = _WorkRep(self.to_integral_value())
1832 exponent = _WorkRep(other.to_integral_value())
1833
1834 # compute result using integer pow()
1835 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1836 for i in xrange(exponent.exp):
1837 base = pow(base, 10, modulo)
1838 base = pow(base, exponent.int, modulo)
1839
Facundo Batista72bc54f2007-11-23 17:59:00 +00001840 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001841
1842 def _power_exact(self, other, p):
1843 """Attempt to compute self**other exactly.
1844
1845 Given Decimals self and other and an integer p, attempt to
1846 compute an exact result for the power self**other, with p
1847 digits of precision. Return None if self**other is not
1848 exactly representable in p digits.
1849
1850 Assumes that elimination of special cases has already been
1851 performed: self and other must both be nonspecial; self must
1852 be positive and not numerically equal to 1; other must be
1853 nonzero. For efficiency, other._exp should not be too large,
1854 so that 10**abs(other._exp) is a feasible calculation."""
1855
1856 # In the comments below, we write x for the value of self and
1857 # y for the value of other. Write x = xc*10**xe and y =
1858 # yc*10**ye.
1859
1860 # The main purpose of this method is to identify the *failure*
1861 # of x**y to be exactly representable with as little effort as
1862 # possible. So we look for cheap and easy tests that
1863 # eliminate the possibility of x**y being exact. Only if all
1864 # these tests are passed do we go on to actually compute x**y.
1865
1866 # Here's the main idea. First normalize both x and y. We
1867 # express y as a rational m/n, with m and n relatively prime
1868 # and n>0. Then for x**y to be exactly representable (at
1869 # *any* precision), xc must be the nth power of a positive
1870 # integer and xe must be divisible by n. If m is negative
1871 # then additionally xc must be a power of either 2 or 5, hence
1872 # a power of 2**n or 5**n.
1873 #
1874 # There's a limit to how small |y| can be: if y=m/n as above
1875 # then:
1876 #
1877 # (1) if xc != 1 then for the result to be representable we
1878 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1879 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1880 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1881 # representable.
1882 #
1883 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1884 # |y| < 1/|xe| then the result is not representable.
1885 #
1886 # Note that since x is not equal to 1, at least one of (1) and
1887 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1888 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1889 #
1890 # There's also a limit to how large y can be, at least if it's
1891 # positive: the normalized result will have coefficient xc**y,
1892 # so if it's representable then xc**y < 10**p, and y <
1893 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1894 # not exactly representable.
1895
1896 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1897 # so |y| < 1/xe and the result is not representable.
1898 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1899 # < 1/nbits(xc).
1900
1901 x = _WorkRep(self)
1902 xc, xe = x.int, x.exp
1903 while xc % 10 == 0:
1904 xc //= 10
1905 xe += 1
1906
1907 y = _WorkRep(other)
1908 yc, ye = y.int, y.exp
1909 while yc % 10 == 0:
1910 yc //= 10
1911 ye += 1
1912
1913 # case where xc == 1: result is 10**(xe*y), with xe*y
1914 # required to be an integer
1915 if xc == 1:
1916 if ye >= 0:
1917 exponent = xe*yc*10**ye
1918 else:
1919 exponent, remainder = divmod(xe*yc, 10**-ye)
1920 if remainder:
1921 return None
1922 if y.sign == 1:
1923 exponent = -exponent
1924 # if other is a nonnegative integer, use ideal exponent
1925 if other._isinteger() and other._sign == 0:
1926 ideal_exponent = self._exp*int(other)
1927 zeros = min(exponent-ideal_exponent, p-1)
1928 else:
1929 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00001930 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00001931
1932 # case where y is negative: xc must be either a power
1933 # of 2 or a power of 5.
1934 if y.sign == 1:
1935 last_digit = xc % 10
1936 if last_digit in (2,4,6,8):
1937 # quick test for power of 2
1938 if xc & -xc != xc:
1939 return None
1940 # now xc is a power of 2; e is its exponent
1941 e = _nbits(xc)-1
1942 # find e*y and xe*y; both must be integers
1943 if ye >= 0:
1944 y_as_int = yc*10**ye
1945 e = e*y_as_int
1946 xe = xe*y_as_int
1947 else:
1948 ten_pow = 10**-ye
1949 e, remainder = divmod(e*yc, ten_pow)
1950 if remainder:
1951 return None
1952 xe, remainder = divmod(xe*yc, ten_pow)
1953 if remainder:
1954 return None
1955
1956 if e*65 >= p*93: # 93/65 > log(10)/log(5)
1957 return None
1958 xc = 5**e
1959
1960 elif last_digit == 5:
1961 # e >= log_5(xc) if xc is a power of 5; we have
1962 # equality all the way up to xc=5**2658
1963 e = _nbits(xc)*28//65
1964 xc, remainder = divmod(5**e, xc)
1965 if remainder:
1966 return None
1967 while xc % 5 == 0:
1968 xc //= 5
1969 e -= 1
1970 if ye >= 0:
1971 y_as_integer = yc*10**ye
1972 e = e*y_as_integer
1973 xe = xe*y_as_integer
1974 else:
1975 ten_pow = 10**-ye
1976 e, remainder = divmod(e*yc, ten_pow)
1977 if remainder:
1978 return None
1979 xe, remainder = divmod(xe*yc, ten_pow)
1980 if remainder:
1981 return None
1982 if e*3 >= p*10: # 10/3 > log(10)/log(2)
1983 return None
1984 xc = 2**e
1985 else:
1986 return None
1987
1988 if xc >= 10**p:
1989 return None
1990 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00001991 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00001992
1993 # now y is positive; find m and n such that y = m/n
1994 if ye >= 0:
1995 m, n = yc*10**ye, 1
1996 else:
1997 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
1998 return None
1999 xc_bits = _nbits(xc)
2000 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2001 return None
2002 m, n = yc, 10**(-ye)
2003 while m % 2 == n % 2 == 0:
2004 m //= 2
2005 n //= 2
2006 while m % 5 == n % 5 == 0:
2007 m //= 5
2008 n //= 5
2009
2010 # compute nth root of xc*10**xe
2011 if n > 1:
2012 # if 1 < xc < 2**n then xc isn't an nth power
2013 if xc != 1 and xc_bits <= n:
2014 return None
2015
2016 xe, rem = divmod(xe, n)
2017 if rem != 0:
2018 return None
2019
2020 # compute nth root of xc using Newton's method
2021 a = 1L << -(-_nbits(xc)//n) # initial estimate
2022 while True:
2023 q, r = divmod(xc, a**(n-1))
2024 if a <= q:
2025 break
2026 else:
2027 a = (a*(n-1) + q)//n
2028 if not (a == q and r == 0):
2029 return None
2030 xc = a
2031
2032 # now xc*10**xe is the nth root of the original xc*10**xe
2033 # compute mth power of xc*10**xe
2034
2035 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2036 # 10**p and the result is not representable.
2037 if xc > 1 and m > p*100//_log10_lb(xc):
2038 return None
2039 xc = xc**m
2040 xe *= m
2041 if xc > 10**p:
2042 return None
2043
2044 # by this point the result *is* exactly representable
2045 # adjust the exponent to get as close as possible to the ideal
2046 # exponent, if necessary
2047 str_xc = str(xc)
2048 if other._isinteger() and other._sign == 0:
2049 ideal_exponent = self._exp*int(other)
2050 zeros = min(xe-ideal_exponent, p-len(str_xc))
2051 else:
2052 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002053 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002054
2055 def __pow__(self, other, modulo=None, context=None):
2056 """Return self ** other [ % modulo].
2057
2058 With two arguments, compute self**other.
2059
2060 With three arguments, compute (self**other) % modulo. For the
2061 three argument form, the following restrictions on the
2062 arguments hold:
2063
2064 - all three arguments must be integral
2065 - other must be nonnegative
2066 - either self or other (or both) must be nonzero
2067 - modulo must be nonzero and must have at most p digits,
2068 where p is the context precision.
2069
2070 If any of these restrictions is violated the InvalidOperation
2071 flag is raised.
2072
2073 The result of pow(self, other, modulo) is identical to the
2074 result that would be obtained by computing (self**other) %
2075 modulo with unbounded precision, but is computed more
2076 efficiently. It is always exact.
2077 """
2078
2079 if modulo is not None:
2080 return self._power_modulo(other, modulo, context)
2081
2082 other = _convert_other(other)
2083 if other is NotImplemented:
2084 return other
2085
2086 if context is None:
2087 context = getcontext()
2088
2089 # either argument is a NaN => result is NaN
2090 ans = self._check_nans(other, context)
2091 if ans:
2092 return ans
2093
2094 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2095 if not other:
2096 if not self:
2097 return context._raise_error(InvalidOperation, '0 ** 0')
2098 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002099 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002100
2101 # result has sign 1 iff self._sign is 1 and other is an odd integer
2102 result_sign = 0
2103 if self._sign == 1:
2104 if other._isinteger():
2105 if not other._iseven():
2106 result_sign = 1
2107 else:
2108 # -ve**noninteger = NaN
2109 # (-0)**noninteger = 0**noninteger
2110 if self:
2111 return context._raise_error(InvalidOperation,
2112 'x ** y with x negative and y not an integer')
2113 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002114 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002115
2116 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2117 if not self:
2118 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002119 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002120 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002121 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002122
2123 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002124 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002125 if other._sign == 0:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002126 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002127 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002128 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002129
Facundo Batista353750c2007-09-13 18:13:15 +00002130 # 1**other = 1, but the choice of exponent and the flags
2131 # depend on the exponent of self, and on whether other is a
2132 # positive integer, a negative integer, or neither
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002133 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002134 if other._isinteger():
2135 # exp = max(self._exp*max(int(other), 0),
2136 # 1-context.prec) but evaluating int(other) directly
2137 # is dangerous until we know other is small (other
2138 # could be 1e999999999)
2139 if other._sign == 1:
2140 multiplier = 0
2141 elif other > context.prec:
2142 multiplier = context.prec
2143 else:
2144 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002145
Facundo Batista353750c2007-09-13 18:13:15 +00002146 exp = self._exp * multiplier
2147 if exp < 1-context.prec:
2148 exp = 1-context.prec
2149 context._raise_error(Rounded)
2150 else:
2151 context._raise_error(Inexact)
2152 context._raise_error(Rounded)
2153 exp = 1-context.prec
2154
Facundo Batista72bc54f2007-11-23 17:59:00 +00002155 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002156
2157 # compute adjusted exponent of self
2158 self_adj = self.adjusted()
2159
2160 # self ** infinity is infinity if self > 1, 0 if self < 1
2161 # self ** -infinity is infinity if self < 1, 0 if self > 1
2162 if other._isinfinity():
2163 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002164 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002165 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002166 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002167
2168 # from here on, the result always goes through the call
2169 # to _fix at the end of this function.
2170 ans = None
2171
2172 # crude test to catch cases of extreme overflow/underflow. If
2173 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2174 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2175 # self**other >= 10**(Emax+1), so overflow occurs. The test
2176 # for underflow is similar.
2177 bound = self._log10_exp_bound() + other.adjusted()
2178 if (self_adj >= 0) == (other._sign == 0):
2179 # self > 1 and other +ve, or self < 1 and other -ve
2180 # possibility of overflow
2181 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002182 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002183 else:
2184 # self > 1 and other -ve, or self < 1 and other +ve
2185 # possibility of underflow to 0
2186 Etiny = context.Etiny()
2187 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002188 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002189
2190 # try for an exact result with precision +1
2191 if ans is None:
2192 ans = self._power_exact(other, context.prec + 1)
2193 if ans is not None and result_sign == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002194 ans = _dec_from_triple(1, ans._int, ans._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002195
2196 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2197 if ans is None:
2198 p = context.prec
2199 x = _WorkRep(self)
2200 xc, xe = x.int, x.exp
2201 y = _WorkRep(other)
2202 yc, ye = y.int, y.exp
2203 if y.sign == 1:
2204 yc = -yc
2205
2206 # compute correctly rounded result: start with precision +3,
2207 # then increase precision until result is unambiguously roundable
2208 extra = 3
2209 while True:
2210 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2211 if coeff % (5*10**(len(str(coeff))-p-1)):
2212 break
2213 extra += 3
2214
Facundo Batista72bc54f2007-11-23 17:59:00 +00002215 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002216
2217 # the specification says that for non-integer other we need to
2218 # raise Inexact, even when the result is actually exact. In
2219 # the same way, we need to raise Underflow here if the result
2220 # is subnormal. (The call to _fix will take care of raising
2221 # Rounded and Subnormal, as usual.)
2222 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002223 context._raise_error(Inexact)
Facundo Batista353750c2007-09-13 18:13:15 +00002224 # pad with zeros up to length context.prec+1 if necessary
2225 if len(ans._int) <= context.prec:
2226 expdiff = context.prec+1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002227 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2228 ans._exp-expdiff)
Facundo Batista353750c2007-09-13 18:13:15 +00002229 if ans.adjusted() < context.Emin:
2230 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002231
Facundo Batista353750c2007-09-13 18:13:15 +00002232 # unlike exp, ln and log10, the power function respects the
2233 # rounding mode; no need to use ROUND_HALF_EVEN here
2234 ans = ans._fix(context)
2235 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002236
2237 def __rpow__(self, other, context=None):
2238 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002239 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002240 if other is NotImplemented:
2241 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002242 return other.__pow__(self, context=context)
2243
2244 def normalize(self, context=None):
2245 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002246
Facundo Batista353750c2007-09-13 18:13:15 +00002247 if context is None:
2248 context = getcontext()
2249
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002250 if self._is_special:
2251 ans = self._check_nans(context=context)
2252 if ans:
2253 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002254
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002255 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002256 if dup._isinfinity():
2257 return dup
2258
2259 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002260 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002261 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002262 end = len(dup._int)
2263 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002264 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002265 exp += 1
2266 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002267 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002268
Facundo Batistabd2fe832007-09-13 18:42:09 +00002269 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002270 """Quantize self so its exponent is the same as that of exp.
2271
2272 Similar to self._rescale(exp._exp) but with error checking.
2273 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002274 exp = _convert_other(exp, raiseit=True)
2275
Facundo Batista353750c2007-09-13 18:13:15 +00002276 if context is None:
2277 context = getcontext()
2278 if rounding is None:
2279 rounding = context.rounding
2280
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002281 if self._is_special or exp._is_special:
2282 ans = self._check_nans(exp, context)
2283 if ans:
2284 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002285
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002286 if exp._isinfinity() or self._isinfinity():
2287 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002288 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002289 return context._raise_error(InvalidOperation,
2290 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002291
Facundo Batistabd2fe832007-09-13 18:42:09 +00002292 # if we're not watching exponents, do a simple rescale
2293 if not watchexp:
2294 ans = self._rescale(exp._exp, rounding)
2295 # raise Inexact and Rounded where appropriate
2296 if ans._exp > self._exp:
2297 context._raise_error(Rounded)
2298 if ans != self:
2299 context._raise_error(Inexact)
2300 return ans
2301
Facundo Batista353750c2007-09-13 18:13:15 +00002302 # exp._exp should be between Etiny and Emax
2303 if not (context.Etiny() <= exp._exp <= context.Emax):
2304 return context._raise_error(InvalidOperation,
2305 'target exponent out of bounds in quantize')
2306
2307 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002308 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002309 return ans._fix(context)
2310
2311 self_adjusted = self.adjusted()
2312 if self_adjusted > context.Emax:
2313 return context._raise_error(InvalidOperation,
2314 'exponent of quantize result too large for current context')
2315 if self_adjusted - exp._exp + 1 > context.prec:
2316 return context._raise_error(InvalidOperation,
2317 'quantize result has too many digits for current context')
2318
2319 ans = self._rescale(exp._exp, rounding)
2320 if ans.adjusted() > context.Emax:
2321 return context._raise_error(InvalidOperation,
2322 'exponent of quantize result too large for current context')
2323 if len(ans._int) > context.prec:
2324 return context._raise_error(InvalidOperation,
2325 'quantize result has too many digits for current context')
2326
2327 # raise appropriate flags
2328 if ans._exp > self._exp:
2329 context._raise_error(Rounded)
2330 if ans != self:
2331 context._raise_error(Inexact)
2332 if ans and ans.adjusted() < context.Emin:
2333 context._raise_error(Subnormal)
2334
2335 # call to fix takes care of any necessary folddown
2336 ans = ans._fix(context)
2337 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002338
2339 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002340 """Return True if self and other have the same exponent; otherwise
2341 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002342
Facundo Batista1a191df2007-10-02 17:01:24 +00002343 If either operand is a special value, the following rules are used:
2344 * return True if both operands are infinities
2345 * return True if both operands are NaNs
2346 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002347 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002348 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002349 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002350 return (self.is_nan() and other.is_nan() or
2351 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002352 return self._exp == other._exp
2353
Facundo Batista353750c2007-09-13 18:13:15 +00002354 def _rescale(self, exp, rounding):
2355 """Rescale self so that the exponent is exp, either by padding with zeros
2356 or by truncating digits, using the given rounding mode.
2357
2358 Specials are returned without change. This operation is
2359 quiet: it raises no flags, and uses no information from the
2360 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002361
2362 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002363 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002364 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002365 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002366 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002367 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002368 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002369
Facundo Batista353750c2007-09-13 18:13:15 +00002370 if self._exp >= exp:
2371 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002372 return _dec_from_triple(self._sign,
2373 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002374
Facundo Batista353750c2007-09-13 18:13:15 +00002375 # too many digits; round and lose data. If self.adjusted() <
2376 # exp-1, replace self by 10**(exp-1) before rounding
2377 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002378 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002379 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002380 digits = 0
2381 this_function = getattr(self, self._pick_rounding_function[rounding])
Facundo Batista2ec74152007-12-03 17:55:00 +00002382 changed = this_function(digits)
2383 coeff = self._int[:digits] or '0'
2384 if changed == 1:
2385 coeff = str(int(coeff)+1)
2386 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002387
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002388 def _round(self, places, rounding):
2389 """Round a nonzero, nonspecial Decimal to a fixed number of
2390 significant figures, using the given rounding mode.
2391
2392 Infinities, NaNs and zeros are returned unaltered.
2393
2394 This operation is quiet: it raises no flags, and uses no
2395 information from the context.
2396
2397 """
2398 if places <= 0:
2399 raise ValueError("argument should be at least 1 in _round")
2400 if self._is_special or not self:
2401 return Decimal(self)
2402 ans = self._rescale(self.adjusted()+1-places, rounding)
2403 # it can happen that the rescale alters the adjusted exponent;
2404 # for example when rounding 99.97 to 3 significant figures.
2405 # When this happens we end up with an extra 0 at the end of
2406 # the number; a second rescale fixes this.
2407 if ans.adjusted() != self.adjusted():
2408 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2409 return ans
2410
Facundo Batista353750c2007-09-13 18:13:15 +00002411 def to_integral_exact(self, rounding=None, context=None):
2412 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002413
Facundo Batista353750c2007-09-13 18:13:15 +00002414 If no rounding mode is specified, take the rounding mode from
2415 the context. This method raises the Rounded and Inexact flags
2416 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002417
Facundo Batista353750c2007-09-13 18:13:15 +00002418 See also: to_integral_value, which does exactly the same as
2419 this method except that it doesn't raise Inexact or Rounded.
2420 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002421 if self._is_special:
2422 ans = self._check_nans(context=context)
2423 if ans:
2424 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002425 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002426 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002427 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002428 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002429 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002430 if context is None:
2431 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002432 if rounding is None:
2433 rounding = context.rounding
2434 context._raise_error(Rounded)
2435 ans = self._rescale(0, rounding)
2436 if ans != self:
2437 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002438 return ans
2439
Facundo Batista353750c2007-09-13 18:13:15 +00002440 def to_integral_value(self, rounding=None, context=None):
2441 """Rounds to the nearest integer, without raising inexact, rounded."""
2442 if context is None:
2443 context = getcontext()
2444 if rounding is None:
2445 rounding = context.rounding
2446 if self._is_special:
2447 ans = self._check_nans(context=context)
2448 if ans:
2449 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002450 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002451 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002452 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002453 else:
2454 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002455
Facundo Batista353750c2007-09-13 18:13:15 +00002456 # the method name changed, but we provide also the old one, for compatibility
2457 to_integral = to_integral_value
2458
2459 def sqrt(self, context=None):
2460 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002461 if context is None:
2462 context = getcontext()
2463
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002464 if self._is_special:
2465 ans = self._check_nans(context=context)
2466 if ans:
2467 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002468
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002469 if self._isinfinity() and self._sign == 0:
2470 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002471
2472 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002473 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002474 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002475 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002476
2477 if self._sign == 1:
2478 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2479
Facundo Batista353750c2007-09-13 18:13:15 +00002480 # At this point self represents a positive number. Let p be
2481 # the desired precision and express self in the form c*100**e
2482 # with c a positive real number and e an integer, c and e
2483 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2484 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2485 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2486 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2487 # the closest integer to sqrt(c) with the even integer chosen
2488 # in the case of a tie.
2489 #
2490 # To ensure correct rounding in all cases, we use the
2491 # following trick: we compute the square root to an extra
2492 # place (precision p+1 instead of precision p), rounding down.
2493 # Then, if the result is inexact and its last digit is 0 or 5,
2494 # we increase the last digit to 1 or 6 respectively; if it's
2495 # exact we leave the last digit alone. Now the final round to
2496 # p places (or fewer in the case of underflow) will round
2497 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002498
Facundo Batista353750c2007-09-13 18:13:15 +00002499 # use an extra digit of precision
2500 prec = context.prec+1
2501
2502 # write argument in the form c*100**e where e = self._exp//2
2503 # is the 'ideal' exponent, to be used if the square root is
2504 # exactly representable. l is the number of 'digits' of c in
2505 # base 100, so that 100**(l-1) <= c < 100**l.
2506 op = _WorkRep(self)
2507 e = op.exp >> 1
2508 if op.exp & 1:
2509 c = op.int * 10
2510 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002511 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002512 c = op.int
2513 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002514
Facundo Batista353750c2007-09-13 18:13:15 +00002515 # rescale so that c has exactly prec base 100 'digits'
2516 shift = prec-l
2517 if shift >= 0:
2518 c *= 100**shift
2519 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002520 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002521 c, remainder = divmod(c, 100**-shift)
2522 exact = not remainder
2523 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002524
Facundo Batista353750c2007-09-13 18:13:15 +00002525 # find n = floor(sqrt(c)) using Newton's method
2526 n = 10**prec
2527 while True:
2528 q = c//n
2529 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002530 break
Facundo Batista353750c2007-09-13 18:13:15 +00002531 else:
2532 n = n + q >> 1
2533 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002534
Facundo Batista353750c2007-09-13 18:13:15 +00002535 if exact:
2536 # result is exact; rescale to use ideal exponent e
2537 if shift >= 0:
2538 # assert n % 10**shift == 0
2539 n //= 10**shift
2540 else:
2541 n *= 10**-shift
2542 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002543 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002544 # result is not exact; fix last digit as described above
2545 if n % 5 == 0:
2546 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002547
Facundo Batista72bc54f2007-11-23 17:59:00 +00002548 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002549
Facundo Batista353750c2007-09-13 18:13:15 +00002550 # round, and fit to current context
2551 context = context._shallow_copy()
2552 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002553 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002554 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002555
Facundo Batista353750c2007-09-13 18:13:15 +00002556 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002557
2558 def max(self, other, context=None):
2559 """Returns the larger value.
2560
Facundo Batista353750c2007-09-13 18:13:15 +00002561 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002562 NaN (and signals if one is sNaN). Also rounds.
2563 """
Facundo Batista353750c2007-09-13 18:13:15 +00002564 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002565
Facundo Batista6c398da2007-09-17 17:30:13 +00002566 if context is None:
2567 context = getcontext()
2568
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002569 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002570 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002571 # number is always returned
2572 sn = self._isnan()
2573 on = other._isnan()
2574 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00002575 if on == 1 and sn == 0:
2576 return self._fix(context)
2577 if sn == 1 and on == 0:
2578 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002579 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002580
Mark Dickinson2fc92632008-02-06 22:10:50 +00002581 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002582 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002583 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002584 # then an ordering is applied:
2585 #
Facundo Batista59c58842007-04-10 12:58:45 +00002586 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002587 # positive sign and min returns the operand with the negative sign
2588 #
Facundo Batista59c58842007-04-10 12:58:45 +00002589 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002590 # the result. This is exactly the ordering used in compare_total.
2591 c = self.compare_total(other)
2592
2593 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002594 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002595 else:
2596 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002597
Facundo Batistae64acfa2007-12-17 14:18:42 +00002598 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002599
2600 def min(self, other, context=None):
2601 """Returns the smaller value.
2602
Facundo Batista59c58842007-04-10 12:58:45 +00002603 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002604 NaN (and signals if one is sNaN). Also rounds.
2605 """
Facundo Batista353750c2007-09-13 18:13:15 +00002606 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002607
Facundo Batista6c398da2007-09-17 17:30:13 +00002608 if context is None:
2609 context = getcontext()
2610
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002611 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002612 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002613 # number is always returned
2614 sn = self._isnan()
2615 on = other._isnan()
2616 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00002617 if on == 1 and sn == 0:
2618 return self._fix(context)
2619 if sn == 1 and on == 0:
2620 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002621 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002622
Mark Dickinson2fc92632008-02-06 22:10:50 +00002623 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002624 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002625 c = self.compare_total(other)
2626
2627 if c == -1:
2628 ans = self
2629 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002630 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002631
Facundo Batistae64acfa2007-12-17 14:18:42 +00002632 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002633
2634 def _isinteger(self):
2635 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002636 if self._is_special:
2637 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002638 if self._exp >= 0:
2639 return True
2640 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002641 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002642
2643 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002644 """Returns True if self is even. Assumes self is an integer."""
2645 if not self or self._exp > 0:
2646 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002647 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002648
2649 def adjusted(self):
2650 """Return the adjusted exponent of self"""
2651 try:
2652 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002653 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002654 except TypeError:
2655 return 0
2656
Facundo Batista353750c2007-09-13 18:13:15 +00002657 def canonical(self, context=None):
2658 """Returns the same Decimal object.
2659
2660 As we do not have different encodings for the same number, the
2661 received object already is in its canonical form.
2662 """
2663 return self
2664
2665 def compare_signal(self, other, context=None):
2666 """Compares self to the other operand numerically.
2667
2668 It's pretty much like compare(), but all NaNs signal, with signaling
2669 NaNs taking precedence over quiet NaNs.
2670 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002671 other = _convert_other(other, raiseit = True)
2672 ans = self._compare_check_nans(other, context)
2673 if ans:
2674 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002675 return self.compare(other, context=context)
2676
2677 def compare_total(self, other):
2678 """Compares self to other using the abstract representations.
2679
2680 This is not like the standard compare, which use their numerical
2681 value. Note that a total ordering is defined for all possible abstract
2682 representations.
2683 """
2684 # if one is negative and the other is positive, it's easy
2685 if self._sign and not other._sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002686 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002687 if not self._sign and other._sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002688 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002689 sign = self._sign
2690
2691 # let's handle both NaN types
2692 self_nan = self._isnan()
2693 other_nan = other._isnan()
2694 if self_nan or other_nan:
2695 if self_nan == other_nan:
2696 if self._int < other._int:
2697 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002698 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002699 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002700 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002701 if self._int > other._int:
2702 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002703 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002704 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002705 return _One
2706 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002707
2708 if sign:
2709 if self_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002710 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002711 if other_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002712 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002713 if self_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002714 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002715 if other_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002716 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002717 else:
2718 if self_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002719 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002720 if other_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002721 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002722 if self_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002723 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002724 if other_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002725 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002726
2727 if self < other:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002728 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002729 if self > other:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002730 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002731
2732 if self._exp < other._exp:
2733 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002734 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002735 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002736 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002737 if self._exp > other._exp:
2738 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002739 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002740 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002741 return _One
2742 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002743
2744
2745 def compare_total_mag(self, other):
2746 """Compares self to other using abstract repr., ignoring sign.
2747
2748 Like compare_total, but with operand's sign ignored and assumed to be 0.
2749 """
2750 s = self.copy_abs()
2751 o = other.copy_abs()
2752 return s.compare_total(o)
2753
2754 def copy_abs(self):
2755 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002756 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002757
2758 def copy_negate(self):
2759 """Returns a copy with the sign inverted."""
2760 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002761 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002762 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002763 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002764
2765 def copy_sign(self, other):
2766 """Returns self with the sign of other."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002767 return _dec_from_triple(other._sign, self._int,
2768 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002769
2770 def exp(self, context=None):
2771 """Returns e ** self."""
2772
2773 if context is None:
2774 context = getcontext()
2775
2776 # exp(NaN) = NaN
2777 ans = self._check_nans(context=context)
2778 if ans:
2779 return ans
2780
2781 # exp(-Infinity) = 0
2782 if self._isinfinity() == -1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002783 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002784
2785 # exp(0) = 1
2786 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002787 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002788
2789 # exp(Infinity) = Infinity
2790 if self._isinfinity() == 1:
2791 return Decimal(self)
2792
2793 # the result is now guaranteed to be inexact (the true
2794 # mathematical result is transcendental). There's no need to
2795 # raise Rounded and Inexact here---they'll always be raised as
2796 # a result of the call to _fix.
2797 p = context.prec
2798 adj = self.adjusted()
2799
2800 # we only need to do any computation for quite a small range
2801 # of adjusted exponents---for example, -29 <= adj <= 10 for
2802 # the default context. For smaller exponent the result is
2803 # indistinguishable from 1 at the given precision, while for
2804 # larger exponent the result either overflows or underflows.
2805 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2806 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002807 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002808 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2809 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002810 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002811 elif self._sign == 0 and adj < -p:
2812 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002813 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002814 elif self._sign == 1 and adj < -p-1:
2815 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002816 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002817 # general case
2818 else:
2819 op = _WorkRep(self)
2820 c, e = op.int, op.exp
2821 if op.sign == 1:
2822 c = -c
2823
2824 # compute correctly rounded result: increase precision by
2825 # 3 digits at a time until we get an unambiguously
2826 # roundable result
2827 extra = 3
2828 while True:
2829 coeff, exp = _dexp(c, e, p+extra)
2830 if coeff % (5*10**(len(str(coeff))-p-1)):
2831 break
2832 extra += 3
2833
Facundo Batista72bc54f2007-11-23 17:59:00 +00002834 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002835
2836 # at this stage, ans should round correctly with *any*
2837 # rounding mode, not just with ROUND_HALF_EVEN
2838 context = context._shallow_copy()
2839 rounding = context._set_rounding(ROUND_HALF_EVEN)
2840 ans = ans._fix(context)
2841 context.rounding = rounding
2842
2843 return ans
2844
2845 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002846 """Return True if self is canonical; otherwise return False.
2847
2848 Currently, the encoding of a Decimal instance is always
2849 canonical, so this method returns True for any Decimal.
2850 """
2851 return True
Facundo Batista353750c2007-09-13 18:13:15 +00002852
2853 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002854 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00002855
Facundo Batista1a191df2007-10-02 17:01:24 +00002856 A Decimal instance is considered finite if it is neither
2857 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00002858 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002859 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00002860
2861 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002862 """Return True if self is infinite; otherwise return False."""
2863 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00002864
2865 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002866 """Return True if self is a qNaN or sNaN; otherwise return False."""
2867 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00002868
2869 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002870 """Return True if self is a normal number; otherwise return False."""
2871 if self._is_special or not self:
2872 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002873 if context is None:
2874 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002875 return context.Emin <= self.adjusted() <= context.Emax
Facundo Batista353750c2007-09-13 18:13:15 +00002876
2877 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002878 """Return True if self is a quiet NaN; otherwise return False."""
2879 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00002880
2881 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002882 """Return True if self is negative; otherwise return False."""
2883 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00002884
2885 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002886 """Return True if self is a signaling NaN; otherwise return False."""
2887 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00002888
2889 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002890 """Return True if self is subnormal; otherwise return False."""
2891 if self._is_special or not self:
2892 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002893 if context is None:
2894 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002895 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00002896
2897 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002898 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002899 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00002900
2901 def _ln_exp_bound(self):
2902 """Compute a lower bound for the adjusted exponent of self.ln().
2903 In other words, compute r such that self.ln() >= 10**r. Assumes
2904 that self is finite and positive and that self != 1.
2905 """
2906
2907 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
2908 adj = self._exp + len(self._int) - 1
2909 if adj >= 1:
2910 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
2911 return len(str(adj*23//10)) - 1
2912 if adj <= -2:
2913 # argument <= 0.1
2914 return len(str((-1-adj)*23//10)) - 1
2915 op = _WorkRep(self)
2916 c, e = op.int, op.exp
2917 if adj == 0:
2918 # 1 < self < 10
2919 num = str(c-10**-e)
2920 den = str(c)
2921 return len(num) - len(den) - (num < den)
2922 # adj == -1, 0.1 <= self < 1
2923 return e + len(str(10**-e - c)) - 1
2924
2925
2926 def ln(self, context=None):
2927 """Returns the natural (base e) logarithm of self."""
2928
2929 if context is None:
2930 context = getcontext()
2931
2932 # ln(NaN) = NaN
2933 ans = self._check_nans(context=context)
2934 if ans:
2935 return ans
2936
2937 # ln(0.0) == -Infinity
2938 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002939 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00002940
2941 # ln(Infinity) = Infinity
2942 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002943 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00002944
2945 # ln(1.0) == 0.0
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002946 if self == _One:
2947 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002948
2949 # ln(negative) raises InvalidOperation
2950 if self._sign == 1:
2951 return context._raise_error(InvalidOperation,
2952 'ln of a negative value')
2953
2954 # result is irrational, so necessarily inexact
2955 op = _WorkRep(self)
2956 c, e = op.int, op.exp
2957 p = context.prec
2958
2959 # correctly rounded result: repeatedly increase precision by 3
2960 # until we get an unambiguously roundable result
2961 places = p - self._ln_exp_bound() + 2 # at least p+3 places
2962 while True:
2963 coeff = _dlog(c, e, places)
2964 # assert len(str(abs(coeff)))-p >= 1
2965 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
2966 break
2967 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00002968 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00002969
2970 context = context._shallow_copy()
2971 rounding = context._set_rounding(ROUND_HALF_EVEN)
2972 ans = ans._fix(context)
2973 context.rounding = rounding
2974 return ans
2975
2976 def _log10_exp_bound(self):
2977 """Compute a lower bound for the adjusted exponent of self.log10().
2978 In other words, find r such that self.log10() >= 10**r.
2979 Assumes that self is finite and positive and that self != 1.
2980 """
2981
2982 # For x >= 10 or x < 0.1 we only need a bound on the integer
2983 # part of log10(self), and this comes directly from the
2984 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
2985 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
2986 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
2987
2988 adj = self._exp + len(self._int) - 1
2989 if adj >= 1:
2990 # self >= 10
2991 return len(str(adj))-1
2992 if adj <= -2:
2993 # self < 0.1
2994 return len(str(-1-adj))-1
2995 op = _WorkRep(self)
2996 c, e = op.int, op.exp
2997 if adj == 0:
2998 # 1 < self < 10
2999 num = str(c-10**-e)
3000 den = str(231*c)
3001 return len(num) - len(den) - (num < den) + 2
3002 # adj == -1, 0.1 <= self < 1
3003 num = str(10**-e-c)
3004 return len(num) + e - (num < "231") - 1
3005
3006 def log10(self, context=None):
3007 """Returns the base 10 logarithm of self."""
3008
3009 if context is None:
3010 context = getcontext()
3011
3012 # log10(NaN) = NaN
3013 ans = self._check_nans(context=context)
3014 if ans:
3015 return ans
3016
3017 # log10(0.0) == -Infinity
3018 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003019 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003020
3021 # log10(Infinity) = Infinity
3022 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003023 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003024
3025 # log10(negative or -Infinity) raises InvalidOperation
3026 if self._sign == 1:
3027 return context._raise_error(InvalidOperation,
3028 'log10 of a negative value')
3029
3030 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003031 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003032 # answer may need rounding
3033 ans = Decimal(self._exp + len(self._int) - 1)
3034 else:
3035 # result is irrational, so necessarily inexact
3036 op = _WorkRep(self)
3037 c, e = op.int, op.exp
3038 p = context.prec
3039
3040 # correctly rounded result: repeatedly increase precision
3041 # until result is unambiguously roundable
3042 places = p-self._log10_exp_bound()+2
3043 while True:
3044 coeff = _dlog10(c, e, places)
3045 # assert len(str(abs(coeff)))-p >= 1
3046 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3047 break
3048 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003049 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003050
3051 context = context._shallow_copy()
3052 rounding = context._set_rounding(ROUND_HALF_EVEN)
3053 ans = ans._fix(context)
3054 context.rounding = rounding
3055 return ans
3056
3057 def logb(self, context=None):
3058 """ Returns the exponent of the magnitude of self's MSD.
3059
3060 The result is the integer which is the exponent of the magnitude
3061 of the most significant digit of self (as though it were truncated
3062 to a single digit while maintaining the value of that digit and
3063 without limiting the resulting exponent).
3064 """
3065 # logb(NaN) = NaN
3066 ans = self._check_nans(context=context)
3067 if ans:
3068 return ans
3069
3070 if context is None:
3071 context = getcontext()
3072
3073 # logb(+/-Inf) = +Inf
3074 if self._isinfinity():
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003075 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003076
3077 # logb(0) = -Inf, DivisionByZero
3078 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003079 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003080
3081 # otherwise, simply return the adjusted exponent of self, as a
3082 # Decimal. Note that no attempt is made to fit the result
3083 # into the current context.
3084 return Decimal(self.adjusted())
3085
3086 def _islogical(self):
3087 """Return True if self is a logical operand.
3088
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003089 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003090 an exponent of 0, and a coefficient whose digits must all be
3091 either 0 or 1.
3092 """
3093 if self._sign != 0 or self._exp != 0:
3094 return False
3095 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003096 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003097 return False
3098 return True
3099
3100 def _fill_logical(self, context, opa, opb):
3101 dif = context.prec - len(opa)
3102 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003103 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003104 elif dif < 0:
3105 opa = opa[-context.prec:]
3106 dif = context.prec - len(opb)
3107 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003108 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003109 elif dif < 0:
3110 opb = opb[-context.prec:]
3111 return opa, opb
3112
3113 def logical_and(self, other, context=None):
3114 """Applies an 'and' operation between self and other's digits."""
3115 if context is None:
3116 context = getcontext()
3117 if not self._islogical() or not other._islogical():
3118 return context._raise_error(InvalidOperation)
3119
3120 # fill to context.prec
3121 (opa, opb) = self._fill_logical(context, self._int, other._int)
3122
3123 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003124 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3125 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003126
3127 def logical_invert(self, context=None):
3128 """Invert all its digits."""
3129 if context is None:
3130 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003131 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3132 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003133
3134 def logical_or(self, other, context=None):
3135 """Applies an 'or' operation between self and other's digits."""
3136 if context is None:
3137 context = getcontext()
3138 if not self._islogical() or not other._islogical():
3139 return context._raise_error(InvalidOperation)
3140
3141 # fill to context.prec
3142 (opa, opb) = self._fill_logical(context, self._int, other._int)
3143
3144 # make the operation, and clean starting zeroes
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00003145 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003146 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003147
3148 def logical_xor(self, other, context=None):
3149 """Applies an 'xor' operation between self and other's digits."""
3150 if context is None:
3151 context = getcontext()
3152 if not self._islogical() or not other._islogical():
3153 return context._raise_error(InvalidOperation)
3154
3155 # fill to context.prec
3156 (opa, opb) = self._fill_logical(context, self._int, other._int)
3157
3158 # make the operation, and clean starting zeroes
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00003159 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003160 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003161
3162 def max_mag(self, other, context=None):
3163 """Compares the values numerically with their sign ignored."""
3164 other = _convert_other(other, raiseit=True)
3165
Facundo Batista6c398da2007-09-17 17:30:13 +00003166 if context is None:
3167 context = getcontext()
3168
Facundo Batista353750c2007-09-13 18:13:15 +00003169 if self._is_special or other._is_special:
3170 # If one operand is a quiet NaN and the other is number, then the
3171 # number is always returned
3172 sn = self._isnan()
3173 on = other._isnan()
3174 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00003175 if on == 1 and sn == 0:
3176 return self._fix(context)
3177 if sn == 1 and on == 0:
3178 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003179 return self._check_nans(other, context)
3180
Mark Dickinson2fc92632008-02-06 22:10:50 +00003181 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003182 if c == 0:
3183 c = self.compare_total(other)
3184
3185 if c == -1:
3186 ans = other
3187 else:
3188 ans = self
3189
Facundo Batistae64acfa2007-12-17 14:18:42 +00003190 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003191
3192 def min_mag(self, other, context=None):
3193 """Compares the values numerically with their sign ignored."""
3194 other = _convert_other(other, raiseit=True)
3195
Facundo Batista6c398da2007-09-17 17:30:13 +00003196 if context is None:
3197 context = getcontext()
3198
Facundo Batista353750c2007-09-13 18:13:15 +00003199 if self._is_special or other._is_special:
3200 # If one operand is a quiet NaN and the other is number, then the
3201 # number is always returned
3202 sn = self._isnan()
3203 on = other._isnan()
3204 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00003205 if on == 1 and sn == 0:
3206 return self._fix(context)
3207 if sn == 1 and on == 0:
3208 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003209 return self._check_nans(other, context)
3210
Mark Dickinson2fc92632008-02-06 22:10:50 +00003211 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003212 if c == 0:
3213 c = self.compare_total(other)
3214
3215 if c == -1:
3216 ans = self
3217 else:
3218 ans = other
3219
Facundo Batistae64acfa2007-12-17 14:18:42 +00003220 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003221
3222 def next_minus(self, context=None):
3223 """Returns the largest representable number smaller than itself."""
3224 if context is None:
3225 context = getcontext()
3226
3227 ans = self._check_nans(context=context)
3228 if ans:
3229 return ans
3230
3231 if self._isinfinity() == -1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003232 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003233 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003234 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003235
3236 context = context.copy()
3237 context._set_rounding(ROUND_FLOOR)
3238 context._ignore_all_flags()
3239 new_self = self._fix(context)
3240 if new_self != self:
3241 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003242 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3243 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003244
3245 def next_plus(self, context=None):
3246 """Returns the smallest representable number larger than itself."""
3247 if context is None:
3248 context = getcontext()
3249
3250 ans = self._check_nans(context=context)
3251 if ans:
3252 return ans
3253
3254 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003255 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003256 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003257 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003258
3259 context = context.copy()
3260 context._set_rounding(ROUND_CEILING)
3261 context._ignore_all_flags()
3262 new_self = self._fix(context)
3263 if new_self != self:
3264 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003265 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3266 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003267
3268 def next_toward(self, other, context=None):
3269 """Returns the number closest to self, in the direction towards other.
3270
3271 The result is the closest representable number to self
3272 (excluding self) that is in the direction towards other,
3273 unless both have the same value. If the two operands are
3274 numerically equal, then the result is a copy of self with the
3275 sign set to be the same as the sign of other.
3276 """
3277 other = _convert_other(other, raiseit=True)
3278
3279 if context is None:
3280 context = getcontext()
3281
3282 ans = self._check_nans(other, context)
3283 if ans:
3284 return ans
3285
Mark Dickinson2fc92632008-02-06 22:10:50 +00003286 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003287 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003288 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003289
3290 if comparison == -1:
3291 ans = self.next_plus(context)
3292 else: # comparison == 1
3293 ans = self.next_minus(context)
3294
3295 # decide which flags to raise using value of ans
3296 if ans._isinfinity():
3297 context._raise_error(Overflow,
3298 'Infinite result from next_toward',
3299 ans._sign)
3300 context._raise_error(Rounded)
3301 context._raise_error(Inexact)
3302 elif ans.adjusted() < context.Emin:
3303 context._raise_error(Underflow)
3304 context._raise_error(Subnormal)
3305 context._raise_error(Rounded)
3306 context._raise_error(Inexact)
3307 # if precision == 1 then we don't raise Clamped for a
3308 # result 0E-Etiny.
3309 if not ans:
3310 context._raise_error(Clamped)
3311
3312 return ans
3313
3314 def number_class(self, context=None):
3315 """Returns an indication of the class of self.
3316
3317 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003318 sNaN
3319 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003320 -Infinity
3321 -Normal
3322 -Subnormal
3323 -Zero
3324 +Zero
3325 +Subnormal
3326 +Normal
3327 +Infinity
3328 """
3329 if self.is_snan():
3330 return "sNaN"
3331 if self.is_qnan():
3332 return "NaN"
3333 inf = self._isinfinity()
3334 if inf == 1:
3335 return "+Infinity"
3336 if inf == -1:
3337 return "-Infinity"
3338 if self.is_zero():
3339 if self._sign:
3340 return "-Zero"
3341 else:
3342 return "+Zero"
3343 if context is None:
3344 context = getcontext()
3345 if self.is_subnormal(context=context):
3346 if self._sign:
3347 return "-Subnormal"
3348 else:
3349 return "+Subnormal"
3350 # just a normal, regular, boring number, :)
3351 if self._sign:
3352 return "-Normal"
3353 else:
3354 return "+Normal"
3355
3356 def radix(self):
3357 """Just returns 10, as this is Decimal, :)"""
3358 return Decimal(10)
3359
3360 def rotate(self, other, context=None):
3361 """Returns a rotated copy of self, value-of-other times."""
3362 if context is None:
3363 context = getcontext()
3364
3365 ans = self._check_nans(other, context)
3366 if ans:
3367 return ans
3368
3369 if other._exp != 0:
3370 return context._raise_error(InvalidOperation)
3371 if not (-context.prec <= int(other) <= context.prec):
3372 return context._raise_error(InvalidOperation)
3373
3374 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003375 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003376
3377 # get values, pad if necessary
3378 torot = int(other)
3379 rotdig = self._int
3380 topad = context.prec - len(rotdig)
3381 if topad:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003382 rotdig = '0'*topad + rotdig
Facundo Batista353750c2007-09-13 18:13:15 +00003383
3384 # let's rotate!
3385 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003386 return _dec_from_triple(self._sign,
3387 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003388
3389 def scaleb (self, other, context=None):
3390 """Returns self operand after adding the second value to its exp."""
3391 if context is None:
3392 context = getcontext()
3393
3394 ans = self._check_nans(other, context)
3395 if ans:
3396 return ans
3397
3398 if other._exp != 0:
3399 return context._raise_error(InvalidOperation)
3400 liminf = -2 * (context.Emax + context.prec)
3401 limsup = 2 * (context.Emax + context.prec)
3402 if not (liminf <= int(other) <= limsup):
3403 return context._raise_error(InvalidOperation)
3404
3405 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003406 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003407
Facundo Batista72bc54f2007-11-23 17:59:00 +00003408 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003409 d = d._fix(context)
3410 return d
3411
3412 def shift(self, other, context=None):
3413 """Returns a shifted copy of self, value-of-other times."""
3414 if context is None:
3415 context = getcontext()
3416
3417 ans = self._check_nans(other, context)
3418 if ans:
3419 return ans
3420
3421 if other._exp != 0:
3422 return context._raise_error(InvalidOperation)
3423 if not (-context.prec <= int(other) <= context.prec):
3424 return context._raise_error(InvalidOperation)
3425
3426 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003427 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003428
3429 # get values, pad if necessary
3430 torot = int(other)
3431 if not torot:
Facundo Batista6c398da2007-09-17 17:30:13 +00003432 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003433 rotdig = self._int
3434 topad = context.prec - len(rotdig)
3435 if topad:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003436 rotdig = '0'*topad + rotdig
Facundo Batista353750c2007-09-13 18:13:15 +00003437
3438 # let's shift!
3439 if torot < 0:
3440 rotated = rotdig[:torot]
3441 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003442 rotated = rotdig + '0'*torot
Facundo Batista353750c2007-09-13 18:13:15 +00003443 rotated = rotated[-context.prec:]
3444
Facundo Batista72bc54f2007-11-23 17:59:00 +00003445 return _dec_from_triple(self._sign,
3446 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003447
Facundo Batista59c58842007-04-10 12:58:45 +00003448 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003449 def __reduce__(self):
3450 return (self.__class__, (str(self),))
3451
3452 def __copy__(self):
3453 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003454 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003455 return self.__class__(str(self))
3456
3457 def __deepcopy__(self, memo):
3458 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003459 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003460 return self.__class__(str(self))
3461
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003462 # PEP 3101 support. See also _parse_format_specifier and _format_align
3463 def __format__(self, specifier, context=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003464 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003465
3466 The specifier should be a standard format specifier, with the
3467 form described in PEP 3101. Formatting types 'e', 'E', 'f',
3468 'F', 'g', 'G', and '%' are supported. If the formatting type
3469 is omitted it defaults to 'g' or 'G', depending on the value
3470 of context.capitals.
3471
3472 At this time the 'n' format specifier type (which is supposed
3473 to use the current locale) is not supported.
3474 """
3475
3476 # Note: PEP 3101 says that if the type is not present then
3477 # there should be at least one digit after the decimal point.
3478 # We take the liberty of ignoring this requirement for
3479 # Decimal---it's presumably there to make sure that
3480 # format(float, '') behaves similarly to str(float).
3481 if context is None:
3482 context = getcontext()
3483
3484 spec = _parse_format_specifier(specifier)
3485
3486 # special values don't care about the type or precision...
3487 if self._is_special:
3488 return _format_align(str(self), spec)
3489
3490 # a type of None defaults to 'g' or 'G', depending on context
3491 # if type is '%', adjust exponent of self accordingly
3492 if spec['type'] is None:
3493 spec['type'] = ['g', 'G'][context.capitals]
3494 elif spec['type'] == '%':
3495 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3496
3497 # round if necessary, taking rounding mode from the context
3498 rounding = context.rounding
3499 precision = spec['precision']
3500 if precision is not None:
3501 if spec['type'] in 'eE':
3502 self = self._round(precision+1, rounding)
3503 elif spec['type'] in 'gG':
3504 if len(self._int) > precision:
3505 self = self._round(precision, rounding)
3506 elif spec['type'] in 'fF%':
3507 self = self._rescale(-precision, rounding)
3508 # special case: zeros with a positive exponent can't be
3509 # represented in fixed point; rescale them to 0e0.
3510 elif not self and self._exp > 0 and spec['type'] in 'fF%':
3511 self = self._rescale(0, rounding)
3512
3513 # figure out placement of the decimal point
3514 leftdigits = self._exp + len(self._int)
3515 if spec['type'] in 'fF%':
3516 dotplace = leftdigits
3517 elif spec['type'] in 'eE':
3518 if not self and precision is not None:
3519 dotplace = 1 - precision
3520 else:
3521 dotplace = 1
3522 elif spec['type'] in 'gG':
3523 if self._exp <= 0 and leftdigits > -6:
3524 dotplace = leftdigits
3525 else:
3526 dotplace = 1
3527
3528 # figure out main part of numeric string...
3529 if dotplace <= 0:
3530 num = '0.' + '0'*(-dotplace) + self._int
3531 elif dotplace >= len(self._int):
3532 # make sure we're not padding a '0' with extra zeros on the right
3533 assert dotplace==len(self._int) or self._int != '0'
3534 num = self._int + '0'*(dotplace-len(self._int))
3535 else:
3536 num = self._int[:dotplace] + '.' + self._int[dotplace:]
3537
3538 # ...then the trailing exponent, or trailing '%'
3539 if leftdigits != dotplace or spec['type'] in 'eE':
3540 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
3541 num = num + "{0}{1:+}".format(echar, leftdigits-dotplace)
3542 elif spec['type'] == '%':
3543 num = num + '%'
3544
3545 # add sign
3546 if self._sign == 1:
3547 num = '-' + num
3548 return _format_align(num, spec)
3549
3550
Facundo Batista72bc54f2007-11-23 17:59:00 +00003551def _dec_from_triple(sign, coefficient, exponent, special=False):
3552 """Create a decimal instance directly, without any validation,
3553 normalization (e.g. removal of leading zeros) or argument
3554 conversion.
3555
3556 This function is for *internal use only*.
3557 """
3558
3559 self = object.__new__(Decimal)
3560 self._sign = sign
3561 self._int = coefficient
3562 self._exp = exponent
3563 self._is_special = special
3564
3565 return self
3566
Raymond Hettinger45fd4762009-02-03 03:42:07 +00003567# Register Decimal as a kind of Number (an abstract base class).
3568# However, do not register it as Real (because Decimals are not
3569# interoperable with floats).
3570_numbers.Number.register(Decimal)
3571
3572
Facundo Batista59c58842007-04-10 12:58:45 +00003573##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003574
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003575
3576# get rounding method function:
Facundo Batista59c58842007-04-10 12:58:45 +00003577rounding_functions = [name for name in Decimal.__dict__.keys()
3578 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003579for name in rounding_functions:
Facundo Batista59c58842007-04-10 12:58:45 +00003580 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003581 globalname = name[1:].upper()
3582 val = globals()[globalname]
3583 Decimal._pick_rounding_function[val] = name
3584
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003585del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003586
Nick Coghlanced12182006-09-02 03:54:17 +00003587class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003588 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003589
Nick Coghlanced12182006-09-02 03:54:17 +00003590 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003591 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003592 """
3593 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003594 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003595 def __enter__(self):
3596 self.saved_context = getcontext()
3597 setcontext(self.new_context)
3598 return self.new_context
3599 def __exit__(self, t, v, tb):
3600 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003601
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003602class Context(object):
3603 """Contains the context for a Decimal instance.
3604
3605 Contains:
3606 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003607 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003608 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003609 raised when it is caused. Otherwise, a value is
3610 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003611 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003612 (Whether or not the trap_enabler is set)
3613 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003614 Emin - Minimum exponent
3615 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003616 capitals - If 1, 1*10^1 is printed as 1E+1.
3617 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003618 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003619 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003620
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003621 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003622 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003623 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003624 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003625 _ignored_flags=None):
3626 if flags is None:
3627 flags = []
3628 if _ignored_flags is None:
3629 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003630 if not isinstance(flags, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003631 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003632 del s
Raymond Hettingerbf440692004-07-10 14:14:37 +00003633 if traps is not None and not isinstance(traps, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003634 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003635 del s
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003636 for name, val in locals().items():
3637 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003638 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003639 else:
3640 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003641 del self.self
3642
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003643 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003644 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003645 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003646 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3647 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3648 % vars(self))
3649 names = [f.__name__ for f, v in self.flags.items() if v]
3650 s.append('flags=[' + ', '.join(names) + ']')
3651 names = [t.__name__ for t, v in self.traps.items() if v]
3652 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003653 return ', '.join(s) + ')'
3654
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003655 def clear_flags(self):
3656 """Reset all flags to zero"""
3657 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003658 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003659
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003660 def _shallow_copy(self):
3661 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003662 nc = Context(self.prec, self.rounding, self.traps,
3663 self.flags, self.Emin, self.Emax,
3664 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003665 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003666
3667 def copy(self):
3668 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003669 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003670 self.flags.copy(), self.Emin, self.Emax,
3671 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003672 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003673 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003674
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003675 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003676 """Handles an error
3677
3678 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003679 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003680 trap_enabler is set, it reaises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003681 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003682 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003683 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003684 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003685 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003686 return error().handle(self, *args)
3687
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003688 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003689 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003690 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003691 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003692
3693 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003694 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003695 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003696
3697 def _ignore_all_flags(self):
3698 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003699 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003700
3701 def _ignore_flags(self, *flags):
3702 """Ignore the flags, if they are raised"""
3703 # Do not mutate-- This way, copies of a context leave the original
3704 # alone.
3705 self._ignored_flags = (self._ignored_flags + list(flags))
3706 return list(flags)
3707
3708 def _regard_flags(self, *flags):
3709 """Stop ignoring the flags, if they are raised"""
3710 if flags and isinstance(flags[0], (tuple,list)):
3711 flags = flags[0]
3712 for flag in flags:
3713 self._ignored_flags.remove(flag)
3714
Nick Coghlan53663a62008-07-15 14:27:37 +00003715 # We inherit object.__hash__, so we must deny this explicitly
3716 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003717
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003718 def Etiny(self):
3719 """Returns Etiny (= Emin - prec + 1)"""
3720 return int(self.Emin - self.prec + 1)
3721
3722 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003723 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003724 return int(self.Emax - self.prec + 1)
3725
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003726 def _set_rounding(self, type):
3727 """Sets the rounding type.
3728
3729 Sets the rounding type, and returns the current (previous)
3730 rounding type. Often used like:
3731
3732 context = context.copy()
3733 # so you don't change the calling context
3734 # if an error occurs in the middle.
3735 rounding = context._set_rounding(ROUND_UP)
3736 val = self.__sub__(other, context=context)
3737 context._set_rounding(rounding)
3738
3739 This will make it round up for that operation.
3740 """
3741 rounding = self.rounding
3742 self.rounding= type
3743 return rounding
3744
Raymond Hettingerfed52962004-07-14 15:41:57 +00003745 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003746 """Creates a new Decimal instance but using self as context.
3747
3748 This method implements the to-number operation of the
3749 IBM Decimal specification."""
3750
3751 if isinstance(num, basestring) and num != num.strip():
3752 return self._raise_error(ConversionSyntax,
3753 "no trailing or leading whitespace is "
3754 "permitted.")
3755
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003756 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003757 if d._isnan() and len(d._int) > self.prec - self._clamp:
3758 return self._raise_error(ConversionSyntax,
3759 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003760 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003761
Facundo Batista59c58842007-04-10 12:58:45 +00003762 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003763 def abs(self, a):
3764 """Returns the absolute value of the operand.
3765
3766 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003767 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003768 the plus operation on the operand.
3769
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003770 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003771 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003772 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003773 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003774 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003775 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003776 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003777 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003778 """
3779 return a.__abs__(context=self)
3780
3781 def add(self, a, b):
3782 """Return the sum of the two operands.
3783
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003784 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003785 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003786 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003787 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003788 """
3789 return a.__add__(b, context=self)
3790
3791 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003792 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003793
Facundo Batista353750c2007-09-13 18:13:15 +00003794 def canonical(self, a):
3795 """Returns the same Decimal object.
3796
3797 As we do not have different encodings for the same number, the
3798 received object already is in its canonical form.
3799
3800 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003801 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003802 """
3803 return a.canonical(context=self)
3804
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003805 def compare(self, a, b):
3806 """Compares values numerically.
3807
3808 If the signs of the operands differ, a value representing each operand
3809 ('-1' if the operand is less than zero, '0' if the operand is zero or
3810 negative zero, or '1' if the operand is greater than zero) is used in
3811 place of that operand for the comparison instead of the actual
3812 operand.
3813
3814 The comparison is then effected by subtracting the second operand from
3815 the first and then returning a value according to the result of the
3816 subtraction: '-1' if the result is less than zero, '0' if the result is
3817 zero or negative zero, or '1' if the result is greater than zero.
3818
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003819 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003820 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003821 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003822 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003823 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003824 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003825 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003826 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003827 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003828 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003829 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003830 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003831 """
3832 return a.compare(b, context=self)
3833
Facundo Batista353750c2007-09-13 18:13:15 +00003834 def compare_signal(self, a, b):
3835 """Compares the values of the two operands numerically.
3836
3837 It's pretty much like compare(), but all NaNs signal, with signaling
3838 NaNs taking precedence over quiet NaNs.
3839
3840 >>> c = ExtendedContext
3841 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003842 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003843 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003844 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003845 >>> c.flags[InvalidOperation] = 0
3846 >>> print c.flags[InvalidOperation]
3847 0
3848 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003849 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003850 >>> print c.flags[InvalidOperation]
3851 1
3852 >>> c.flags[InvalidOperation] = 0
3853 >>> print c.flags[InvalidOperation]
3854 0
3855 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003856 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003857 >>> print c.flags[InvalidOperation]
3858 1
3859 """
3860 return a.compare_signal(b, context=self)
3861
3862 def compare_total(self, a, b):
3863 """Compares two operands using their abstract representation.
3864
3865 This is not like the standard compare, which use their numerical
3866 value. Note that a total ordering is defined for all possible abstract
3867 representations.
3868
3869 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003870 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003871 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003872 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003873 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003874 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003875 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003876 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003877 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003878 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00003879 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003880 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003881 """
3882 return a.compare_total(b)
3883
3884 def compare_total_mag(self, a, b):
3885 """Compares two operands using their abstract representation ignoring sign.
3886
3887 Like compare_total, but with operand's sign ignored and assumed to be 0.
3888 """
3889 return a.compare_total_mag(b)
3890
3891 def copy_abs(self, a):
3892 """Returns a copy of the operand with the sign set to 0.
3893
3894 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003895 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003896 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003897 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00003898 """
3899 return a.copy_abs()
3900
3901 def copy_decimal(self, a):
3902 """Returns a copy of the decimal objet.
3903
3904 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003905 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003906 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003907 Decimal('-1.00')
Facundo Batista353750c2007-09-13 18:13:15 +00003908 """
Facundo Batista6c398da2007-09-17 17:30:13 +00003909 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00003910
3911 def copy_negate(self, a):
3912 """Returns a copy of the operand with the sign inverted.
3913
3914 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003915 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003916 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003917 Decimal('101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003918 """
3919 return a.copy_negate()
3920
3921 def copy_sign(self, a, b):
3922 """Copies the second operand's sign to the first one.
3923
3924 In detail, it returns a copy of the first operand with the sign
3925 equal to the sign of the second operand.
3926
3927 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003928 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003929 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003930 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003931 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003932 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003933 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003934 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003935 """
3936 return a.copy_sign(b)
3937
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003938 def divide(self, a, b):
3939 """Decimal division in a specified context.
3940
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003941 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003942 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003943 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003944 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003945 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003946 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003947 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003948 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003949 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003950 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003951 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003952 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003953 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003954 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003955 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003956 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003957 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003958 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003959 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003960 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003961 """
3962 return a.__div__(b, context=self)
3963
3964 def divide_int(self, a, b):
3965 """Divides two numbers and returns the integer part of the result.
3966
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003967 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003968 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003969 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003970 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003971 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003972 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003973 """
3974 return a.__floordiv__(b, context=self)
3975
3976 def divmod(self, a, b):
3977 return a.__divmod__(b, context=self)
3978
Facundo Batista353750c2007-09-13 18:13:15 +00003979 def exp(self, a):
3980 """Returns e ** a.
3981
3982 >>> c = ExtendedContext.copy()
3983 >>> c.Emin = -999
3984 >>> c.Emax = 999
3985 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003986 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003987 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003988 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00003989 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003990 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00003991 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003992 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00003993 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003994 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00003995 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003996 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00003997 """
3998 return a.exp(context=self)
3999
4000 def fma(self, a, b, c):
4001 """Returns a multiplied by b, plus c.
4002
4003 The first two operands are multiplied together, using multiply,
4004 the third operand is then added to the result of that
4005 multiplication, using add, all with only one final rounding.
4006
4007 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004008 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004009 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004010 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004011 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004012 Decimal('1.38435736E+12')
Facundo Batista353750c2007-09-13 18:13:15 +00004013 """
4014 return a.fma(b, c, context=self)
4015
4016 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004017 """Return True if the operand is canonical; otherwise return False.
4018
4019 Currently, the encoding of a Decimal instance is always
4020 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004021
4022 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004023 True
Facundo Batista353750c2007-09-13 18:13:15 +00004024 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004025 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004026
4027 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004028 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004029
Facundo Batista1a191df2007-10-02 17:01:24 +00004030 A Decimal instance is considered finite if it is neither
4031 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004032
4033 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004034 True
Facundo Batista353750c2007-09-13 18:13:15 +00004035 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004036 True
Facundo Batista353750c2007-09-13 18:13:15 +00004037 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004038 True
Facundo Batista353750c2007-09-13 18:13:15 +00004039 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004040 False
Facundo Batista353750c2007-09-13 18:13:15 +00004041 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004042 False
Facundo Batista353750c2007-09-13 18:13:15 +00004043 """
4044 return a.is_finite()
4045
4046 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004047 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004048
4049 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004050 False
Facundo Batista353750c2007-09-13 18:13:15 +00004051 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004052 True
Facundo Batista353750c2007-09-13 18:13:15 +00004053 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004054 False
Facundo Batista353750c2007-09-13 18:13:15 +00004055 """
4056 return a.is_infinite()
4057
4058 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004059 """Return True if the operand is a qNaN or sNaN;
4060 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004061
4062 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004063 False
Facundo Batista353750c2007-09-13 18:13:15 +00004064 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004065 True
Facundo Batista353750c2007-09-13 18:13:15 +00004066 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004067 True
Facundo Batista353750c2007-09-13 18:13:15 +00004068 """
4069 return a.is_nan()
4070
4071 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004072 """Return True if the operand is a normal number;
4073 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004074
4075 >>> c = ExtendedContext.copy()
4076 >>> c.Emin = -999
4077 >>> c.Emax = 999
4078 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004079 True
Facundo Batista353750c2007-09-13 18:13:15 +00004080 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004081 False
Facundo Batista353750c2007-09-13 18:13:15 +00004082 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004083 False
Facundo Batista353750c2007-09-13 18:13:15 +00004084 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004085 False
Facundo Batista353750c2007-09-13 18:13:15 +00004086 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004087 False
Facundo Batista353750c2007-09-13 18:13:15 +00004088 """
4089 return a.is_normal(context=self)
4090
4091 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004092 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004093
4094 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004095 False
Facundo Batista353750c2007-09-13 18:13:15 +00004096 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004097 True
Facundo Batista353750c2007-09-13 18:13:15 +00004098 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004099 False
Facundo Batista353750c2007-09-13 18:13:15 +00004100 """
4101 return a.is_qnan()
4102
4103 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004104 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004105
4106 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004107 False
Facundo Batista353750c2007-09-13 18:13:15 +00004108 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004109 True
Facundo Batista353750c2007-09-13 18:13:15 +00004110 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004111 True
Facundo Batista353750c2007-09-13 18:13:15 +00004112 """
4113 return a.is_signed()
4114
4115 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004116 """Return True if the operand is a signaling NaN;
4117 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004118
4119 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004120 False
Facundo Batista353750c2007-09-13 18:13:15 +00004121 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004122 False
Facundo Batista353750c2007-09-13 18:13:15 +00004123 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004124 True
Facundo Batista353750c2007-09-13 18:13:15 +00004125 """
4126 return a.is_snan()
4127
4128 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004129 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004130
4131 >>> c = ExtendedContext.copy()
4132 >>> c.Emin = -999
4133 >>> c.Emax = 999
4134 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004135 False
Facundo Batista353750c2007-09-13 18:13:15 +00004136 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004137 True
Facundo Batista353750c2007-09-13 18:13:15 +00004138 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004139 False
Facundo Batista353750c2007-09-13 18:13:15 +00004140 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004141 False
Facundo Batista353750c2007-09-13 18:13:15 +00004142 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004143 False
Facundo Batista353750c2007-09-13 18:13:15 +00004144 """
4145 return a.is_subnormal(context=self)
4146
4147 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004148 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004149
4150 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004151 True
Facundo Batista353750c2007-09-13 18:13:15 +00004152 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004153 False
Facundo Batista353750c2007-09-13 18:13:15 +00004154 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004155 True
Facundo Batista353750c2007-09-13 18:13:15 +00004156 """
4157 return a.is_zero()
4158
4159 def ln(self, a):
4160 """Returns the natural (base e) logarithm of the operand.
4161
4162 >>> c = ExtendedContext.copy()
4163 >>> c.Emin = -999
4164 >>> c.Emax = 999
4165 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004166 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004167 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004168 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004169 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004170 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004171 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004172 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004173 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004174 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004175 """
4176 return a.ln(context=self)
4177
4178 def log10(self, a):
4179 """Returns the base 10 logarithm of the operand.
4180
4181 >>> c = ExtendedContext.copy()
4182 >>> c.Emin = -999
4183 >>> c.Emax = 999
4184 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004185 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004186 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004187 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004188 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004189 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004190 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004191 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004192 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004193 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004194 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004195 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004196 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004197 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004198 """
4199 return a.log10(context=self)
4200
4201 def logb(self, a):
4202 """ Returns the exponent of the magnitude of the operand's MSD.
4203
4204 The result is the integer which is the exponent of the magnitude
4205 of the most significant digit of the operand (as though the
4206 operand were truncated to a single digit while maintaining the
4207 value of that digit and without limiting the resulting exponent).
4208
4209 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004210 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004211 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004212 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004213 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004214 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004215 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004216 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004217 """
4218 return a.logb(context=self)
4219
4220 def logical_and(self, a, b):
4221 """Applies the logical operation 'and' between each operand's digits.
4222
4223 The operands must be both logical numbers.
4224
4225 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004226 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004227 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004228 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004229 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004230 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004231 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004232 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004233 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004234 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004235 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004236 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004237 """
4238 return a.logical_and(b, context=self)
4239
4240 def logical_invert(self, a):
4241 """Invert all the digits in the operand.
4242
4243 The operand must be a logical number.
4244
4245 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004246 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004247 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004248 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004249 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004250 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004251 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004252 Decimal('10101010')
Facundo Batista353750c2007-09-13 18:13:15 +00004253 """
4254 return a.logical_invert(context=self)
4255
4256 def logical_or(self, a, b):
4257 """Applies the logical operation 'or' between each operand's digits.
4258
4259 The operands must be both logical numbers.
4260
4261 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004262 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004263 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004264 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004265 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004266 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004267 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004268 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004269 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004270 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004271 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004272 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004273 """
4274 return a.logical_or(b, context=self)
4275
4276 def logical_xor(self, a, b):
4277 """Applies the logical operation 'xor' between each operand's digits.
4278
4279 The operands must be both logical numbers.
4280
4281 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004282 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004283 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004284 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004285 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004286 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004287 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004288 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004289 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004290 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004291 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004292 Decimal('1101')
Facundo Batista353750c2007-09-13 18:13:15 +00004293 """
4294 return a.logical_xor(b, context=self)
4295
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004296 def max(self, a,b):
4297 """max compares two values numerically and returns the maximum.
4298
4299 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004300 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004301 operation. If they are numerically equal then the left-hand operand
4302 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004303 infinity) of the two operands is chosen as the result.
4304
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004305 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004306 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004307 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004308 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004309 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004310 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004311 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004312 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004313 """
4314 return a.max(b, context=self)
4315
Facundo Batista353750c2007-09-13 18:13:15 +00004316 def max_mag(self, a, b):
4317 """Compares the values numerically with their sign ignored."""
4318 return a.max_mag(b, context=self)
4319
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004320 def min(self, a,b):
4321 """min compares two values numerically and returns the minimum.
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 minimum (closer to negative
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.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004330 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004331 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004332 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004333 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004334 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004335 >>> ExtendedContext.min(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.min(b, context=self)
4339
Facundo Batista353750c2007-09-13 18:13:15 +00004340 def min_mag(self, a, b):
4341 """Compares the values numerically with their sign ignored."""
4342 return a.min_mag(b, context=self)
4343
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004344 def minus(self, a):
4345 """Minus corresponds to unary prefix minus in Python.
4346
4347 The operation is evaluated using the same rules as subtract; the
4348 operation minus(a) is calculated as subtract('0', a) where the '0'
4349 has the same exponent as the operand.
4350
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004351 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004352 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004353 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004354 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004355 """
4356 return a.__neg__(context=self)
4357
4358 def multiply(self, a, b):
4359 """multiply multiplies two operands.
4360
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004361 If either operand is a special value then the general rules apply.
4362 Otherwise, the operands are multiplied together ('long multiplication'),
4363 resulting in a number which may be as long as the sum of the lengths
4364 of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004365
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004366 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004367 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004368 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004369 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004370 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004371 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004372 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004373 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004374 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004375 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004376 """
4377 return a.__mul__(b, context=self)
4378
Facundo Batista353750c2007-09-13 18:13:15 +00004379 def next_minus(self, a):
4380 """Returns the largest representable number smaller than a.
4381
4382 >>> c = ExtendedContext.copy()
4383 >>> c.Emin = -999
4384 >>> c.Emax = 999
4385 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004386 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004387 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004388 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004389 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004390 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004391 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004392 Decimal('9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004393 """
4394 return a.next_minus(context=self)
4395
4396 def next_plus(self, a):
4397 """Returns the smallest representable number larger than a.
4398
4399 >>> c = ExtendedContext.copy()
4400 >>> c.Emin = -999
4401 >>> c.Emax = 999
4402 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004403 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004404 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004405 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004406 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004407 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004408 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004409 Decimal('-9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004410 """
4411 return a.next_plus(context=self)
4412
4413 def next_toward(self, a, b):
4414 """Returns the number closest to a, in direction towards b.
4415
4416 The result is the closest representable number from the first
4417 operand (but not the first operand) that is in the direction
4418 towards the second operand, unless the operands have the same
4419 value.
4420
4421 >>> c = ExtendedContext.copy()
4422 >>> c.Emin = -999
4423 >>> c.Emax = 999
4424 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004425 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004426 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004427 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004428 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004429 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004430 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004431 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004432 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004433 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004434 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004435 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004436 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004437 Decimal('-0.00')
Facundo Batista353750c2007-09-13 18:13:15 +00004438 """
4439 return a.next_toward(b, context=self)
4440
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004441 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004442 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004443
4444 Essentially a plus operation with all trailing zeros removed from the
4445 result.
4446
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004447 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004448 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004449 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004450 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004451 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004452 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004453 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004454 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004455 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004456 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004457 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004458 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004459 """
4460 return a.normalize(context=self)
4461
Facundo Batista353750c2007-09-13 18:13:15 +00004462 def number_class(self, a):
4463 """Returns an indication of the class of the operand.
4464
4465 The class is one of the following strings:
4466 -sNaN
4467 -NaN
4468 -Infinity
4469 -Normal
4470 -Subnormal
4471 -Zero
4472 +Zero
4473 +Subnormal
4474 +Normal
4475 +Infinity
4476
4477 >>> c = Context(ExtendedContext)
4478 >>> c.Emin = -999
4479 >>> c.Emax = 999
4480 >>> c.number_class(Decimal('Infinity'))
4481 '+Infinity'
4482 >>> c.number_class(Decimal('1E-10'))
4483 '+Normal'
4484 >>> c.number_class(Decimal('2.50'))
4485 '+Normal'
4486 >>> c.number_class(Decimal('0.1E-999'))
4487 '+Subnormal'
4488 >>> c.number_class(Decimal('0'))
4489 '+Zero'
4490 >>> c.number_class(Decimal('-0'))
4491 '-Zero'
4492 >>> c.number_class(Decimal('-0.1E-999'))
4493 '-Subnormal'
4494 >>> c.number_class(Decimal('-1E-10'))
4495 '-Normal'
4496 >>> c.number_class(Decimal('-2.50'))
4497 '-Normal'
4498 >>> c.number_class(Decimal('-Infinity'))
4499 '-Infinity'
4500 >>> c.number_class(Decimal('NaN'))
4501 'NaN'
4502 >>> c.number_class(Decimal('-NaN'))
4503 'NaN'
4504 >>> c.number_class(Decimal('sNaN'))
4505 'sNaN'
4506 """
4507 return a.number_class(context=self)
4508
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004509 def plus(self, a):
4510 """Plus corresponds to unary prefix plus in Python.
4511
4512 The operation is evaluated using the same rules as add; the
4513 operation plus(a) is calculated as add('0', a) where the '0'
4514 has the same exponent as the operand.
4515
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004516 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004517 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004518 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004519 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004520 """
4521 return a.__pos__(context=self)
4522
4523 def power(self, a, b, modulo=None):
4524 """Raises a to the power of b, to modulo if given.
4525
Facundo Batista353750c2007-09-13 18:13:15 +00004526 With two arguments, compute a**b. If a is negative then b
4527 must be integral. The result will be inexact unless b is
4528 integral and the result is finite and can be expressed exactly
4529 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004530
Facundo Batista353750c2007-09-13 18:13:15 +00004531 With three arguments, compute (a**b) % modulo. For the
4532 three argument form, the following restrictions on the
4533 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004534
Facundo Batista353750c2007-09-13 18:13:15 +00004535 - all three arguments must be integral
4536 - b must be nonnegative
4537 - at least one of a or b must be nonzero
4538 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004539
Facundo Batista353750c2007-09-13 18:13:15 +00004540 The result of pow(a, b, modulo) is identical to the result
4541 that would be obtained by computing (a**b) % modulo with
4542 unbounded precision, but is computed more efficiently. It is
4543 always exact.
4544
4545 >>> c = ExtendedContext.copy()
4546 >>> c.Emin = -999
4547 >>> c.Emax = 999
4548 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004549 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004550 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004551 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004552 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004553 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004554 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004555 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004556 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004557 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004558 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004559 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004560 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004561 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004562 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004563 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004564 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004565 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004566 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004567 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004568 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004569 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004570 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004571 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004572 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004573 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004574
4575 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004576 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004577 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004578 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00004579 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004580 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004581 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004582 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004583 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004584 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00004585 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004586 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004587 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004588 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004589 """
4590 return a.__pow__(b, modulo, context=self)
4591
4592 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00004593 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004594
4595 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00004596 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004597 exponent is being increased), multiplied by a positive power of ten (if
4598 the exponent is being decreased), or is unchanged (if the exponent is
4599 already equal to that of the right-hand operand).
4600
4601 Unlike other operations, if the length of the coefficient after the
4602 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00004603 operation condition is raised. This guarantees that, unless there is
4604 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004605 equal to that of the right-hand operand.
4606
4607 Also unlike other operations, quantize will never raise Underflow, even
4608 if the result is subnormal and inexact.
4609
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004610 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004611 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004612 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004613 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004614 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004615 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004616 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004617 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004618 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004619 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004620 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004621 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004622 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004623 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004624 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004625 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004626 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004627 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004628 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004629 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004630 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004631 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004632 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004633 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004634 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004635 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004636 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004637 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004638 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004639 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004640 """
4641 return a.quantize(b, context=self)
4642
Facundo Batista353750c2007-09-13 18:13:15 +00004643 def radix(self):
4644 """Just returns 10, as this is Decimal, :)
4645
4646 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00004647 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004648 """
4649 return Decimal(10)
4650
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004651 def remainder(self, a, b):
4652 """Returns the remainder from integer division.
4653
4654 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00004655 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00004656 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00004657 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004658
4659 This operation will fail under the same conditions as integer division
4660 (that is, if integer division on the same two operands would fail, the
4661 remainder cannot be calculated).
4662
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004663 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004664 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004665 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004666 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004667 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004668 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004669 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004670 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004671 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004672 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004673 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004674 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004675 """
4676 return a.__mod__(b, context=self)
4677
4678 def remainder_near(self, a, b):
4679 """Returns to be "a - b * n", where n is the integer nearest the exact
4680 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00004681 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004682 sign of a.
4683
4684 This operation will fail under the same conditions as integer division
4685 (that is, if integer division on the same two operands would fail, the
4686 remainder cannot be calculated).
4687
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004688 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004689 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004690 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004691 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004692 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004693 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004694 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004695 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004696 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004697 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004698 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004699 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004700 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004701 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004702 """
4703 return a.remainder_near(b, context=self)
4704
Facundo Batista353750c2007-09-13 18:13:15 +00004705 def rotate(self, a, b):
4706 """Returns a rotated copy of a, b times.
4707
4708 The coefficient of the result is a rotated copy of the digits in
4709 the coefficient of the first operand. The number of places of
4710 rotation is taken from the absolute value of the second operand,
4711 with the rotation being to the left if the second operand is
4712 positive or to the right otherwise.
4713
4714 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004715 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00004716 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004717 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00004718 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004719 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004720 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004721 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004722 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004723 Decimal('345678912')
Facundo Batista353750c2007-09-13 18:13:15 +00004724 """
4725 return a.rotate(b, context=self)
4726
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004727 def same_quantum(self, a, b):
4728 """Returns True if the two operands have the same exponent.
4729
4730 The result is never affected by either the sign or the coefficient of
4731 either operand.
4732
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004733 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004734 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004735 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004736 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004737 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004738 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004739 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004740 True
4741 """
4742 return a.same_quantum(b)
4743
Facundo Batista353750c2007-09-13 18:13:15 +00004744 def scaleb (self, a, b):
4745 """Returns the first operand after adding the second value its exp.
4746
4747 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004748 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00004749 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004750 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004751 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004752 Decimal('7.50E+3')
Facundo Batista353750c2007-09-13 18:13:15 +00004753 """
4754 return a.scaleb (b, context=self)
4755
4756 def shift(self, a, b):
4757 """Returns a shifted copy of a, b times.
4758
4759 The coefficient of the result is a shifted copy of the digits
4760 in the coefficient of the first operand. The number of places
4761 to shift is taken from the absolute value of the second operand,
4762 with the shift being to the left if the second operand is
4763 positive or to the right otherwise. Digits shifted into the
4764 coefficient are zeros.
4765
4766 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004767 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004768 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004769 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004770 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004771 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004772 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004773 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004774 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004775 Decimal('345678900')
Facundo Batista353750c2007-09-13 18:13:15 +00004776 """
4777 return a.shift(b, context=self)
4778
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004779 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00004780 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004781
4782 If the result must be inexact, it is rounded using the round-half-even
4783 algorithm.
4784
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004785 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004786 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004787 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004788 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004789 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004790 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004791 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004792 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004793 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004794 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004795 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004796 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004797 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004798 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004799 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004800 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004801 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004802 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004803 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00004804 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004805 """
4806 return a.sqrt(context=self)
4807
4808 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00004809 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004810
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004811 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004812 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004813 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004814 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004815 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004816 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004817 """
4818 return a.__sub__(b, context=self)
4819
4820 def to_eng_string(self, a):
4821 """Converts a number to a string, using scientific notation.
4822
4823 The operation is not affected by the context.
4824 """
4825 return a.to_eng_string(context=self)
4826
4827 def to_sci_string(self, a):
4828 """Converts a number to a string, using scientific notation.
4829
4830 The operation is not affected by the context.
4831 """
4832 return a.__str__(context=self)
4833
Facundo Batista353750c2007-09-13 18:13:15 +00004834 def to_integral_exact(self, a):
4835 """Rounds to an integer.
4836
4837 When the operand has a negative exponent, the result is the same
4838 as using the quantize() operation using the given operand as the
4839 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4840 of the operand as the precision setting; Inexact and Rounded flags
4841 are allowed in this operation. The rounding mode is taken from the
4842 context.
4843
4844 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004845 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004846 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004847 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004848 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004849 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004850 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004851 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004852 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004853 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004854 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004855 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004856 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004857 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004858 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004859 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004860 """
4861 return a.to_integral_exact(context=self)
4862
4863 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004864 """Rounds to an integer.
4865
4866 When the operand has a negative exponent, the result is the same
4867 as using the quantize() operation using the given operand as the
4868 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4869 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00004870 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004871
Facundo Batista353750c2007-09-13 18:13:15 +00004872 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004873 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004874 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004875 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004876 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004877 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004878 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004879 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004880 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004881 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004882 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004883 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004884 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004885 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004886 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004887 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004888 """
Facundo Batista353750c2007-09-13 18:13:15 +00004889 return a.to_integral_value(context=self)
4890
4891 # the method name changed, but we provide also the old one, for compatibility
4892 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004893
4894class _WorkRep(object):
4895 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00004896 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004897 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004898 # exp: None, int, or string
4899
4900 def __init__(self, value=None):
4901 if value is None:
4902 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004903 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004904 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00004905 elif isinstance(value, Decimal):
4906 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00004907 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004908 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00004909 else:
4910 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004911 self.sign = value[0]
4912 self.int = value[1]
4913 self.exp = value[2]
4914
4915 def __repr__(self):
4916 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
4917
4918 __str__ = __repr__
4919
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004920
4921
Facundo Batistae64acfa2007-12-17 14:18:42 +00004922def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004923 """Normalizes op1, op2 to have the same exp and length of coefficient.
4924
4925 Done during addition.
4926 """
Facundo Batista353750c2007-09-13 18:13:15 +00004927 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004928 tmp = op2
4929 other = op1
4930 else:
4931 tmp = op1
4932 other = op2
4933
Facundo Batista353750c2007-09-13 18:13:15 +00004934 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
4935 # Then adding 10**exp to tmp has the same effect (after rounding)
4936 # as adding any positive quantity smaller than 10**exp; similarly
4937 # for subtraction. So if other is smaller than 10**exp we replace
4938 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00004939 tmp_len = len(str(tmp.int))
4940 other_len = len(str(other.int))
4941 exp = tmp.exp + min(-1, tmp_len - prec - 2)
4942 if other_len + other.exp - 1 < exp:
4943 other.int = 1
4944 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004945
Facundo Batista353750c2007-09-13 18:13:15 +00004946 tmp.int *= 10 ** (tmp.exp - other.exp)
4947 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004948 return op1, op2
4949
Facundo Batista353750c2007-09-13 18:13:15 +00004950##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
4951
4952# This function from Tim Peters was taken from here:
4953# http://mail.python.org/pipermail/python-list/1999-July/007758.html
4954# The correction being in the function definition is for speed, and
4955# the whole function is not resolved with math.log because of avoiding
4956# the use of floats.
4957def _nbits(n, correction = {
4958 '0': 4, '1': 3, '2': 2, '3': 2,
4959 '4': 1, '5': 1, '6': 1, '7': 1,
4960 '8': 0, '9': 0, 'a': 0, 'b': 0,
4961 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
4962 """Number of bits in binary representation of the positive integer n,
4963 or 0 if n == 0.
4964 """
4965 if n < 0:
4966 raise ValueError("The argument to _nbits should be nonnegative.")
4967 hex_n = "%x" % n
4968 return 4*len(hex_n) - correction[hex_n[0]]
4969
4970def _sqrt_nearest(n, a):
4971 """Closest integer to the square root of the positive integer n. a is
4972 an initial approximation to the square root. Any positive integer
4973 will do for a, but the closer a is to the square root of n the
4974 faster convergence will be.
4975
4976 """
4977 if n <= 0 or a <= 0:
4978 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
4979
4980 b=0
4981 while a != b:
4982 b, a = a, a--n//a>>1
4983 return a
4984
4985def _rshift_nearest(x, shift):
4986 """Given an integer x and a nonnegative integer shift, return closest
4987 integer to x / 2**shift; use round-to-even in case of a tie.
4988
4989 """
4990 b, q = 1L << shift, x >> shift
4991 return q + (2*(x & (b-1)) + (q&1) > b)
4992
4993def _div_nearest(a, b):
4994 """Closest integer to a/b, a and b positive integers; rounds to even
4995 in the case of a tie.
4996
4997 """
4998 q, r = divmod(a, b)
4999 return q + (2*r + (q&1) > b)
5000
5001def _ilog(x, M, L = 8):
5002 """Integer approximation to M*log(x/M), with absolute error boundable
5003 in terms only of x/M.
5004
5005 Given positive integers x and M, return an integer approximation to
5006 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5007 between the approximation and the exact result is at most 22. For
5008 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5009 both cases these are upper bounds on the error; it will usually be
5010 much smaller."""
5011
5012 # The basic algorithm is the following: let log1p be the function
5013 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5014 # the reduction
5015 #
5016 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5017 #
5018 # repeatedly until the argument to log1p is small (< 2**-L in
5019 # absolute value). For small y we can use the Taylor series
5020 # expansion
5021 #
5022 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5023 #
5024 # truncating at T such that y**T is small enough. The whole
5025 # computation is carried out in a form of fixed-point arithmetic,
5026 # with a real number z being represented by an integer
5027 # approximation to z*M. To avoid loss of precision, the y below
5028 # is actually an integer approximation to 2**R*y*M, where R is the
5029 # number of reductions performed so far.
5030
5031 y = x-M
5032 # argument reduction; R = number of reductions performed
5033 R = 0
5034 while (R <= L and long(abs(y)) << L-R >= M or
5035 R > L and abs(y) >> R-L >= M):
5036 y = _div_nearest(long(M*y) << 1,
5037 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5038 R += 1
5039
5040 # Taylor series with T terms
5041 T = -int(-10*len(str(M))//(3*L))
5042 yshift = _rshift_nearest(y, R)
5043 w = _div_nearest(M, T)
5044 for k in xrange(T-1, 0, -1):
5045 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5046
5047 return _div_nearest(w*y, M)
5048
5049def _dlog10(c, e, p):
5050 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5051 approximation to 10**p * log10(c*10**e), with an absolute error of
5052 at most 1. Assumes that c*10**e is not exactly 1."""
5053
5054 # increase precision by 2; compensate for this by dividing
5055 # final result by 100
5056 p += 2
5057
5058 # write c*10**e as d*10**f with either:
5059 # f >= 0 and 1 <= d <= 10, or
5060 # f <= 0 and 0.1 <= d <= 1.
5061 # Thus for c*10**e close to 1, f = 0
5062 l = len(str(c))
5063 f = e+l - (e+l >= 1)
5064
5065 if p > 0:
5066 M = 10**p
5067 k = e+p-f
5068 if k >= 0:
5069 c *= 10**k
5070 else:
5071 c = _div_nearest(c, 10**-k)
5072
5073 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005074 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005075 log_d = _div_nearest(log_d*M, log_10)
5076 log_tenpower = f*M # exact
5077 else:
5078 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005079 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005080
5081 return _div_nearest(log_tenpower+log_d, 100)
5082
5083def _dlog(c, e, p):
5084 """Given integers c, e and p with c > 0, compute an integer
5085 approximation to 10**p * log(c*10**e), with an absolute error of
5086 at most 1. Assumes that c*10**e is not exactly 1."""
5087
5088 # Increase precision by 2. The precision increase is compensated
5089 # for at the end with a division by 100.
5090 p += 2
5091
5092 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5093 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5094 # as 10**p * log(d) + 10**p*f * log(10).
5095 l = len(str(c))
5096 f = e+l - (e+l >= 1)
5097
5098 # compute approximation to 10**p*log(d), with error < 27
5099 if p > 0:
5100 k = e+p-f
5101 if k >= 0:
5102 c *= 10**k
5103 else:
5104 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5105
5106 # _ilog magnifies existing error in c by a factor of at most 10
5107 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5108 else:
5109 # p <= 0: just approximate the whole thing by 0; error < 2.31
5110 log_d = 0
5111
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005112 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005113 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005114 extra = len(str(abs(f)))-1
5115 if p + extra >= 0:
5116 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5117 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5118 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005119 else:
5120 f_log_ten = 0
5121 else:
5122 f_log_ten = 0
5123
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005124 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005125 return _div_nearest(f_log_ten + log_d, 100)
5126
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005127class _Log10Memoize(object):
5128 """Class to compute, store, and allow retrieval of, digits of the
5129 constant log(10) = 2.302585.... This constant is needed by
5130 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5131 def __init__(self):
5132 self.digits = "23025850929940456840179914546843642076011014886"
5133
5134 def getdigits(self, p):
5135 """Given an integer p >= 0, return floor(10**p)*log(10).
5136
5137 For example, self.getdigits(3) returns 2302.
5138 """
5139 # digits are stored as a string, for quick conversion to
5140 # integer in the case that we've already computed enough
5141 # digits; the stored digits should always be correct
5142 # (truncated, not rounded to nearest).
5143 if p < 0:
5144 raise ValueError("p should be nonnegative")
5145
5146 if p >= len(self.digits):
5147 # compute p+3, p+6, p+9, ... digits; continue until at
5148 # least one of the extra digits is nonzero
5149 extra = 3
5150 while True:
5151 # compute p+extra digits, correct to within 1ulp
5152 M = 10**(p+extra+2)
5153 digits = str(_div_nearest(_ilog(10*M, M), 100))
5154 if digits[-extra:] != '0'*extra:
5155 break
5156 extra += 3
5157 # keep all reliable digits so far; remove trailing zeros
5158 # and next nonzero digit
5159 self.digits = digits.rstrip('0')[:-1]
5160 return int(self.digits[:p+1])
5161
5162_log10_digits = _Log10Memoize().getdigits
5163
Facundo Batista353750c2007-09-13 18:13:15 +00005164def _iexp(x, M, L=8):
5165 """Given integers x and M, M > 0, such that x/M is small in absolute
5166 value, compute an integer approximation to M*exp(x/M). For 0 <=
5167 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5168 is usually much smaller)."""
5169
5170 # Algorithm: to compute exp(z) for a real number z, first divide z
5171 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5172 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5173 # series
5174 #
5175 # expm1(x) = x + x**2/2! + x**3/3! + ...
5176 #
5177 # Now use the identity
5178 #
5179 # expm1(2x) = expm1(x)*(expm1(x)+2)
5180 #
5181 # R times to compute the sequence expm1(z/2**R),
5182 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5183
5184 # Find R such that x/2**R/M <= 2**-L
5185 R = _nbits((long(x)<<L)//M)
5186
5187 # Taylor series. (2**L)**T > M
5188 T = -int(-10*len(str(M))//(3*L))
5189 y = _div_nearest(x, T)
5190 Mshift = long(M)<<R
5191 for i in xrange(T-1, 0, -1):
5192 y = _div_nearest(x*(Mshift + y), Mshift * i)
5193
5194 # Expansion
5195 for k in xrange(R-1, -1, -1):
5196 Mshift = long(M)<<(k+2)
5197 y = _div_nearest(y*(y+Mshift), Mshift)
5198
5199 return M+y
5200
5201def _dexp(c, e, p):
5202 """Compute an approximation to exp(c*10**e), with p decimal places of
5203 precision.
5204
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005205 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005206
5207 10**(p-1) <= d <= 10**p, and
5208 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5209
5210 In other words, d*10**f is an approximation to exp(c*10**e) with p
5211 digits of precision, and with an error in d of at most 1. This is
5212 almost, but not quite, the same as the error being < 1ulp: when d
5213 = 10**(p-1) the error could be up to 10 ulp."""
5214
5215 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5216 p += 2
5217
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005218 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005219 extra = max(0, e + len(str(c)) - 1)
5220 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005221
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005222 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005223 # rounding down
5224 shift = e+q
5225 if shift >= 0:
5226 cshift = c*10**shift
5227 else:
5228 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005229 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005230
5231 # reduce remainder back to original precision
5232 rem = _div_nearest(rem, 10**extra)
5233
5234 # error in result of _iexp < 120; error after division < 0.62
5235 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5236
5237def _dpower(xc, xe, yc, ye, p):
5238 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5239 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5240
5241 10**(p-1) <= c <= 10**p, and
5242 (c-1)*10**e < x**y < (c+1)*10**e
5243
5244 in other words, c*10**e is an approximation to x**y with p digits
5245 of precision, and with an error in c of at most 1. (This is
5246 almost, but not quite, the same as the error being < 1ulp: when c
5247 == 10**(p-1) we can only guarantee error < 10ulp.)
5248
5249 We assume that: x is positive and not equal to 1, and y is nonzero.
5250 """
5251
5252 # Find b such that 10**(b-1) <= |y| <= 10**b
5253 b = len(str(abs(yc))) + ye
5254
5255 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5256 lxc = _dlog(xc, xe, p+b+1)
5257
5258 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5259 shift = ye-b
5260 if shift >= 0:
5261 pc = lxc*yc*10**shift
5262 else:
5263 pc = _div_nearest(lxc*yc, 10**-shift)
5264
5265 if pc == 0:
5266 # we prefer a result that isn't exactly 1; this makes it
5267 # easier to compute a correctly rounded result in __pow__
5268 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5269 coeff, exp = 10**(p-1)+1, 1-p
5270 else:
5271 coeff, exp = 10**p-1, -p
5272 else:
5273 coeff, exp = _dexp(pc, -(p+1), p+1)
5274 coeff = _div_nearest(coeff, 10)
5275 exp += 1
5276
5277 return coeff, exp
5278
5279def _log10_lb(c, correction = {
5280 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5281 '6': 23, '7': 16, '8': 10, '9': 5}):
5282 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5283 if c <= 0:
5284 raise ValueError("The argument to _log10_lb should be nonnegative.")
5285 str_c = str(c)
5286 return 100*len(str_c) - correction[str_c[0]]
5287
Facundo Batista59c58842007-04-10 12:58:45 +00005288##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005289
Facundo Batista353750c2007-09-13 18:13:15 +00005290def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005291 """Convert other to Decimal.
5292
5293 Verifies that it's ok to use in an implicit construction.
5294 """
5295 if isinstance(other, Decimal):
5296 return other
5297 if isinstance(other, (int, long)):
5298 return Decimal(other)
Facundo Batista353750c2007-09-13 18:13:15 +00005299 if raiseit:
5300 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005301 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005302
Facundo Batista59c58842007-04-10 12:58:45 +00005303##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005304
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005305# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005306# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005307
5308DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005309 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005310 traps=[DivisionByZero, Overflow, InvalidOperation],
5311 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005312 Emax=999999999,
5313 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005314 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005315)
5316
5317# Pre-made alternate contexts offered by the specification
5318# Don't change these; the user should be able to select these
5319# contexts and be able to reproduce results from other implementations
5320# of the spec.
5321
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005322BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005323 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005324 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5325 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005326)
5327
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005328ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005329 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005330 traps=[],
5331 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005332)
5333
5334
Facundo Batista72bc54f2007-11-23 17:59:00 +00005335##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005336#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005337# Regular expression used for parsing numeric strings. Additional
5338# comments:
5339#
5340# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5341# whitespace. But note that the specification disallows whitespace in
5342# a numeric string.
5343#
5344# 2. For finite numbers (not infinities and NaNs) the body of the
5345# number between the optional sign and the optional exponent must have
5346# at least one decimal digit, possibly after the decimal point. The
5347# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005348
5349import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005350_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005351# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005352 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005353 (
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005354 (?=\d|\.\d) # ...a number (with at least one digit)
5355 (?P<int>\d*) # having a (possibly empty) integer part
5356 (\.(?P<frac>\d*))? # followed by an optional fractional part
5357 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005358 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005359 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005360 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005361 (?P<signal>s)? # ...an (optionally signaling)
5362 NaN # NaN
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005363 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005364 )
5365# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005366 \Z
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005367""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005368
Facundo Batista2ec74152007-12-03 17:55:00 +00005369_all_zeros = re.compile('0*$').match
5370_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005371
5372##### PEP3101 support functions ##############################################
5373# The functions parse_format_specifier and format_align have little to do
5374# with the Decimal class, and could potentially be reused for other pure
5375# Python numeric classes that want to implement __format__
5376#
5377# A format specifier for Decimal looks like:
5378#
5379# [[fill]align][sign][0][minimumwidth][.precision][type]
5380#
5381
5382_parse_format_specifier_regex = re.compile(r"""\A
5383(?:
5384 (?P<fill>.)?
5385 (?P<align>[<>=^])
5386)?
5387(?P<sign>[-+ ])?
5388(?P<zeropad>0)?
5389(?P<minimumwidth>(?!0)\d+)?
5390(?:\.(?P<precision>0|(?!0)\d+))?
5391(?P<type>[eEfFgG%])?
5392\Z
5393""", re.VERBOSE)
5394
Facundo Batista72bc54f2007-11-23 17:59:00 +00005395del re
5396
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005397def _parse_format_specifier(format_spec):
5398 """Parse and validate a format specifier.
5399
5400 Turns a standard numeric format specifier into a dict, with the
5401 following entries:
5402
5403 fill: fill character to pad field to minimum width
5404 align: alignment type, either '<', '>', '=' or '^'
5405 sign: either '+', '-' or ' '
5406 minimumwidth: nonnegative integer giving minimum width
5407 precision: nonnegative integer giving precision, or None
5408 type: one of the characters 'eEfFgG%', or None
5409 unicode: either True or False (always True for Python 3.x)
5410
5411 """
5412 m = _parse_format_specifier_regex.match(format_spec)
5413 if m is None:
5414 raise ValueError("Invalid format specifier: " + format_spec)
5415
5416 # get the dictionary
5417 format_dict = m.groupdict()
5418
5419 # defaults for fill and alignment
5420 fill = format_dict['fill']
5421 align = format_dict['align']
5422 if format_dict.pop('zeropad') is not None:
5423 # in the face of conflict, refuse the temptation to guess
5424 if fill is not None and fill != '0':
5425 raise ValueError("Fill character conflicts with '0'"
5426 " in format specifier: " + format_spec)
5427 if align is not None and align != '=':
5428 raise ValueError("Alignment conflicts with '0' in "
5429 "format specifier: " + format_spec)
5430 fill = '0'
5431 align = '='
5432 format_dict['fill'] = fill or ' '
5433 format_dict['align'] = align or '<'
5434
5435 if format_dict['sign'] is None:
5436 format_dict['sign'] = '-'
5437
5438 # turn minimumwidth and precision entries into integers.
5439 # minimumwidth defaults to 0; precision remains None if not given
5440 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5441 if format_dict['precision'] is not None:
5442 format_dict['precision'] = int(format_dict['precision'])
5443
5444 # if format type is 'g' or 'G' then a precision of 0 makes little
5445 # sense; convert it to 1. Same if format type is unspecified.
5446 if format_dict['precision'] == 0:
5447 if format_dict['type'] in 'gG' or format_dict['type'] is None:
5448 format_dict['precision'] = 1
5449
5450 # record whether return type should be str or unicode
5451 format_dict['unicode'] = isinstance(format_spec, unicode)
5452
5453 return format_dict
5454
5455def _format_align(body, spec_dict):
5456 """Given an unpadded, non-aligned numeric string, add padding and
5457 aligment to conform with the given format specifier dictionary (as
5458 output from parse_format_specifier).
5459
5460 It's assumed that if body is negative then it starts with '-'.
5461 Any leading sign ('-' or '+') is stripped from the body before
5462 applying the alignment and padding rules, and replaced in the
5463 appropriate position.
5464
5465 """
5466 # figure out the sign; we only examine the first character, so if
5467 # body has leading whitespace the results may be surprising.
5468 if len(body) > 0 and body[0] in '-+':
5469 sign = body[0]
5470 body = body[1:]
5471 else:
5472 sign = ''
5473
5474 if sign != '-':
5475 if spec_dict['sign'] in ' +':
5476 sign = spec_dict['sign']
5477 else:
5478 sign = ''
5479
5480 # how much extra space do we have to play with?
5481 minimumwidth = spec_dict['minimumwidth']
5482 fill = spec_dict['fill']
5483 padding = fill*(max(minimumwidth - (len(sign+body)), 0))
5484
5485 align = spec_dict['align']
5486 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005487 result = sign + body + padding
Mark Dickinson71416822009-03-17 18:07:41 +00005488 elif align == '>':
5489 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005490 elif align == '=':
5491 result = sign + padding + body
5492 else: #align == '^'
5493 half = len(padding)//2
5494 result = padding[:half] + sign + body + padding[half:]
5495
5496 # make sure that result is unicode if necessary
5497 if spec_dict['unicode']:
5498 result = unicode(result)
5499
5500 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00005501
Facundo Batista59c58842007-04-10 12:58:45 +00005502##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005503
Facundo Batista59c58842007-04-10 12:58:45 +00005504# Reusable defaults
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005505_Infinity = Decimal('Inf')
5506_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonfd6032d2009-01-02 23:16:51 +00005507_NaN = Decimal('NaN')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005508_Zero = Decimal(0)
5509_One = Decimal(1)
5510_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005511
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005512# _SignedInfinity[sign] is infinity w/ that sign
5513_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005514
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005515
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005516
5517if __name__ == '__main__':
5518 import doctest, sys
5519 doctest.testmod(sys.modules[__name__])