blob: 43244308c0a7248f3e16f9d55e3c741829f70834 [file] [log] [blame]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001# Copyright (c) 2004 Python Software Foundation.
2# All rights reserved.
3
4# Written by Eric Price <eprice at tjhsst.edu>
5# and Facundo Batista <facundo at taniquetil.com.ar>
6# and Raymond Hettinger <python at rcn.com>
Fred Drake1f34eb12004-07-01 14:28:36 +00007# and Aahz <aahz at pobox.com>
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00008# and Tim Peters
9
Raymond Hettinger27dbcf22004-08-19 22:39:55 +000010# This module is currently Py2.3 compatible and should be kept that way
11# unless a major compelling advantage arises. IOW, 2.3 compatibility is
12# strongly preferred, but not guaranteed.
13
14# Also, this module should be kept in sync with the latest updates of
15# the IBM specification as it evolves. Those updates will be treated
16# as bug fixes (deviation from the spec is a compatibility, usability
17# bug) and will be backported. At this point the spec is stabilizing
18# and the updates are becoming fewer, smaller, and less significant.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000019
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000020"""
21This is a Py2.3 implementation of decimal floating point arithmetic based on
22the General Decimal Arithmetic Specification:
23
24 www2.hursley.ibm.com/decimal/decarith.html
25
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000026and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000027
28 www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html
29
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030Decimal floating point has finite precision with arbitrarily large bounds.
31
Facundo Batista59c58842007-04-10 12:58:45 +000032The purpose of this module is to support arithmetic using familiar
33"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000034issues associated with binary floating point. The package is especially
35useful for financial applications or for contexts where users have
36expectations that are at odds with binary floating point (for instance,
37in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Raymond Hettingerabe32372008-02-14 02:41:22 +000038of the expected Decimal('0.00') returned by decimal floating point).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000039
40Here are some examples of using the decimal module:
41
42>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000043>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000044>>> Decimal(0)
Raymond Hettingerabe32372008-02-14 02:41:22 +000045Decimal('0')
46>>> Decimal('1')
47Decimal('1')
48>>> Decimal('-.0123')
49Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000050>>> Decimal(123456)
Raymond Hettingerabe32372008-02-14 02:41:22 +000051Decimal('123456')
52>>> Decimal('123.45e12345678901234567890')
53Decimal('1.2345E+12345678901234567892')
54>>> Decimal('1.33') + Decimal('1.27')
55Decimal('2.60')
56>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
57Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000058>>> dig = Decimal(1)
59>>> print dig / Decimal(3)
600.333333333
61>>> getcontext().prec = 18
62>>> print dig / Decimal(3)
630.333333333333333333
64>>> print dig.sqrt()
651
66>>> print Decimal(3).sqrt()
671.73205080756887729
68>>> print Decimal(3) ** 123
694.85192780976896427E+58
70>>> inf = Decimal(1) / Decimal(0)
71>>> print inf
72Infinity
73>>> neginf = Decimal(-1) / Decimal(0)
74>>> print neginf
75-Infinity
76>>> print neginf + inf
77NaN
78>>> print neginf * inf
79-Infinity
80>>> print dig / 0
81Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000082>>> getcontext().traps[DivisionByZero] = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000083>>> print dig / 0
84Traceback (most recent call last):
85 ...
86 ...
87 ...
88DivisionByZero: x / 0
89>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000090>>> c.traps[InvalidOperation] = 0
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000091>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
93>>> c.divide(Decimal(0), Decimal(0))
Raymond Hettingerabe32372008-02-14 02:41:22 +000094Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000095>>> c.traps[InvalidOperation] = 1
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000096>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000971
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000098>>> c.flags[InvalidOperation] = 0
99>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000
101>>> print c.divide(Decimal(0), Decimal(0))
102Traceback (most recent call last):
103 ...
104 ...
105 ...
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000106InvalidOperation: 0 / 0
107>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001081
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000109>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000110>>> c.traps[InvalidOperation] = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000111>>> print c.divide(Decimal(0), Decimal(0))
112NaN
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000113>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001141
115>>>
116"""
117
118__all__ = [
119 # Two major classes
120 'Decimal', 'Context',
121
122 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000123 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000124
125 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000126 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
127 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000128
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000129 # Constants for use in setting up contexts
130 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Facundo Batista353750c2007-09-13 18:13:15 +0000131 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000132
133 # Functions for manipulating contexts
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000134 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000135]
136
Raymond Hettingereb260842005-06-07 18:52:34 +0000137import copy as _copy
Raymond Hettinger45fd4762009-02-03 03:42:07 +0000138import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000139
Raymond Hettinger097a1902008-01-11 02:24:13 +0000140try:
141 from collections import namedtuple as _namedtuple
142 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
143except ImportError:
144 DecimalTuple = lambda *args: args
145
Facundo Batista59c58842007-04-10 12:58:45 +0000146# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000147ROUND_DOWN = 'ROUND_DOWN'
148ROUND_HALF_UP = 'ROUND_HALF_UP'
149ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
150ROUND_CEILING = 'ROUND_CEILING'
151ROUND_FLOOR = 'ROUND_FLOOR'
152ROUND_UP = 'ROUND_UP'
153ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Facundo Batista353750c2007-09-13 18:13:15 +0000154ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000155
Facundo Batista59c58842007-04-10 12:58:45 +0000156# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000157
158class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000159 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000160
161 Used exceptions derive from this.
162 If an exception derives from another exception besides this (such as
163 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
164 called if the others are present. This isn't actually used for
165 anything, though.
166
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000167 handle -- Called when context._raise_error is called and the
168 trap_enabler is set. First argument is self, second is the
169 context. More arguments can be given, those being after
170 the explanation in _raise_error (For example,
171 context._raise_error(NewError, '(-x)!', self._sign) would
172 call NewError().handle(context, self._sign).)
173
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000174 To define a new exception, it should be sufficient to have it derive
175 from DecimalException.
176 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000177 def handle(self, context, *args):
178 pass
179
180
181class Clamped(DecimalException):
182 """Exponent of a 0 changed to fit bounds.
183
184 This occurs and signals clamped if the exponent of a result has been
185 altered in order to fit the constraints of a specific concrete
Facundo Batista59c58842007-04-10 12:58:45 +0000186 representation. This may occur when the exponent of a zero result would
187 be outside the bounds of a representation, or when a large normal
188 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000189 this latter case, the exponent is reduced to fit and the corresponding
190 number of zero digits are appended to the coefficient ("fold-down").
191 """
192
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000193class InvalidOperation(DecimalException):
194 """An invalid operation was performed.
195
196 Various bad things cause this:
197
198 Something creates a signaling NaN
199 -INF + INF
Facundo Batista59c58842007-04-10 12:58:45 +0000200 0 * (+-)INF
201 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000202 x % 0
203 (+-)INF % x
204 x._rescale( non-integer )
205 sqrt(-x) , x > 0
206 0 ** 0
207 x ** (non-integer)
208 x ** (+-)INF
209 An operand is invalid
Facundo Batista353750c2007-09-13 18:13:15 +0000210
211 The result of the operation after these is a quiet positive NaN,
212 except when the cause is a signaling NaN, in which case the result is
213 also a quiet NaN, but with the original sign, and an optional
214 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000215 """
216 def handle(self, context, *args):
217 if args:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000218 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
219 return ans._fix_nan(context)
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000220 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000221
222class ConversionSyntax(InvalidOperation):
223 """Trying to convert badly formed string.
224
225 This occurs and signals invalid-operation if an string is being
226 converted to a number and it does not conform to the numeric string
Facundo Batista59c58842007-04-10 12:58:45 +0000227 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000228 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000229 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000230 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000231
232class DivisionByZero(DecimalException, ZeroDivisionError):
233 """Division by 0.
234
235 This occurs and signals division-by-zero if division of a finite number
236 by zero was attempted (during a divide-integer or divide operation, or a
237 power operation with negative right-hand operand), and the dividend was
238 not zero.
239
240 The result of the operation is [sign,inf], where sign is the exclusive
241 or of the signs of the operands for divide, or is 1 for an odd power of
242 -0, for power.
243 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000244
Facundo Batistacce8df22007-09-18 16:53:18 +0000245 def handle(self, context, sign, *args):
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000246 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000247
248class DivisionImpossible(InvalidOperation):
249 """Cannot perform the division adequately.
250
251 This occurs and signals invalid-operation if the integer result of a
252 divide-integer or remainder operation had too many digits (would be
Facundo Batista59c58842007-04-10 12:58:45 +0000253 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000254 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000255
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000256 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000257 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000258
259class DivisionUndefined(InvalidOperation, ZeroDivisionError):
260 """Undefined result of division.
261
262 This occurs and signals invalid-operation if division by zero was
263 attempted (during a divide-integer, divide, or remainder operation), and
Facundo Batista59c58842007-04-10 12:58:45 +0000264 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000265 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000266
Facundo Batistacce8df22007-09-18 16:53:18 +0000267 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000268 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000269
270class Inexact(DecimalException):
271 """Had to round, losing information.
272
273 This occurs and signals inexact whenever the result of an operation is
274 not exact (that is, it needed to be rounded and any discarded digits
Facundo Batista59c58842007-04-10 12:58:45 +0000275 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000276 result in all cases is unchanged.
277
278 The inexact signal may be tested (or trapped) to determine if a given
279 operation (or sequence of operations) was inexact.
280 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000281
282class InvalidContext(InvalidOperation):
283 """Invalid context. Unknown rounding, for example.
284
285 This occurs and signals invalid-operation if an invalid context was
Facundo Batista59c58842007-04-10 12:58:45 +0000286 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000287 on creation and either the precision exceeds the capability of the
288 underlying concrete representation or an unknown or unsupported rounding
Facundo Batista59c58842007-04-10 12:58:45 +0000289 was specified. These aspects of the context need only be checked when
290 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000291 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000292
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000293 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000294 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000295
296class Rounded(DecimalException):
297 """Number got rounded (not necessarily changed during rounding).
298
299 This occurs and signals rounded whenever the result of an operation is
300 rounded (that is, some zero or non-zero digits were discarded from the
Facundo Batista59c58842007-04-10 12:58:45 +0000301 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000302 result in all cases is unchanged.
303
304 The rounded signal may be tested (or trapped) to determine if a given
305 operation (or sequence of operations) caused a loss of precision.
306 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000307
308class Subnormal(DecimalException):
309 """Exponent < Emin before rounding.
310
311 This occurs and signals subnormal whenever the result of a conversion or
312 operation is subnormal (that is, its adjusted exponent is less than
Facundo Batista59c58842007-04-10 12:58:45 +0000313 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000314
315 The subnormal signal may be tested (or trapped) to determine if a given
316 or operation (or sequence of operations) yielded a subnormal result.
317 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000318
319class Overflow(Inexact, Rounded):
320 """Numerical overflow.
321
322 This occurs and signals overflow if the adjusted exponent of a result
323 (from a conversion or from an operation that is not an attempt to divide
324 by zero), after rounding, would be greater than the largest value that
325 can be handled by the implementation (the value Emax).
326
327 The result depends on the rounding mode:
328
329 For round-half-up and round-half-even (and for round-half-down and
330 round-up, if implemented), the result of the operation is [sign,inf],
Facundo Batista59c58842007-04-10 12:58:45 +0000331 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000332 result is the largest finite number that can be represented in the
Facundo Batista59c58842007-04-10 12:58:45 +0000333 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000334 round-ceiling, the result is the same as for round-down if the sign of
Facundo Batista59c58842007-04-10 12:58:45 +0000335 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000336 the result is the same as for round-down if the sign of the intermediate
Facundo Batista59c58842007-04-10 12:58:45 +0000337 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000338 will also be raised.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000339 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000340
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000341 def handle(self, context, sign, *args):
342 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Facundo Batista353750c2007-09-13 18:13:15 +0000343 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000344 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000345 if sign == 0:
346 if context.rounding == ROUND_CEILING:
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000347 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000348 return _dec_from_triple(sign, '9'*context.prec,
349 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000350 if sign == 1:
351 if context.rounding == ROUND_FLOOR:
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000352 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000353 return _dec_from_triple(sign, '9'*context.prec,
354 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000355
356
357class Underflow(Inexact, Rounded, Subnormal):
358 """Numerical underflow with result rounded to 0.
359
360 This occurs and signals underflow if a result is inexact and the
361 adjusted exponent of the result would be smaller (more negative) than
362 the smallest value that can be handled by the implementation (the value
Facundo Batista59c58842007-04-10 12:58:45 +0000363 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000364
365 The result after an underflow will be a subnormal number rounded, if
Facundo Batista59c58842007-04-10 12:58:45 +0000366 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000367 in 0 with the sign of the intermediate result and an exponent of Etiny.
368
369 In all cases, Inexact, Rounded, and Subnormal will also be raised.
370 """
371
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000372# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000373_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000374 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000375
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000376# Map conditions (per the spec) to signals
377_condition_map = {ConversionSyntax:InvalidOperation,
378 DivisionImpossible:InvalidOperation,
379 DivisionUndefined:InvalidOperation,
380 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000381
Facundo Batista59c58842007-04-10 12:58:45 +0000382##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000383
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000384# The getcontext() and setcontext() function manage access to a thread-local
385# current context. Py2.4 offers direct support for thread locals. If that
386# is not available, use threading.currentThread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000387# work for older Pythons. If threads are not part of the build, create a
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000388# mock threading object with threading.local() returning the module namespace.
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000389
390try:
391 import threading
392except ImportError:
393 # Python was compiled without threads; create a mock object instead
394 import sys
Facundo Batista59c58842007-04-10 12:58:45 +0000395 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000396 def local(self, sys=sys):
397 return sys.modules[__name__]
398 threading = MockThreading()
399 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000400
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000401try:
402 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000403
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000404except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000405
Facundo Batista59c58842007-04-10 12:58:45 +0000406 # To fix reloading, force it to create a new context
407 # Old contexts have different exceptions in their dicts, making problems.
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000408 if hasattr(threading.currentThread(), '__decimal_context__'):
409 del threading.currentThread().__decimal_context__
410
411 def setcontext(context):
412 """Set this thread's context to context."""
413 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000414 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000415 context.clear_flags()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000416 threading.currentThread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000417
418 def getcontext():
419 """Returns this thread's context.
420
421 If this thread does not yet have a context, returns
422 a new context and sets this thread's context.
423 New contexts are copies of DefaultContext.
424 """
425 try:
426 return threading.currentThread().__decimal_context__
427 except AttributeError:
428 context = Context()
429 threading.currentThread().__decimal_context__ = context
430 return context
431
432else:
433
434 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000435 if hasattr(local, '__decimal_context__'):
436 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000437
438 def getcontext(_local=local):
439 """Returns this thread's context.
440
441 If this thread does not yet have a context, returns
442 a new context and sets this thread's context.
443 New contexts are copies of DefaultContext.
444 """
445 try:
446 return _local.__decimal_context__
447 except AttributeError:
448 context = Context()
449 _local.__decimal_context__ = context
450 return context
451
452 def setcontext(context, _local=local):
453 """Set this thread's context to context."""
454 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000455 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000456 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000457 _local.__decimal_context__ = context
458
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000459 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000460
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000461def localcontext(ctx=None):
462 """Return a context manager for a copy of the supplied context
463
464 Uses a copy of the current context if no context is specified
465 The returned context manager creates a local decimal context
466 in a with statement:
467 def sin(x):
468 with localcontext() as ctx:
469 ctx.prec += 2
470 # Rest of sin calculation algorithm
471 # uses a precision 2 greater than normal
Facundo Batista59c58842007-04-10 12:58:45 +0000472 return +s # Convert result to normal precision
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000473
474 def sin(x):
475 with localcontext(ExtendedContext):
476 # Rest of sin calculation algorithm
477 # uses the Extended Context from the
478 # General Decimal Arithmetic Specification
Facundo Batista59c58842007-04-10 12:58:45 +0000479 return +s # Convert result to normal context
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000480
Facundo Batistaee340e52008-05-02 17:39:00 +0000481 >>> setcontext(DefaultContext)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000482 >>> print getcontext().prec
483 28
484 >>> with localcontext():
485 ... ctx = getcontext()
Raymond Hettinger495df472007-02-08 01:42:35 +0000486 ... ctx.prec += 2
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000487 ... print ctx.prec
488 ...
489 30
490 >>> with localcontext(ExtendedContext):
491 ... print getcontext().prec
492 ...
493 9
494 >>> print getcontext().prec
495 28
496 """
Nick Coghlanced12182006-09-02 03:54:17 +0000497 if ctx is None: ctx = getcontext()
498 return _ContextManager(ctx)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000499
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000500
Facundo Batista59c58842007-04-10 12:58:45 +0000501##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000502
503class Decimal(object):
504 """Floating point class for decimal arithmetic."""
505
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000506 __slots__ = ('_exp','_int','_sign', '_is_special')
507 # Generally, the value of the Decimal instance is given by
508 # (-1)**_sign * _int * 10**_exp
509 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000510
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000511 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000512 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000513 """Create a decimal point instance.
514
515 >>> Decimal('3.14') # string input
Raymond Hettingerabe32372008-02-14 02:41:22 +0000516 Decimal('3.14')
Facundo Batista59c58842007-04-10 12:58:45 +0000517 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Raymond Hettingerabe32372008-02-14 02:41:22 +0000518 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000519 >>> Decimal(314) # int or long
Raymond Hettingerabe32372008-02-14 02:41:22 +0000520 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000521 >>> Decimal(Decimal(314)) # another decimal instance
Raymond Hettingerabe32372008-02-14 02:41:22 +0000522 Decimal('314')
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000523 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Raymond Hettingerabe32372008-02-14 02:41:22 +0000524 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000525 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000526
Facundo Batista72bc54f2007-11-23 17:59:00 +0000527 # Note that the coefficient, self._int, is actually stored as
528 # a string rather than as a tuple of digits. This speeds up
529 # the "digits to integer" and "integer to digits" conversions
530 # that are used in almost every arithmetic operation on
531 # Decimals. This is an internal detail: the as_tuple function
532 # and the Decimal constructor still deal with tuples of
533 # digits.
534
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000535 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000536
Facundo Batista0d157a02007-11-30 17:15:25 +0000537 # From a string
538 # REs insist on real strings, so we can too.
539 if isinstance(value, basestring):
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000540 m = _parser(value.strip())
Facundo Batista0d157a02007-11-30 17:15:25 +0000541 if m is None:
542 if context is None:
543 context = getcontext()
544 return context._raise_error(ConversionSyntax,
545 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000546
Facundo Batista0d157a02007-11-30 17:15:25 +0000547 if m.group('sign') == "-":
548 self._sign = 1
549 else:
550 self._sign = 0
551 intpart = m.group('int')
552 if intpart is not None:
553 # finite number
Mark Dickinson9a6e6452009-08-02 11:01:01 +0000554 fracpart = m.group('frac') or ''
Facundo Batista0d157a02007-11-30 17:15:25 +0000555 exp = int(m.group('exp') or '0')
Mark Dickinson9a6e6452009-08-02 11:01:01 +0000556 self._int = str(int(intpart+fracpart))
557 self._exp = exp - len(fracpart)
Facundo Batista0d157a02007-11-30 17:15:25 +0000558 self._is_special = False
559 else:
560 diag = m.group('diag')
561 if diag is not None:
562 # NaN
Mark Dickinson9a6e6452009-08-02 11:01:01 +0000563 self._int = str(int(diag or '0')).lstrip('0')
Facundo Batista0d157a02007-11-30 17:15:25 +0000564 if m.group('signal'):
565 self._exp = 'N'
566 else:
567 self._exp = 'n'
568 else:
569 # infinity
570 self._int = '0'
571 self._exp = 'F'
572 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000573 return self
574
575 # From an integer
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000576 if isinstance(value, (int,long)):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000577 if value >= 0:
578 self._sign = 0
579 else:
580 self._sign = 1
581 self._exp = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +0000582 self._int = str(abs(value))
Facundo Batista0d157a02007-11-30 17:15:25 +0000583 self._is_special = False
584 return self
585
586 # From another decimal
587 if isinstance(value, Decimal):
588 self._exp = value._exp
589 self._sign = value._sign
590 self._int = value._int
591 self._is_special = value._is_special
592 return self
593
594 # From an internal working value
595 if isinstance(value, _WorkRep):
596 self._sign = value.sign
597 self._int = str(value.int)
598 self._exp = int(value.exp)
599 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000600 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000601
602 # tuple/list conversion (possibly from as_tuple())
603 if isinstance(value, (list,tuple)):
604 if len(value) != 3:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000605 raise ValueError('Invalid tuple size in creation of Decimal '
606 'from list or tuple. The list or tuple '
607 'should have exactly three elements.')
608 # process sign. The isinstance test rejects floats
609 if not (isinstance(value[0], (int, long)) and value[0] in (0,1)):
610 raise ValueError("Invalid sign. The first value in the tuple "
611 "should be an integer; either 0 for a "
612 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000613 self._sign = value[0]
Facundo Batista9b5e2312007-10-19 19:25:57 +0000614 if value[2] == 'F':
615 # infinity: value[1] is ignored
Facundo Batista72bc54f2007-11-23 17:59:00 +0000616 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000617 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000618 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000619 else:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000620 # process and validate the digits in value[1]
621 digits = []
622 for digit in value[1]:
623 if isinstance(digit, (int, long)) and 0 <= digit <= 9:
624 # skip leading zeros
625 if digits or digit != 0:
626 digits.append(digit)
627 else:
628 raise ValueError("The second value in the tuple must "
629 "be composed of integers in the range "
630 "0 through 9.")
631 if value[2] in ('n', 'N'):
632 # NaN: digits form the diagnostic
Facundo Batista72bc54f2007-11-23 17:59:00 +0000633 self._int = ''.join(map(str, digits))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000634 self._exp = value[2]
635 self._is_special = True
636 elif isinstance(value[2], (int, long)):
637 # finite number: digits give the coefficient
Facundo Batista72bc54f2007-11-23 17:59:00 +0000638 self._int = ''.join(map(str, digits or [0]))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000639 self._exp = value[2]
640 self._is_special = False
641 else:
642 raise ValueError("The third value in the tuple must "
643 "be an integer, or one of the "
644 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000645 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000646
Raymond Hettingerbf440692004-07-10 14:14:37 +0000647 if isinstance(value, float):
648 raise TypeError("Cannot convert float to Decimal. " +
649 "First convert the float to a string")
650
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000651 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000652
653 def _isnan(self):
654 """Returns whether the number is not actually one.
655
656 0 if a number
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000657 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000658 2 if sNaN
659 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000660 if self._is_special:
661 exp = self._exp
662 if exp == 'n':
663 return 1
664 elif exp == 'N':
665 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000666 return 0
667
668 def _isinfinity(self):
669 """Returns whether the number is infinite
670
671 0 if finite or not a number
672 1 if +INF
673 -1 if -INF
674 """
675 if self._exp == 'F':
676 if self._sign:
677 return -1
678 return 1
679 return 0
680
Facundo Batista353750c2007-09-13 18:13:15 +0000681 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000682 """Returns whether the number is not actually one.
683
684 if self, other are sNaN, signal
685 if self, other are NaN return nan
686 return 0
687
688 Done before operations.
689 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000690
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000691 self_is_nan = self._isnan()
692 if other is None:
693 other_is_nan = False
694 else:
695 other_is_nan = other._isnan()
696
697 if self_is_nan or other_is_nan:
698 if context is None:
699 context = getcontext()
700
701 if self_is_nan == 2:
702 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000703 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000704 if other_is_nan == 2:
705 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000706 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000707 if self_is_nan:
Facundo Batista353750c2007-09-13 18:13:15 +0000708 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000709
Facundo Batista353750c2007-09-13 18:13:15 +0000710 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000711 return 0
712
Mark Dickinson2fc92632008-02-06 22:10:50 +0000713 def _compare_check_nans(self, other, context):
714 """Version of _check_nans used for the signaling comparisons
715 compare_signal, __le__, __lt__, __ge__, __gt__.
716
717 Signal InvalidOperation if either self or other is a (quiet
718 or signaling) NaN. Signaling NaNs take precedence over quiet
719 NaNs.
720
721 Return 0 if neither operand is a NaN.
722
723 """
724 if context is None:
725 context = getcontext()
726
727 if self._is_special or other._is_special:
728 if self.is_snan():
729 return context._raise_error(InvalidOperation,
730 'comparison involving sNaN',
731 self)
732 elif other.is_snan():
733 return context._raise_error(InvalidOperation,
734 'comparison involving sNaN',
735 other)
736 elif self.is_qnan():
737 return context._raise_error(InvalidOperation,
738 'comparison involving NaN',
739 self)
740 elif other.is_qnan():
741 return context._raise_error(InvalidOperation,
742 'comparison involving NaN',
743 other)
744 return 0
745
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000746 def __nonzero__(self):
Facundo Batista1a191df2007-10-02 17:01:24 +0000747 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000748
Facundo Batista1a191df2007-10-02 17:01:24 +0000749 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000750 """
Facundo Batista72bc54f2007-11-23 17:59:00 +0000751 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000752
Mark Dickinson2fc92632008-02-06 22:10:50 +0000753 def _cmp(self, other):
754 """Compare the two non-NaN decimal instances self and other.
755
756 Returns -1 if self < other, 0 if self == other and 1
757 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000758
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000759 if self._is_special or other._is_special:
Mark Dickinson8ec69bc2009-01-25 10:47:45 +0000760 self_inf = self._isinfinity()
761 other_inf = other._isinfinity()
762 if self_inf == other_inf:
763 return 0
764 elif self_inf < other_inf:
765 return -1
766 else:
767 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000768
Mark Dickinson8ec69bc2009-01-25 10:47:45 +0000769 # check for zeros; Decimal('0') == Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +0000770 if not self:
771 if not other:
772 return 0
773 else:
774 return -((-1)**other._sign)
775 if not other:
776 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000777
Facundo Batista59c58842007-04-10 12:58:45 +0000778 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000779 if other._sign < self._sign:
780 return -1
781 if self._sign < other._sign:
782 return 1
783
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000784 self_adjusted = self.adjusted()
785 other_adjusted = other.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +0000786 if self_adjusted == other_adjusted:
Facundo Batista72bc54f2007-11-23 17:59:00 +0000787 self_padded = self._int + '0'*(self._exp - other._exp)
788 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinson8ec69bc2009-01-25 10:47:45 +0000789 if self_padded == other_padded:
790 return 0
791 elif self_padded < other_padded:
792 return -(-1)**self._sign
793 else:
794 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000795 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000796 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000797 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000798 return -((-1)**self._sign)
799
Mark Dickinson2fc92632008-02-06 22:10:50 +0000800 # Note: The Decimal standard doesn't cover rich comparisons for
801 # Decimals. In particular, the specification is silent on the
802 # subject of what should happen for a comparison involving a NaN.
803 # We take the following approach:
804 #
805 # == comparisons involving a NaN always return False
806 # != comparisons involving a NaN always return True
807 # <, >, <= and >= comparisons involving a (quiet or signaling)
808 # NaN signal InvalidOperation, and return False if the
Mark Dickinson3a94ee02008-02-10 15:19:58 +0000809 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000810 #
811 # This behavior is designed to conform as closely as possible to
812 # that specified by IEEE 754.
813
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000814 def __eq__(self, other):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000815 other = _convert_other(other)
816 if other is NotImplemented:
817 return other
818 if self.is_nan() or other.is_nan():
819 return False
820 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000821
822 def __ne__(self, other):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000823 other = _convert_other(other)
824 if other is NotImplemented:
825 return other
826 if self.is_nan() or other.is_nan():
827 return True
828 return self._cmp(other) != 0
829
830 def __lt__(self, other, context=None):
831 other = _convert_other(other)
832 if other is NotImplemented:
833 return other
834 ans = self._compare_check_nans(other, context)
835 if ans:
836 return False
837 return self._cmp(other) < 0
838
839 def __le__(self, other, context=None):
840 other = _convert_other(other)
841 if other is NotImplemented:
842 return other
843 ans = self._compare_check_nans(other, context)
844 if ans:
845 return False
846 return self._cmp(other) <= 0
847
848 def __gt__(self, other, context=None):
849 other = _convert_other(other)
850 if other is NotImplemented:
851 return other
852 ans = self._compare_check_nans(other, context)
853 if ans:
854 return False
855 return self._cmp(other) > 0
856
857 def __ge__(self, other, context=None):
858 other = _convert_other(other)
859 if other is NotImplemented:
860 return other
861 ans = self._compare_check_nans(other, context)
862 if ans:
863 return False
864 return self._cmp(other) >= 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000865
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000866 def compare(self, other, context=None):
867 """Compares one to another.
868
869 -1 => a < b
870 0 => a = b
871 1 => a > b
872 NaN => one is NaN
873 Like __cmp__, but returns Decimal instances.
874 """
Facundo Batista353750c2007-09-13 18:13:15 +0000875 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000876
Facundo Batista59c58842007-04-10 12:58:45 +0000877 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000878 if (self._is_special or other and other._is_special):
879 ans = self._check_nans(other, context)
880 if ans:
881 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000882
Mark Dickinson2fc92632008-02-06 22:10:50 +0000883 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000884
885 def __hash__(self):
886 """x.__hash__() <==> hash(x)"""
887 # Decimal integers must hash the same as the ints
Facundo Batista52b25792008-01-08 12:25:20 +0000888 #
889 # The hash of a nonspecial noninteger Decimal must depend only
890 # on the value of that Decimal, and not on its representation.
Raymond Hettingerabe32372008-02-14 02:41:22 +0000891 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000892 if self._is_special:
893 if self._isnan():
894 raise TypeError('Cannot hash a NaN value.')
895 return hash(str(self))
Facundo Batista8c202442007-09-19 17:53:25 +0000896 if not self:
897 return 0
898 if self._isinteger():
899 op = _WorkRep(self.to_integral_value())
900 # to make computation feasible for Decimals with large
901 # exponent, we use the fact that hash(n) == hash(m) for
902 # any two nonzero integers n and m such that (i) n and m
903 # have the same sign, and (ii) n is congruent to m modulo
904 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
905 # hash((-1)**s*c*pow(10, e, 2**64-1).
906 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Facundo Batista52b25792008-01-08 12:25:20 +0000907 # The value of a nonzero nonspecial Decimal instance is
908 # faithfully represented by the triple consisting of its sign,
909 # its adjusted exponent, and its coefficient with trailing
910 # zeros removed.
911 return hash((self._sign,
912 self._exp+len(self._int),
913 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000914
915 def as_tuple(self):
916 """Represents the number as a triple tuple.
917
918 To show the internals exactly as they are.
919 """
Raymond Hettinger097a1902008-01-11 02:24:13 +0000920 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000921
922 def __repr__(self):
923 """Represents the number as an instance of Decimal."""
924 # Invariant: eval(repr(d)) == d
Raymond Hettingerabe32372008-02-14 02:41:22 +0000925 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000926
Facundo Batista353750c2007-09-13 18:13:15 +0000927 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000928 """Return string representation of the number in scientific notation.
929
930 Captures all of the information in the underlying representation.
931 """
932
Facundo Batista62edb712007-12-03 16:29:52 +0000933 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000934 if self._is_special:
Facundo Batista62edb712007-12-03 16:29:52 +0000935 if self._exp == 'F':
936 return sign + 'Infinity'
937 elif self._exp == 'n':
938 return sign + 'NaN' + self._int
939 else: # self._exp == 'N'
940 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000941
Facundo Batista62edb712007-12-03 16:29:52 +0000942 # number of digits of self._int to left of decimal point
943 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000944
Facundo Batista62edb712007-12-03 16:29:52 +0000945 # dotplace is number of digits of self._int to the left of the
946 # decimal point in the mantissa of the output string (that is,
947 # after adjusting the exponent)
948 if self._exp <= 0 and leftdigits > -6:
949 # no exponent required
950 dotplace = leftdigits
951 elif not eng:
952 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000953 dotplace = 1
Facundo Batista62edb712007-12-03 16:29:52 +0000954 elif self._int == '0':
955 # engineering notation, zero
956 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000957 else:
Facundo Batista62edb712007-12-03 16:29:52 +0000958 # engineering notation, nonzero
959 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000960
Facundo Batista62edb712007-12-03 16:29:52 +0000961 if dotplace <= 0:
962 intpart = '0'
963 fracpart = '.' + '0'*(-dotplace) + self._int
964 elif dotplace >= len(self._int):
965 intpart = self._int+'0'*(dotplace-len(self._int))
966 fracpart = ''
967 else:
968 intpart = self._int[:dotplace]
969 fracpart = '.' + self._int[dotplace:]
970 if leftdigits == dotplace:
971 exp = ''
972 else:
973 if context is None:
974 context = getcontext()
975 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
976
977 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000978
979 def to_eng_string(self, context=None):
980 """Convert to engineering-type string.
981
982 Engineering notation has an exponent which is a multiple of 3, so there
983 are up to 3 digits left of the decimal place.
984
985 Same rules for when in exponential and when as a value as in __str__.
986 """
Facundo Batista353750c2007-09-13 18:13:15 +0000987 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000988
989 def __neg__(self, context=None):
990 """Returns a copy with the sign switched.
991
992 Rounds, if it has reason.
993 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000994 if self._is_special:
995 ans = self._check_nans(context=context)
996 if ans:
997 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000998
999 if not self:
1000 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001001 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001002 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001003 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001004
1005 if context is None:
1006 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001007 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001008
1009 def __pos__(self, context=None):
1010 """Returns a copy, unless it is a sNaN.
1011
1012 Rounds the number (if more then precision digits)
1013 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001014 if self._is_special:
1015 ans = self._check_nans(context=context)
1016 if ans:
1017 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001018
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001019 if not self:
1020 # + (-0) = 0
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001021 ans = self.copy_abs()
Facundo Batista353750c2007-09-13 18:13:15 +00001022 else:
1023 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001024
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001025 if context is None:
1026 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001027 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001028
Facundo Batistae64acfa2007-12-17 14:18:42 +00001029 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001030 """Returns the absolute value of self.
1031
Facundo Batistae64acfa2007-12-17 14:18:42 +00001032 If the keyword argument 'round' is false, do not round. The
1033 expression self.__abs__(round=False) is equivalent to
1034 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001035 """
Facundo Batistae64acfa2007-12-17 14:18:42 +00001036 if not round:
1037 return self.copy_abs()
1038
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001039 if self._is_special:
1040 ans = self._check_nans(context=context)
1041 if ans:
1042 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001043
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001044 if self._sign:
1045 ans = self.__neg__(context=context)
1046 else:
1047 ans = self.__pos__(context=context)
1048
1049 return ans
1050
1051 def __add__(self, other, context=None):
1052 """Returns self + other.
1053
1054 -INF + INF (or the reverse) cause InvalidOperation errors.
1055 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001056 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001057 if other is NotImplemented:
1058 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001059
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001060 if context is None:
1061 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001062
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001063 if self._is_special or other._is_special:
1064 ans = self._check_nans(other, context)
1065 if ans:
1066 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001067
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001068 if self._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001069 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001070 if self._sign != other._sign and other._isinfinity():
1071 return context._raise_error(InvalidOperation, '-INF + INF')
1072 return Decimal(self)
1073 if other._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001074 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001075
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001076 exp = min(self._exp, other._exp)
1077 negativezero = 0
1078 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Facundo Batista59c58842007-04-10 12:58:45 +00001079 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001080 negativezero = 1
1081
1082 if not self and not other:
1083 sign = min(self._sign, other._sign)
1084 if negativezero:
1085 sign = 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00001086 ans = _dec_from_triple(sign, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001087 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001088 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001089 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001090 exp = max(exp, other._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001091 ans = other._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001092 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001093 return ans
1094 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001095 exp = max(exp, self._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001096 ans = self._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001097 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001098 return ans
1099
1100 op1 = _WorkRep(self)
1101 op2 = _WorkRep(other)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001102 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001103
1104 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001105 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001106 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001107 if op1.int == op2.int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001108 ans = _dec_from_triple(negativezero, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001109 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001110 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001111 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001112 op1, op2 = op2, op1
Facundo Batista59c58842007-04-10 12:58:45 +00001113 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001114 if op1.sign == 1:
1115 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001116 op1.sign, op2.sign = op2.sign, op1.sign
1117 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001118 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001119 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001120 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001121 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001122 op1.sign, op2.sign = (0, 0)
1123 else:
1124 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001125 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001126
Raymond Hettinger17931de2004-10-27 06:21:46 +00001127 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001128 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001129 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001130 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001131
1132 result.exp = op1.exp
1133 ans = Decimal(result)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001134 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001135 return ans
1136
1137 __radd__ = __add__
1138
1139 def __sub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001140 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001141 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001142 if other is NotImplemented:
1143 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001144
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001145 if self._is_special or other._is_special:
1146 ans = self._check_nans(other, context=context)
1147 if ans:
1148 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149
Facundo Batista353750c2007-09-13 18:13:15 +00001150 # self - other is computed as self + other.copy_negate()
1151 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001152
1153 def __rsub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001154 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001155 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001156 if other is NotImplemented:
1157 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001158
Facundo Batista353750c2007-09-13 18:13:15 +00001159 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001160
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001161 def __mul__(self, other, context=None):
1162 """Return self * other.
1163
1164 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1165 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001166 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001167 if other is NotImplemented:
1168 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001169
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001170 if context is None:
1171 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001172
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001173 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001174
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001175 if self._is_special or other._is_special:
1176 ans = self._check_nans(other, context)
1177 if ans:
1178 return ans
1179
1180 if self._isinfinity():
1181 if not other:
1182 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001183 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001184
1185 if other._isinfinity():
1186 if not self:
1187 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001188 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001189
1190 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001191
1192 # Special case for multiplying by zero
1193 if not self or not other:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001194 ans = _dec_from_triple(resultsign, '0', resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001195 # Fixing in case the exponent is out of bounds
1196 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001197 return ans
1198
1199 # Special case for multiplying by power of 10
Facundo Batista72bc54f2007-11-23 17:59:00 +00001200 if self._int == '1':
1201 ans = _dec_from_triple(resultsign, other._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001202 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001203 return ans
Facundo Batista72bc54f2007-11-23 17:59:00 +00001204 if other._int == '1':
1205 ans = _dec_from_triple(resultsign, self._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001206 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001207 return ans
1208
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001209 op1 = _WorkRep(self)
1210 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001211
Facundo Batista72bc54f2007-11-23 17:59:00 +00001212 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001213 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001214
1215 return ans
1216 __rmul__ = __mul__
1217
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001218 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001219 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001220 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001221 if other is NotImplemented:
Facundo Batistacce8df22007-09-18 16:53:18 +00001222 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001223
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001224 if context is None:
1225 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001226
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001227 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001228
1229 if self._is_special or other._is_special:
1230 ans = self._check_nans(other, context)
1231 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001232 return ans
1233
1234 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001236
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001237 if self._isinfinity():
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001238 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001239
1240 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001241 context._raise_error(Clamped, 'Division by infinity')
Facundo Batista72bc54f2007-11-23 17:59:00 +00001242 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001243
1244 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001245 if not other:
Facundo Batistacce8df22007-09-18 16:53:18 +00001246 if not self:
1247 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001248 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001249
Facundo Batistacce8df22007-09-18 16:53:18 +00001250 if not self:
1251 exp = self._exp - other._exp
1252 coeff = 0
1253 else:
1254 # OK, so neither = 0, INF or NaN
1255 shift = len(other._int) - len(self._int) + context.prec + 1
1256 exp = self._exp - other._exp - shift
1257 op1 = _WorkRep(self)
1258 op2 = _WorkRep(other)
1259 if shift >= 0:
1260 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1261 else:
1262 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1263 if remainder:
1264 # result is not exact; adjust to ensure correct rounding
1265 if coeff % 5 == 0:
1266 coeff += 1
1267 else:
1268 # result is exact; get as close to ideal exponent as possible
1269 ideal_exp = self._exp - other._exp
1270 while exp < ideal_exp and coeff % 10 == 0:
1271 coeff //= 10
1272 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001273
Facundo Batista72bc54f2007-11-23 17:59:00 +00001274 ans = _dec_from_triple(sign, str(coeff), exp)
Facundo Batistacce8df22007-09-18 16:53:18 +00001275 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001276
Facundo Batistacce8df22007-09-18 16:53:18 +00001277 def _divide(self, other, context):
1278 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001279
Facundo Batistacce8df22007-09-18 16:53:18 +00001280 Assumes that neither self nor other is a NaN, that self is not
1281 infinite and that other is nonzero.
1282 """
1283 sign = self._sign ^ other._sign
1284 if other._isinfinity():
1285 ideal_exp = self._exp
1286 else:
1287 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001288
Facundo Batistacce8df22007-09-18 16:53:18 +00001289 expdiff = self.adjusted() - other.adjusted()
1290 if not self or other._isinfinity() or expdiff <= -2:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001291 return (_dec_from_triple(sign, '0', 0),
Facundo Batistacce8df22007-09-18 16:53:18 +00001292 self._rescale(ideal_exp, context.rounding))
1293 if expdiff <= context.prec:
1294 op1 = _WorkRep(self)
1295 op2 = _WorkRep(other)
1296 if op1.exp >= op2.exp:
1297 op1.int *= 10**(op1.exp - op2.exp)
1298 else:
1299 op2.int *= 10**(op2.exp - op1.exp)
1300 q, r = divmod(op1.int, op2.int)
1301 if q < 10**context.prec:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001302 return (_dec_from_triple(sign, str(q), 0),
1303 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001304
Facundo Batistacce8df22007-09-18 16:53:18 +00001305 # Here the quotient is too large to be representable
1306 ans = context._raise_error(DivisionImpossible,
1307 'quotient too large in //, % or divmod')
1308 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001309
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001310 def __rtruediv__(self, other, context=None):
1311 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001312 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001313 if other is NotImplemented:
1314 return other
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001315 return other.__truediv__(self, context=context)
1316
1317 __div__ = __truediv__
1318 __rdiv__ = __rtruediv__
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001319
1320 def __divmod__(self, other, context=None):
1321 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001322 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001323 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001324 other = _convert_other(other)
1325 if other is NotImplemented:
1326 return other
1327
1328 if context is None:
1329 context = getcontext()
1330
1331 ans = self._check_nans(other, context)
1332 if ans:
1333 return (ans, ans)
1334
1335 sign = self._sign ^ other._sign
1336 if self._isinfinity():
1337 if other._isinfinity():
1338 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1339 return ans, ans
1340 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001341 return (_SignedInfinity[sign],
Facundo Batistacce8df22007-09-18 16:53:18 +00001342 context._raise_error(InvalidOperation, 'INF % x'))
1343
1344 if not other:
1345 if not self:
1346 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1347 return ans, ans
1348 else:
1349 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1350 context._raise_error(InvalidOperation, 'x % 0'))
1351
1352 quotient, remainder = self._divide(other, context)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001353 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001354 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001355
1356 def __rdivmod__(self, other, context=None):
1357 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001358 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001359 if other is NotImplemented:
1360 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001361 return other.__divmod__(self, context=context)
1362
1363 def __mod__(self, other, context=None):
1364 """
1365 self % other
1366 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001367 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001368 if other is NotImplemented:
1369 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001370
Facundo Batistacce8df22007-09-18 16:53:18 +00001371 if context is None:
1372 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001373
Facundo Batistacce8df22007-09-18 16:53:18 +00001374 ans = self._check_nans(other, context)
1375 if ans:
1376 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001377
Facundo Batistacce8df22007-09-18 16:53:18 +00001378 if self._isinfinity():
1379 return context._raise_error(InvalidOperation, 'INF % x')
1380 elif not other:
1381 if self:
1382 return context._raise_error(InvalidOperation, 'x % 0')
1383 else:
1384 return context._raise_error(DivisionUndefined, '0 % 0')
1385
1386 remainder = self._divide(other, context)[1]
Facundo Batistae64acfa2007-12-17 14:18:42 +00001387 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001388 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001389
1390 def __rmod__(self, other, context=None):
1391 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001392 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001393 if other is NotImplemented:
1394 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001395 return other.__mod__(self, context=context)
1396
1397 def remainder_near(self, other, context=None):
1398 """
1399 Remainder nearest to 0- abs(remainder-near) <= other/2
1400 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001401 if context is None:
1402 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001403
Facundo Batista353750c2007-09-13 18:13:15 +00001404 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001405
Facundo Batista353750c2007-09-13 18:13:15 +00001406 ans = self._check_nans(other, context)
1407 if ans:
1408 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001409
Facundo Batista353750c2007-09-13 18:13:15 +00001410 # self == +/-infinity -> InvalidOperation
1411 if self._isinfinity():
1412 return context._raise_error(InvalidOperation,
1413 'remainder_near(infinity, x)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001414
Facundo Batista353750c2007-09-13 18:13:15 +00001415 # other == 0 -> either InvalidOperation or DivisionUndefined
1416 if not other:
1417 if self:
1418 return context._raise_error(InvalidOperation,
1419 'remainder_near(x, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001420 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001421 return context._raise_error(DivisionUndefined,
1422 'remainder_near(0, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001423
Facundo Batista353750c2007-09-13 18:13:15 +00001424 # other = +/-infinity -> remainder = self
1425 if other._isinfinity():
1426 ans = Decimal(self)
1427 return ans._fix(context)
1428
1429 # self = 0 -> remainder = self, with ideal exponent
1430 ideal_exponent = min(self._exp, other._exp)
1431 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001432 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001433 return ans._fix(context)
1434
1435 # catch most cases of large or small quotient
1436 expdiff = self.adjusted() - other.adjusted()
1437 if expdiff >= context.prec + 1:
1438 # expdiff >= prec+1 => abs(self/other) > 10**prec
Facundo Batistacce8df22007-09-18 16:53:18 +00001439 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001440 if expdiff <= -2:
1441 # expdiff <= -2 => abs(self/other) < 0.1
1442 ans = self._rescale(ideal_exponent, context.rounding)
1443 return ans._fix(context)
1444
1445 # adjust both arguments to have the same exponent, then divide
1446 op1 = _WorkRep(self)
1447 op2 = _WorkRep(other)
1448 if op1.exp >= op2.exp:
1449 op1.int *= 10**(op1.exp - op2.exp)
1450 else:
1451 op2.int *= 10**(op2.exp - op1.exp)
1452 q, r = divmod(op1.int, op2.int)
1453 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1454 # 10**ideal_exponent. Apply correction to ensure that
1455 # abs(remainder) <= abs(other)/2
1456 if 2*r + (q&1) > op2.int:
1457 r -= op2.int
1458 q += 1
1459
1460 if q >= 10**context.prec:
Facundo Batistacce8df22007-09-18 16:53:18 +00001461 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001462
1463 # result has same sign as self unless r is negative
1464 sign = self._sign
1465 if r < 0:
1466 sign = 1-sign
1467 r = -r
1468
Facundo Batista72bc54f2007-11-23 17:59:00 +00001469 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001470 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001471
1472 def __floordiv__(self, other, context=None):
1473 """self // other"""
Facundo Batistacce8df22007-09-18 16:53:18 +00001474 other = _convert_other(other)
1475 if other is NotImplemented:
1476 return other
1477
1478 if context is None:
1479 context = getcontext()
1480
1481 ans = self._check_nans(other, context)
1482 if ans:
1483 return ans
1484
1485 if self._isinfinity():
1486 if other._isinfinity():
1487 return context._raise_error(InvalidOperation, 'INF // INF')
1488 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001489 return _SignedInfinity[self._sign ^ other._sign]
Facundo Batistacce8df22007-09-18 16:53:18 +00001490
1491 if not other:
1492 if self:
1493 return context._raise_error(DivisionByZero, 'x // 0',
1494 self._sign ^ other._sign)
1495 else:
1496 return context._raise_error(DivisionUndefined, '0 // 0')
1497
1498 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001499
1500 def __rfloordiv__(self, other, context=None):
1501 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001502 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001503 if other is NotImplemented:
1504 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001505 return other.__floordiv__(self, context=context)
1506
1507 def __float__(self):
1508 """Float representation."""
1509 return float(str(self))
1510
1511 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001512 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001513 if self._is_special:
1514 if self._isnan():
Mark Dickinsonc05b7892009-09-08 19:22:18 +00001515 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001516 elif self._isinfinity():
Mark Dickinsonc05b7892009-09-08 19:22:18 +00001517 raise OverflowError("Cannot convert infinity to integer")
Facundo Batista353750c2007-09-13 18:13:15 +00001518 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001519 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001520 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001521 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001522 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001523
Raymond Hettinger5a053642008-01-24 19:05:29 +00001524 __trunc__ = __int__
1525
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001526 def real(self):
1527 return self
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00001528 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001529
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001530 def imag(self):
1531 return Decimal(0)
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00001532 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001533
1534 def conjugate(self):
1535 return self
1536
1537 def __complex__(self):
1538 return complex(float(self))
1539
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001540 def __long__(self):
1541 """Converts to a long.
1542
1543 Equivalent to long(int(self))
1544 """
1545 return long(self.__int__())
1546
Facundo Batista353750c2007-09-13 18:13:15 +00001547 def _fix_nan(self, context):
1548 """Decapitate the payload of a NaN to fit the context"""
1549 payload = self._int
1550
1551 # maximum length of payload is precision if _clamp=0,
1552 # precision-1 if _clamp=1.
1553 max_payload_len = context.prec - context._clamp
1554 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001555 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1556 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001557 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001558
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001559 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001560 """Round if it is necessary to keep self within prec precision.
1561
1562 Rounds and fixes the exponent. Does not raise on a sNaN.
1563
1564 Arguments:
1565 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001566 context - context used.
1567 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001568
Facundo Batista353750c2007-09-13 18:13:15 +00001569 if self._is_special:
1570 if self._isnan():
1571 # decapitate payload if necessary
1572 return self._fix_nan(context)
1573 else:
1574 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001575 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001576
Facundo Batista353750c2007-09-13 18:13:15 +00001577 # if self is zero then exponent should be between Etiny and
1578 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1579 Etiny = context.Etiny()
1580 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001581 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001582 exp_max = [context.Emax, Etop][context._clamp]
1583 new_exp = min(max(self._exp, Etiny), exp_max)
1584 if new_exp != self._exp:
1585 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001586 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001587 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001588 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001589
1590 # exp_min is the smallest allowable exponent of the result,
1591 # equal to max(self.adjusted()-context.prec+1, Etiny)
1592 exp_min = len(self._int) + self._exp - context.prec
1593 if exp_min > Etop:
1594 # overflow: exp_min > Etop iff self.adjusted() > Emax
1595 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001596 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00001597 return context._raise_error(Overflow, 'above Emax', self._sign)
1598 self_is_subnormal = exp_min < Etiny
1599 if self_is_subnormal:
1600 context._raise_error(Subnormal)
1601 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001602
Facundo Batista353750c2007-09-13 18:13:15 +00001603 # round if self has too many digits
1604 if self._exp < exp_min:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001605 context._raise_error(Rounded)
Facundo Batista2ec74152007-12-03 17:55:00 +00001606 digits = len(self._int) + self._exp - exp_min
1607 if digits < 0:
1608 self = _dec_from_triple(self._sign, '1', exp_min-1)
1609 digits = 0
1610 this_function = getattr(self, self._pick_rounding_function[context.rounding])
1611 changed = this_function(digits)
1612 coeff = self._int[:digits] or '0'
1613 if changed == 1:
1614 coeff = str(int(coeff)+1)
1615 ans = _dec_from_triple(self._sign, coeff, exp_min)
1616
1617 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001618 context._raise_error(Inexact)
1619 if self_is_subnormal:
1620 context._raise_error(Underflow)
1621 if not ans:
1622 # raise Clamped on underflow to 0
1623 context._raise_error(Clamped)
1624 elif len(ans._int) == context.prec+1:
1625 # we get here only if rescaling rounds the
1626 # cofficient up to exactly 10**context.prec
1627 if ans._exp < Etop:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001628 ans = _dec_from_triple(ans._sign,
1629 ans._int[:-1], ans._exp+1)
Facundo Batista353750c2007-09-13 18:13:15 +00001630 else:
1631 # Inexact and Rounded have already been raised
1632 ans = context._raise_error(Overflow, 'above Emax',
1633 self._sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001634 return ans
1635
Facundo Batista353750c2007-09-13 18:13:15 +00001636 # fold down if _clamp == 1 and self has too few digits
1637 if context._clamp == 1 and self._exp > Etop:
1638 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001639 self_padded = self._int + '0'*(self._exp - Etop)
1640 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001641
Facundo Batista353750c2007-09-13 18:13:15 +00001642 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001643 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001644
1645 _pick_rounding_function = {}
1646
Facundo Batista353750c2007-09-13 18:13:15 +00001647 # for each of the rounding functions below:
1648 # self is a finite, nonzero Decimal
1649 # prec is an integer satisfying 0 <= prec < len(self._int)
Facundo Batista2ec74152007-12-03 17:55:00 +00001650 #
1651 # each function returns either -1, 0, or 1, as follows:
1652 # 1 indicates that self should be rounded up (away from zero)
1653 # 0 indicates that self should be truncated, and that all the
1654 # digits to be truncated are zeros (so the value is unchanged)
1655 # -1 indicates that there are nonzero digits to be truncated
Facundo Batista353750c2007-09-13 18:13:15 +00001656
1657 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001658 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001659 if _all_zeros(self._int, prec):
1660 return 0
1661 else:
1662 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001663
Facundo Batista353750c2007-09-13 18:13:15 +00001664 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001665 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001666 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001667
Facundo Batista353750c2007-09-13 18:13:15 +00001668 def _round_half_up(self, prec):
1669 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001670 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001671 return 1
1672 elif _all_zeros(self._int, prec):
1673 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001674 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001675 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001676
1677 def _round_half_down(self, prec):
1678 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001679 if _exact_half(self._int, prec):
1680 return -1
1681 else:
1682 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001683
1684 def _round_half_even(self, prec):
1685 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001686 if _exact_half(self._int, prec) and \
1687 (prec == 0 or self._int[prec-1] in '02468'):
1688 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001689 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001690 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001691
1692 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001693 """Rounds up (not away from 0 if negative.)"""
1694 if self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001695 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001696 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001697 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001698
Facundo Batista353750c2007-09-13 18:13:15 +00001699 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001700 """Rounds down (not towards 0 if negative)"""
1701 if not self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001702 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001703 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001704 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001705
Facundo Batista353750c2007-09-13 18:13:15 +00001706 def _round_05up(self, prec):
1707 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001708 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001709 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001710 else:
1711 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001712
Facundo Batista353750c2007-09-13 18:13:15 +00001713 def fma(self, other, third, context=None):
1714 """Fused multiply-add.
1715
1716 Returns self*other+third with no rounding of the intermediate
1717 product self*other.
1718
1719 self and other are multiplied together, with no rounding of
1720 the result. The third operand is then added to the result,
1721 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001722 """
Facundo Batista353750c2007-09-13 18:13:15 +00001723
1724 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001725
1726 # compute product; raise InvalidOperation if either operand is
1727 # a signaling NaN or if the product is zero times infinity.
1728 if self._is_special or other._is_special:
1729 if context is None:
1730 context = getcontext()
1731 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001732 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001733 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001734 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001735 if self._exp == 'n':
1736 product = self
1737 elif other._exp == 'n':
1738 product = other
1739 elif self._exp == 'F':
1740 if not other:
1741 return context._raise_error(InvalidOperation,
1742 'INF * 0 in fma')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001743 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001744 elif other._exp == 'F':
1745 if not self:
1746 return context._raise_error(InvalidOperation,
1747 '0 * INF in fma')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001748 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001749 else:
1750 product = _dec_from_triple(self._sign ^ other._sign,
1751 str(int(self._int) * int(other._int)),
1752 self._exp + other._exp)
1753
Facundo Batista353750c2007-09-13 18:13:15 +00001754 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001755 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001756
Facundo Batista353750c2007-09-13 18:13:15 +00001757 def _power_modulo(self, other, modulo, context=None):
1758 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001759
Facundo Batista353750c2007-09-13 18:13:15 +00001760 # if can't convert other and modulo to Decimal, raise
1761 # TypeError; there's no point returning NotImplemented (no
1762 # equivalent of __rpow__ for three argument pow)
1763 other = _convert_other(other, raiseit=True)
1764 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001765
Facundo Batista353750c2007-09-13 18:13:15 +00001766 if context is None:
1767 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001768
Facundo Batista353750c2007-09-13 18:13:15 +00001769 # deal with NaNs: if there are any sNaNs then first one wins,
1770 # (i.e. behaviour for NaNs is identical to that of fma)
1771 self_is_nan = self._isnan()
1772 other_is_nan = other._isnan()
1773 modulo_is_nan = modulo._isnan()
1774 if self_is_nan or other_is_nan or modulo_is_nan:
1775 if self_is_nan == 2:
1776 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001777 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001778 if other_is_nan == 2:
1779 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001780 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001781 if modulo_is_nan == 2:
1782 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001783 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001784 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001785 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001786 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001787 return other._fix_nan(context)
1788 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001789
Facundo Batista353750c2007-09-13 18:13:15 +00001790 # check inputs: we apply same restrictions as Python's pow()
1791 if not (self._isinteger() and
1792 other._isinteger() and
1793 modulo._isinteger()):
1794 return context._raise_error(InvalidOperation,
1795 'pow() 3rd argument not allowed '
1796 'unless all arguments are integers')
1797 if other < 0:
1798 return context._raise_error(InvalidOperation,
1799 'pow() 2nd argument cannot be '
1800 'negative when 3rd argument specified')
1801 if not modulo:
1802 return context._raise_error(InvalidOperation,
1803 'pow() 3rd argument cannot be 0')
1804
1805 # additional restriction for decimal: the modulus must be less
1806 # than 10**prec in absolute value
1807 if modulo.adjusted() >= context.prec:
1808 return context._raise_error(InvalidOperation,
1809 'insufficient precision: pow() 3rd '
1810 'argument must not have more than '
1811 'precision digits')
1812
1813 # define 0**0 == NaN, for consistency with two-argument pow
1814 # (even though it hurts!)
1815 if not other and not self:
1816 return context._raise_error(InvalidOperation,
1817 'at least one of pow() 1st argument '
1818 'and 2nd argument must be nonzero ;'
1819 '0**0 is not defined')
1820
1821 # compute sign of result
1822 if other._iseven():
1823 sign = 0
1824 else:
1825 sign = self._sign
1826
1827 # convert modulo to a Python integer, and self and other to
1828 # Decimal integers (i.e. force their exponents to be >= 0)
1829 modulo = abs(int(modulo))
1830 base = _WorkRep(self.to_integral_value())
1831 exponent = _WorkRep(other.to_integral_value())
1832
1833 # compute result using integer pow()
1834 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1835 for i in xrange(exponent.exp):
1836 base = pow(base, 10, modulo)
1837 base = pow(base, exponent.int, modulo)
1838
Facundo Batista72bc54f2007-11-23 17:59:00 +00001839 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001840
1841 def _power_exact(self, other, p):
1842 """Attempt to compute self**other exactly.
1843
1844 Given Decimals self and other and an integer p, attempt to
1845 compute an exact result for the power self**other, with p
1846 digits of precision. Return None if self**other is not
1847 exactly representable in p digits.
1848
1849 Assumes that elimination of special cases has already been
1850 performed: self and other must both be nonspecial; self must
1851 be positive and not numerically equal to 1; other must be
1852 nonzero. For efficiency, other._exp should not be too large,
1853 so that 10**abs(other._exp) is a feasible calculation."""
1854
1855 # In the comments below, we write x for the value of self and
1856 # y for the value of other. Write x = xc*10**xe and y =
1857 # yc*10**ye.
1858
1859 # The main purpose of this method is to identify the *failure*
1860 # of x**y to be exactly representable with as little effort as
1861 # possible. So we look for cheap and easy tests that
1862 # eliminate the possibility of x**y being exact. Only if all
1863 # these tests are passed do we go on to actually compute x**y.
1864
1865 # Here's the main idea. First normalize both x and y. We
1866 # express y as a rational m/n, with m and n relatively prime
1867 # and n>0. Then for x**y to be exactly representable (at
1868 # *any* precision), xc must be the nth power of a positive
1869 # integer and xe must be divisible by n. If m is negative
1870 # then additionally xc must be a power of either 2 or 5, hence
1871 # a power of 2**n or 5**n.
1872 #
1873 # There's a limit to how small |y| can be: if y=m/n as above
1874 # then:
1875 #
1876 # (1) if xc != 1 then for the result to be representable we
1877 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1878 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1879 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1880 # representable.
1881 #
1882 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1883 # |y| < 1/|xe| then the result is not representable.
1884 #
1885 # Note that since x is not equal to 1, at least one of (1) and
1886 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1887 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1888 #
1889 # There's also a limit to how large y can be, at least if it's
1890 # positive: the normalized result will have coefficient xc**y,
1891 # so if it's representable then xc**y < 10**p, and y <
1892 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1893 # not exactly representable.
1894
1895 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1896 # so |y| < 1/xe and the result is not representable.
1897 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1898 # < 1/nbits(xc).
1899
1900 x = _WorkRep(self)
1901 xc, xe = x.int, x.exp
1902 while xc % 10 == 0:
1903 xc //= 10
1904 xe += 1
1905
1906 y = _WorkRep(other)
1907 yc, ye = y.int, y.exp
1908 while yc % 10 == 0:
1909 yc //= 10
1910 ye += 1
1911
1912 # case where xc == 1: result is 10**(xe*y), with xe*y
1913 # required to be an integer
1914 if xc == 1:
1915 if ye >= 0:
1916 exponent = xe*yc*10**ye
1917 else:
1918 exponent, remainder = divmod(xe*yc, 10**-ye)
1919 if remainder:
1920 return None
1921 if y.sign == 1:
1922 exponent = -exponent
1923 # if other is a nonnegative integer, use ideal exponent
1924 if other._isinteger() and other._sign == 0:
1925 ideal_exponent = self._exp*int(other)
1926 zeros = min(exponent-ideal_exponent, p-1)
1927 else:
1928 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00001929 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00001930
1931 # case where y is negative: xc must be either a power
1932 # of 2 or a power of 5.
1933 if y.sign == 1:
1934 last_digit = xc % 10
1935 if last_digit in (2,4,6,8):
1936 # quick test for power of 2
1937 if xc & -xc != xc:
1938 return None
1939 # now xc is a power of 2; e is its exponent
1940 e = _nbits(xc)-1
1941 # find e*y and xe*y; both must be integers
1942 if ye >= 0:
1943 y_as_int = yc*10**ye
1944 e = e*y_as_int
1945 xe = xe*y_as_int
1946 else:
1947 ten_pow = 10**-ye
1948 e, remainder = divmod(e*yc, ten_pow)
1949 if remainder:
1950 return None
1951 xe, remainder = divmod(xe*yc, ten_pow)
1952 if remainder:
1953 return None
1954
1955 if e*65 >= p*93: # 93/65 > log(10)/log(5)
1956 return None
1957 xc = 5**e
1958
1959 elif last_digit == 5:
1960 # e >= log_5(xc) if xc is a power of 5; we have
1961 # equality all the way up to xc=5**2658
1962 e = _nbits(xc)*28//65
1963 xc, remainder = divmod(5**e, xc)
1964 if remainder:
1965 return None
1966 while xc % 5 == 0:
1967 xc //= 5
1968 e -= 1
1969 if ye >= 0:
1970 y_as_integer = yc*10**ye
1971 e = e*y_as_integer
1972 xe = xe*y_as_integer
1973 else:
1974 ten_pow = 10**-ye
1975 e, remainder = divmod(e*yc, ten_pow)
1976 if remainder:
1977 return None
1978 xe, remainder = divmod(xe*yc, ten_pow)
1979 if remainder:
1980 return None
1981 if e*3 >= p*10: # 10/3 > log(10)/log(2)
1982 return None
1983 xc = 2**e
1984 else:
1985 return None
1986
1987 if xc >= 10**p:
1988 return None
1989 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00001990 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00001991
1992 # now y is positive; find m and n such that y = m/n
1993 if ye >= 0:
1994 m, n = yc*10**ye, 1
1995 else:
1996 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
1997 return None
1998 xc_bits = _nbits(xc)
1999 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2000 return None
2001 m, n = yc, 10**(-ye)
2002 while m % 2 == n % 2 == 0:
2003 m //= 2
2004 n //= 2
2005 while m % 5 == n % 5 == 0:
2006 m //= 5
2007 n //= 5
2008
2009 # compute nth root of xc*10**xe
2010 if n > 1:
2011 # if 1 < xc < 2**n then xc isn't an nth power
2012 if xc != 1 and xc_bits <= n:
2013 return None
2014
2015 xe, rem = divmod(xe, n)
2016 if rem != 0:
2017 return None
2018
2019 # compute nth root of xc using Newton's method
2020 a = 1L << -(-_nbits(xc)//n) # initial estimate
2021 while True:
2022 q, r = divmod(xc, a**(n-1))
2023 if a <= q:
2024 break
2025 else:
2026 a = (a*(n-1) + q)//n
2027 if not (a == q and r == 0):
2028 return None
2029 xc = a
2030
2031 # now xc*10**xe is the nth root of the original xc*10**xe
2032 # compute mth power of xc*10**xe
2033
2034 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2035 # 10**p and the result is not representable.
2036 if xc > 1 and m > p*100//_log10_lb(xc):
2037 return None
2038 xc = xc**m
2039 xe *= m
2040 if xc > 10**p:
2041 return None
2042
2043 # by this point the result *is* exactly representable
2044 # adjust the exponent to get as close as possible to the ideal
2045 # exponent, if necessary
2046 str_xc = str(xc)
2047 if other._isinteger() and other._sign == 0:
2048 ideal_exponent = self._exp*int(other)
2049 zeros = min(xe-ideal_exponent, p-len(str_xc))
2050 else:
2051 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002052 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002053
2054 def __pow__(self, other, modulo=None, context=None):
2055 """Return self ** other [ % modulo].
2056
2057 With two arguments, compute self**other.
2058
2059 With three arguments, compute (self**other) % modulo. For the
2060 three argument form, the following restrictions on the
2061 arguments hold:
2062
2063 - all three arguments must be integral
2064 - other must be nonnegative
2065 - either self or other (or both) must be nonzero
2066 - modulo must be nonzero and must have at most p digits,
2067 where p is the context precision.
2068
2069 If any of these restrictions is violated the InvalidOperation
2070 flag is raised.
2071
2072 The result of pow(self, other, modulo) is identical to the
2073 result that would be obtained by computing (self**other) %
2074 modulo with unbounded precision, but is computed more
2075 efficiently. It is always exact.
2076 """
2077
2078 if modulo is not None:
2079 return self._power_modulo(other, modulo, context)
2080
2081 other = _convert_other(other)
2082 if other is NotImplemented:
2083 return other
2084
2085 if context is None:
2086 context = getcontext()
2087
2088 # either argument is a NaN => result is NaN
2089 ans = self._check_nans(other, context)
2090 if ans:
2091 return ans
2092
2093 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2094 if not other:
2095 if not self:
2096 return context._raise_error(InvalidOperation, '0 ** 0')
2097 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002098 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002099
2100 # result has sign 1 iff self._sign is 1 and other is an odd integer
2101 result_sign = 0
2102 if self._sign == 1:
2103 if other._isinteger():
2104 if not other._iseven():
2105 result_sign = 1
2106 else:
2107 # -ve**noninteger = NaN
2108 # (-0)**noninteger = 0**noninteger
2109 if self:
2110 return context._raise_error(InvalidOperation,
2111 'x ** y with x negative and y not an integer')
2112 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002113 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002114
2115 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2116 if not self:
2117 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002118 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002119 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002120 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002121
2122 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002123 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002124 if other._sign == 0:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002125 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002126 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002127 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002128
Facundo Batista353750c2007-09-13 18:13:15 +00002129 # 1**other = 1, but the choice of exponent and the flags
2130 # depend on the exponent of self, and on whether other is a
2131 # positive integer, a negative integer, or neither
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002132 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002133 if other._isinteger():
2134 # exp = max(self._exp*max(int(other), 0),
2135 # 1-context.prec) but evaluating int(other) directly
2136 # is dangerous until we know other is small (other
2137 # could be 1e999999999)
2138 if other._sign == 1:
2139 multiplier = 0
2140 elif other > context.prec:
2141 multiplier = context.prec
2142 else:
2143 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002144
Facundo Batista353750c2007-09-13 18:13:15 +00002145 exp = self._exp * multiplier
2146 if exp < 1-context.prec:
2147 exp = 1-context.prec
2148 context._raise_error(Rounded)
2149 else:
2150 context._raise_error(Inexact)
2151 context._raise_error(Rounded)
2152 exp = 1-context.prec
2153
Facundo Batista72bc54f2007-11-23 17:59:00 +00002154 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002155
2156 # compute adjusted exponent of self
2157 self_adj = self.adjusted()
2158
2159 # self ** infinity is infinity if self > 1, 0 if self < 1
2160 # self ** -infinity is infinity if self < 1, 0 if self > 1
2161 if other._isinfinity():
2162 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002163 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002164 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002165 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002166
2167 # from here on, the result always goes through the call
2168 # to _fix at the end of this function.
2169 ans = None
2170
2171 # crude test to catch cases of extreme overflow/underflow. If
2172 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2173 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2174 # self**other >= 10**(Emax+1), so overflow occurs. The test
2175 # for underflow is similar.
2176 bound = self._log10_exp_bound() + other.adjusted()
2177 if (self_adj >= 0) == (other._sign == 0):
2178 # self > 1 and other +ve, or self < 1 and other -ve
2179 # possibility of overflow
2180 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002181 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002182 else:
2183 # self > 1 and other -ve, or self < 1 and other +ve
2184 # possibility of underflow to 0
2185 Etiny = context.Etiny()
2186 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002187 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002188
2189 # try for an exact result with precision +1
2190 if ans is None:
2191 ans = self._power_exact(other, context.prec + 1)
2192 if ans is not None and result_sign == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002193 ans = _dec_from_triple(1, ans._int, ans._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002194
2195 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2196 if ans is None:
2197 p = context.prec
2198 x = _WorkRep(self)
2199 xc, xe = x.int, x.exp
2200 y = _WorkRep(other)
2201 yc, ye = y.int, y.exp
2202 if y.sign == 1:
2203 yc = -yc
2204
2205 # compute correctly rounded result: start with precision +3,
2206 # then increase precision until result is unambiguously roundable
2207 extra = 3
2208 while True:
2209 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2210 if coeff % (5*10**(len(str(coeff))-p-1)):
2211 break
2212 extra += 3
2213
Facundo Batista72bc54f2007-11-23 17:59:00 +00002214 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002215
2216 # the specification says that for non-integer other we need to
2217 # raise Inexact, even when the result is actually exact. In
2218 # the same way, we need to raise Underflow here if the result
2219 # is subnormal. (The call to _fix will take care of raising
2220 # Rounded and Subnormal, as usual.)
2221 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002222 context._raise_error(Inexact)
Facundo Batista353750c2007-09-13 18:13:15 +00002223 # pad with zeros up to length context.prec+1 if necessary
2224 if len(ans._int) <= context.prec:
2225 expdiff = context.prec+1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002226 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2227 ans._exp-expdiff)
Facundo Batista353750c2007-09-13 18:13:15 +00002228 if ans.adjusted() < context.Emin:
2229 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002230
Facundo Batista353750c2007-09-13 18:13:15 +00002231 # unlike exp, ln and log10, the power function respects the
2232 # rounding mode; no need to use ROUND_HALF_EVEN here
2233 ans = ans._fix(context)
2234 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002235
2236 def __rpow__(self, other, context=None):
2237 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002238 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002239 if other is NotImplemented:
2240 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002241 return other.__pow__(self, context=context)
2242
2243 def normalize(self, context=None):
2244 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002245
Facundo Batista353750c2007-09-13 18:13:15 +00002246 if context is None:
2247 context = getcontext()
2248
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002249 if self._is_special:
2250 ans = self._check_nans(context=context)
2251 if ans:
2252 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002253
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002254 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002255 if dup._isinfinity():
2256 return dup
2257
2258 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002259 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002260 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002261 end = len(dup._int)
2262 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002263 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002264 exp += 1
2265 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002266 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002267
Facundo Batistabd2fe832007-09-13 18:42:09 +00002268 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002269 """Quantize self so its exponent is the same as that of exp.
2270
2271 Similar to self._rescale(exp._exp) but with error checking.
2272 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002273 exp = _convert_other(exp, raiseit=True)
2274
Facundo Batista353750c2007-09-13 18:13:15 +00002275 if context is None:
2276 context = getcontext()
2277 if rounding is None:
2278 rounding = context.rounding
2279
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002280 if self._is_special or exp._is_special:
2281 ans = self._check_nans(exp, context)
2282 if ans:
2283 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002284
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002285 if exp._isinfinity() or self._isinfinity():
2286 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002287 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002288 return context._raise_error(InvalidOperation,
2289 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002290
Facundo Batistabd2fe832007-09-13 18:42:09 +00002291 # if we're not watching exponents, do a simple rescale
2292 if not watchexp:
2293 ans = self._rescale(exp._exp, rounding)
2294 # raise Inexact and Rounded where appropriate
2295 if ans._exp > self._exp:
2296 context._raise_error(Rounded)
2297 if ans != self:
2298 context._raise_error(Inexact)
2299 return ans
2300
Facundo Batista353750c2007-09-13 18:13:15 +00002301 # exp._exp should be between Etiny and Emax
2302 if not (context.Etiny() <= exp._exp <= context.Emax):
2303 return context._raise_error(InvalidOperation,
2304 'target exponent out of bounds in quantize')
2305
2306 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002307 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002308 return ans._fix(context)
2309
2310 self_adjusted = self.adjusted()
2311 if self_adjusted > context.Emax:
2312 return context._raise_error(InvalidOperation,
2313 'exponent of quantize result too large for current context')
2314 if self_adjusted - exp._exp + 1 > context.prec:
2315 return context._raise_error(InvalidOperation,
2316 'quantize result has too many digits for current context')
2317
2318 ans = self._rescale(exp._exp, rounding)
2319 if ans.adjusted() > context.Emax:
2320 return context._raise_error(InvalidOperation,
2321 'exponent of quantize result too large for current context')
2322 if len(ans._int) > context.prec:
2323 return context._raise_error(InvalidOperation,
2324 'quantize result has too many digits for current context')
2325
2326 # raise appropriate flags
2327 if ans._exp > self._exp:
2328 context._raise_error(Rounded)
2329 if ans != self:
2330 context._raise_error(Inexact)
2331 if ans and ans.adjusted() < context.Emin:
2332 context._raise_error(Subnormal)
2333
2334 # call to fix takes care of any necessary folddown
2335 ans = ans._fix(context)
2336 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002337
2338 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002339 """Return True if self and other have the same exponent; otherwise
2340 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002341
Facundo Batista1a191df2007-10-02 17:01:24 +00002342 If either operand is a special value, the following rules are used:
2343 * return True if both operands are infinities
2344 * return True if both operands are NaNs
2345 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002346 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002347 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002348 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002349 return (self.is_nan() and other.is_nan() or
2350 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002351 return self._exp == other._exp
2352
Facundo Batista353750c2007-09-13 18:13:15 +00002353 def _rescale(self, exp, rounding):
2354 """Rescale self so that the exponent is exp, either by padding with zeros
2355 or by truncating digits, using the given rounding mode.
2356
2357 Specials are returned without change. This operation is
2358 quiet: it raises no flags, and uses no information from the
2359 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002360
2361 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002362 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002363 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002364 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002365 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002366 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002367 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002368
Facundo Batista353750c2007-09-13 18:13:15 +00002369 if self._exp >= exp:
2370 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002371 return _dec_from_triple(self._sign,
2372 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002373
Facundo Batista353750c2007-09-13 18:13:15 +00002374 # too many digits; round and lose data. If self.adjusted() <
2375 # exp-1, replace self by 10**(exp-1) before rounding
2376 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002377 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002378 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002379 digits = 0
2380 this_function = getattr(self, self._pick_rounding_function[rounding])
Facundo Batista2ec74152007-12-03 17:55:00 +00002381 changed = this_function(digits)
2382 coeff = self._int[:digits] or '0'
2383 if changed == 1:
2384 coeff = str(int(coeff)+1)
2385 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002386
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002387 def _round(self, places, rounding):
2388 """Round a nonzero, nonspecial Decimal to a fixed number of
2389 significant figures, using the given rounding mode.
2390
2391 Infinities, NaNs and zeros are returned unaltered.
2392
2393 This operation is quiet: it raises no flags, and uses no
2394 information from the context.
2395
2396 """
2397 if places <= 0:
2398 raise ValueError("argument should be at least 1 in _round")
2399 if self._is_special or not self:
2400 return Decimal(self)
2401 ans = self._rescale(self.adjusted()+1-places, rounding)
2402 # it can happen that the rescale alters the adjusted exponent;
2403 # for example when rounding 99.97 to 3 significant figures.
2404 # When this happens we end up with an extra 0 at the end of
2405 # the number; a second rescale fixes this.
2406 if ans.adjusted() != self.adjusted():
2407 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2408 return ans
2409
Facundo Batista353750c2007-09-13 18:13:15 +00002410 def to_integral_exact(self, rounding=None, context=None):
2411 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002412
Facundo Batista353750c2007-09-13 18:13:15 +00002413 If no rounding mode is specified, take the rounding mode from
2414 the context. This method raises the Rounded and Inexact flags
2415 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002416
Facundo Batista353750c2007-09-13 18:13:15 +00002417 See also: to_integral_value, which does exactly the same as
2418 this method except that it doesn't raise Inexact or Rounded.
2419 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002420 if self._is_special:
2421 ans = self._check_nans(context=context)
2422 if ans:
2423 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002424 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002425 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002426 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002427 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002428 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002429 if context is None:
2430 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002431 if rounding is None:
2432 rounding = context.rounding
2433 context._raise_error(Rounded)
2434 ans = self._rescale(0, rounding)
2435 if ans != self:
2436 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002437 return ans
2438
Facundo Batista353750c2007-09-13 18:13:15 +00002439 def to_integral_value(self, rounding=None, context=None):
2440 """Rounds to the nearest integer, without raising inexact, rounded."""
2441 if context is None:
2442 context = getcontext()
2443 if rounding is None:
2444 rounding = context.rounding
2445 if self._is_special:
2446 ans = self._check_nans(context=context)
2447 if ans:
2448 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002449 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002450 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002451 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002452 else:
2453 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002454
Facundo Batista353750c2007-09-13 18:13:15 +00002455 # the method name changed, but we provide also the old one, for compatibility
2456 to_integral = to_integral_value
2457
2458 def sqrt(self, context=None):
2459 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002460 if context is None:
2461 context = getcontext()
2462
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002463 if self._is_special:
2464 ans = self._check_nans(context=context)
2465 if ans:
2466 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002467
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002468 if self._isinfinity() and self._sign == 0:
2469 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002470
2471 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002472 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002473 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002474 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002475
2476 if self._sign == 1:
2477 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2478
Facundo Batista353750c2007-09-13 18:13:15 +00002479 # At this point self represents a positive number. Let p be
2480 # the desired precision and express self in the form c*100**e
2481 # with c a positive real number and e an integer, c and e
2482 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2483 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2484 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2485 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2486 # the closest integer to sqrt(c) with the even integer chosen
2487 # in the case of a tie.
2488 #
2489 # To ensure correct rounding in all cases, we use the
2490 # following trick: we compute the square root to an extra
2491 # place (precision p+1 instead of precision p), rounding down.
2492 # Then, if the result is inexact and its last digit is 0 or 5,
2493 # we increase the last digit to 1 or 6 respectively; if it's
2494 # exact we leave the last digit alone. Now the final round to
2495 # p places (or fewer in the case of underflow) will round
2496 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002497
Facundo Batista353750c2007-09-13 18:13:15 +00002498 # use an extra digit of precision
2499 prec = context.prec+1
2500
2501 # write argument in the form c*100**e where e = self._exp//2
2502 # is the 'ideal' exponent, to be used if the square root is
2503 # exactly representable. l is the number of 'digits' of c in
2504 # base 100, so that 100**(l-1) <= c < 100**l.
2505 op = _WorkRep(self)
2506 e = op.exp >> 1
2507 if op.exp & 1:
2508 c = op.int * 10
2509 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002510 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002511 c = op.int
2512 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002513
Facundo Batista353750c2007-09-13 18:13:15 +00002514 # rescale so that c has exactly prec base 100 'digits'
2515 shift = prec-l
2516 if shift >= 0:
2517 c *= 100**shift
2518 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002519 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002520 c, remainder = divmod(c, 100**-shift)
2521 exact = not remainder
2522 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002523
Facundo Batista353750c2007-09-13 18:13:15 +00002524 # find n = floor(sqrt(c)) using Newton's method
2525 n = 10**prec
2526 while True:
2527 q = c//n
2528 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002529 break
Facundo Batista353750c2007-09-13 18:13:15 +00002530 else:
2531 n = n + q >> 1
2532 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002533
Facundo Batista353750c2007-09-13 18:13:15 +00002534 if exact:
2535 # result is exact; rescale to use ideal exponent e
2536 if shift >= 0:
2537 # assert n % 10**shift == 0
2538 n //= 10**shift
2539 else:
2540 n *= 10**-shift
2541 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002542 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002543 # result is not exact; fix last digit as described above
2544 if n % 5 == 0:
2545 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002546
Facundo Batista72bc54f2007-11-23 17:59:00 +00002547 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002548
Facundo Batista353750c2007-09-13 18:13:15 +00002549 # round, and fit to current context
2550 context = context._shallow_copy()
2551 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002552 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002553 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002554
Facundo Batista353750c2007-09-13 18:13:15 +00002555 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002556
2557 def max(self, other, context=None):
2558 """Returns the larger value.
2559
Facundo Batista353750c2007-09-13 18:13:15 +00002560 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002561 NaN (and signals if one is sNaN). Also rounds.
2562 """
Facundo Batista353750c2007-09-13 18:13:15 +00002563 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002564
Facundo Batista6c398da2007-09-17 17:30:13 +00002565 if context is None:
2566 context = getcontext()
2567
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002568 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002569 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002570 # number is always returned
2571 sn = self._isnan()
2572 on = other._isnan()
2573 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00002574 if on == 1 and sn == 0:
2575 return self._fix(context)
2576 if sn == 1 and on == 0:
2577 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002578 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002579
Mark Dickinson2fc92632008-02-06 22:10:50 +00002580 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002581 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002582 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002583 # then an ordering is applied:
2584 #
Facundo Batista59c58842007-04-10 12:58:45 +00002585 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002586 # positive sign and min returns the operand with the negative sign
2587 #
Facundo Batista59c58842007-04-10 12:58:45 +00002588 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002589 # the result. This is exactly the ordering used in compare_total.
2590 c = self.compare_total(other)
2591
2592 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002593 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002594 else:
2595 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002596
Facundo Batistae64acfa2007-12-17 14:18:42 +00002597 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002598
2599 def min(self, other, context=None):
2600 """Returns the smaller value.
2601
Facundo Batista59c58842007-04-10 12:58:45 +00002602 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002603 NaN (and signals if one is sNaN). Also rounds.
2604 """
Facundo Batista353750c2007-09-13 18:13:15 +00002605 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002606
Facundo Batista6c398da2007-09-17 17:30:13 +00002607 if context is None:
2608 context = getcontext()
2609
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002610 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002611 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002612 # number is always returned
2613 sn = self._isnan()
2614 on = other._isnan()
2615 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00002616 if on == 1 and sn == 0:
2617 return self._fix(context)
2618 if sn == 1 and on == 0:
2619 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002620 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002621
Mark Dickinson2fc92632008-02-06 22:10:50 +00002622 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002623 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002624 c = self.compare_total(other)
2625
2626 if c == -1:
2627 ans = self
2628 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002629 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002630
Facundo Batistae64acfa2007-12-17 14:18:42 +00002631 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002632
2633 def _isinteger(self):
2634 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002635 if self._is_special:
2636 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002637 if self._exp >= 0:
2638 return True
2639 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002640 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002641
2642 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002643 """Returns True if self is even. Assumes self is an integer."""
2644 if not self or self._exp > 0:
2645 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002646 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002647
2648 def adjusted(self):
2649 """Return the adjusted exponent of self"""
2650 try:
2651 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002652 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002653 except TypeError:
2654 return 0
2655
Facundo Batista353750c2007-09-13 18:13:15 +00002656 def canonical(self, context=None):
2657 """Returns the same Decimal object.
2658
2659 As we do not have different encodings for the same number, the
2660 received object already is in its canonical form.
2661 """
2662 return self
2663
2664 def compare_signal(self, other, context=None):
2665 """Compares self to the other operand numerically.
2666
2667 It's pretty much like compare(), but all NaNs signal, with signaling
2668 NaNs taking precedence over quiet NaNs.
2669 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002670 other = _convert_other(other, raiseit = True)
2671 ans = self._compare_check_nans(other, context)
2672 if ans:
2673 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002674 return self.compare(other, context=context)
2675
2676 def compare_total(self, other):
2677 """Compares self to other using the abstract representations.
2678
2679 This is not like the standard compare, which use their numerical
2680 value. Note that a total ordering is defined for all possible abstract
2681 representations.
2682 """
2683 # if one is negative and the other is positive, it's easy
2684 if self._sign and not other._sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002685 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002686 if not self._sign and other._sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002687 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002688 sign = self._sign
2689
2690 # let's handle both NaN types
2691 self_nan = self._isnan()
2692 other_nan = other._isnan()
2693 if self_nan or other_nan:
2694 if self_nan == other_nan:
Mark Dickinson7f265b72009-08-28 13:35:02 +00002695 # compare payloads as though they're integers
2696 self_key = len(self._int), self._int
2697 other_key = len(other._int), other._int
2698 if self_key < other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002699 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002700 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002701 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002702 return _NegativeOne
Mark Dickinson7f265b72009-08-28 13:35:02 +00002703 if self_key > other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002704 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002705 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002706 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002707 return _One
2708 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002709
2710 if sign:
2711 if self_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002712 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002713 if other_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002714 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002715 if self_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002716 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002717 if other_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002718 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002719 else:
2720 if self_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002721 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002722 if other_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002723 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002724 if self_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002725 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002726 if other_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002727 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002728
2729 if self < other:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002730 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002731 if self > other:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002732 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002733
2734 if self._exp < other._exp:
2735 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002736 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002737 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002738 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002739 if self._exp > other._exp:
2740 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002741 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002742 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002743 return _One
2744 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002745
2746
2747 def compare_total_mag(self, other):
2748 """Compares self to other using abstract repr., ignoring sign.
2749
2750 Like compare_total, but with operand's sign ignored and assumed to be 0.
2751 """
2752 s = self.copy_abs()
2753 o = other.copy_abs()
2754 return s.compare_total(o)
2755
2756 def copy_abs(self):
2757 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002758 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002759
2760 def copy_negate(self):
2761 """Returns a copy with the sign inverted."""
2762 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002763 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002764 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002765 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002766
2767 def copy_sign(self, other):
2768 """Returns self with the sign of other."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002769 return _dec_from_triple(other._sign, self._int,
2770 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002771
2772 def exp(self, context=None):
2773 """Returns e ** self."""
2774
2775 if context is None:
2776 context = getcontext()
2777
2778 # exp(NaN) = NaN
2779 ans = self._check_nans(context=context)
2780 if ans:
2781 return ans
2782
2783 # exp(-Infinity) = 0
2784 if self._isinfinity() == -1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002785 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002786
2787 # exp(0) = 1
2788 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002789 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002790
2791 # exp(Infinity) = Infinity
2792 if self._isinfinity() == 1:
2793 return Decimal(self)
2794
2795 # the result is now guaranteed to be inexact (the true
2796 # mathematical result is transcendental). There's no need to
2797 # raise Rounded and Inexact here---they'll always be raised as
2798 # a result of the call to _fix.
2799 p = context.prec
2800 adj = self.adjusted()
2801
2802 # we only need to do any computation for quite a small range
2803 # of adjusted exponents---for example, -29 <= adj <= 10 for
2804 # the default context. For smaller exponent the result is
2805 # indistinguishable from 1 at the given precision, while for
2806 # larger exponent the result either overflows or underflows.
2807 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2808 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002809 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002810 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2811 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002812 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002813 elif self._sign == 0 and adj < -p:
2814 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002815 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002816 elif self._sign == 1 and adj < -p-1:
2817 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002818 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002819 # general case
2820 else:
2821 op = _WorkRep(self)
2822 c, e = op.int, op.exp
2823 if op.sign == 1:
2824 c = -c
2825
2826 # compute correctly rounded result: increase precision by
2827 # 3 digits at a time until we get an unambiguously
2828 # roundable result
2829 extra = 3
2830 while True:
2831 coeff, exp = _dexp(c, e, p+extra)
2832 if coeff % (5*10**(len(str(coeff))-p-1)):
2833 break
2834 extra += 3
2835
Facundo Batista72bc54f2007-11-23 17:59:00 +00002836 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002837
2838 # at this stage, ans should round correctly with *any*
2839 # rounding mode, not just with ROUND_HALF_EVEN
2840 context = context._shallow_copy()
2841 rounding = context._set_rounding(ROUND_HALF_EVEN)
2842 ans = ans._fix(context)
2843 context.rounding = rounding
2844
2845 return ans
2846
2847 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002848 """Return True if self is canonical; otherwise return False.
2849
2850 Currently, the encoding of a Decimal instance is always
2851 canonical, so this method returns True for any Decimal.
2852 """
2853 return True
Facundo Batista353750c2007-09-13 18:13:15 +00002854
2855 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002856 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00002857
Facundo Batista1a191df2007-10-02 17:01:24 +00002858 A Decimal instance is considered finite if it is neither
2859 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00002860 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002861 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00002862
2863 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002864 """Return True if self is infinite; otherwise return False."""
2865 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00002866
2867 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002868 """Return True if self is a qNaN or sNaN; otherwise return False."""
2869 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00002870
2871 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002872 """Return True if self is a normal number; otherwise return False."""
2873 if self._is_special or not self:
2874 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002875 if context is None:
2876 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002877 return context.Emin <= self.adjusted() <= context.Emax
Facundo Batista353750c2007-09-13 18:13:15 +00002878
2879 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002880 """Return True if self is a quiet NaN; otherwise return False."""
2881 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00002882
2883 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002884 """Return True if self is negative; otherwise return False."""
2885 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00002886
2887 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002888 """Return True if self is a signaling NaN; otherwise return False."""
2889 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00002890
2891 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002892 """Return True if self is subnormal; otherwise return False."""
2893 if self._is_special or not self:
2894 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002895 if context is None:
2896 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002897 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00002898
2899 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002900 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002901 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00002902
2903 def _ln_exp_bound(self):
2904 """Compute a lower bound for the adjusted exponent of self.ln().
2905 In other words, compute r such that self.ln() >= 10**r. Assumes
2906 that self is finite and positive and that self != 1.
2907 """
2908
2909 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
2910 adj = self._exp + len(self._int) - 1
2911 if adj >= 1:
2912 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
2913 return len(str(adj*23//10)) - 1
2914 if adj <= -2:
2915 # argument <= 0.1
2916 return len(str((-1-adj)*23//10)) - 1
2917 op = _WorkRep(self)
2918 c, e = op.int, op.exp
2919 if adj == 0:
2920 # 1 < self < 10
2921 num = str(c-10**-e)
2922 den = str(c)
2923 return len(num) - len(den) - (num < den)
2924 # adj == -1, 0.1 <= self < 1
2925 return e + len(str(10**-e - c)) - 1
2926
2927
2928 def ln(self, context=None):
2929 """Returns the natural (base e) logarithm of self."""
2930
2931 if context is None:
2932 context = getcontext()
2933
2934 # ln(NaN) = NaN
2935 ans = self._check_nans(context=context)
2936 if ans:
2937 return ans
2938
2939 # ln(0.0) == -Infinity
2940 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002941 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00002942
2943 # ln(Infinity) = Infinity
2944 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002945 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00002946
2947 # ln(1.0) == 0.0
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002948 if self == _One:
2949 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002950
2951 # ln(negative) raises InvalidOperation
2952 if self._sign == 1:
2953 return context._raise_error(InvalidOperation,
2954 'ln of a negative value')
2955
2956 # result is irrational, so necessarily inexact
2957 op = _WorkRep(self)
2958 c, e = op.int, op.exp
2959 p = context.prec
2960
2961 # correctly rounded result: repeatedly increase precision by 3
2962 # until we get an unambiguously roundable result
2963 places = p - self._ln_exp_bound() + 2 # at least p+3 places
2964 while True:
2965 coeff = _dlog(c, e, places)
2966 # assert len(str(abs(coeff)))-p >= 1
2967 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
2968 break
2969 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00002970 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00002971
2972 context = context._shallow_copy()
2973 rounding = context._set_rounding(ROUND_HALF_EVEN)
2974 ans = ans._fix(context)
2975 context.rounding = rounding
2976 return ans
2977
2978 def _log10_exp_bound(self):
2979 """Compute a lower bound for the adjusted exponent of self.log10().
2980 In other words, find r such that self.log10() >= 10**r.
2981 Assumes that self is finite and positive and that self != 1.
2982 """
2983
2984 # For x >= 10 or x < 0.1 we only need a bound on the integer
2985 # part of log10(self), and this comes directly from the
2986 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
2987 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
2988 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
2989
2990 adj = self._exp + len(self._int) - 1
2991 if adj >= 1:
2992 # self >= 10
2993 return len(str(adj))-1
2994 if adj <= -2:
2995 # self < 0.1
2996 return len(str(-1-adj))-1
2997 op = _WorkRep(self)
2998 c, e = op.int, op.exp
2999 if adj == 0:
3000 # 1 < self < 10
3001 num = str(c-10**-e)
3002 den = str(231*c)
3003 return len(num) - len(den) - (num < den) + 2
3004 # adj == -1, 0.1 <= self < 1
3005 num = str(10**-e-c)
3006 return len(num) + e - (num < "231") - 1
3007
3008 def log10(self, context=None):
3009 """Returns the base 10 logarithm of self."""
3010
3011 if context is None:
3012 context = getcontext()
3013
3014 # log10(NaN) = NaN
3015 ans = self._check_nans(context=context)
3016 if ans:
3017 return ans
3018
3019 # log10(0.0) == -Infinity
3020 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003021 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003022
3023 # log10(Infinity) = Infinity
3024 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003025 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003026
3027 # log10(negative or -Infinity) raises InvalidOperation
3028 if self._sign == 1:
3029 return context._raise_error(InvalidOperation,
3030 'log10 of a negative value')
3031
3032 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003033 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003034 # answer may need rounding
3035 ans = Decimal(self._exp + len(self._int) - 1)
3036 else:
3037 # result is irrational, so necessarily inexact
3038 op = _WorkRep(self)
3039 c, e = op.int, op.exp
3040 p = context.prec
3041
3042 # correctly rounded result: repeatedly increase precision
3043 # until result is unambiguously roundable
3044 places = p-self._log10_exp_bound()+2
3045 while True:
3046 coeff = _dlog10(c, e, places)
3047 # assert len(str(abs(coeff)))-p >= 1
3048 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3049 break
3050 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003051 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003052
3053 context = context._shallow_copy()
3054 rounding = context._set_rounding(ROUND_HALF_EVEN)
3055 ans = ans._fix(context)
3056 context.rounding = rounding
3057 return ans
3058
3059 def logb(self, context=None):
3060 """ Returns the exponent of the magnitude of self's MSD.
3061
3062 The result is the integer which is the exponent of the magnitude
3063 of the most significant digit of self (as though it were truncated
3064 to a single digit while maintaining the value of that digit and
3065 without limiting the resulting exponent).
3066 """
3067 # logb(NaN) = NaN
3068 ans = self._check_nans(context=context)
3069 if ans:
3070 return ans
3071
3072 if context is None:
3073 context = getcontext()
3074
3075 # logb(+/-Inf) = +Inf
3076 if self._isinfinity():
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003077 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003078
3079 # logb(0) = -Inf, DivisionByZero
3080 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003081 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003082
3083 # otherwise, simply return the adjusted exponent of self, as a
3084 # Decimal. Note that no attempt is made to fit the result
3085 # into the current context.
3086 return Decimal(self.adjusted())
3087
3088 def _islogical(self):
3089 """Return True if self is a logical operand.
3090
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003091 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003092 an exponent of 0, and a coefficient whose digits must all be
3093 either 0 or 1.
3094 """
3095 if self._sign != 0 or self._exp != 0:
3096 return False
3097 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003098 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003099 return False
3100 return True
3101
3102 def _fill_logical(self, context, opa, opb):
3103 dif = context.prec - len(opa)
3104 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003105 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003106 elif dif < 0:
3107 opa = opa[-context.prec:]
3108 dif = context.prec - len(opb)
3109 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003110 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003111 elif dif < 0:
3112 opb = opb[-context.prec:]
3113 return opa, opb
3114
3115 def logical_and(self, other, context=None):
3116 """Applies an 'and' operation between self and other's digits."""
3117 if context is None:
3118 context = getcontext()
3119 if not self._islogical() or not other._islogical():
3120 return context._raise_error(InvalidOperation)
3121
3122 # fill to context.prec
3123 (opa, opb) = self._fill_logical(context, self._int, other._int)
3124
3125 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003126 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3127 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003128
3129 def logical_invert(self, context=None):
3130 """Invert all its digits."""
3131 if context is None:
3132 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003133 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3134 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003135
3136 def logical_or(self, other, context=None):
3137 """Applies an 'or' operation between self and other's digits."""
3138 if context is None:
3139 context = getcontext()
3140 if not self._islogical() or not other._islogical():
3141 return context._raise_error(InvalidOperation)
3142
3143 # fill to context.prec
3144 (opa, opb) = self._fill_logical(context, self._int, other._int)
3145
3146 # make the operation, and clean starting zeroes
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00003147 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003148 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003149
3150 def logical_xor(self, other, context=None):
3151 """Applies an 'xor' operation between self and other's digits."""
3152 if context is None:
3153 context = getcontext()
3154 if not self._islogical() or not other._islogical():
3155 return context._raise_error(InvalidOperation)
3156
3157 # fill to context.prec
3158 (opa, opb) = self._fill_logical(context, self._int, other._int)
3159
3160 # make the operation, and clean starting zeroes
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00003161 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003162 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003163
3164 def max_mag(self, other, context=None):
3165 """Compares the values numerically with their sign ignored."""
3166 other = _convert_other(other, raiseit=True)
3167
Facundo Batista6c398da2007-09-17 17:30:13 +00003168 if context is None:
3169 context = getcontext()
3170
Facundo Batista353750c2007-09-13 18:13:15 +00003171 if self._is_special or other._is_special:
3172 # If one operand is a quiet NaN and the other is number, then the
3173 # number is always returned
3174 sn = self._isnan()
3175 on = other._isnan()
3176 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00003177 if on == 1 and sn == 0:
3178 return self._fix(context)
3179 if sn == 1 and on == 0:
3180 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003181 return self._check_nans(other, context)
3182
Mark Dickinson2fc92632008-02-06 22:10:50 +00003183 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003184 if c == 0:
3185 c = self.compare_total(other)
3186
3187 if c == -1:
3188 ans = other
3189 else:
3190 ans = self
3191
Facundo Batistae64acfa2007-12-17 14:18:42 +00003192 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003193
3194 def min_mag(self, other, context=None):
3195 """Compares the values numerically with their sign ignored."""
3196 other = _convert_other(other, raiseit=True)
3197
Facundo Batista6c398da2007-09-17 17:30:13 +00003198 if context is None:
3199 context = getcontext()
3200
Facundo Batista353750c2007-09-13 18:13:15 +00003201 if self._is_special or other._is_special:
3202 # If one operand is a quiet NaN and the other is number, then the
3203 # number is always returned
3204 sn = self._isnan()
3205 on = other._isnan()
3206 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00003207 if on == 1 and sn == 0:
3208 return self._fix(context)
3209 if sn == 1 and on == 0:
3210 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003211 return self._check_nans(other, context)
3212
Mark Dickinson2fc92632008-02-06 22:10:50 +00003213 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003214 if c == 0:
3215 c = self.compare_total(other)
3216
3217 if c == -1:
3218 ans = self
3219 else:
3220 ans = other
3221
Facundo Batistae64acfa2007-12-17 14:18:42 +00003222 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003223
3224 def next_minus(self, context=None):
3225 """Returns the largest representable number smaller than itself."""
3226 if context is None:
3227 context = getcontext()
3228
3229 ans = self._check_nans(context=context)
3230 if ans:
3231 return ans
3232
3233 if self._isinfinity() == -1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003234 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003235 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003236 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003237
3238 context = context.copy()
3239 context._set_rounding(ROUND_FLOOR)
3240 context._ignore_all_flags()
3241 new_self = self._fix(context)
3242 if new_self != self:
3243 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003244 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3245 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003246
3247 def next_plus(self, context=None):
3248 """Returns the smallest representable number larger than itself."""
3249 if context is None:
3250 context = getcontext()
3251
3252 ans = self._check_nans(context=context)
3253 if ans:
3254 return ans
3255
3256 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003257 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003258 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003259 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003260
3261 context = context.copy()
3262 context._set_rounding(ROUND_CEILING)
3263 context._ignore_all_flags()
3264 new_self = self._fix(context)
3265 if new_self != self:
3266 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003267 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3268 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003269
3270 def next_toward(self, other, context=None):
3271 """Returns the number closest to self, in the direction towards other.
3272
3273 The result is the closest representable number to self
3274 (excluding self) that is in the direction towards other,
3275 unless both have the same value. If the two operands are
3276 numerically equal, then the result is a copy of self with the
3277 sign set to be the same as the sign of other.
3278 """
3279 other = _convert_other(other, raiseit=True)
3280
3281 if context is None:
3282 context = getcontext()
3283
3284 ans = self._check_nans(other, context)
3285 if ans:
3286 return ans
3287
Mark Dickinson2fc92632008-02-06 22:10:50 +00003288 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003289 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003290 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003291
3292 if comparison == -1:
3293 ans = self.next_plus(context)
3294 else: # comparison == 1
3295 ans = self.next_minus(context)
3296
3297 # decide which flags to raise using value of ans
3298 if ans._isinfinity():
3299 context._raise_error(Overflow,
3300 'Infinite result from next_toward',
3301 ans._sign)
3302 context._raise_error(Rounded)
3303 context._raise_error(Inexact)
3304 elif ans.adjusted() < context.Emin:
3305 context._raise_error(Underflow)
3306 context._raise_error(Subnormal)
3307 context._raise_error(Rounded)
3308 context._raise_error(Inexact)
3309 # if precision == 1 then we don't raise Clamped for a
3310 # result 0E-Etiny.
3311 if not ans:
3312 context._raise_error(Clamped)
3313
3314 return ans
3315
3316 def number_class(self, context=None):
3317 """Returns an indication of the class of self.
3318
3319 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003320 sNaN
3321 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003322 -Infinity
3323 -Normal
3324 -Subnormal
3325 -Zero
3326 +Zero
3327 +Subnormal
3328 +Normal
3329 +Infinity
3330 """
3331 if self.is_snan():
3332 return "sNaN"
3333 if self.is_qnan():
3334 return "NaN"
3335 inf = self._isinfinity()
3336 if inf == 1:
3337 return "+Infinity"
3338 if inf == -1:
3339 return "-Infinity"
3340 if self.is_zero():
3341 if self._sign:
3342 return "-Zero"
3343 else:
3344 return "+Zero"
3345 if context is None:
3346 context = getcontext()
3347 if self.is_subnormal(context=context):
3348 if self._sign:
3349 return "-Subnormal"
3350 else:
3351 return "+Subnormal"
3352 # just a normal, regular, boring number, :)
3353 if self._sign:
3354 return "-Normal"
3355 else:
3356 return "+Normal"
3357
3358 def radix(self):
3359 """Just returns 10, as this is Decimal, :)"""
3360 return Decimal(10)
3361
3362 def rotate(self, other, context=None):
3363 """Returns a rotated copy of self, value-of-other times."""
3364 if context is None:
3365 context = getcontext()
3366
3367 ans = self._check_nans(other, context)
3368 if ans:
3369 return ans
3370
3371 if other._exp != 0:
3372 return context._raise_error(InvalidOperation)
3373 if not (-context.prec <= int(other) <= context.prec):
3374 return context._raise_error(InvalidOperation)
3375
3376 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003377 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003378
3379 # get values, pad if necessary
3380 torot = int(other)
3381 rotdig = self._int
3382 topad = context.prec - len(rotdig)
3383 if topad:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003384 rotdig = '0'*topad + rotdig
Facundo Batista353750c2007-09-13 18:13:15 +00003385
3386 # let's rotate!
3387 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003388 return _dec_from_triple(self._sign,
3389 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003390
3391 def scaleb (self, other, context=None):
3392 """Returns self operand after adding the second value to its exp."""
3393 if context is None:
3394 context = getcontext()
3395
3396 ans = self._check_nans(other, context)
3397 if ans:
3398 return ans
3399
3400 if other._exp != 0:
3401 return context._raise_error(InvalidOperation)
3402 liminf = -2 * (context.Emax + context.prec)
3403 limsup = 2 * (context.Emax + context.prec)
3404 if not (liminf <= int(other) <= limsup):
3405 return context._raise_error(InvalidOperation)
3406
3407 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003408 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003409
Facundo Batista72bc54f2007-11-23 17:59:00 +00003410 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003411 d = d._fix(context)
3412 return d
3413
3414 def shift(self, other, context=None):
3415 """Returns a shifted copy of self, value-of-other times."""
3416 if context is None:
3417 context = getcontext()
3418
3419 ans = self._check_nans(other, context)
3420 if ans:
3421 return ans
3422
3423 if other._exp != 0:
3424 return context._raise_error(InvalidOperation)
3425 if not (-context.prec <= int(other) <= context.prec):
3426 return context._raise_error(InvalidOperation)
3427
3428 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003429 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003430
3431 # get values, pad if necessary
3432 torot = int(other)
3433 if not torot:
Facundo Batista6c398da2007-09-17 17:30:13 +00003434 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003435 rotdig = self._int
3436 topad = context.prec - len(rotdig)
3437 if topad:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003438 rotdig = '0'*topad + rotdig
Facundo Batista353750c2007-09-13 18:13:15 +00003439
3440 # let's shift!
3441 if torot < 0:
3442 rotated = rotdig[:torot]
3443 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003444 rotated = rotdig + '0'*torot
Facundo Batista353750c2007-09-13 18:13:15 +00003445 rotated = rotated[-context.prec:]
3446
Facundo Batista72bc54f2007-11-23 17:59:00 +00003447 return _dec_from_triple(self._sign,
3448 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003449
Facundo Batista59c58842007-04-10 12:58:45 +00003450 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003451 def __reduce__(self):
3452 return (self.__class__, (str(self),))
3453
3454 def __copy__(self):
3455 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003456 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003457 return self.__class__(str(self))
3458
3459 def __deepcopy__(self, memo):
3460 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003461 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003462 return self.__class__(str(self))
3463
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003464 # PEP 3101 support. See also _parse_format_specifier and _format_align
3465 def __format__(self, specifier, context=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003466 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003467
3468 The specifier should be a standard format specifier, with the
3469 form described in PEP 3101. Formatting types 'e', 'E', 'f',
3470 'F', 'g', 'G', and '%' are supported. If the formatting type
3471 is omitted it defaults to 'g' or 'G', depending on the value
3472 of context.capitals.
3473
3474 At this time the 'n' format specifier type (which is supposed
3475 to use the current locale) is not supported.
3476 """
3477
3478 # Note: PEP 3101 says that if the type is not present then
3479 # there should be at least one digit after the decimal point.
3480 # We take the liberty of ignoring this requirement for
3481 # Decimal---it's presumably there to make sure that
3482 # format(float, '') behaves similarly to str(float).
3483 if context is None:
3484 context = getcontext()
3485
3486 spec = _parse_format_specifier(specifier)
3487
3488 # special values don't care about the type or precision...
3489 if self._is_special:
3490 return _format_align(str(self), spec)
3491
3492 # a type of None defaults to 'g' or 'G', depending on context
3493 # if type is '%', adjust exponent of self accordingly
3494 if spec['type'] is None:
3495 spec['type'] = ['g', 'G'][context.capitals]
3496 elif spec['type'] == '%':
3497 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3498
3499 # round if necessary, taking rounding mode from the context
3500 rounding = context.rounding
3501 precision = spec['precision']
3502 if precision is not None:
3503 if spec['type'] in 'eE':
3504 self = self._round(precision+1, rounding)
3505 elif spec['type'] in 'gG':
3506 if len(self._int) > precision:
3507 self = self._round(precision, rounding)
3508 elif spec['type'] in 'fF%':
3509 self = self._rescale(-precision, rounding)
3510 # special case: zeros with a positive exponent can't be
3511 # represented in fixed point; rescale them to 0e0.
3512 elif not self and self._exp > 0 and spec['type'] in 'fF%':
3513 self = self._rescale(0, rounding)
3514
3515 # figure out placement of the decimal point
3516 leftdigits = self._exp + len(self._int)
3517 if spec['type'] in 'fF%':
3518 dotplace = leftdigits
3519 elif spec['type'] in 'eE':
3520 if not self and precision is not None:
3521 dotplace = 1 - precision
3522 else:
3523 dotplace = 1
3524 elif spec['type'] in 'gG':
3525 if self._exp <= 0 and leftdigits > -6:
3526 dotplace = leftdigits
3527 else:
3528 dotplace = 1
3529
3530 # figure out main part of numeric string...
3531 if dotplace <= 0:
3532 num = '0.' + '0'*(-dotplace) + self._int
3533 elif dotplace >= len(self._int):
3534 # make sure we're not padding a '0' with extra zeros on the right
3535 assert dotplace==len(self._int) or self._int != '0'
3536 num = self._int + '0'*(dotplace-len(self._int))
3537 else:
3538 num = self._int[:dotplace] + '.' + self._int[dotplace:]
3539
3540 # ...then the trailing exponent, or trailing '%'
3541 if leftdigits != dotplace or spec['type'] in 'eE':
3542 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
3543 num = num + "{0}{1:+}".format(echar, leftdigits-dotplace)
3544 elif spec['type'] == '%':
3545 num = num + '%'
3546
3547 # add sign
3548 if self._sign == 1:
3549 num = '-' + num
3550 return _format_align(num, spec)
3551
3552
Facundo Batista72bc54f2007-11-23 17:59:00 +00003553def _dec_from_triple(sign, coefficient, exponent, special=False):
3554 """Create a decimal instance directly, without any validation,
3555 normalization (e.g. removal of leading zeros) or argument
3556 conversion.
3557
3558 This function is for *internal use only*.
3559 """
3560
3561 self = object.__new__(Decimal)
3562 self._sign = sign
3563 self._int = coefficient
3564 self._exp = exponent
3565 self._is_special = special
3566
3567 return self
3568
Raymond Hettinger45fd4762009-02-03 03:42:07 +00003569# Register Decimal as a kind of Number (an abstract base class).
3570# However, do not register it as Real (because Decimals are not
3571# interoperable with floats).
3572_numbers.Number.register(Decimal)
3573
3574
Facundo Batista59c58842007-04-10 12:58:45 +00003575##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003576
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003577
3578# get rounding method function:
Facundo Batista59c58842007-04-10 12:58:45 +00003579rounding_functions = [name for name in Decimal.__dict__.keys()
3580 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003581for name in rounding_functions:
Facundo Batista59c58842007-04-10 12:58:45 +00003582 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003583 globalname = name[1:].upper()
3584 val = globals()[globalname]
3585 Decimal._pick_rounding_function[val] = name
3586
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003587del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003588
Nick Coghlanced12182006-09-02 03:54:17 +00003589class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003590 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003591
Nick Coghlanced12182006-09-02 03:54:17 +00003592 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003593 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003594 """
3595 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003596 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003597 def __enter__(self):
3598 self.saved_context = getcontext()
3599 setcontext(self.new_context)
3600 return self.new_context
3601 def __exit__(self, t, v, tb):
3602 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003603
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003604class Context(object):
3605 """Contains the context for a Decimal instance.
3606
3607 Contains:
3608 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003609 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003610 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003611 raised when it is caused. Otherwise, a value is
3612 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003613 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003614 (Whether or not the trap_enabler is set)
3615 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003616 Emin - Minimum exponent
3617 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003618 capitals - If 1, 1*10^1 is printed as 1E+1.
3619 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003620 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003621 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003622
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003623 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003624 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003625 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003626 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003627 _ignored_flags=None):
3628 if flags is None:
3629 flags = []
3630 if _ignored_flags is None:
3631 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003632 if not isinstance(flags, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003633 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003634 del s
Raymond Hettingerbf440692004-07-10 14:14:37 +00003635 if traps is not None and not isinstance(traps, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003636 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003637 del s
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003638 for name, val in locals().items():
3639 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003640 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003641 else:
3642 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003643 del self.self
3644
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003645 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003646 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003647 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003648 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3649 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3650 % vars(self))
3651 names = [f.__name__ for f, v in self.flags.items() if v]
3652 s.append('flags=[' + ', '.join(names) + ']')
3653 names = [t.__name__ for t, v in self.traps.items() if v]
3654 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003655 return ', '.join(s) + ')'
3656
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003657 def clear_flags(self):
3658 """Reset all flags to zero"""
3659 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003660 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003661
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003662 def _shallow_copy(self):
3663 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003664 nc = Context(self.prec, self.rounding, self.traps,
3665 self.flags, self.Emin, self.Emax,
3666 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003667 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003668
3669 def copy(self):
3670 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003671 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003672 self.flags.copy(), self.Emin, self.Emax,
3673 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003674 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003675 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003676
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003677 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003678 """Handles an error
3679
3680 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003681 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003682 trap_enabler is set, it reaises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003683 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003684 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003685 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003686 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003687 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003688 return error().handle(self, *args)
3689
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003690 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003691 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003692 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003693 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003694
3695 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003696 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003697 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003698
3699 def _ignore_all_flags(self):
3700 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003701 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003702
3703 def _ignore_flags(self, *flags):
3704 """Ignore the flags, if they are raised"""
3705 # Do not mutate-- This way, copies of a context leave the original
3706 # alone.
3707 self._ignored_flags = (self._ignored_flags + list(flags))
3708 return list(flags)
3709
3710 def _regard_flags(self, *flags):
3711 """Stop ignoring the flags, if they are raised"""
3712 if flags and isinstance(flags[0], (tuple,list)):
3713 flags = flags[0]
3714 for flag in flags:
3715 self._ignored_flags.remove(flag)
3716
Nick Coghlan53663a62008-07-15 14:27:37 +00003717 # We inherit object.__hash__, so we must deny this explicitly
3718 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003719
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003720 def Etiny(self):
3721 """Returns Etiny (= Emin - prec + 1)"""
3722 return int(self.Emin - self.prec + 1)
3723
3724 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003725 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003726 return int(self.Emax - self.prec + 1)
3727
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003728 def _set_rounding(self, type):
3729 """Sets the rounding type.
3730
3731 Sets the rounding type, and returns the current (previous)
3732 rounding type. Often used like:
3733
3734 context = context.copy()
3735 # so you don't change the calling context
3736 # if an error occurs in the middle.
3737 rounding = context._set_rounding(ROUND_UP)
3738 val = self.__sub__(other, context=context)
3739 context._set_rounding(rounding)
3740
3741 This will make it round up for that operation.
3742 """
3743 rounding = self.rounding
3744 self.rounding= type
3745 return rounding
3746
Raymond Hettingerfed52962004-07-14 15:41:57 +00003747 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003748 """Creates a new Decimal instance but using self as context.
3749
3750 This method implements the to-number operation of the
3751 IBM Decimal specification."""
3752
3753 if isinstance(num, basestring) and num != num.strip():
3754 return self._raise_error(ConversionSyntax,
3755 "no trailing or leading whitespace is "
3756 "permitted.")
3757
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003758 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003759 if d._isnan() and len(d._int) > self.prec - self._clamp:
3760 return self._raise_error(ConversionSyntax,
3761 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003762 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003763
Facundo Batista59c58842007-04-10 12:58:45 +00003764 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003765 def abs(self, a):
3766 """Returns the absolute value of the operand.
3767
3768 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003769 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003770 the plus operation on the operand.
3771
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003772 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003773 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003774 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003775 Decimal('100')
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 Hettinger9ec3e3b2004-07-03 13:48:56 +00003778 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003779 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003780 """
3781 return a.__abs__(context=self)
3782
3783 def add(self, a, b):
3784 """Return the sum of the two operands.
3785
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003786 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003787 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003788 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003789 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003790 """
3791 return a.__add__(b, context=self)
3792
3793 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003794 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003795
Facundo Batista353750c2007-09-13 18:13:15 +00003796 def canonical(self, a):
3797 """Returns the same Decimal object.
3798
3799 As we do not have different encodings for the same number, the
3800 received object already is in its canonical form.
3801
3802 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003803 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003804 """
3805 return a.canonical(context=self)
3806
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003807 def compare(self, a, b):
3808 """Compares values numerically.
3809
3810 If the signs of the operands differ, a value representing each operand
3811 ('-1' if the operand is less than zero, '0' if the operand is zero or
3812 negative zero, or '1' if the operand is greater than zero) is used in
3813 place of that operand for the comparison instead of the actual
3814 operand.
3815
3816 The comparison is then effected by subtracting the second operand from
3817 the first and then returning a value according to the result of the
3818 subtraction: '-1' if the result is less than zero, '0' if the result is
3819 zero or negative zero, or '1' if the result is greater than zero.
3820
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003821 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003822 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003823 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003824 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003825 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003826 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003827 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003828 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003829 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003830 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003831 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003832 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003833 """
3834 return a.compare(b, context=self)
3835
Facundo Batista353750c2007-09-13 18:13:15 +00003836 def compare_signal(self, a, b):
3837 """Compares the values of the two operands numerically.
3838
3839 It's pretty much like compare(), but all NaNs signal, with signaling
3840 NaNs taking precedence over quiet NaNs.
3841
3842 >>> c = ExtendedContext
3843 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003844 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003845 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003846 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003847 >>> c.flags[InvalidOperation] = 0
3848 >>> print c.flags[InvalidOperation]
3849 0
3850 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003851 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003852 >>> print c.flags[InvalidOperation]
3853 1
3854 >>> c.flags[InvalidOperation] = 0
3855 >>> print c.flags[InvalidOperation]
3856 0
3857 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003858 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003859 >>> print c.flags[InvalidOperation]
3860 1
3861 """
3862 return a.compare_signal(b, context=self)
3863
3864 def compare_total(self, a, b):
3865 """Compares two operands using their abstract representation.
3866
3867 This is not like the standard compare, which use their numerical
3868 value. Note that a total ordering is defined for all possible abstract
3869 representations.
3870
3871 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003872 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003873 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
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.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003876 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003877 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003878 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003879 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003880 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00003881 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003882 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003883 """
3884 return a.compare_total(b)
3885
3886 def compare_total_mag(self, a, b):
3887 """Compares two operands using their abstract representation ignoring sign.
3888
3889 Like compare_total, but with operand's sign ignored and assumed to be 0.
3890 """
3891 return a.compare_total_mag(b)
3892
3893 def copy_abs(self, a):
3894 """Returns a copy of the operand with the sign set to 0.
3895
3896 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003897 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003898 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003899 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00003900 """
3901 return a.copy_abs()
3902
3903 def copy_decimal(self, a):
3904 """Returns a copy of the decimal objet.
3905
3906 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003907 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003908 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003909 Decimal('-1.00')
Facundo Batista353750c2007-09-13 18:13:15 +00003910 """
Facundo Batista6c398da2007-09-17 17:30:13 +00003911 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00003912
3913 def copy_negate(self, a):
3914 """Returns a copy of the operand with the sign inverted.
3915
3916 >>> 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 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003919 Decimal('101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003920 """
3921 return a.copy_negate()
3922
3923 def copy_sign(self, a, b):
3924 """Copies the second operand's sign to the first one.
3925
3926 In detail, it returns a copy of the first operand with the sign
3927 equal to the sign of the second operand.
3928
3929 >>> 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 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003936 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003937 """
3938 return a.copy_sign(b)
3939
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003940 def divide(self, a, b):
3941 """Decimal division in a specified context.
3942
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003943 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003944 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003945 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003946 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003947 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003948 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003949 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003950 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003951 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003952 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003953 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003954 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003955 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003956 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003957 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003958 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003959 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003960 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003961 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003962 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003963 """
3964 return a.__div__(b, context=self)
3965
3966 def divide_int(self, a, b):
3967 """Divides two numbers and returns the integer part of the result.
3968
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003969 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003970 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003971 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003972 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003973 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003974 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003975 """
3976 return a.__floordiv__(b, context=self)
3977
3978 def divmod(self, a, b):
3979 return a.__divmod__(b, context=self)
3980
Facundo Batista353750c2007-09-13 18:13:15 +00003981 def exp(self, a):
3982 """Returns e ** a.
3983
3984 >>> c = ExtendedContext.copy()
3985 >>> c.Emin = -999
3986 >>> c.Emax = 999
3987 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003988 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003989 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003990 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00003991 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003992 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00003993 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003994 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00003995 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003996 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00003997 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003998 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00003999 """
4000 return a.exp(context=self)
4001
4002 def fma(self, a, b, c):
4003 """Returns a multiplied by b, plus c.
4004
4005 The first two operands are multiplied together, using multiply,
4006 the third operand is then added to the result of that
4007 multiplication, using add, all with only one final rounding.
4008
4009 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004010 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004011 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004012 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004013 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004014 Decimal('1.38435736E+12')
Facundo Batista353750c2007-09-13 18:13:15 +00004015 """
4016 return a.fma(b, c, context=self)
4017
4018 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004019 """Return True if the operand is canonical; otherwise return False.
4020
4021 Currently, the encoding of a Decimal instance is always
4022 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004023
4024 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004025 True
Facundo Batista353750c2007-09-13 18:13:15 +00004026 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004027 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004028
4029 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004030 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004031
Facundo Batista1a191df2007-10-02 17:01:24 +00004032 A Decimal instance is considered finite if it is neither
4033 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004034
4035 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004036 True
Facundo Batista353750c2007-09-13 18:13:15 +00004037 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004038 True
Facundo Batista353750c2007-09-13 18:13:15 +00004039 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004040 True
Facundo Batista353750c2007-09-13 18:13:15 +00004041 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004042 False
Facundo Batista353750c2007-09-13 18:13:15 +00004043 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004044 False
Facundo Batista353750c2007-09-13 18:13:15 +00004045 """
4046 return a.is_finite()
4047
4048 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004049 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004050
4051 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004052 False
Facundo Batista353750c2007-09-13 18:13:15 +00004053 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004054 True
Facundo Batista353750c2007-09-13 18:13:15 +00004055 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004056 False
Facundo Batista353750c2007-09-13 18:13:15 +00004057 """
4058 return a.is_infinite()
4059
4060 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004061 """Return True if the operand is a qNaN or sNaN;
4062 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004063
4064 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004065 False
Facundo Batista353750c2007-09-13 18:13:15 +00004066 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004067 True
Facundo Batista353750c2007-09-13 18:13:15 +00004068 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004069 True
Facundo Batista353750c2007-09-13 18:13:15 +00004070 """
4071 return a.is_nan()
4072
4073 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004074 """Return True if the operand is a normal number;
4075 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004076
4077 >>> c = ExtendedContext.copy()
4078 >>> c.Emin = -999
4079 >>> c.Emax = 999
4080 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004081 True
Facundo Batista353750c2007-09-13 18:13:15 +00004082 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004083 False
Facundo Batista353750c2007-09-13 18:13:15 +00004084 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004085 False
Facundo Batista353750c2007-09-13 18:13:15 +00004086 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004087 False
Facundo Batista353750c2007-09-13 18:13:15 +00004088 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004089 False
Facundo Batista353750c2007-09-13 18:13:15 +00004090 """
4091 return a.is_normal(context=self)
4092
4093 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004094 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004095
4096 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004097 False
Facundo Batista353750c2007-09-13 18:13:15 +00004098 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004099 True
Facundo Batista353750c2007-09-13 18:13:15 +00004100 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004101 False
Facundo Batista353750c2007-09-13 18:13:15 +00004102 """
4103 return a.is_qnan()
4104
4105 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004106 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004107
4108 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004109 False
Facundo Batista353750c2007-09-13 18:13:15 +00004110 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004111 True
Facundo Batista353750c2007-09-13 18:13:15 +00004112 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004113 True
Facundo Batista353750c2007-09-13 18:13:15 +00004114 """
4115 return a.is_signed()
4116
4117 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004118 """Return True if the operand is a signaling NaN;
4119 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004120
4121 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004122 False
Facundo Batista353750c2007-09-13 18:13:15 +00004123 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004124 False
Facundo Batista353750c2007-09-13 18:13:15 +00004125 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004126 True
Facundo Batista353750c2007-09-13 18:13:15 +00004127 """
4128 return a.is_snan()
4129
4130 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004131 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004132
4133 >>> c = ExtendedContext.copy()
4134 >>> c.Emin = -999
4135 >>> c.Emax = 999
4136 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004137 False
Facundo Batista353750c2007-09-13 18:13:15 +00004138 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004139 True
Facundo Batista353750c2007-09-13 18:13:15 +00004140 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004141 False
Facundo Batista353750c2007-09-13 18:13:15 +00004142 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004143 False
Facundo Batista353750c2007-09-13 18:13:15 +00004144 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004145 False
Facundo Batista353750c2007-09-13 18:13:15 +00004146 """
4147 return a.is_subnormal(context=self)
4148
4149 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004150 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004151
4152 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004153 True
Facundo Batista353750c2007-09-13 18:13:15 +00004154 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004155 False
Facundo Batista353750c2007-09-13 18:13:15 +00004156 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004157 True
Facundo Batista353750c2007-09-13 18:13:15 +00004158 """
4159 return a.is_zero()
4160
4161 def ln(self, a):
4162 """Returns the natural (base e) logarithm of the operand.
4163
4164 >>> c = ExtendedContext.copy()
4165 >>> c.Emin = -999
4166 >>> c.Emax = 999
4167 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004168 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004169 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004170 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004171 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004172 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004173 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004174 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004175 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004176 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004177 """
4178 return a.ln(context=self)
4179
4180 def log10(self, a):
4181 """Returns the base 10 logarithm of the operand.
4182
4183 >>> c = ExtendedContext.copy()
4184 >>> c.Emin = -999
4185 >>> c.Emax = 999
4186 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004187 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004188 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004189 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004190 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004191 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004192 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004193 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004194 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004195 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004196 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004197 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004198 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004199 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004200 """
4201 return a.log10(context=self)
4202
4203 def logb(self, a):
4204 """ Returns the exponent of the magnitude of the operand's MSD.
4205
4206 The result is the integer which is the exponent of the magnitude
4207 of the most significant digit of the operand (as though the
4208 operand were truncated to a single digit while maintaining the
4209 value of that digit and without limiting the resulting exponent).
4210
4211 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004212 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004213 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004214 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004215 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004216 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004217 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004218 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004219 """
4220 return a.logb(context=self)
4221
4222 def logical_and(self, a, b):
4223 """Applies the logical operation 'and' between each operand's digits.
4224
4225 The operands must be both logical numbers.
4226
4227 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004228 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004229 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004230 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004231 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004232 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004233 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004234 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004235 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004236 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004237 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004238 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004239 """
4240 return a.logical_and(b, context=self)
4241
4242 def logical_invert(self, a):
4243 """Invert all the digits in the operand.
4244
4245 The operand must be a logical number.
4246
4247 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004248 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004249 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004250 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004251 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004252 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004253 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004254 Decimal('10101010')
Facundo Batista353750c2007-09-13 18:13:15 +00004255 """
4256 return a.logical_invert(context=self)
4257
4258 def logical_or(self, a, b):
4259 """Applies the logical operation 'or' between each operand's digits.
4260
4261 The operands must be both logical numbers.
4262
4263 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004264 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004265 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004266 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004267 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004268 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004269 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004270 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004271 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004272 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004273 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004274 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004275 """
4276 return a.logical_or(b, context=self)
4277
4278 def logical_xor(self, a, b):
4279 """Applies the logical operation 'xor' between each operand's digits.
4280
4281 The operands must be both logical numbers.
4282
4283 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004284 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004285 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004286 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004287 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004288 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004289 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004290 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004291 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004292 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004293 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004294 Decimal('1101')
Facundo Batista353750c2007-09-13 18:13:15 +00004295 """
4296 return a.logical_xor(b, context=self)
4297
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004298 def max(self, a,b):
4299 """max compares two values numerically and returns the maximum.
4300
4301 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004302 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004303 operation. If they are numerically equal then the left-hand operand
4304 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004305 infinity) of the two operands is chosen as the result.
4306
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004307 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004308 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004309 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004310 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004311 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004312 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004313 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004314 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004315 """
4316 return a.max(b, context=self)
4317
Facundo Batista353750c2007-09-13 18:13:15 +00004318 def max_mag(self, a, b):
4319 """Compares the values numerically with their sign ignored."""
4320 return a.max_mag(b, context=self)
4321
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004322 def min(self, a,b):
4323 """min compares two values numerically and returns the minimum.
4324
4325 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004326 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004327 operation. If they are numerically equal then the left-hand operand
4328 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004329 infinity) of the two operands is chosen as the result.
4330
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004331 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004332 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004333 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004334 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004335 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004336 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004337 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004338 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004339 """
4340 return a.min(b, context=self)
4341
Facundo Batista353750c2007-09-13 18:13:15 +00004342 def min_mag(self, a, b):
4343 """Compares the values numerically with their sign ignored."""
4344 return a.min_mag(b, context=self)
4345
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004346 def minus(self, a):
4347 """Minus corresponds to unary prefix minus in Python.
4348
4349 The operation is evaluated using the same rules as subtract; the
4350 operation minus(a) is calculated as subtract('0', a) where the '0'
4351 has the same exponent as the operand.
4352
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 Hettinger9ec3e3b2004-07-03 13:48:56 +00004355 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004356 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004357 """
4358 return a.__neg__(context=self)
4359
4360 def multiply(self, a, b):
4361 """multiply multiplies two operands.
4362
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004363 If either operand is a special value then the general rules apply.
4364 Otherwise, the operands are multiplied together ('long multiplication'),
4365 resulting in a number which may be as long as the sum of the lengths
4366 of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004367
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004368 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004369 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004370 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004371 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004372 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004373 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004374 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004375 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004376 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004377 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004378 """
4379 return a.__mul__(b, context=self)
4380
Facundo Batista353750c2007-09-13 18:13:15 +00004381 def next_minus(self, a):
4382 """Returns the largest representable number smaller than a.
4383
4384 >>> c = ExtendedContext.copy()
4385 >>> c.Emin = -999
4386 >>> c.Emax = 999
4387 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004388 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004389 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004390 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004391 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004392 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004393 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004394 Decimal('9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004395 """
4396 return a.next_minus(context=self)
4397
4398 def next_plus(self, a):
4399 """Returns the smallest representable number larger than a.
4400
4401 >>> c = ExtendedContext.copy()
4402 >>> c.Emin = -999
4403 >>> c.Emax = 999
4404 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004405 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004406 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004407 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004408 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004409 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004410 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004411 Decimal('-9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004412 """
4413 return a.next_plus(context=self)
4414
4415 def next_toward(self, a, b):
4416 """Returns the number closest to a, in direction towards b.
4417
4418 The result is the closest representable number from the first
4419 operand (but not the first operand) that is in the direction
4420 towards the second operand, unless the operands have the same
4421 value.
4422
4423 >>> c = ExtendedContext.copy()
4424 >>> c.Emin = -999
4425 >>> c.Emax = 999
4426 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004427 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004428 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004429 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004430 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004431 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004432 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004433 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004434 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004435 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004436 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004437 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004438 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004439 Decimal('-0.00')
Facundo Batista353750c2007-09-13 18:13:15 +00004440 """
4441 return a.next_toward(b, context=self)
4442
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004443 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004444 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004445
4446 Essentially a plus operation with all trailing zeros removed from the
4447 result.
4448
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004449 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004450 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004451 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004452 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004453 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004454 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004455 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004456 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004457 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004458 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004459 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004460 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004461 """
4462 return a.normalize(context=self)
4463
Facundo Batista353750c2007-09-13 18:13:15 +00004464 def number_class(self, a):
4465 """Returns an indication of the class of the operand.
4466
4467 The class is one of the following strings:
4468 -sNaN
4469 -NaN
4470 -Infinity
4471 -Normal
4472 -Subnormal
4473 -Zero
4474 +Zero
4475 +Subnormal
4476 +Normal
4477 +Infinity
4478
4479 >>> c = Context(ExtendedContext)
4480 >>> c.Emin = -999
4481 >>> c.Emax = 999
4482 >>> c.number_class(Decimal('Infinity'))
4483 '+Infinity'
4484 >>> c.number_class(Decimal('1E-10'))
4485 '+Normal'
4486 >>> c.number_class(Decimal('2.50'))
4487 '+Normal'
4488 >>> c.number_class(Decimal('0.1E-999'))
4489 '+Subnormal'
4490 >>> c.number_class(Decimal('0'))
4491 '+Zero'
4492 >>> c.number_class(Decimal('-0'))
4493 '-Zero'
4494 >>> c.number_class(Decimal('-0.1E-999'))
4495 '-Subnormal'
4496 >>> c.number_class(Decimal('-1E-10'))
4497 '-Normal'
4498 >>> c.number_class(Decimal('-2.50'))
4499 '-Normal'
4500 >>> c.number_class(Decimal('-Infinity'))
4501 '-Infinity'
4502 >>> c.number_class(Decimal('NaN'))
4503 'NaN'
4504 >>> c.number_class(Decimal('-NaN'))
4505 'NaN'
4506 >>> c.number_class(Decimal('sNaN'))
4507 'sNaN'
4508 """
4509 return a.number_class(context=self)
4510
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004511 def plus(self, a):
4512 """Plus corresponds to unary prefix plus in Python.
4513
4514 The operation is evaluated using the same rules as add; the
4515 operation plus(a) is calculated as add('0', a) where the '0'
4516 has the same exponent as the operand.
4517
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 Hettinger9ec3e3b2004-07-03 13:48:56 +00004520 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004521 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004522 """
4523 return a.__pos__(context=self)
4524
4525 def power(self, a, b, modulo=None):
4526 """Raises a to the power of b, to modulo if given.
4527
Facundo Batista353750c2007-09-13 18:13:15 +00004528 With two arguments, compute a**b. If a is negative then b
4529 must be integral. The result will be inexact unless b is
4530 integral and the result is finite and can be expressed exactly
4531 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004532
Facundo Batista353750c2007-09-13 18:13:15 +00004533 With three arguments, compute (a**b) % modulo. For the
4534 three argument form, the following restrictions on the
4535 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004536
Facundo Batista353750c2007-09-13 18:13:15 +00004537 - all three arguments must be integral
4538 - b must be nonnegative
4539 - at least one of a or b must be nonzero
4540 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004541
Facundo Batista353750c2007-09-13 18:13:15 +00004542 The result of pow(a, b, modulo) is identical to the result
4543 that would be obtained by computing (a**b) % modulo with
4544 unbounded precision, but is computed more efficiently. It is
4545 always exact.
4546
4547 >>> c = ExtendedContext.copy()
4548 >>> c.Emin = -999
4549 >>> c.Emax = 999
4550 >>> 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('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004554 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004555 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004556 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004557 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004558 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004559 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004560 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004561 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004562 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004563 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004564 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004565 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004566 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004567 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004568 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004569 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004570 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004571 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004572 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004573 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004574 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004575 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004576
4577 >>> 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('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004580 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00004581 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004582 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004583 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004584 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004585 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004586 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00004587 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004588 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004589 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004590 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004591 """
4592 return a.__pow__(b, modulo, context=self)
4593
4594 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00004595 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004596
4597 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00004598 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004599 exponent is being increased), multiplied by a positive power of ten (if
4600 the exponent is being decreased), or is unchanged (if the exponent is
4601 already equal to that of the right-hand operand).
4602
4603 Unlike other operations, if the length of the coefficient after the
4604 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00004605 operation condition is raised. This guarantees that, unless there is
4606 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004607 equal to that of the right-hand operand.
4608
4609 Also unlike other operations, quantize will never raise Underflow, even
4610 if the result is subnormal and inexact.
4611
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004612 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004613 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004614 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004615 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004616 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004617 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004618 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004619 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004620 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004621 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004622 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004623 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004624 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004625 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004626 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004627 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004628 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004629 Decimal('-0E+5')
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('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004633 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004634 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004635 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004636 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004637 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004638 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004639 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004640 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004641 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004642 """
4643 return a.quantize(b, context=self)
4644
Facundo Batista353750c2007-09-13 18:13:15 +00004645 def radix(self):
4646 """Just returns 10, as this is Decimal, :)
4647
4648 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00004649 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004650 """
4651 return Decimal(10)
4652
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004653 def remainder(self, a, b):
4654 """Returns the remainder from integer division.
4655
4656 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00004657 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00004658 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00004659 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004660
4661 This operation will fail under the same conditions as integer division
4662 (that is, if integer division on the same two operands would fail, the
4663 remainder cannot be calculated).
4664
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004665 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004666 Decimal('2.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'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004670 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004671 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004672 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004673 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004674 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004675 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004676 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004677 """
4678 return a.__mod__(b, context=self)
4679
4680 def remainder_near(self, a, b):
4681 """Returns to be "a - b * n", where n is the integer nearest the exact
4682 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00004683 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004684 sign of a.
4685
4686 This operation will fail under the same conditions as integer division
4687 (that is, if integer division on the same two operands would fail, the
4688 remainder cannot be calculated).
4689
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004690 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004691 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004692 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004693 Decimal('-2')
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'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004697 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004698 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004699 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004700 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004701 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004702 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004703 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004704 """
4705 return a.remainder_near(b, context=self)
4706
Facundo Batista353750c2007-09-13 18:13:15 +00004707 def rotate(self, a, b):
4708 """Returns a rotated copy of a, b times.
4709
4710 The coefficient of the result is a rotated copy of the digits in
4711 the coefficient of the first operand. The number of places of
4712 rotation is taken from the absolute value of the second operand,
4713 with the rotation being to the left if the second operand is
4714 positive or to the right otherwise.
4715
4716 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004717 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00004718 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004719 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00004720 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004721 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004722 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004723 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004724 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004725 Decimal('345678912')
Facundo Batista353750c2007-09-13 18:13:15 +00004726 """
4727 return a.rotate(b, context=self)
4728
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004729 def same_quantum(self, a, b):
4730 """Returns True if the two operands have the same exponent.
4731
4732 The result is never affected by either the sign or the coefficient of
4733 either operand.
4734
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004735 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004736 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004737 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004738 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004739 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004740 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004741 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004742 True
4743 """
4744 return a.same_quantum(b)
4745
Facundo Batista353750c2007-09-13 18:13:15 +00004746 def scaleb (self, a, b):
4747 """Returns the first operand after adding the second value its exp.
4748
4749 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004750 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00004751 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004752 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004753 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004754 Decimal('7.50E+3')
Facundo Batista353750c2007-09-13 18:13:15 +00004755 """
4756 return a.scaleb (b, context=self)
4757
4758 def shift(self, a, b):
4759 """Returns a shifted copy of a, b times.
4760
4761 The coefficient of the result is a shifted copy of the digits
4762 in the coefficient of the first operand. The number of places
4763 to shift is taken from the absolute value of the second operand,
4764 with the shift being to the left if the second operand is
4765 positive or to the right otherwise. Digits shifted into the
4766 coefficient are zeros.
4767
4768 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004769 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004770 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004771 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004772 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004773 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004774 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004775 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004776 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004777 Decimal('345678900')
Facundo Batista353750c2007-09-13 18:13:15 +00004778 """
4779 return a.shift(b, context=self)
4780
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004781 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00004782 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004783
4784 If the result must be inexact, it is rounded using the round-half-even
4785 algorithm.
4786
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'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004790 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004791 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004792 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004793 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004794 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004795 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004796 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004797 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004798 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004799 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004800 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004801 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004802 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004803 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004804 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004805 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00004806 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004807 """
4808 return a.sqrt(context=self)
4809
4810 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00004811 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004812
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004813 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004814 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004815 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004816 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004817 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004818 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004819 """
4820 return a.__sub__(b, context=self)
4821
4822 def to_eng_string(self, a):
4823 """Converts a number to a string, using scientific notation.
4824
4825 The operation is not affected by the context.
4826 """
4827 return a.to_eng_string(context=self)
4828
4829 def to_sci_string(self, a):
4830 """Converts a number to a string, using scientific notation.
4831
4832 The operation is not affected by the context.
4833 """
4834 return a.__str__(context=self)
4835
Facundo Batista353750c2007-09-13 18:13:15 +00004836 def to_integral_exact(self, a):
4837 """Rounds to an integer.
4838
4839 When the operand has a negative exponent, the result is the same
4840 as using the quantize() operation using the given operand as the
4841 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4842 of the operand as the precision setting; Inexact and Rounded flags
4843 are allowed in this operation. The rounding mode is taken from the
4844 context.
4845
4846 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004847 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004848 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004849 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004850 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004851 Decimal('100')
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('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004855 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004856 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004857 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004858 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004859 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004860 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004861 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004862 """
4863 return a.to_integral_exact(context=self)
4864
4865 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004866 """Rounds to an integer.
4867
4868 When the operand has a negative exponent, the result is the same
4869 as using the quantize() operation using the given operand as the
4870 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4871 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00004872 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004873
Facundo Batista353750c2007-09-13 18:13:15 +00004874 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004875 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004876 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004877 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004878 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004879 Decimal('100')
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('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004883 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004884 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004885 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004886 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004887 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004888 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004889 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004890 """
Facundo Batista353750c2007-09-13 18:13:15 +00004891 return a.to_integral_value(context=self)
4892
4893 # the method name changed, but we provide also the old one, for compatibility
4894 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004895
4896class _WorkRep(object):
4897 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00004898 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004899 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004900 # exp: None, int, or string
4901
4902 def __init__(self, value=None):
4903 if value is None:
4904 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004905 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004906 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00004907 elif isinstance(value, Decimal):
4908 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00004909 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004910 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00004911 else:
4912 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004913 self.sign = value[0]
4914 self.int = value[1]
4915 self.exp = value[2]
4916
4917 def __repr__(self):
4918 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
4919
4920 __str__ = __repr__
4921
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004922
4923
Facundo Batistae64acfa2007-12-17 14:18:42 +00004924def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004925 """Normalizes op1, op2 to have the same exp and length of coefficient.
4926
4927 Done during addition.
4928 """
Facundo Batista353750c2007-09-13 18:13:15 +00004929 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004930 tmp = op2
4931 other = op1
4932 else:
4933 tmp = op1
4934 other = op2
4935
Facundo Batista353750c2007-09-13 18:13:15 +00004936 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
4937 # Then adding 10**exp to tmp has the same effect (after rounding)
4938 # as adding any positive quantity smaller than 10**exp; similarly
4939 # for subtraction. So if other is smaller than 10**exp we replace
4940 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00004941 tmp_len = len(str(tmp.int))
4942 other_len = len(str(other.int))
4943 exp = tmp.exp + min(-1, tmp_len - prec - 2)
4944 if other_len + other.exp - 1 < exp:
4945 other.int = 1
4946 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004947
Facundo Batista353750c2007-09-13 18:13:15 +00004948 tmp.int *= 10 ** (tmp.exp - other.exp)
4949 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004950 return op1, op2
4951
Facundo Batista353750c2007-09-13 18:13:15 +00004952##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
4953
4954# This function from Tim Peters was taken from here:
4955# http://mail.python.org/pipermail/python-list/1999-July/007758.html
4956# The correction being in the function definition is for speed, and
4957# the whole function is not resolved with math.log because of avoiding
4958# the use of floats.
4959def _nbits(n, correction = {
4960 '0': 4, '1': 3, '2': 2, '3': 2,
4961 '4': 1, '5': 1, '6': 1, '7': 1,
4962 '8': 0, '9': 0, 'a': 0, 'b': 0,
4963 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
4964 """Number of bits in binary representation of the positive integer n,
4965 or 0 if n == 0.
4966 """
4967 if n < 0:
4968 raise ValueError("The argument to _nbits should be nonnegative.")
4969 hex_n = "%x" % n
4970 return 4*len(hex_n) - correction[hex_n[0]]
4971
4972def _sqrt_nearest(n, a):
4973 """Closest integer to the square root of the positive integer n. a is
4974 an initial approximation to the square root. Any positive integer
4975 will do for a, but the closer a is to the square root of n the
4976 faster convergence will be.
4977
4978 """
4979 if n <= 0 or a <= 0:
4980 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
4981
4982 b=0
4983 while a != b:
4984 b, a = a, a--n//a>>1
4985 return a
4986
4987def _rshift_nearest(x, shift):
4988 """Given an integer x and a nonnegative integer shift, return closest
4989 integer to x / 2**shift; use round-to-even in case of a tie.
4990
4991 """
4992 b, q = 1L << shift, x >> shift
4993 return q + (2*(x & (b-1)) + (q&1) > b)
4994
4995def _div_nearest(a, b):
4996 """Closest integer to a/b, a and b positive integers; rounds to even
4997 in the case of a tie.
4998
4999 """
5000 q, r = divmod(a, b)
5001 return q + (2*r + (q&1) > b)
5002
5003def _ilog(x, M, L = 8):
5004 """Integer approximation to M*log(x/M), with absolute error boundable
5005 in terms only of x/M.
5006
5007 Given positive integers x and M, return an integer approximation to
5008 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5009 between the approximation and the exact result is at most 22. For
5010 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5011 both cases these are upper bounds on the error; it will usually be
5012 much smaller."""
5013
5014 # The basic algorithm is the following: let log1p be the function
5015 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5016 # the reduction
5017 #
5018 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5019 #
5020 # repeatedly until the argument to log1p is small (< 2**-L in
5021 # absolute value). For small y we can use the Taylor series
5022 # expansion
5023 #
5024 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5025 #
5026 # truncating at T such that y**T is small enough. The whole
5027 # computation is carried out in a form of fixed-point arithmetic,
5028 # with a real number z being represented by an integer
5029 # approximation to z*M. To avoid loss of precision, the y below
5030 # is actually an integer approximation to 2**R*y*M, where R is the
5031 # number of reductions performed so far.
5032
5033 y = x-M
5034 # argument reduction; R = number of reductions performed
5035 R = 0
5036 while (R <= L and long(abs(y)) << L-R >= M or
5037 R > L and abs(y) >> R-L >= M):
5038 y = _div_nearest(long(M*y) << 1,
5039 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5040 R += 1
5041
5042 # Taylor series with T terms
5043 T = -int(-10*len(str(M))//(3*L))
5044 yshift = _rshift_nearest(y, R)
5045 w = _div_nearest(M, T)
5046 for k in xrange(T-1, 0, -1):
5047 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5048
5049 return _div_nearest(w*y, M)
5050
5051def _dlog10(c, e, p):
5052 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5053 approximation to 10**p * log10(c*10**e), with an absolute error of
5054 at most 1. Assumes that c*10**e is not exactly 1."""
5055
5056 # increase precision by 2; compensate for this by dividing
5057 # final result by 100
5058 p += 2
5059
5060 # write c*10**e as d*10**f with either:
5061 # f >= 0 and 1 <= d <= 10, or
5062 # f <= 0 and 0.1 <= d <= 1.
5063 # Thus for c*10**e close to 1, f = 0
5064 l = len(str(c))
5065 f = e+l - (e+l >= 1)
5066
5067 if p > 0:
5068 M = 10**p
5069 k = e+p-f
5070 if k >= 0:
5071 c *= 10**k
5072 else:
5073 c = _div_nearest(c, 10**-k)
5074
5075 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005076 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005077 log_d = _div_nearest(log_d*M, log_10)
5078 log_tenpower = f*M # exact
5079 else:
5080 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005081 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005082
5083 return _div_nearest(log_tenpower+log_d, 100)
5084
5085def _dlog(c, e, p):
5086 """Given integers c, e and p with c > 0, compute an integer
5087 approximation to 10**p * log(c*10**e), with an absolute error of
5088 at most 1. Assumes that c*10**e is not exactly 1."""
5089
5090 # Increase precision by 2. The precision increase is compensated
5091 # for at the end with a division by 100.
5092 p += 2
5093
5094 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5095 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5096 # as 10**p * log(d) + 10**p*f * log(10).
5097 l = len(str(c))
5098 f = e+l - (e+l >= 1)
5099
5100 # compute approximation to 10**p*log(d), with error < 27
5101 if p > 0:
5102 k = e+p-f
5103 if k >= 0:
5104 c *= 10**k
5105 else:
5106 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5107
5108 # _ilog magnifies existing error in c by a factor of at most 10
5109 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5110 else:
5111 # p <= 0: just approximate the whole thing by 0; error < 2.31
5112 log_d = 0
5113
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005114 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005115 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005116 extra = len(str(abs(f)))-1
5117 if p + extra >= 0:
5118 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5119 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5120 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005121 else:
5122 f_log_ten = 0
5123 else:
5124 f_log_ten = 0
5125
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005126 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005127 return _div_nearest(f_log_ten + log_d, 100)
5128
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005129class _Log10Memoize(object):
5130 """Class to compute, store, and allow retrieval of, digits of the
5131 constant log(10) = 2.302585.... This constant is needed by
5132 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5133 def __init__(self):
5134 self.digits = "23025850929940456840179914546843642076011014886"
5135
5136 def getdigits(self, p):
5137 """Given an integer p >= 0, return floor(10**p)*log(10).
5138
5139 For example, self.getdigits(3) returns 2302.
5140 """
5141 # digits are stored as a string, for quick conversion to
5142 # integer in the case that we've already computed enough
5143 # digits; the stored digits should always be correct
5144 # (truncated, not rounded to nearest).
5145 if p < 0:
5146 raise ValueError("p should be nonnegative")
5147
5148 if p >= len(self.digits):
5149 # compute p+3, p+6, p+9, ... digits; continue until at
5150 # least one of the extra digits is nonzero
5151 extra = 3
5152 while True:
5153 # compute p+extra digits, correct to within 1ulp
5154 M = 10**(p+extra+2)
5155 digits = str(_div_nearest(_ilog(10*M, M), 100))
5156 if digits[-extra:] != '0'*extra:
5157 break
5158 extra += 3
5159 # keep all reliable digits so far; remove trailing zeros
5160 # and next nonzero digit
5161 self.digits = digits.rstrip('0')[:-1]
5162 return int(self.digits[:p+1])
5163
5164_log10_digits = _Log10Memoize().getdigits
5165
Facundo Batista353750c2007-09-13 18:13:15 +00005166def _iexp(x, M, L=8):
5167 """Given integers x and M, M > 0, such that x/M is small in absolute
5168 value, compute an integer approximation to M*exp(x/M). For 0 <=
5169 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5170 is usually much smaller)."""
5171
5172 # Algorithm: to compute exp(z) for a real number z, first divide z
5173 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5174 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5175 # series
5176 #
5177 # expm1(x) = x + x**2/2! + x**3/3! + ...
5178 #
5179 # Now use the identity
5180 #
5181 # expm1(2x) = expm1(x)*(expm1(x)+2)
5182 #
5183 # R times to compute the sequence expm1(z/2**R),
5184 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5185
5186 # Find R such that x/2**R/M <= 2**-L
5187 R = _nbits((long(x)<<L)//M)
5188
5189 # Taylor series. (2**L)**T > M
5190 T = -int(-10*len(str(M))//(3*L))
5191 y = _div_nearest(x, T)
5192 Mshift = long(M)<<R
5193 for i in xrange(T-1, 0, -1):
5194 y = _div_nearest(x*(Mshift + y), Mshift * i)
5195
5196 # Expansion
5197 for k in xrange(R-1, -1, -1):
5198 Mshift = long(M)<<(k+2)
5199 y = _div_nearest(y*(y+Mshift), Mshift)
5200
5201 return M+y
5202
5203def _dexp(c, e, p):
5204 """Compute an approximation to exp(c*10**e), with p decimal places of
5205 precision.
5206
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005207 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005208
5209 10**(p-1) <= d <= 10**p, and
5210 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5211
5212 In other words, d*10**f is an approximation to exp(c*10**e) with p
5213 digits of precision, and with an error in d of at most 1. This is
5214 almost, but not quite, the same as the error being < 1ulp: when d
5215 = 10**(p-1) the error could be up to 10 ulp."""
5216
5217 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5218 p += 2
5219
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005220 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005221 extra = max(0, e + len(str(c)) - 1)
5222 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005223
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005224 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005225 # rounding down
5226 shift = e+q
5227 if shift >= 0:
5228 cshift = c*10**shift
5229 else:
5230 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005231 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005232
5233 # reduce remainder back to original precision
5234 rem = _div_nearest(rem, 10**extra)
5235
5236 # error in result of _iexp < 120; error after division < 0.62
5237 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5238
5239def _dpower(xc, xe, yc, ye, p):
5240 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5241 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5242
5243 10**(p-1) <= c <= 10**p, and
5244 (c-1)*10**e < x**y < (c+1)*10**e
5245
5246 in other words, c*10**e is an approximation to x**y with p digits
5247 of precision, and with an error in c of at most 1. (This is
5248 almost, but not quite, the same as the error being < 1ulp: when c
5249 == 10**(p-1) we can only guarantee error < 10ulp.)
5250
5251 We assume that: x is positive and not equal to 1, and y is nonzero.
5252 """
5253
5254 # Find b such that 10**(b-1) <= |y| <= 10**b
5255 b = len(str(abs(yc))) + ye
5256
5257 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5258 lxc = _dlog(xc, xe, p+b+1)
5259
5260 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5261 shift = ye-b
5262 if shift >= 0:
5263 pc = lxc*yc*10**shift
5264 else:
5265 pc = _div_nearest(lxc*yc, 10**-shift)
5266
5267 if pc == 0:
5268 # we prefer a result that isn't exactly 1; this makes it
5269 # easier to compute a correctly rounded result in __pow__
5270 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5271 coeff, exp = 10**(p-1)+1, 1-p
5272 else:
5273 coeff, exp = 10**p-1, -p
5274 else:
5275 coeff, exp = _dexp(pc, -(p+1), p+1)
5276 coeff = _div_nearest(coeff, 10)
5277 exp += 1
5278
5279 return coeff, exp
5280
5281def _log10_lb(c, correction = {
5282 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5283 '6': 23, '7': 16, '8': 10, '9': 5}):
5284 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5285 if c <= 0:
5286 raise ValueError("The argument to _log10_lb should be nonnegative.")
5287 str_c = str(c)
5288 return 100*len(str_c) - correction[str_c[0]]
5289
Facundo Batista59c58842007-04-10 12:58:45 +00005290##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005291
Facundo Batista353750c2007-09-13 18:13:15 +00005292def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005293 """Convert other to Decimal.
5294
5295 Verifies that it's ok to use in an implicit construction.
5296 """
5297 if isinstance(other, Decimal):
5298 return other
5299 if isinstance(other, (int, long)):
5300 return Decimal(other)
Facundo Batista353750c2007-09-13 18:13:15 +00005301 if raiseit:
5302 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005303 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005304
Facundo Batista59c58842007-04-10 12:58:45 +00005305##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005306
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005307# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005308# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005309
5310DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005311 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005312 traps=[DivisionByZero, Overflow, InvalidOperation],
5313 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005314 Emax=999999999,
5315 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005316 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005317)
5318
5319# Pre-made alternate contexts offered by the specification
5320# Don't change these; the user should be able to select these
5321# contexts and be able to reproduce results from other implementations
5322# of the spec.
5323
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005324BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005325 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005326 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5327 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005328)
5329
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005330ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005331 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005332 traps=[],
5333 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005334)
5335
5336
Facundo Batista72bc54f2007-11-23 17:59:00 +00005337##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005338#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005339# Regular expression used for parsing numeric strings. Additional
5340# comments:
5341#
5342# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5343# whitespace. But note that the specification disallows whitespace in
5344# a numeric string.
5345#
5346# 2. For finite numbers (not infinities and NaNs) the body of the
5347# number between the optional sign and the optional exponent must have
5348# at least one decimal digit, possibly after the decimal point. The
5349# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005350
5351import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005352_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005353# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005354 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005355 (
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005356 (?=\d|\.\d) # ...a number (with at least one digit)
5357 (?P<int>\d*) # having a (possibly empty) integer part
5358 (\.(?P<frac>\d*))? # followed by an optional fractional part
5359 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005360 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005361 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005362 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005363 (?P<signal>s)? # ...an (optionally signaling)
5364 NaN # NaN
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005365 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005366 )
5367# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005368 \Z
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005369""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005370
Facundo Batista2ec74152007-12-03 17:55:00 +00005371_all_zeros = re.compile('0*$').match
5372_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005373
5374##### PEP3101 support functions ##############################################
5375# The functions parse_format_specifier and format_align have little to do
5376# with the Decimal class, and could potentially be reused for other pure
5377# Python numeric classes that want to implement __format__
5378#
5379# A format specifier for Decimal looks like:
5380#
5381# [[fill]align][sign][0][minimumwidth][.precision][type]
5382#
5383
5384_parse_format_specifier_regex = re.compile(r"""\A
5385(?:
5386 (?P<fill>.)?
5387 (?P<align>[<>=^])
5388)?
5389(?P<sign>[-+ ])?
5390(?P<zeropad>0)?
5391(?P<minimumwidth>(?!0)\d+)?
5392(?:\.(?P<precision>0|(?!0)\d+))?
5393(?P<type>[eEfFgG%])?
5394\Z
5395""", re.VERBOSE)
5396
Facundo Batista72bc54f2007-11-23 17:59:00 +00005397del re
5398
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005399def _parse_format_specifier(format_spec):
5400 """Parse and validate a format specifier.
5401
5402 Turns a standard numeric format specifier into a dict, with the
5403 following entries:
5404
5405 fill: fill character to pad field to minimum width
5406 align: alignment type, either '<', '>', '=' or '^'
5407 sign: either '+', '-' or ' '
5408 minimumwidth: nonnegative integer giving minimum width
5409 precision: nonnegative integer giving precision, or None
5410 type: one of the characters 'eEfFgG%', or None
5411 unicode: either True or False (always True for Python 3.x)
5412
5413 """
5414 m = _parse_format_specifier_regex.match(format_spec)
5415 if m is None:
5416 raise ValueError("Invalid format specifier: " + format_spec)
5417
5418 # get the dictionary
5419 format_dict = m.groupdict()
5420
5421 # defaults for fill and alignment
5422 fill = format_dict['fill']
5423 align = format_dict['align']
5424 if format_dict.pop('zeropad') is not None:
5425 # in the face of conflict, refuse the temptation to guess
5426 if fill is not None and fill != '0':
5427 raise ValueError("Fill character conflicts with '0'"
5428 " in format specifier: " + format_spec)
5429 if align is not None and align != '=':
5430 raise ValueError("Alignment conflicts with '0' in "
5431 "format specifier: " + format_spec)
5432 fill = '0'
5433 align = '='
5434 format_dict['fill'] = fill or ' '
5435 format_dict['align'] = align or '<'
5436
5437 if format_dict['sign'] is None:
5438 format_dict['sign'] = '-'
5439
5440 # turn minimumwidth and precision entries into integers.
5441 # minimumwidth defaults to 0; precision remains None if not given
5442 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5443 if format_dict['precision'] is not None:
5444 format_dict['precision'] = int(format_dict['precision'])
5445
5446 # if format type is 'g' or 'G' then a precision of 0 makes little
5447 # sense; convert it to 1. Same if format type is unspecified.
5448 if format_dict['precision'] == 0:
Mark Dickinsonc3c112d2009-09-07 16:19:35 +00005449 if format_dict['type'] is None or format_dict['type'] in 'gG':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005450 format_dict['precision'] = 1
5451
5452 # record whether return type should be str or unicode
5453 format_dict['unicode'] = isinstance(format_spec, unicode)
5454
5455 return format_dict
5456
5457def _format_align(body, spec_dict):
5458 """Given an unpadded, non-aligned numeric string, add padding and
5459 aligment to conform with the given format specifier dictionary (as
5460 output from parse_format_specifier).
5461
5462 It's assumed that if body is negative then it starts with '-'.
5463 Any leading sign ('-' or '+') is stripped from the body before
5464 applying the alignment and padding rules, and replaced in the
5465 appropriate position.
5466
5467 """
5468 # figure out the sign; we only examine the first character, so if
5469 # body has leading whitespace the results may be surprising.
5470 if len(body) > 0 and body[0] in '-+':
5471 sign = body[0]
5472 body = body[1:]
5473 else:
5474 sign = ''
5475
5476 if sign != '-':
5477 if spec_dict['sign'] in ' +':
5478 sign = spec_dict['sign']
5479 else:
5480 sign = ''
5481
5482 # how much extra space do we have to play with?
5483 minimumwidth = spec_dict['minimumwidth']
5484 fill = spec_dict['fill']
5485 padding = fill*(max(minimumwidth - (len(sign+body)), 0))
5486
5487 align = spec_dict['align']
5488 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005489 result = sign + body + padding
Mark Dickinson71416822009-03-17 18:07:41 +00005490 elif align == '>':
5491 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005492 elif align == '=':
5493 result = sign + padding + body
5494 else: #align == '^'
5495 half = len(padding)//2
5496 result = padding[:half] + sign + body + padding[half:]
5497
5498 # make sure that result is unicode if necessary
5499 if spec_dict['unicode']:
5500 result = unicode(result)
5501
5502 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00005503
Facundo Batista59c58842007-04-10 12:58:45 +00005504##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005505
Facundo Batista59c58842007-04-10 12:58:45 +00005506# Reusable defaults
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005507_Infinity = Decimal('Inf')
5508_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonfd6032d2009-01-02 23:16:51 +00005509_NaN = Decimal('NaN')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005510_Zero = Decimal(0)
5511_One = Decimal(1)
5512_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005513
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005514# _SignedInfinity[sign] is infinity w/ that sign
5515_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005516
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005517
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005518
5519if __name__ == '__main__':
5520 import doctest, sys
5521 doctest.testmod(sys.modules[__name__])