blob: 87bd142048aea6a988d1d4f281541c046778800d [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 Hettingerf4d85972009-01-03 19:02:23 +0000138import math as _math
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 Dickinsonc5de0962009-01-02 23:07:08 +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 Dickinsonc5de0962009-01-02 23:07:08 +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):
Raymond Hettingerb7e835b2009-01-03 19:08:10 +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 Dickinsonc5de0962009-01-02 23:07:08 +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 Dickinsonc5de0962009-01-02 23:07:08 +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 Dickinsonc5de0962009-01-02 23:07:08 +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):
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000344 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000345 if sign == 0:
346 if context.rounding == ROUND_CEILING:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +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:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +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
554 fracpart = m.group('frac')
555 exp = int(m.group('exp') or '0')
556 if fracpart is not None:
Mark Dickinson8e85ffa2008-03-25 18:47:59 +0000557 self._int = str((intpart+fracpart).lstrip('0') or '0')
Facundo Batista0d157a02007-11-30 17:15:25 +0000558 self._exp = exp - len(fracpart)
559 else:
Mark Dickinson8e85ffa2008-03-25 18:47:59 +0000560 self._int = str(intpart.lstrip('0') or '0')
Facundo Batista0d157a02007-11-30 17:15:25 +0000561 self._exp = exp
562 self._is_special = False
563 else:
564 diag = m.group('diag')
565 if diag is not None:
566 # NaN
Mark Dickinson8e85ffa2008-03-25 18:47:59 +0000567 self._int = str(diag.lstrip('0'))
Facundo Batista0d157a02007-11-30 17:15:25 +0000568 if m.group('signal'):
569 self._exp = 'N'
570 else:
571 self._exp = 'n'
572 else:
573 # infinity
574 self._int = '0'
575 self._exp = 'F'
576 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000577 return self
578
579 # From an integer
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000580 if isinstance(value, (int,long)):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000581 if value >= 0:
582 self._sign = 0
583 else:
584 self._sign = 1
585 self._exp = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +0000586 self._int = str(abs(value))
Facundo Batista0d157a02007-11-30 17:15:25 +0000587 self._is_special = False
588 return self
589
590 # From another decimal
591 if isinstance(value, Decimal):
592 self._exp = value._exp
593 self._sign = value._sign
594 self._int = value._int
595 self._is_special = value._is_special
596 return self
597
598 # From an internal working value
599 if isinstance(value, _WorkRep):
600 self._sign = value.sign
601 self._int = str(value.int)
602 self._exp = int(value.exp)
603 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000604 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000605
606 # tuple/list conversion (possibly from as_tuple())
607 if isinstance(value, (list,tuple)):
608 if len(value) != 3:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000609 raise ValueError('Invalid tuple size in creation of Decimal '
610 'from list or tuple. The list or tuple '
611 'should have exactly three elements.')
612 # process sign. The isinstance test rejects floats
613 if not (isinstance(value[0], (int, long)) and value[0] in (0,1)):
614 raise ValueError("Invalid sign. The first value in the tuple "
615 "should be an integer; either 0 for a "
616 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000617 self._sign = value[0]
Facundo Batista9b5e2312007-10-19 19:25:57 +0000618 if value[2] == 'F':
619 # infinity: value[1] is ignored
Facundo Batista72bc54f2007-11-23 17:59:00 +0000620 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000621 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000622 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000623 else:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000624 # process and validate the digits in value[1]
625 digits = []
626 for digit in value[1]:
627 if isinstance(digit, (int, long)) and 0 <= digit <= 9:
628 # skip leading zeros
629 if digits or digit != 0:
630 digits.append(digit)
631 else:
632 raise ValueError("The second value in the tuple must "
633 "be composed of integers in the range "
634 "0 through 9.")
635 if value[2] in ('n', 'N'):
636 # NaN: digits form the diagnostic
Facundo Batista72bc54f2007-11-23 17:59:00 +0000637 self._int = ''.join(map(str, digits))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000638 self._exp = value[2]
639 self._is_special = True
640 elif isinstance(value[2], (int, long)):
641 # finite number: digits give the coefficient
Facundo Batista72bc54f2007-11-23 17:59:00 +0000642 self._int = ''.join(map(str, digits or [0]))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000643 self._exp = value[2]
644 self._is_special = False
645 else:
646 raise ValueError("The third value in the tuple must "
647 "be an integer, or one of the "
648 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000649 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000650
Raymond Hettingerbf440692004-07-10 14:14:37 +0000651 if isinstance(value, float):
652 raise TypeError("Cannot convert float to Decimal. " +
653 "First convert the float to a string")
654
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000655 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000656
Mark Dickinson6a961632009-01-04 21:10:56 +0000657 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
658 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000659 def from_float(cls, f):
660 """Converts a float to a decimal number, exactly.
661
662 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
663 Since 0.1 is not exactly representable in binary floating point, the
664 value is stored as the nearest representable value which is
665 0x1.999999999999ap-4. The exact equivalent of the value in decimal
666 is 0.1000000000000000055511151231257827021181583404541015625.
667
668 >>> Decimal.from_float(0.1)
669 Decimal('0.1000000000000000055511151231257827021181583404541015625')
670 >>> Decimal.from_float(float('nan'))
671 Decimal('NaN')
672 >>> Decimal.from_float(float('inf'))
673 Decimal('Infinity')
674 >>> Decimal.from_float(-float('inf'))
675 Decimal('-Infinity')
676 >>> Decimal.from_float(-0.0)
677 Decimal('-0')
678
679 """
680 if isinstance(f, (int, long)): # handle integer inputs
681 return cls(f)
682 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
683 return cls(repr(f))
Mark Dickinson6a961632009-01-04 21:10:56 +0000684 if _math.copysign(1.0, f) == 1.0:
685 sign = 0
686 else:
687 sign = 1
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000688 n, d = abs(f).as_integer_ratio()
689 k = d.bit_length() - 1
690 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinson6a961632009-01-04 21:10:56 +0000691 if cls is Decimal:
692 return result
693 else:
694 return cls(result)
695 from_float = classmethod(from_float)
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000696
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000697 def _isnan(self):
698 """Returns whether the number is not actually one.
699
700 0 if a number
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000701 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000702 2 if sNaN
703 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000704 if self._is_special:
705 exp = self._exp
706 if exp == 'n':
707 return 1
708 elif exp == 'N':
709 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000710 return 0
711
712 def _isinfinity(self):
713 """Returns whether the number is infinite
714
715 0 if finite or not a number
716 1 if +INF
717 -1 if -INF
718 """
719 if self._exp == 'F':
720 if self._sign:
721 return -1
722 return 1
723 return 0
724
Facundo Batista353750c2007-09-13 18:13:15 +0000725 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000726 """Returns whether the number is not actually one.
727
728 if self, other are sNaN, signal
729 if self, other are NaN return nan
730 return 0
731
732 Done before operations.
733 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000734
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000735 self_is_nan = self._isnan()
736 if other is None:
737 other_is_nan = False
738 else:
739 other_is_nan = other._isnan()
740
741 if self_is_nan or other_is_nan:
742 if context is None:
743 context = getcontext()
744
745 if self_is_nan == 2:
746 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000747 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000748 if other_is_nan == 2:
749 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000750 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000751 if self_is_nan:
Facundo Batista353750c2007-09-13 18:13:15 +0000752 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000753
Facundo Batista353750c2007-09-13 18:13:15 +0000754 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000755 return 0
756
Mark Dickinson2fc92632008-02-06 22:10:50 +0000757 def _compare_check_nans(self, other, context):
758 """Version of _check_nans used for the signaling comparisons
759 compare_signal, __le__, __lt__, __ge__, __gt__.
760
761 Signal InvalidOperation if either self or other is a (quiet
762 or signaling) NaN. Signaling NaNs take precedence over quiet
763 NaNs.
764
765 Return 0 if neither operand is a NaN.
766
767 """
768 if context is None:
769 context = getcontext()
770
771 if self._is_special or other._is_special:
772 if self.is_snan():
773 return context._raise_error(InvalidOperation,
774 'comparison involving sNaN',
775 self)
776 elif other.is_snan():
777 return context._raise_error(InvalidOperation,
778 'comparison involving sNaN',
779 other)
780 elif self.is_qnan():
781 return context._raise_error(InvalidOperation,
782 'comparison involving NaN',
783 self)
784 elif other.is_qnan():
785 return context._raise_error(InvalidOperation,
786 'comparison involving NaN',
787 other)
788 return 0
789
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000790 def __nonzero__(self):
Facundo Batista1a191df2007-10-02 17:01:24 +0000791 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000792
Facundo Batista1a191df2007-10-02 17:01:24 +0000793 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000794 """
Facundo Batista72bc54f2007-11-23 17:59:00 +0000795 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000796
Mark Dickinson2fc92632008-02-06 22:10:50 +0000797 def _cmp(self, other):
798 """Compare the two non-NaN decimal instances self and other.
799
800 Returns -1 if self < other, 0 if self == other and 1
801 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000802
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000803 if self._is_special or other._is_special:
Mark Dickinsone52c3142009-01-25 10:39:15 +0000804 self_inf = self._isinfinity()
805 other_inf = other._isinfinity()
806 if self_inf == other_inf:
807 return 0
808 elif self_inf < other_inf:
809 return -1
810 else:
811 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000812
Mark Dickinsone52c3142009-01-25 10:39:15 +0000813 # check for zeros; Decimal('0') == Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +0000814 if not self:
815 if not other:
816 return 0
817 else:
818 return -((-1)**other._sign)
819 if not other:
820 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000821
Facundo Batista59c58842007-04-10 12:58:45 +0000822 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000823 if other._sign < self._sign:
824 return -1
825 if self._sign < other._sign:
826 return 1
827
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000828 self_adjusted = self.adjusted()
829 other_adjusted = other.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +0000830 if self_adjusted == other_adjusted:
Facundo Batista72bc54f2007-11-23 17:59:00 +0000831 self_padded = self._int + '0'*(self._exp - other._exp)
832 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone52c3142009-01-25 10:39:15 +0000833 if self_padded == other_padded:
834 return 0
835 elif self_padded < other_padded:
836 return -(-1)**self._sign
837 else:
838 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000839 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000840 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000841 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000842 return -((-1)**self._sign)
843
Mark Dickinson2fc92632008-02-06 22:10:50 +0000844 # Note: The Decimal standard doesn't cover rich comparisons for
845 # Decimals. In particular, the specification is silent on the
846 # subject of what should happen for a comparison involving a NaN.
847 # We take the following approach:
848 #
849 # == comparisons involving a NaN always return False
850 # != comparisons involving a NaN always return True
851 # <, >, <= and >= comparisons involving a (quiet or signaling)
852 # NaN signal InvalidOperation, and return False if the
Mark Dickinson3a94ee02008-02-10 15:19:58 +0000853 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000854 #
855 # This behavior is designed to conform as closely as possible to
856 # that specified by IEEE 754.
857
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000858 def __eq__(self, other):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000859 other = _convert_other(other)
860 if other is NotImplemented:
861 return other
862 if self.is_nan() or other.is_nan():
863 return False
864 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000865
866 def __ne__(self, other):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000867 other = _convert_other(other)
868 if other is NotImplemented:
869 return other
870 if self.is_nan() or other.is_nan():
871 return True
872 return self._cmp(other) != 0
873
874 def __lt__(self, other, context=None):
875 other = _convert_other(other)
876 if other is NotImplemented:
877 return other
878 ans = self._compare_check_nans(other, context)
879 if ans:
880 return False
881 return self._cmp(other) < 0
882
883 def __le__(self, other, context=None):
884 other = _convert_other(other)
885 if other is NotImplemented:
886 return other
887 ans = self._compare_check_nans(other, context)
888 if ans:
889 return False
890 return self._cmp(other) <= 0
891
892 def __gt__(self, other, context=None):
893 other = _convert_other(other)
894 if other is NotImplemented:
895 return other
896 ans = self._compare_check_nans(other, context)
897 if ans:
898 return False
899 return self._cmp(other) > 0
900
901 def __ge__(self, other, context=None):
902 other = _convert_other(other)
903 if other is NotImplemented:
904 return other
905 ans = self._compare_check_nans(other, context)
906 if ans:
907 return False
908 return self._cmp(other) >= 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000909
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000910 def compare(self, other, context=None):
911 """Compares one to another.
912
913 -1 => a < b
914 0 => a = b
915 1 => a > b
916 NaN => one is NaN
917 Like __cmp__, but returns Decimal instances.
918 """
Facundo Batista353750c2007-09-13 18:13:15 +0000919 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
Facundo Batista59c58842007-04-10 12:58:45 +0000921 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000922 if (self._is_special or other and other._is_special):
923 ans = self._check_nans(other, context)
924 if ans:
925 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000926
Mark Dickinson2fc92632008-02-06 22:10:50 +0000927 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000928
929 def __hash__(self):
930 """x.__hash__() <==> hash(x)"""
931 # Decimal integers must hash the same as the ints
Facundo Batista52b25792008-01-08 12:25:20 +0000932 #
933 # The hash of a nonspecial noninteger Decimal must depend only
934 # on the value of that Decimal, and not on its representation.
Raymond Hettingerabe32372008-02-14 02:41:22 +0000935 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000936 if self._is_special:
937 if self._isnan():
938 raise TypeError('Cannot hash a NaN value.')
939 return hash(str(self))
Facundo Batista8c202442007-09-19 17:53:25 +0000940 if not self:
941 return 0
942 if self._isinteger():
943 op = _WorkRep(self.to_integral_value())
944 # to make computation feasible for Decimals with large
945 # exponent, we use the fact that hash(n) == hash(m) for
946 # any two nonzero integers n and m such that (i) n and m
947 # have the same sign, and (ii) n is congruent to m modulo
948 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
949 # hash((-1)**s*c*pow(10, e, 2**64-1).
950 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Facundo Batista52b25792008-01-08 12:25:20 +0000951 # The value of a nonzero nonspecial Decimal instance is
952 # faithfully represented by the triple consisting of its sign,
953 # its adjusted exponent, and its coefficient with trailing
954 # zeros removed.
955 return hash((self._sign,
956 self._exp+len(self._int),
957 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000958
959 def as_tuple(self):
960 """Represents the number as a triple tuple.
961
962 To show the internals exactly as they are.
963 """
Raymond Hettinger097a1902008-01-11 02:24:13 +0000964 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000965
966 def __repr__(self):
967 """Represents the number as an instance of Decimal."""
968 # Invariant: eval(repr(d)) == d
Raymond Hettingerabe32372008-02-14 02:41:22 +0000969 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000970
Facundo Batista353750c2007-09-13 18:13:15 +0000971 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000972 """Return string representation of the number in scientific notation.
973
974 Captures all of the information in the underlying representation.
975 """
976
Facundo Batista62edb712007-12-03 16:29:52 +0000977 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000978 if self._is_special:
Facundo Batista62edb712007-12-03 16:29:52 +0000979 if self._exp == 'F':
980 return sign + 'Infinity'
981 elif self._exp == 'n':
982 return sign + 'NaN' + self._int
983 else: # self._exp == 'N'
984 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000985
Facundo Batista62edb712007-12-03 16:29:52 +0000986 # number of digits of self._int to left of decimal point
987 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000988
Facundo Batista62edb712007-12-03 16:29:52 +0000989 # dotplace is number of digits of self._int to the left of the
990 # decimal point in the mantissa of the output string (that is,
991 # after adjusting the exponent)
992 if self._exp <= 0 and leftdigits > -6:
993 # no exponent required
994 dotplace = leftdigits
995 elif not eng:
996 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000997 dotplace = 1
Facundo Batista62edb712007-12-03 16:29:52 +0000998 elif self._int == '0':
999 # engineering notation, zero
1000 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001001 else:
Facundo Batista62edb712007-12-03 16:29:52 +00001002 # engineering notation, nonzero
1003 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001004
Facundo Batista62edb712007-12-03 16:29:52 +00001005 if dotplace <= 0:
1006 intpart = '0'
1007 fracpart = '.' + '0'*(-dotplace) + self._int
1008 elif dotplace >= len(self._int):
1009 intpart = self._int+'0'*(dotplace-len(self._int))
1010 fracpart = ''
1011 else:
1012 intpart = self._int[:dotplace]
1013 fracpart = '.' + self._int[dotplace:]
1014 if leftdigits == dotplace:
1015 exp = ''
1016 else:
1017 if context is None:
1018 context = getcontext()
1019 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1020
1021 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001022
1023 def to_eng_string(self, context=None):
1024 """Convert to engineering-type string.
1025
1026 Engineering notation has an exponent which is a multiple of 3, so there
1027 are up to 3 digits left of the decimal place.
1028
1029 Same rules for when in exponential and when as a value as in __str__.
1030 """
Facundo Batista353750c2007-09-13 18:13:15 +00001031 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001032
1033 def __neg__(self, context=None):
1034 """Returns a copy with the sign switched.
1035
1036 Rounds, if it has reason.
1037 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001038 if self._is_special:
1039 ans = self._check_nans(context=context)
1040 if ans:
1041 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001042
1043 if not self:
1044 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001045 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001046 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001047 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001048
1049 if context is None:
1050 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001051 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001052
1053 def __pos__(self, context=None):
1054 """Returns a copy, unless it is a sNaN.
1055
1056 Rounds the number (if more then precision digits)
1057 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001058 if self._is_special:
1059 ans = self._check_nans(context=context)
1060 if ans:
1061 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001062
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001063 if not self:
1064 # + (-0) = 0
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001065 ans = self.copy_abs()
Facundo Batista353750c2007-09-13 18:13:15 +00001066 else:
1067 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001068
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001069 if context is None:
1070 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001071 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001072
Facundo Batistae64acfa2007-12-17 14:18:42 +00001073 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001074 """Returns the absolute value of self.
1075
Facundo Batistae64acfa2007-12-17 14:18:42 +00001076 If the keyword argument 'round' is false, do not round. The
1077 expression self.__abs__(round=False) is equivalent to
1078 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001079 """
Facundo Batistae64acfa2007-12-17 14:18:42 +00001080 if not round:
1081 return self.copy_abs()
1082
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001083 if self._is_special:
1084 ans = self._check_nans(context=context)
1085 if ans:
1086 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001087
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001088 if self._sign:
1089 ans = self.__neg__(context=context)
1090 else:
1091 ans = self.__pos__(context=context)
1092
1093 return ans
1094
1095 def __add__(self, other, context=None):
1096 """Returns self + other.
1097
1098 -INF + INF (or the reverse) cause InvalidOperation errors.
1099 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001100 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001101 if other is NotImplemented:
1102 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001103
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001104 if context is None:
1105 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001106
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001107 if self._is_special or other._is_special:
1108 ans = self._check_nans(other, context)
1109 if ans:
1110 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001111
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001112 if self._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001113 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001114 if self._sign != other._sign and other._isinfinity():
1115 return context._raise_error(InvalidOperation, '-INF + INF')
1116 return Decimal(self)
1117 if other._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001118 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001119
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001120 exp = min(self._exp, other._exp)
1121 negativezero = 0
1122 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Facundo Batista59c58842007-04-10 12:58:45 +00001123 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001124 negativezero = 1
1125
1126 if not self and not other:
1127 sign = min(self._sign, other._sign)
1128 if negativezero:
1129 sign = 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00001130 ans = _dec_from_triple(sign, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001131 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001132 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001133 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001134 exp = max(exp, other._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001135 ans = other._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001136 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001137 return ans
1138 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001139 exp = max(exp, self._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001140 ans = self._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001141 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001142 return ans
1143
1144 op1 = _WorkRep(self)
1145 op2 = _WorkRep(other)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001146 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001147
1148 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001150 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001151 if op1.int == op2.int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001152 ans = _dec_from_triple(negativezero, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001153 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001154 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001155 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001156 op1, op2 = op2, op1
Facundo Batista59c58842007-04-10 12:58:45 +00001157 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001158 if op1.sign == 1:
1159 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001160 op1.sign, op2.sign = op2.sign, op1.sign
1161 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001162 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001163 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001164 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001165 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001166 op1.sign, op2.sign = (0, 0)
1167 else:
1168 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001169 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001170
Raymond Hettinger17931de2004-10-27 06:21:46 +00001171 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001172 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001173 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001174 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001175
1176 result.exp = op1.exp
1177 ans = Decimal(result)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001178 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001179 return ans
1180
1181 __radd__ = __add__
1182
1183 def __sub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001184 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001185 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001186 if other is NotImplemented:
1187 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001188
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001189 if self._is_special or other._is_special:
1190 ans = self._check_nans(other, context=context)
1191 if ans:
1192 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001193
Facundo Batista353750c2007-09-13 18:13:15 +00001194 # self - other is computed as self + other.copy_negate()
1195 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001196
1197 def __rsub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001198 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001199 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001200 if other is NotImplemented:
1201 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001202
Facundo Batista353750c2007-09-13 18:13:15 +00001203 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001205 def __mul__(self, other, context=None):
1206 """Return self * other.
1207
1208 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1209 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001210 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001211 if other is NotImplemented:
1212 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001213
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001214 if context is None:
1215 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001216
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001217 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001218
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001219 if self._is_special or other._is_special:
1220 ans = self._check_nans(other, context)
1221 if ans:
1222 return ans
1223
1224 if self._isinfinity():
1225 if not other:
1226 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001227 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001228
1229 if other._isinfinity():
1230 if not self:
1231 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001232 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233
1234 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235
1236 # Special case for multiplying by zero
1237 if not self or not other:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001238 ans = _dec_from_triple(resultsign, '0', resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001239 # Fixing in case the exponent is out of bounds
1240 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001241 return ans
1242
1243 # Special case for multiplying by power of 10
Facundo Batista72bc54f2007-11-23 17:59:00 +00001244 if self._int == '1':
1245 ans = _dec_from_triple(resultsign, other._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001246 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001247 return ans
Facundo Batista72bc54f2007-11-23 17:59:00 +00001248 if other._int == '1':
1249 ans = _dec_from_triple(resultsign, self._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001250 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001251 return ans
1252
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001253 op1 = _WorkRep(self)
1254 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001255
Facundo Batista72bc54f2007-11-23 17:59:00 +00001256 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001257 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001258
1259 return ans
1260 __rmul__ = __mul__
1261
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001262 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001263 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001264 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001265 if other is NotImplemented:
Facundo Batistacce8df22007-09-18 16:53:18 +00001266 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001267
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001268 if context is None:
1269 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001270
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001271 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001272
1273 if self._is_special or other._is_special:
1274 ans = self._check_nans(other, context)
1275 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001276 return ans
1277
1278 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001279 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001280
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001281 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001282 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001283
1284 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001285 context._raise_error(Clamped, 'Division by infinity')
Facundo Batista72bc54f2007-11-23 17:59:00 +00001286 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001287
1288 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001289 if not other:
Facundo Batistacce8df22007-09-18 16:53:18 +00001290 if not self:
1291 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001292 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001293
Facundo Batistacce8df22007-09-18 16:53:18 +00001294 if not self:
1295 exp = self._exp - other._exp
1296 coeff = 0
1297 else:
1298 # OK, so neither = 0, INF or NaN
1299 shift = len(other._int) - len(self._int) + context.prec + 1
1300 exp = self._exp - other._exp - shift
1301 op1 = _WorkRep(self)
1302 op2 = _WorkRep(other)
1303 if shift >= 0:
1304 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1305 else:
1306 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1307 if remainder:
1308 # result is not exact; adjust to ensure correct rounding
1309 if coeff % 5 == 0:
1310 coeff += 1
1311 else:
1312 # result is exact; get as close to ideal exponent as possible
1313 ideal_exp = self._exp - other._exp
1314 while exp < ideal_exp and coeff % 10 == 0:
1315 coeff //= 10
1316 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001317
Facundo Batista72bc54f2007-11-23 17:59:00 +00001318 ans = _dec_from_triple(sign, str(coeff), exp)
Facundo Batistacce8df22007-09-18 16:53:18 +00001319 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001320
Facundo Batistacce8df22007-09-18 16:53:18 +00001321 def _divide(self, other, context):
1322 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001323
Facundo Batistacce8df22007-09-18 16:53:18 +00001324 Assumes that neither self nor other is a NaN, that self is not
1325 infinite and that other is nonzero.
1326 """
1327 sign = self._sign ^ other._sign
1328 if other._isinfinity():
1329 ideal_exp = self._exp
1330 else:
1331 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001332
Facundo Batistacce8df22007-09-18 16:53:18 +00001333 expdiff = self.adjusted() - other.adjusted()
1334 if not self or other._isinfinity() or expdiff <= -2:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001335 return (_dec_from_triple(sign, '0', 0),
Facundo Batistacce8df22007-09-18 16:53:18 +00001336 self._rescale(ideal_exp, context.rounding))
1337 if expdiff <= context.prec:
1338 op1 = _WorkRep(self)
1339 op2 = _WorkRep(other)
1340 if op1.exp >= op2.exp:
1341 op1.int *= 10**(op1.exp - op2.exp)
1342 else:
1343 op2.int *= 10**(op2.exp - op1.exp)
1344 q, r = divmod(op1.int, op2.int)
1345 if q < 10**context.prec:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001346 return (_dec_from_triple(sign, str(q), 0),
1347 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001348
Facundo Batistacce8df22007-09-18 16:53:18 +00001349 # Here the quotient is too large to be representable
1350 ans = context._raise_error(DivisionImpossible,
1351 'quotient too large in //, % or divmod')
1352 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001353
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001354 def __rtruediv__(self, other, context=None):
1355 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001356 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001357 if other is NotImplemented:
1358 return other
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001359 return other.__truediv__(self, context=context)
1360
1361 __div__ = __truediv__
1362 __rdiv__ = __rtruediv__
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001363
1364 def __divmod__(self, other, context=None):
1365 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001366 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001367 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001368 other = _convert_other(other)
1369 if other is NotImplemented:
1370 return other
1371
1372 if context is None:
1373 context = getcontext()
1374
1375 ans = self._check_nans(other, context)
1376 if ans:
1377 return (ans, ans)
1378
1379 sign = self._sign ^ other._sign
1380 if self._isinfinity():
1381 if other._isinfinity():
1382 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1383 return ans, ans
1384 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001385 return (_SignedInfinity[sign],
Facundo Batistacce8df22007-09-18 16:53:18 +00001386 context._raise_error(InvalidOperation, 'INF % x'))
1387
1388 if not other:
1389 if not self:
1390 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1391 return ans, ans
1392 else:
1393 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1394 context._raise_error(InvalidOperation, 'x % 0'))
1395
1396 quotient, remainder = self._divide(other, context)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001397 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001398 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001399
1400 def __rdivmod__(self, other, context=None):
1401 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001402 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001403 if other is NotImplemented:
1404 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001405 return other.__divmod__(self, context=context)
1406
1407 def __mod__(self, other, context=None):
1408 """
1409 self % other
1410 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001411 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001412 if other is NotImplemented:
1413 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001414
Facundo Batistacce8df22007-09-18 16:53:18 +00001415 if context is None:
1416 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001417
Facundo Batistacce8df22007-09-18 16:53:18 +00001418 ans = self._check_nans(other, context)
1419 if ans:
1420 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001421
Facundo Batistacce8df22007-09-18 16:53:18 +00001422 if self._isinfinity():
1423 return context._raise_error(InvalidOperation, 'INF % x')
1424 elif not other:
1425 if self:
1426 return context._raise_error(InvalidOperation, 'x % 0')
1427 else:
1428 return context._raise_error(DivisionUndefined, '0 % 0')
1429
1430 remainder = self._divide(other, context)[1]
Facundo Batistae64acfa2007-12-17 14:18:42 +00001431 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001432 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001433
1434 def __rmod__(self, other, context=None):
1435 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001436 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001437 if other is NotImplemented:
1438 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001439 return other.__mod__(self, context=context)
1440
1441 def remainder_near(self, other, context=None):
1442 """
1443 Remainder nearest to 0- abs(remainder-near) <= other/2
1444 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001445 if context is None:
1446 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001447
Facundo Batista353750c2007-09-13 18:13:15 +00001448 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001449
Facundo Batista353750c2007-09-13 18:13:15 +00001450 ans = self._check_nans(other, context)
1451 if ans:
1452 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001453
Facundo Batista353750c2007-09-13 18:13:15 +00001454 # self == +/-infinity -> InvalidOperation
1455 if self._isinfinity():
1456 return context._raise_error(InvalidOperation,
1457 'remainder_near(infinity, x)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001458
Facundo Batista353750c2007-09-13 18:13:15 +00001459 # other == 0 -> either InvalidOperation or DivisionUndefined
1460 if not other:
1461 if self:
1462 return context._raise_error(InvalidOperation,
1463 'remainder_near(x, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001464 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001465 return context._raise_error(DivisionUndefined,
1466 'remainder_near(0, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001467
Facundo Batista353750c2007-09-13 18:13:15 +00001468 # other = +/-infinity -> remainder = self
1469 if other._isinfinity():
1470 ans = Decimal(self)
1471 return ans._fix(context)
1472
1473 # self = 0 -> remainder = self, with ideal exponent
1474 ideal_exponent = min(self._exp, other._exp)
1475 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001476 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001477 return ans._fix(context)
1478
1479 # catch most cases of large or small quotient
1480 expdiff = self.adjusted() - other.adjusted()
1481 if expdiff >= context.prec + 1:
1482 # expdiff >= prec+1 => abs(self/other) > 10**prec
Facundo Batistacce8df22007-09-18 16:53:18 +00001483 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001484 if expdiff <= -2:
1485 # expdiff <= -2 => abs(self/other) < 0.1
1486 ans = self._rescale(ideal_exponent, context.rounding)
1487 return ans._fix(context)
1488
1489 # adjust both arguments to have the same exponent, then divide
1490 op1 = _WorkRep(self)
1491 op2 = _WorkRep(other)
1492 if op1.exp >= op2.exp:
1493 op1.int *= 10**(op1.exp - op2.exp)
1494 else:
1495 op2.int *= 10**(op2.exp - op1.exp)
1496 q, r = divmod(op1.int, op2.int)
1497 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1498 # 10**ideal_exponent. Apply correction to ensure that
1499 # abs(remainder) <= abs(other)/2
1500 if 2*r + (q&1) > op2.int:
1501 r -= op2.int
1502 q += 1
1503
1504 if q >= 10**context.prec:
Facundo Batistacce8df22007-09-18 16:53:18 +00001505 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001506
1507 # result has same sign as self unless r is negative
1508 sign = self._sign
1509 if r < 0:
1510 sign = 1-sign
1511 r = -r
1512
Facundo Batista72bc54f2007-11-23 17:59:00 +00001513 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001514 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001515
1516 def __floordiv__(self, other, context=None):
1517 """self // other"""
Facundo Batistacce8df22007-09-18 16:53:18 +00001518 other = _convert_other(other)
1519 if other is NotImplemented:
1520 return other
1521
1522 if context is None:
1523 context = getcontext()
1524
1525 ans = self._check_nans(other, context)
1526 if ans:
1527 return ans
1528
1529 if self._isinfinity():
1530 if other._isinfinity():
1531 return context._raise_error(InvalidOperation, 'INF // INF')
1532 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001533 return _SignedInfinity[self._sign ^ other._sign]
Facundo Batistacce8df22007-09-18 16:53:18 +00001534
1535 if not other:
1536 if self:
1537 return context._raise_error(DivisionByZero, 'x // 0',
1538 self._sign ^ other._sign)
1539 else:
1540 return context._raise_error(DivisionUndefined, '0 // 0')
1541
1542 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001543
1544 def __rfloordiv__(self, other, context=None):
1545 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001546 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001547 if other is NotImplemented:
1548 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001549 return other.__floordiv__(self, context=context)
1550
1551 def __float__(self):
1552 """Float representation."""
1553 return float(str(self))
1554
1555 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001556 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001557 if self._is_special:
1558 if self._isnan():
1559 context = getcontext()
1560 return context._raise_error(InvalidContext)
1561 elif self._isinfinity():
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001562 raise OverflowError("Cannot convert infinity to int")
Facundo Batista353750c2007-09-13 18:13:15 +00001563 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001564 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001565 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001566 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001567 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001568
Raymond Hettinger5a053642008-01-24 19:05:29 +00001569 __trunc__ = __int__
1570
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001571 def real(self):
1572 return self
Mark Dickinson65808ff2009-01-04 21:22:02 +00001573 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001574
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001575 def imag(self):
1576 return Decimal(0)
Mark Dickinson65808ff2009-01-04 21:22:02 +00001577 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001578
1579 def conjugate(self):
1580 return self
1581
1582 def __complex__(self):
1583 return complex(float(self))
1584
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001585 def __long__(self):
1586 """Converts to a long.
1587
1588 Equivalent to long(int(self))
1589 """
1590 return long(self.__int__())
1591
Facundo Batista353750c2007-09-13 18:13:15 +00001592 def _fix_nan(self, context):
1593 """Decapitate the payload of a NaN to fit the context"""
1594 payload = self._int
1595
1596 # maximum length of payload is precision if _clamp=0,
1597 # precision-1 if _clamp=1.
1598 max_payload_len = context.prec - context._clamp
1599 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001600 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1601 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001602 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001603
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001604 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001605 """Round if it is necessary to keep self within prec precision.
1606
1607 Rounds and fixes the exponent. Does not raise on a sNaN.
1608
1609 Arguments:
1610 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001611 context - context used.
1612 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001613
Facundo Batista353750c2007-09-13 18:13:15 +00001614 if self._is_special:
1615 if self._isnan():
1616 # decapitate payload if necessary
1617 return self._fix_nan(context)
1618 else:
1619 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001620 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001621
Facundo Batista353750c2007-09-13 18:13:15 +00001622 # if self is zero then exponent should be between Etiny and
1623 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1624 Etiny = context.Etiny()
1625 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001626 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001627 exp_max = [context.Emax, Etop][context._clamp]
1628 new_exp = min(max(self._exp, Etiny), exp_max)
1629 if new_exp != self._exp:
1630 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001631 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001632 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001633 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001634
1635 # exp_min is the smallest allowable exponent of the result,
1636 # equal to max(self.adjusted()-context.prec+1, Etiny)
1637 exp_min = len(self._int) + self._exp - context.prec
1638 if exp_min > Etop:
1639 # overflow: exp_min > Etop iff self.adjusted() > Emax
1640 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001641 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00001642 return context._raise_error(Overflow, 'above Emax', self._sign)
1643 self_is_subnormal = exp_min < Etiny
1644 if self_is_subnormal:
1645 context._raise_error(Subnormal)
1646 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001647
Facundo Batista353750c2007-09-13 18:13:15 +00001648 # round if self has too many digits
1649 if self._exp < exp_min:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001650 context._raise_error(Rounded)
Facundo Batista2ec74152007-12-03 17:55:00 +00001651 digits = len(self._int) + self._exp - exp_min
1652 if digits < 0:
1653 self = _dec_from_triple(self._sign, '1', exp_min-1)
1654 digits = 0
1655 this_function = getattr(self, self._pick_rounding_function[context.rounding])
1656 changed = this_function(digits)
1657 coeff = self._int[:digits] or '0'
1658 if changed == 1:
1659 coeff = str(int(coeff)+1)
1660 ans = _dec_from_triple(self._sign, coeff, exp_min)
1661
1662 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001663 context._raise_error(Inexact)
1664 if self_is_subnormal:
1665 context._raise_error(Underflow)
1666 if not ans:
1667 # raise Clamped on underflow to 0
1668 context._raise_error(Clamped)
1669 elif len(ans._int) == context.prec+1:
1670 # we get here only if rescaling rounds the
1671 # cofficient up to exactly 10**context.prec
1672 if ans._exp < Etop:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001673 ans = _dec_from_triple(ans._sign,
1674 ans._int[:-1], ans._exp+1)
Facundo Batista353750c2007-09-13 18:13:15 +00001675 else:
1676 # Inexact and Rounded have already been raised
1677 ans = context._raise_error(Overflow, 'above Emax',
1678 self._sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001679 return ans
1680
Facundo Batista353750c2007-09-13 18:13:15 +00001681 # fold down if _clamp == 1 and self has too few digits
1682 if context._clamp == 1 and self._exp > Etop:
1683 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001684 self_padded = self._int + '0'*(self._exp - Etop)
1685 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001686
Facundo Batista353750c2007-09-13 18:13:15 +00001687 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001688 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001689
1690 _pick_rounding_function = {}
1691
Facundo Batista353750c2007-09-13 18:13:15 +00001692 # for each of the rounding functions below:
1693 # self is a finite, nonzero Decimal
1694 # prec is an integer satisfying 0 <= prec < len(self._int)
Facundo Batista2ec74152007-12-03 17:55:00 +00001695 #
1696 # each function returns either -1, 0, or 1, as follows:
1697 # 1 indicates that self should be rounded up (away from zero)
1698 # 0 indicates that self should be truncated, and that all the
1699 # digits to be truncated are zeros (so the value is unchanged)
1700 # -1 indicates that there are nonzero digits to be truncated
Facundo Batista353750c2007-09-13 18:13:15 +00001701
1702 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001703 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001704 if _all_zeros(self._int, prec):
1705 return 0
1706 else:
1707 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001708
Facundo Batista353750c2007-09-13 18:13:15 +00001709 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001710 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001711 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001712
Facundo Batista353750c2007-09-13 18:13:15 +00001713 def _round_half_up(self, prec):
1714 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001715 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001716 return 1
1717 elif _all_zeros(self._int, prec):
1718 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001719 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001720 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001721
1722 def _round_half_down(self, prec):
1723 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001724 if _exact_half(self._int, prec):
1725 return -1
1726 else:
1727 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001728
1729 def _round_half_even(self, prec):
1730 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001731 if _exact_half(self._int, prec) and \
1732 (prec == 0 or self._int[prec-1] in '02468'):
1733 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001734 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001735 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001736
1737 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001738 """Rounds up (not away from 0 if negative.)"""
1739 if self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001740 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001741 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001742 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001743
Facundo Batista353750c2007-09-13 18:13:15 +00001744 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001745 """Rounds down (not towards 0 if negative)"""
1746 if not self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001747 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001748 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001749 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001750
Facundo Batista353750c2007-09-13 18:13:15 +00001751 def _round_05up(self, prec):
1752 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001753 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001754 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001755 else:
1756 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001757
Facundo Batista353750c2007-09-13 18:13:15 +00001758 def fma(self, other, third, context=None):
1759 """Fused multiply-add.
1760
1761 Returns self*other+third with no rounding of the intermediate
1762 product self*other.
1763
1764 self and other are multiplied together, with no rounding of
1765 the result. The third operand is then added to the result,
1766 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001767 """
Facundo Batista353750c2007-09-13 18:13:15 +00001768
1769 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001770
1771 # compute product; raise InvalidOperation if either operand is
1772 # a signaling NaN or if the product is zero times infinity.
1773 if self._is_special or other._is_special:
1774 if context is None:
1775 context = getcontext()
1776 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001777 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001778 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001779 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001780 if self._exp == 'n':
1781 product = self
1782 elif other._exp == 'n':
1783 product = other
1784 elif self._exp == 'F':
1785 if not other:
1786 return context._raise_error(InvalidOperation,
1787 'INF * 0 in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001788 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001789 elif other._exp == 'F':
1790 if not self:
1791 return context._raise_error(InvalidOperation,
1792 '0 * INF in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001793 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001794 else:
1795 product = _dec_from_triple(self._sign ^ other._sign,
1796 str(int(self._int) * int(other._int)),
1797 self._exp + other._exp)
1798
Facundo Batista353750c2007-09-13 18:13:15 +00001799 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001800 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001801
Facundo Batista353750c2007-09-13 18:13:15 +00001802 def _power_modulo(self, other, modulo, context=None):
1803 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001804
Facundo Batista353750c2007-09-13 18:13:15 +00001805 # if can't convert other and modulo to Decimal, raise
1806 # TypeError; there's no point returning NotImplemented (no
1807 # equivalent of __rpow__ for three argument pow)
1808 other = _convert_other(other, raiseit=True)
1809 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001810
Facundo Batista353750c2007-09-13 18:13:15 +00001811 if context is None:
1812 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001813
Facundo Batista353750c2007-09-13 18:13:15 +00001814 # deal with NaNs: if there are any sNaNs then first one wins,
1815 # (i.e. behaviour for NaNs is identical to that of fma)
1816 self_is_nan = self._isnan()
1817 other_is_nan = other._isnan()
1818 modulo_is_nan = modulo._isnan()
1819 if self_is_nan or other_is_nan or modulo_is_nan:
1820 if self_is_nan == 2:
1821 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001822 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001823 if other_is_nan == 2:
1824 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001825 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001826 if modulo_is_nan == 2:
1827 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001828 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001829 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001830 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001831 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001832 return other._fix_nan(context)
1833 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001834
Facundo Batista353750c2007-09-13 18:13:15 +00001835 # check inputs: we apply same restrictions as Python's pow()
1836 if not (self._isinteger() and
1837 other._isinteger() and
1838 modulo._isinteger()):
1839 return context._raise_error(InvalidOperation,
1840 'pow() 3rd argument not allowed '
1841 'unless all arguments are integers')
1842 if other < 0:
1843 return context._raise_error(InvalidOperation,
1844 'pow() 2nd argument cannot be '
1845 'negative when 3rd argument specified')
1846 if not modulo:
1847 return context._raise_error(InvalidOperation,
1848 'pow() 3rd argument cannot be 0')
1849
1850 # additional restriction for decimal: the modulus must be less
1851 # than 10**prec in absolute value
1852 if modulo.adjusted() >= context.prec:
1853 return context._raise_error(InvalidOperation,
1854 'insufficient precision: pow() 3rd '
1855 'argument must not have more than '
1856 'precision digits')
1857
1858 # define 0**0 == NaN, for consistency with two-argument pow
1859 # (even though it hurts!)
1860 if not other and not self:
1861 return context._raise_error(InvalidOperation,
1862 'at least one of pow() 1st argument '
1863 'and 2nd argument must be nonzero ;'
1864 '0**0 is not defined')
1865
1866 # compute sign of result
1867 if other._iseven():
1868 sign = 0
1869 else:
1870 sign = self._sign
1871
1872 # convert modulo to a Python integer, and self and other to
1873 # Decimal integers (i.e. force their exponents to be >= 0)
1874 modulo = abs(int(modulo))
1875 base = _WorkRep(self.to_integral_value())
1876 exponent = _WorkRep(other.to_integral_value())
1877
1878 # compute result using integer pow()
1879 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1880 for i in xrange(exponent.exp):
1881 base = pow(base, 10, modulo)
1882 base = pow(base, exponent.int, modulo)
1883
Facundo Batista72bc54f2007-11-23 17:59:00 +00001884 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001885
1886 def _power_exact(self, other, p):
1887 """Attempt to compute self**other exactly.
1888
1889 Given Decimals self and other and an integer p, attempt to
1890 compute an exact result for the power self**other, with p
1891 digits of precision. Return None if self**other is not
1892 exactly representable in p digits.
1893
1894 Assumes that elimination of special cases has already been
1895 performed: self and other must both be nonspecial; self must
1896 be positive and not numerically equal to 1; other must be
1897 nonzero. For efficiency, other._exp should not be too large,
1898 so that 10**abs(other._exp) is a feasible calculation."""
1899
1900 # In the comments below, we write x for the value of self and
1901 # y for the value of other. Write x = xc*10**xe and y =
1902 # yc*10**ye.
1903
1904 # The main purpose of this method is to identify the *failure*
1905 # of x**y to be exactly representable with as little effort as
1906 # possible. So we look for cheap and easy tests that
1907 # eliminate the possibility of x**y being exact. Only if all
1908 # these tests are passed do we go on to actually compute x**y.
1909
1910 # Here's the main idea. First normalize both x and y. We
1911 # express y as a rational m/n, with m and n relatively prime
1912 # and n>0. Then for x**y to be exactly representable (at
1913 # *any* precision), xc must be the nth power of a positive
1914 # integer and xe must be divisible by n. If m is negative
1915 # then additionally xc must be a power of either 2 or 5, hence
1916 # a power of 2**n or 5**n.
1917 #
1918 # There's a limit to how small |y| can be: if y=m/n as above
1919 # then:
1920 #
1921 # (1) if xc != 1 then for the result to be representable we
1922 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1923 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1924 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1925 # representable.
1926 #
1927 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1928 # |y| < 1/|xe| then the result is not representable.
1929 #
1930 # Note that since x is not equal to 1, at least one of (1) and
1931 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1932 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1933 #
1934 # There's also a limit to how large y can be, at least if it's
1935 # positive: the normalized result will have coefficient xc**y,
1936 # so if it's representable then xc**y < 10**p, and y <
1937 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1938 # not exactly representable.
1939
1940 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1941 # so |y| < 1/xe and the result is not representable.
1942 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1943 # < 1/nbits(xc).
1944
1945 x = _WorkRep(self)
1946 xc, xe = x.int, x.exp
1947 while xc % 10 == 0:
1948 xc //= 10
1949 xe += 1
1950
1951 y = _WorkRep(other)
1952 yc, ye = y.int, y.exp
1953 while yc % 10 == 0:
1954 yc //= 10
1955 ye += 1
1956
1957 # case where xc == 1: result is 10**(xe*y), with xe*y
1958 # required to be an integer
1959 if xc == 1:
1960 if ye >= 0:
1961 exponent = xe*yc*10**ye
1962 else:
1963 exponent, remainder = divmod(xe*yc, 10**-ye)
1964 if remainder:
1965 return None
1966 if y.sign == 1:
1967 exponent = -exponent
1968 # if other is a nonnegative integer, use ideal exponent
1969 if other._isinteger() and other._sign == 0:
1970 ideal_exponent = self._exp*int(other)
1971 zeros = min(exponent-ideal_exponent, p-1)
1972 else:
1973 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00001974 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00001975
1976 # case where y is negative: xc must be either a power
1977 # of 2 or a power of 5.
1978 if y.sign == 1:
1979 last_digit = xc % 10
1980 if last_digit in (2,4,6,8):
1981 # quick test for power of 2
1982 if xc & -xc != xc:
1983 return None
1984 # now xc is a power of 2; e is its exponent
1985 e = _nbits(xc)-1
1986 # find e*y and xe*y; both must be integers
1987 if ye >= 0:
1988 y_as_int = yc*10**ye
1989 e = e*y_as_int
1990 xe = xe*y_as_int
1991 else:
1992 ten_pow = 10**-ye
1993 e, remainder = divmod(e*yc, ten_pow)
1994 if remainder:
1995 return None
1996 xe, remainder = divmod(xe*yc, ten_pow)
1997 if remainder:
1998 return None
1999
2000 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2001 return None
2002 xc = 5**e
2003
2004 elif last_digit == 5:
2005 # e >= log_5(xc) if xc is a power of 5; we have
2006 # equality all the way up to xc=5**2658
2007 e = _nbits(xc)*28//65
2008 xc, remainder = divmod(5**e, xc)
2009 if remainder:
2010 return None
2011 while xc % 5 == 0:
2012 xc //= 5
2013 e -= 1
2014 if ye >= 0:
2015 y_as_integer = yc*10**ye
2016 e = e*y_as_integer
2017 xe = xe*y_as_integer
2018 else:
2019 ten_pow = 10**-ye
2020 e, remainder = divmod(e*yc, ten_pow)
2021 if remainder:
2022 return None
2023 xe, remainder = divmod(xe*yc, ten_pow)
2024 if remainder:
2025 return None
2026 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2027 return None
2028 xc = 2**e
2029 else:
2030 return None
2031
2032 if xc >= 10**p:
2033 return None
2034 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00002035 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00002036
2037 # now y is positive; find m and n such that y = m/n
2038 if ye >= 0:
2039 m, n = yc*10**ye, 1
2040 else:
2041 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2042 return None
2043 xc_bits = _nbits(xc)
2044 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2045 return None
2046 m, n = yc, 10**(-ye)
2047 while m % 2 == n % 2 == 0:
2048 m //= 2
2049 n //= 2
2050 while m % 5 == n % 5 == 0:
2051 m //= 5
2052 n //= 5
2053
2054 # compute nth root of xc*10**xe
2055 if n > 1:
2056 # if 1 < xc < 2**n then xc isn't an nth power
2057 if xc != 1 and xc_bits <= n:
2058 return None
2059
2060 xe, rem = divmod(xe, n)
2061 if rem != 0:
2062 return None
2063
2064 # compute nth root of xc using Newton's method
2065 a = 1L << -(-_nbits(xc)//n) # initial estimate
2066 while True:
2067 q, r = divmod(xc, a**(n-1))
2068 if a <= q:
2069 break
2070 else:
2071 a = (a*(n-1) + q)//n
2072 if not (a == q and r == 0):
2073 return None
2074 xc = a
2075
2076 # now xc*10**xe is the nth root of the original xc*10**xe
2077 # compute mth power of xc*10**xe
2078
2079 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2080 # 10**p and the result is not representable.
2081 if xc > 1 and m > p*100//_log10_lb(xc):
2082 return None
2083 xc = xc**m
2084 xe *= m
2085 if xc > 10**p:
2086 return None
2087
2088 # by this point the result *is* exactly representable
2089 # adjust the exponent to get as close as possible to the ideal
2090 # exponent, if necessary
2091 str_xc = str(xc)
2092 if other._isinteger() and other._sign == 0:
2093 ideal_exponent = self._exp*int(other)
2094 zeros = min(xe-ideal_exponent, p-len(str_xc))
2095 else:
2096 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002097 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002098
2099 def __pow__(self, other, modulo=None, context=None):
2100 """Return self ** other [ % modulo].
2101
2102 With two arguments, compute self**other.
2103
2104 With three arguments, compute (self**other) % modulo. For the
2105 three argument form, the following restrictions on the
2106 arguments hold:
2107
2108 - all three arguments must be integral
2109 - other must be nonnegative
2110 - either self or other (or both) must be nonzero
2111 - modulo must be nonzero and must have at most p digits,
2112 where p is the context precision.
2113
2114 If any of these restrictions is violated the InvalidOperation
2115 flag is raised.
2116
2117 The result of pow(self, other, modulo) is identical to the
2118 result that would be obtained by computing (self**other) %
2119 modulo with unbounded precision, but is computed more
2120 efficiently. It is always exact.
2121 """
2122
2123 if modulo is not None:
2124 return self._power_modulo(other, modulo, context)
2125
2126 other = _convert_other(other)
2127 if other is NotImplemented:
2128 return other
2129
2130 if context is None:
2131 context = getcontext()
2132
2133 # either argument is a NaN => result is NaN
2134 ans = self._check_nans(other, context)
2135 if ans:
2136 return ans
2137
2138 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2139 if not other:
2140 if not self:
2141 return context._raise_error(InvalidOperation, '0 ** 0')
2142 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002143 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002144
2145 # result has sign 1 iff self._sign is 1 and other is an odd integer
2146 result_sign = 0
2147 if self._sign == 1:
2148 if other._isinteger():
2149 if not other._iseven():
2150 result_sign = 1
2151 else:
2152 # -ve**noninteger = NaN
2153 # (-0)**noninteger = 0**noninteger
2154 if self:
2155 return context._raise_error(InvalidOperation,
2156 'x ** y with x negative and y not an integer')
2157 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002158 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002159
2160 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2161 if not self:
2162 if other._sign == 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:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002165 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002166
2167 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002168 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002169 if other._sign == 0:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002170 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002171 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002172 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002173
Facundo Batista353750c2007-09-13 18:13:15 +00002174 # 1**other = 1, but the choice of exponent and the flags
2175 # depend on the exponent of self, and on whether other is a
2176 # positive integer, a negative integer, or neither
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002177 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002178 if other._isinteger():
2179 # exp = max(self._exp*max(int(other), 0),
2180 # 1-context.prec) but evaluating int(other) directly
2181 # is dangerous until we know other is small (other
2182 # could be 1e999999999)
2183 if other._sign == 1:
2184 multiplier = 0
2185 elif other > context.prec:
2186 multiplier = context.prec
2187 else:
2188 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002189
Facundo Batista353750c2007-09-13 18:13:15 +00002190 exp = self._exp * multiplier
2191 if exp < 1-context.prec:
2192 exp = 1-context.prec
2193 context._raise_error(Rounded)
2194 else:
2195 context._raise_error(Inexact)
2196 context._raise_error(Rounded)
2197 exp = 1-context.prec
2198
Facundo Batista72bc54f2007-11-23 17:59:00 +00002199 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002200
2201 # compute adjusted exponent of self
2202 self_adj = self.adjusted()
2203
2204 # self ** infinity is infinity if self > 1, 0 if self < 1
2205 # self ** -infinity is infinity if self < 1, 0 if self > 1
2206 if other._isinfinity():
2207 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002208 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002209 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002210 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002211
2212 # from here on, the result always goes through the call
2213 # to _fix at the end of this function.
2214 ans = None
2215
2216 # crude test to catch cases of extreme overflow/underflow. If
2217 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2218 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2219 # self**other >= 10**(Emax+1), so overflow occurs. The test
2220 # for underflow is similar.
2221 bound = self._log10_exp_bound() + other.adjusted()
2222 if (self_adj >= 0) == (other._sign == 0):
2223 # self > 1 and other +ve, or self < 1 and other -ve
2224 # possibility of overflow
2225 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002226 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002227 else:
2228 # self > 1 and other -ve, or self < 1 and other +ve
2229 # possibility of underflow to 0
2230 Etiny = context.Etiny()
2231 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002232 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002233
2234 # try for an exact result with precision +1
2235 if ans is None:
2236 ans = self._power_exact(other, context.prec + 1)
2237 if ans is not None and result_sign == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002238 ans = _dec_from_triple(1, ans._int, ans._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002239
2240 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2241 if ans is None:
2242 p = context.prec
2243 x = _WorkRep(self)
2244 xc, xe = x.int, x.exp
2245 y = _WorkRep(other)
2246 yc, ye = y.int, y.exp
2247 if y.sign == 1:
2248 yc = -yc
2249
2250 # compute correctly rounded result: start with precision +3,
2251 # then increase precision until result is unambiguously roundable
2252 extra = 3
2253 while True:
2254 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2255 if coeff % (5*10**(len(str(coeff))-p-1)):
2256 break
2257 extra += 3
2258
Facundo Batista72bc54f2007-11-23 17:59:00 +00002259 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002260
2261 # the specification says that for non-integer other we need to
2262 # raise Inexact, even when the result is actually exact. In
2263 # the same way, we need to raise Underflow here if the result
2264 # is subnormal. (The call to _fix will take care of raising
2265 # Rounded and Subnormal, as usual.)
2266 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002267 context._raise_error(Inexact)
Facundo Batista353750c2007-09-13 18:13:15 +00002268 # pad with zeros up to length context.prec+1 if necessary
2269 if len(ans._int) <= context.prec:
2270 expdiff = context.prec+1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002271 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2272 ans._exp-expdiff)
Facundo Batista353750c2007-09-13 18:13:15 +00002273 if ans.adjusted() < context.Emin:
2274 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002275
Facundo Batista353750c2007-09-13 18:13:15 +00002276 # unlike exp, ln and log10, the power function respects the
2277 # rounding mode; no need to use ROUND_HALF_EVEN here
2278 ans = ans._fix(context)
2279 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002280
2281 def __rpow__(self, other, context=None):
2282 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002283 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002284 if other is NotImplemented:
2285 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002286 return other.__pow__(self, context=context)
2287
2288 def normalize(self, context=None):
2289 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002290
Facundo Batista353750c2007-09-13 18:13:15 +00002291 if context is None:
2292 context = getcontext()
2293
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002294 if self._is_special:
2295 ans = self._check_nans(context=context)
2296 if ans:
2297 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002298
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002299 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002300 if dup._isinfinity():
2301 return dup
2302
2303 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002304 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002305 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002306 end = len(dup._int)
2307 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002308 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002309 exp += 1
2310 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002311 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002312
Facundo Batistabd2fe832007-09-13 18:42:09 +00002313 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002314 """Quantize self so its exponent is the same as that of exp.
2315
2316 Similar to self._rescale(exp._exp) but with error checking.
2317 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002318 exp = _convert_other(exp, raiseit=True)
2319
Facundo Batista353750c2007-09-13 18:13:15 +00002320 if context is None:
2321 context = getcontext()
2322 if rounding is None:
2323 rounding = context.rounding
2324
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002325 if self._is_special or exp._is_special:
2326 ans = self._check_nans(exp, context)
2327 if ans:
2328 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002329
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002330 if exp._isinfinity() or self._isinfinity():
2331 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002332 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002333 return context._raise_error(InvalidOperation,
2334 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002335
Facundo Batistabd2fe832007-09-13 18:42:09 +00002336 # if we're not watching exponents, do a simple rescale
2337 if not watchexp:
2338 ans = self._rescale(exp._exp, rounding)
2339 # raise Inexact and Rounded where appropriate
2340 if ans._exp > self._exp:
2341 context._raise_error(Rounded)
2342 if ans != self:
2343 context._raise_error(Inexact)
2344 return ans
2345
Facundo Batista353750c2007-09-13 18:13:15 +00002346 # exp._exp should be between Etiny and Emax
2347 if not (context.Etiny() <= exp._exp <= context.Emax):
2348 return context._raise_error(InvalidOperation,
2349 'target exponent out of bounds in quantize')
2350
2351 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002352 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002353 return ans._fix(context)
2354
2355 self_adjusted = self.adjusted()
2356 if self_adjusted > context.Emax:
2357 return context._raise_error(InvalidOperation,
2358 'exponent of quantize result too large for current context')
2359 if self_adjusted - exp._exp + 1 > context.prec:
2360 return context._raise_error(InvalidOperation,
2361 'quantize result has too many digits for current context')
2362
2363 ans = self._rescale(exp._exp, rounding)
2364 if ans.adjusted() > context.Emax:
2365 return context._raise_error(InvalidOperation,
2366 'exponent of quantize result too large for current context')
2367 if len(ans._int) > context.prec:
2368 return context._raise_error(InvalidOperation,
2369 'quantize result has too many digits for current context')
2370
2371 # raise appropriate flags
2372 if ans._exp > self._exp:
2373 context._raise_error(Rounded)
2374 if ans != self:
2375 context._raise_error(Inexact)
2376 if ans and ans.adjusted() < context.Emin:
2377 context._raise_error(Subnormal)
2378
2379 # call to fix takes care of any necessary folddown
2380 ans = ans._fix(context)
2381 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002382
2383 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002384 """Return True if self and other have the same exponent; otherwise
2385 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002386
Facundo Batista1a191df2007-10-02 17:01:24 +00002387 If either operand is a special value, the following rules are used:
2388 * return True if both operands are infinities
2389 * return True if both operands are NaNs
2390 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002391 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002392 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002393 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002394 return (self.is_nan() and other.is_nan() or
2395 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002396 return self._exp == other._exp
2397
Facundo Batista353750c2007-09-13 18:13:15 +00002398 def _rescale(self, exp, rounding):
2399 """Rescale self so that the exponent is exp, either by padding with zeros
2400 or by truncating digits, using the given rounding mode.
2401
2402 Specials are returned without change. This operation is
2403 quiet: it raises no flags, and uses no information from the
2404 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002405
2406 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002407 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002408 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002409 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002410 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002411 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002412 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002413
Facundo Batista353750c2007-09-13 18:13:15 +00002414 if self._exp >= exp:
2415 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002416 return _dec_from_triple(self._sign,
2417 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002418
Facundo Batista353750c2007-09-13 18:13:15 +00002419 # too many digits; round and lose data. If self.adjusted() <
2420 # exp-1, replace self by 10**(exp-1) before rounding
2421 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002422 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002423 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002424 digits = 0
2425 this_function = getattr(self, self._pick_rounding_function[rounding])
Facundo Batista2ec74152007-12-03 17:55:00 +00002426 changed = this_function(digits)
2427 coeff = self._int[:digits] or '0'
2428 if changed == 1:
2429 coeff = str(int(coeff)+1)
2430 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002431
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002432 def _round(self, places, rounding):
2433 """Round a nonzero, nonspecial Decimal to a fixed number of
2434 significant figures, using the given rounding mode.
2435
2436 Infinities, NaNs and zeros are returned unaltered.
2437
2438 This operation is quiet: it raises no flags, and uses no
2439 information from the context.
2440
2441 """
2442 if places <= 0:
2443 raise ValueError("argument should be at least 1 in _round")
2444 if self._is_special or not self:
2445 return Decimal(self)
2446 ans = self._rescale(self.adjusted()+1-places, rounding)
2447 # it can happen that the rescale alters the adjusted exponent;
2448 # for example when rounding 99.97 to 3 significant figures.
2449 # When this happens we end up with an extra 0 at the end of
2450 # the number; a second rescale fixes this.
2451 if ans.adjusted() != self.adjusted():
2452 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2453 return ans
2454
Facundo Batista353750c2007-09-13 18:13:15 +00002455 def to_integral_exact(self, rounding=None, context=None):
2456 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002457
Facundo Batista353750c2007-09-13 18:13:15 +00002458 If no rounding mode is specified, take the rounding mode from
2459 the context. This method raises the Rounded and Inexact flags
2460 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002461
Facundo Batista353750c2007-09-13 18:13:15 +00002462 See also: to_integral_value, which does exactly the same as
2463 this method except that it doesn't raise Inexact or Rounded.
2464 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002465 if self._is_special:
2466 ans = self._check_nans(context=context)
2467 if ans:
2468 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002469 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002470 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002471 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002472 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002473 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002474 if context is None:
2475 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002476 if rounding is None:
2477 rounding = context.rounding
2478 context._raise_error(Rounded)
2479 ans = self._rescale(0, rounding)
2480 if ans != self:
2481 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002482 return ans
2483
Facundo Batista353750c2007-09-13 18:13:15 +00002484 def to_integral_value(self, rounding=None, context=None):
2485 """Rounds to the nearest integer, without raising inexact, rounded."""
2486 if context is None:
2487 context = getcontext()
2488 if rounding is None:
2489 rounding = context.rounding
2490 if self._is_special:
2491 ans = self._check_nans(context=context)
2492 if ans:
2493 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002494 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002495 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002496 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002497 else:
2498 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002499
Facundo Batista353750c2007-09-13 18:13:15 +00002500 # the method name changed, but we provide also the old one, for compatibility
2501 to_integral = to_integral_value
2502
2503 def sqrt(self, context=None):
2504 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002505 if context is None:
2506 context = getcontext()
2507
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002508 if self._is_special:
2509 ans = self._check_nans(context=context)
2510 if ans:
2511 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002512
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002513 if self._isinfinity() and self._sign == 0:
2514 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002515
2516 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002517 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002518 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002519 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002520
2521 if self._sign == 1:
2522 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2523
Facundo Batista353750c2007-09-13 18:13:15 +00002524 # At this point self represents a positive number. Let p be
2525 # the desired precision and express self in the form c*100**e
2526 # with c a positive real number and e an integer, c and e
2527 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2528 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2529 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2530 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2531 # the closest integer to sqrt(c) with the even integer chosen
2532 # in the case of a tie.
2533 #
2534 # To ensure correct rounding in all cases, we use the
2535 # following trick: we compute the square root to an extra
2536 # place (precision p+1 instead of precision p), rounding down.
2537 # Then, if the result is inexact and its last digit is 0 or 5,
2538 # we increase the last digit to 1 or 6 respectively; if it's
2539 # exact we leave the last digit alone. Now the final round to
2540 # p places (or fewer in the case of underflow) will round
2541 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002542
Facundo Batista353750c2007-09-13 18:13:15 +00002543 # use an extra digit of precision
2544 prec = context.prec+1
2545
2546 # write argument in the form c*100**e where e = self._exp//2
2547 # is the 'ideal' exponent, to be used if the square root is
2548 # exactly representable. l is the number of 'digits' of c in
2549 # base 100, so that 100**(l-1) <= c < 100**l.
2550 op = _WorkRep(self)
2551 e = op.exp >> 1
2552 if op.exp & 1:
2553 c = op.int * 10
2554 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002555 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002556 c = op.int
2557 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002558
Facundo Batista353750c2007-09-13 18:13:15 +00002559 # rescale so that c has exactly prec base 100 'digits'
2560 shift = prec-l
2561 if shift >= 0:
2562 c *= 100**shift
2563 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002564 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002565 c, remainder = divmod(c, 100**-shift)
2566 exact = not remainder
2567 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002568
Facundo Batista353750c2007-09-13 18:13:15 +00002569 # find n = floor(sqrt(c)) using Newton's method
2570 n = 10**prec
2571 while True:
2572 q = c//n
2573 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002574 break
Facundo Batista353750c2007-09-13 18:13:15 +00002575 else:
2576 n = n + q >> 1
2577 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002578
Facundo Batista353750c2007-09-13 18:13:15 +00002579 if exact:
2580 # result is exact; rescale to use ideal exponent e
2581 if shift >= 0:
2582 # assert n % 10**shift == 0
2583 n //= 10**shift
2584 else:
2585 n *= 10**-shift
2586 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002587 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002588 # result is not exact; fix last digit as described above
2589 if n % 5 == 0:
2590 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002591
Facundo Batista72bc54f2007-11-23 17:59:00 +00002592 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002593
Facundo Batista353750c2007-09-13 18:13:15 +00002594 # round, and fit to current context
2595 context = context._shallow_copy()
2596 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002597 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002598 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002599
Facundo Batista353750c2007-09-13 18:13:15 +00002600 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002601
2602 def max(self, other, context=None):
2603 """Returns the larger value.
2604
Facundo Batista353750c2007-09-13 18:13:15 +00002605 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002606 NaN (and signals if one is sNaN). Also rounds.
2607 """
Facundo Batista353750c2007-09-13 18:13:15 +00002608 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002609
Facundo Batista6c398da2007-09-17 17:30:13 +00002610 if context is None:
2611 context = getcontext()
2612
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002613 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002614 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002615 # number is always returned
2616 sn = self._isnan()
2617 on = other._isnan()
2618 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002619 if on == 1 and sn == 0:
2620 return self._fix(context)
2621 if sn == 1 and on == 0:
2622 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002623 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002624
Mark Dickinson2fc92632008-02-06 22:10:50 +00002625 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002626 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002627 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002628 # then an ordering is applied:
2629 #
Facundo Batista59c58842007-04-10 12:58:45 +00002630 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002631 # positive sign and min returns the operand with the negative sign
2632 #
Facundo Batista59c58842007-04-10 12:58:45 +00002633 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002634 # the result. This is exactly the ordering used in compare_total.
2635 c = self.compare_total(other)
2636
2637 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002638 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002639 else:
2640 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002641
Facundo Batistae64acfa2007-12-17 14:18:42 +00002642 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002643
2644 def min(self, other, context=None):
2645 """Returns the smaller value.
2646
Facundo Batista59c58842007-04-10 12:58:45 +00002647 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002648 NaN (and signals if one is sNaN). Also rounds.
2649 """
Facundo Batista353750c2007-09-13 18:13:15 +00002650 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002651
Facundo Batista6c398da2007-09-17 17:30:13 +00002652 if context is None:
2653 context = getcontext()
2654
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002655 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002656 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002657 # number is always returned
2658 sn = self._isnan()
2659 on = other._isnan()
2660 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002661 if on == 1 and sn == 0:
2662 return self._fix(context)
2663 if sn == 1 and on == 0:
2664 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002665 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002666
Mark Dickinson2fc92632008-02-06 22:10:50 +00002667 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002668 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002669 c = self.compare_total(other)
2670
2671 if c == -1:
2672 ans = self
2673 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002674 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002675
Facundo Batistae64acfa2007-12-17 14:18:42 +00002676 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002677
2678 def _isinteger(self):
2679 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002680 if self._is_special:
2681 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002682 if self._exp >= 0:
2683 return True
2684 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002685 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002686
2687 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002688 """Returns True if self is even. Assumes self is an integer."""
2689 if not self or self._exp > 0:
2690 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002691 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002692
2693 def adjusted(self):
2694 """Return the adjusted exponent of self"""
2695 try:
2696 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002697 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002698 except TypeError:
2699 return 0
2700
Facundo Batista353750c2007-09-13 18:13:15 +00002701 def canonical(self, context=None):
2702 """Returns the same Decimal object.
2703
2704 As we do not have different encodings for the same number, the
2705 received object already is in its canonical form.
2706 """
2707 return self
2708
2709 def compare_signal(self, other, context=None):
2710 """Compares self to the other operand numerically.
2711
2712 It's pretty much like compare(), but all NaNs signal, with signaling
2713 NaNs taking precedence over quiet NaNs.
2714 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002715 other = _convert_other(other, raiseit = True)
2716 ans = self._compare_check_nans(other, context)
2717 if ans:
2718 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002719 return self.compare(other, context=context)
2720
2721 def compare_total(self, other):
2722 """Compares self to other using the abstract representations.
2723
2724 This is not like the standard compare, which use their numerical
2725 value. Note that a total ordering is defined for all possible abstract
2726 representations.
2727 """
2728 # if one is negative and the other is positive, it's easy
2729 if self._sign and not other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002730 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002731 if not self._sign and other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002732 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002733 sign = self._sign
2734
2735 # let's handle both NaN types
2736 self_nan = self._isnan()
2737 other_nan = other._isnan()
2738 if self_nan or other_nan:
2739 if self_nan == other_nan:
2740 if self._int < other._int:
2741 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002742 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002743 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002744 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002745 if self._int > other._int:
2746 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002747 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002748 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002749 return _One
2750 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002751
2752 if sign:
2753 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002754 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002755 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002756 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002757 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002758 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002759 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002760 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002761 else:
2762 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002763 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002764 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002765 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002766 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002767 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002768 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002769 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002770
2771 if self < other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002772 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002773 if self > other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002774 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002775
2776 if self._exp < other._exp:
2777 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002778 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002779 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002780 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002781 if self._exp > other._exp:
2782 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002783 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002784 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002785 return _One
2786 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002787
2788
2789 def compare_total_mag(self, other):
2790 """Compares self to other using abstract repr., ignoring sign.
2791
2792 Like compare_total, but with operand's sign ignored and assumed to be 0.
2793 """
2794 s = self.copy_abs()
2795 o = other.copy_abs()
2796 return s.compare_total(o)
2797
2798 def copy_abs(self):
2799 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002800 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002801
2802 def copy_negate(self):
2803 """Returns a copy with the sign inverted."""
2804 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002805 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002806 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002807 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002808
2809 def copy_sign(self, other):
2810 """Returns self with the sign of other."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002811 return _dec_from_triple(other._sign, self._int,
2812 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002813
2814 def exp(self, context=None):
2815 """Returns e ** self."""
2816
2817 if context is None:
2818 context = getcontext()
2819
2820 # exp(NaN) = NaN
2821 ans = self._check_nans(context=context)
2822 if ans:
2823 return ans
2824
2825 # exp(-Infinity) = 0
2826 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002827 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002828
2829 # exp(0) = 1
2830 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002831 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002832
2833 # exp(Infinity) = Infinity
2834 if self._isinfinity() == 1:
2835 return Decimal(self)
2836
2837 # the result is now guaranteed to be inexact (the true
2838 # mathematical result is transcendental). There's no need to
2839 # raise Rounded and Inexact here---they'll always be raised as
2840 # a result of the call to _fix.
2841 p = context.prec
2842 adj = self.adjusted()
2843
2844 # we only need to do any computation for quite a small range
2845 # of adjusted exponents---for example, -29 <= adj <= 10 for
2846 # the default context. For smaller exponent the result is
2847 # indistinguishable from 1 at the given precision, while for
2848 # larger exponent the result either overflows or underflows.
2849 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2850 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002851 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002852 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2853 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002854 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002855 elif self._sign == 0 and adj < -p:
2856 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002857 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002858 elif self._sign == 1 and adj < -p-1:
2859 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002860 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002861 # general case
2862 else:
2863 op = _WorkRep(self)
2864 c, e = op.int, op.exp
2865 if op.sign == 1:
2866 c = -c
2867
2868 # compute correctly rounded result: increase precision by
2869 # 3 digits at a time until we get an unambiguously
2870 # roundable result
2871 extra = 3
2872 while True:
2873 coeff, exp = _dexp(c, e, p+extra)
2874 if coeff % (5*10**(len(str(coeff))-p-1)):
2875 break
2876 extra += 3
2877
Facundo Batista72bc54f2007-11-23 17:59:00 +00002878 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002879
2880 # at this stage, ans should round correctly with *any*
2881 # rounding mode, not just with ROUND_HALF_EVEN
2882 context = context._shallow_copy()
2883 rounding = context._set_rounding(ROUND_HALF_EVEN)
2884 ans = ans._fix(context)
2885 context.rounding = rounding
2886
2887 return ans
2888
2889 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002890 """Return True if self is canonical; otherwise return False.
2891
2892 Currently, the encoding of a Decimal instance is always
2893 canonical, so this method returns True for any Decimal.
2894 """
2895 return True
Facundo Batista353750c2007-09-13 18:13:15 +00002896
2897 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002898 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00002899
Facundo Batista1a191df2007-10-02 17:01:24 +00002900 A Decimal instance is considered finite if it is neither
2901 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00002902 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002903 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00002904
2905 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002906 """Return True if self is infinite; otherwise return False."""
2907 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00002908
2909 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002910 """Return True if self is a qNaN or sNaN; otherwise return False."""
2911 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00002912
2913 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002914 """Return True if self is a normal number; otherwise return False."""
2915 if self._is_special or not self:
2916 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002917 if context is None:
2918 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002919 return context.Emin <= self.adjusted() <= context.Emax
Facundo Batista353750c2007-09-13 18:13:15 +00002920
2921 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002922 """Return True if self is a quiet NaN; otherwise return False."""
2923 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00002924
2925 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002926 """Return True if self is negative; otherwise return False."""
2927 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00002928
2929 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002930 """Return True if self is a signaling NaN; otherwise return False."""
2931 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00002932
2933 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002934 """Return True if self is subnormal; otherwise return False."""
2935 if self._is_special or not self:
2936 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002937 if context is None:
2938 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002939 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00002940
2941 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002942 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002943 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00002944
2945 def _ln_exp_bound(self):
2946 """Compute a lower bound for the adjusted exponent of self.ln().
2947 In other words, compute r such that self.ln() >= 10**r. Assumes
2948 that self is finite and positive and that self != 1.
2949 """
2950
2951 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
2952 adj = self._exp + len(self._int) - 1
2953 if adj >= 1:
2954 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
2955 return len(str(adj*23//10)) - 1
2956 if adj <= -2:
2957 # argument <= 0.1
2958 return len(str((-1-adj)*23//10)) - 1
2959 op = _WorkRep(self)
2960 c, e = op.int, op.exp
2961 if adj == 0:
2962 # 1 < self < 10
2963 num = str(c-10**-e)
2964 den = str(c)
2965 return len(num) - len(den) - (num < den)
2966 # adj == -1, 0.1 <= self < 1
2967 return e + len(str(10**-e - c)) - 1
2968
2969
2970 def ln(self, context=None):
2971 """Returns the natural (base e) logarithm of self."""
2972
2973 if context is None:
2974 context = getcontext()
2975
2976 # ln(NaN) = NaN
2977 ans = self._check_nans(context=context)
2978 if ans:
2979 return ans
2980
2981 # ln(0.0) == -Infinity
2982 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002983 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00002984
2985 # ln(Infinity) = Infinity
2986 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002987 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00002988
2989 # ln(1.0) == 0.0
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002990 if self == _One:
2991 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002992
2993 # ln(negative) raises InvalidOperation
2994 if self._sign == 1:
2995 return context._raise_error(InvalidOperation,
2996 'ln of a negative value')
2997
2998 # result is irrational, so necessarily inexact
2999 op = _WorkRep(self)
3000 c, e = op.int, op.exp
3001 p = context.prec
3002
3003 # correctly rounded result: repeatedly increase precision by 3
3004 # until we get an unambiguously roundable result
3005 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3006 while True:
3007 coeff = _dlog(c, e, places)
3008 # assert len(str(abs(coeff)))-p >= 1
3009 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3010 break
3011 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003012 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003013
3014 context = context._shallow_copy()
3015 rounding = context._set_rounding(ROUND_HALF_EVEN)
3016 ans = ans._fix(context)
3017 context.rounding = rounding
3018 return ans
3019
3020 def _log10_exp_bound(self):
3021 """Compute a lower bound for the adjusted exponent of self.log10().
3022 In other words, find r such that self.log10() >= 10**r.
3023 Assumes that self is finite and positive and that self != 1.
3024 """
3025
3026 # For x >= 10 or x < 0.1 we only need a bound on the integer
3027 # part of log10(self), and this comes directly from the
3028 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3029 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3030 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3031
3032 adj = self._exp + len(self._int) - 1
3033 if adj >= 1:
3034 # self >= 10
3035 return len(str(adj))-1
3036 if adj <= -2:
3037 # self < 0.1
3038 return len(str(-1-adj))-1
3039 op = _WorkRep(self)
3040 c, e = op.int, op.exp
3041 if adj == 0:
3042 # 1 < self < 10
3043 num = str(c-10**-e)
3044 den = str(231*c)
3045 return len(num) - len(den) - (num < den) + 2
3046 # adj == -1, 0.1 <= self < 1
3047 num = str(10**-e-c)
3048 return len(num) + e - (num < "231") - 1
3049
3050 def log10(self, context=None):
3051 """Returns the base 10 logarithm of self."""
3052
3053 if context is None:
3054 context = getcontext()
3055
3056 # log10(NaN) = NaN
3057 ans = self._check_nans(context=context)
3058 if ans:
3059 return ans
3060
3061 # log10(0.0) == -Infinity
3062 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003063 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003064
3065 # log10(Infinity) = Infinity
3066 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003067 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003068
3069 # log10(negative or -Infinity) raises InvalidOperation
3070 if self._sign == 1:
3071 return context._raise_error(InvalidOperation,
3072 'log10 of a negative value')
3073
3074 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003075 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003076 # answer may need rounding
3077 ans = Decimal(self._exp + len(self._int) - 1)
3078 else:
3079 # result is irrational, so necessarily inexact
3080 op = _WorkRep(self)
3081 c, e = op.int, op.exp
3082 p = context.prec
3083
3084 # correctly rounded result: repeatedly increase precision
3085 # until result is unambiguously roundable
3086 places = p-self._log10_exp_bound()+2
3087 while True:
3088 coeff = _dlog10(c, e, places)
3089 # assert len(str(abs(coeff)))-p >= 1
3090 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3091 break
3092 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003093 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003094
3095 context = context._shallow_copy()
3096 rounding = context._set_rounding(ROUND_HALF_EVEN)
3097 ans = ans._fix(context)
3098 context.rounding = rounding
3099 return ans
3100
3101 def logb(self, context=None):
3102 """ Returns the exponent of the magnitude of self's MSD.
3103
3104 The result is the integer which is the exponent of the magnitude
3105 of the most significant digit of self (as though it were truncated
3106 to a single digit while maintaining the value of that digit and
3107 without limiting the resulting exponent).
3108 """
3109 # logb(NaN) = NaN
3110 ans = self._check_nans(context=context)
3111 if ans:
3112 return ans
3113
3114 if context is None:
3115 context = getcontext()
3116
3117 # logb(+/-Inf) = +Inf
3118 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003119 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003120
3121 # logb(0) = -Inf, DivisionByZero
3122 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003123 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003124
3125 # otherwise, simply return the adjusted exponent of self, as a
3126 # Decimal. Note that no attempt is made to fit the result
3127 # into the current context.
3128 return Decimal(self.adjusted())
3129
3130 def _islogical(self):
3131 """Return True if self is a logical operand.
3132
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003133 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003134 an exponent of 0, and a coefficient whose digits must all be
3135 either 0 or 1.
3136 """
3137 if self._sign != 0 or self._exp != 0:
3138 return False
3139 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003140 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003141 return False
3142 return True
3143
3144 def _fill_logical(self, context, opa, opb):
3145 dif = context.prec - len(opa)
3146 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003147 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003148 elif dif < 0:
3149 opa = opa[-context.prec:]
3150 dif = context.prec - len(opb)
3151 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003152 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003153 elif dif < 0:
3154 opb = opb[-context.prec:]
3155 return opa, opb
3156
3157 def logical_and(self, other, context=None):
3158 """Applies an 'and' operation between self and other's digits."""
3159 if context is None:
3160 context = getcontext()
3161 if not self._islogical() or not other._islogical():
3162 return context._raise_error(InvalidOperation)
3163
3164 # fill to context.prec
3165 (opa, opb) = self._fill_logical(context, self._int, other._int)
3166
3167 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003168 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3169 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003170
3171 def logical_invert(self, context=None):
3172 """Invert all its digits."""
3173 if context is None:
3174 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003175 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3176 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003177
3178 def logical_or(self, other, context=None):
3179 """Applies an 'or' operation between self and other's digits."""
3180 if context is None:
3181 context = getcontext()
3182 if not self._islogical() or not other._islogical():
3183 return context._raise_error(InvalidOperation)
3184
3185 # fill to context.prec
3186 (opa, opb) = self._fill_logical(context, self._int, other._int)
3187
3188 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003189 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003190 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003191
3192 def logical_xor(self, other, context=None):
3193 """Applies an 'xor' operation between self and other's digits."""
3194 if context is None:
3195 context = getcontext()
3196 if not self._islogical() or not other._islogical():
3197 return context._raise_error(InvalidOperation)
3198
3199 # fill to context.prec
3200 (opa, opb) = self._fill_logical(context, self._int, other._int)
3201
3202 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003203 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003204 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003205
3206 def max_mag(self, other, context=None):
3207 """Compares the values numerically with their sign ignored."""
3208 other = _convert_other(other, raiseit=True)
3209
Facundo Batista6c398da2007-09-17 17:30:13 +00003210 if context is None:
3211 context = getcontext()
3212
Facundo Batista353750c2007-09-13 18:13:15 +00003213 if self._is_special or other._is_special:
3214 # If one operand is a quiet NaN and the other is number, then the
3215 # number is always returned
3216 sn = self._isnan()
3217 on = other._isnan()
3218 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003219 if on == 1 and sn == 0:
3220 return self._fix(context)
3221 if sn == 1 and on == 0:
3222 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003223 return self._check_nans(other, context)
3224
Mark Dickinson2fc92632008-02-06 22:10:50 +00003225 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003226 if c == 0:
3227 c = self.compare_total(other)
3228
3229 if c == -1:
3230 ans = other
3231 else:
3232 ans = self
3233
Facundo Batistae64acfa2007-12-17 14:18:42 +00003234 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003235
3236 def min_mag(self, other, context=None):
3237 """Compares the values numerically with their sign ignored."""
3238 other = _convert_other(other, raiseit=True)
3239
Facundo Batista6c398da2007-09-17 17:30:13 +00003240 if context is None:
3241 context = getcontext()
3242
Facundo Batista353750c2007-09-13 18:13:15 +00003243 if self._is_special or other._is_special:
3244 # If one operand is a quiet NaN and the other is number, then the
3245 # number is always returned
3246 sn = self._isnan()
3247 on = other._isnan()
3248 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003249 if on == 1 and sn == 0:
3250 return self._fix(context)
3251 if sn == 1 and on == 0:
3252 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003253 return self._check_nans(other, context)
3254
Mark Dickinson2fc92632008-02-06 22:10:50 +00003255 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003256 if c == 0:
3257 c = self.compare_total(other)
3258
3259 if c == -1:
3260 ans = self
3261 else:
3262 ans = other
3263
Facundo Batistae64acfa2007-12-17 14:18:42 +00003264 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003265
3266 def next_minus(self, context=None):
3267 """Returns the largest representable number smaller than itself."""
3268 if context is None:
3269 context = getcontext()
3270
3271 ans = self._check_nans(context=context)
3272 if ans:
3273 return ans
3274
3275 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003276 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003277 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003278 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003279
3280 context = context.copy()
3281 context._set_rounding(ROUND_FLOOR)
3282 context._ignore_all_flags()
3283 new_self = self._fix(context)
3284 if new_self != self:
3285 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003286 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3287 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003288
3289 def next_plus(self, context=None):
3290 """Returns the smallest representable number larger than itself."""
3291 if context is None:
3292 context = getcontext()
3293
3294 ans = self._check_nans(context=context)
3295 if ans:
3296 return ans
3297
3298 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003299 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003300 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003301 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003302
3303 context = context.copy()
3304 context._set_rounding(ROUND_CEILING)
3305 context._ignore_all_flags()
3306 new_self = self._fix(context)
3307 if new_self != self:
3308 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003309 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3310 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003311
3312 def next_toward(self, other, context=None):
3313 """Returns the number closest to self, in the direction towards other.
3314
3315 The result is the closest representable number to self
3316 (excluding self) that is in the direction towards other,
3317 unless both have the same value. If the two operands are
3318 numerically equal, then the result is a copy of self with the
3319 sign set to be the same as the sign of other.
3320 """
3321 other = _convert_other(other, raiseit=True)
3322
3323 if context is None:
3324 context = getcontext()
3325
3326 ans = self._check_nans(other, context)
3327 if ans:
3328 return ans
3329
Mark Dickinson2fc92632008-02-06 22:10:50 +00003330 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003331 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003332 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003333
3334 if comparison == -1:
3335 ans = self.next_plus(context)
3336 else: # comparison == 1
3337 ans = self.next_minus(context)
3338
3339 # decide which flags to raise using value of ans
3340 if ans._isinfinity():
3341 context._raise_error(Overflow,
3342 'Infinite result from next_toward',
3343 ans._sign)
3344 context._raise_error(Rounded)
3345 context._raise_error(Inexact)
3346 elif ans.adjusted() < context.Emin:
3347 context._raise_error(Underflow)
3348 context._raise_error(Subnormal)
3349 context._raise_error(Rounded)
3350 context._raise_error(Inexact)
3351 # if precision == 1 then we don't raise Clamped for a
3352 # result 0E-Etiny.
3353 if not ans:
3354 context._raise_error(Clamped)
3355
3356 return ans
3357
3358 def number_class(self, context=None):
3359 """Returns an indication of the class of self.
3360
3361 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003362 sNaN
3363 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003364 -Infinity
3365 -Normal
3366 -Subnormal
3367 -Zero
3368 +Zero
3369 +Subnormal
3370 +Normal
3371 +Infinity
3372 """
3373 if self.is_snan():
3374 return "sNaN"
3375 if self.is_qnan():
3376 return "NaN"
3377 inf = self._isinfinity()
3378 if inf == 1:
3379 return "+Infinity"
3380 if inf == -1:
3381 return "-Infinity"
3382 if self.is_zero():
3383 if self._sign:
3384 return "-Zero"
3385 else:
3386 return "+Zero"
3387 if context is None:
3388 context = getcontext()
3389 if self.is_subnormal(context=context):
3390 if self._sign:
3391 return "-Subnormal"
3392 else:
3393 return "+Subnormal"
3394 # just a normal, regular, boring number, :)
3395 if self._sign:
3396 return "-Normal"
3397 else:
3398 return "+Normal"
3399
3400 def radix(self):
3401 """Just returns 10, as this is Decimal, :)"""
3402 return Decimal(10)
3403
3404 def rotate(self, other, context=None):
3405 """Returns a rotated copy of self, value-of-other times."""
3406 if context is None:
3407 context = getcontext()
3408
3409 ans = self._check_nans(other, context)
3410 if ans:
3411 return ans
3412
3413 if other._exp != 0:
3414 return context._raise_error(InvalidOperation)
3415 if not (-context.prec <= int(other) <= context.prec):
3416 return context._raise_error(InvalidOperation)
3417
3418 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003419 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003420
3421 # get values, pad if necessary
3422 torot = int(other)
3423 rotdig = self._int
3424 topad = context.prec - len(rotdig)
3425 if topad:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003426 rotdig = '0'*topad + rotdig
Facundo Batista353750c2007-09-13 18:13:15 +00003427
3428 # let's rotate!
3429 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003430 return _dec_from_triple(self._sign,
3431 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003432
3433 def scaleb (self, other, context=None):
3434 """Returns self operand after adding the second value to its exp."""
3435 if context is None:
3436 context = getcontext()
3437
3438 ans = self._check_nans(other, context)
3439 if ans:
3440 return ans
3441
3442 if other._exp != 0:
3443 return context._raise_error(InvalidOperation)
3444 liminf = -2 * (context.Emax + context.prec)
3445 limsup = 2 * (context.Emax + context.prec)
3446 if not (liminf <= int(other) <= limsup):
3447 return context._raise_error(InvalidOperation)
3448
3449 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003450 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003451
Facundo Batista72bc54f2007-11-23 17:59:00 +00003452 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003453 d = d._fix(context)
3454 return d
3455
3456 def shift(self, other, context=None):
3457 """Returns a shifted copy of self, value-of-other times."""
3458 if context is None:
3459 context = getcontext()
3460
3461 ans = self._check_nans(other, context)
3462 if ans:
3463 return ans
3464
3465 if other._exp != 0:
3466 return context._raise_error(InvalidOperation)
3467 if not (-context.prec <= int(other) <= context.prec):
3468 return context._raise_error(InvalidOperation)
3469
3470 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003471 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003472
3473 # get values, pad if necessary
3474 torot = int(other)
3475 if not torot:
Facundo Batista6c398da2007-09-17 17:30:13 +00003476 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003477 rotdig = self._int
3478 topad = context.prec - len(rotdig)
3479 if topad:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003480 rotdig = '0'*topad + rotdig
Facundo Batista353750c2007-09-13 18:13:15 +00003481
3482 # let's shift!
3483 if torot < 0:
3484 rotated = rotdig[:torot]
3485 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003486 rotated = rotdig + '0'*torot
Facundo Batista353750c2007-09-13 18:13:15 +00003487 rotated = rotated[-context.prec:]
3488
Facundo Batista72bc54f2007-11-23 17:59:00 +00003489 return _dec_from_triple(self._sign,
3490 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003491
Facundo Batista59c58842007-04-10 12:58:45 +00003492 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003493 def __reduce__(self):
3494 return (self.__class__, (str(self),))
3495
3496 def __copy__(self):
3497 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003498 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003499 return self.__class__(str(self))
3500
3501 def __deepcopy__(self, memo):
3502 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003503 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003504 return self.__class__(str(self))
3505
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003506 # PEP 3101 support. See also _parse_format_specifier and _format_align
3507 def __format__(self, specifier, context=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003508 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003509
3510 The specifier should be a standard format specifier, with the
3511 form described in PEP 3101. Formatting types 'e', 'E', 'f',
3512 'F', 'g', 'G', and '%' are supported. If the formatting type
3513 is omitted it defaults to 'g' or 'G', depending on the value
3514 of context.capitals.
3515
3516 At this time the 'n' format specifier type (which is supposed
3517 to use the current locale) is not supported.
3518 """
3519
3520 # Note: PEP 3101 says that if the type is not present then
3521 # there should be at least one digit after the decimal point.
3522 # We take the liberty of ignoring this requirement for
3523 # Decimal---it's presumably there to make sure that
3524 # format(float, '') behaves similarly to str(float).
3525 if context is None:
3526 context = getcontext()
3527
3528 spec = _parse_format_specifier(specifier)
3529
3530 # special values don't care about the type or precision...
3531 if self._is_special:
3532 return _format_align(str(self), spec)
3533
3534 # a type of None defaults to 'g' or 'G', depending on context
3535 # if type is '%', adjust exponent of self accordingly
3536 if spec['type'] is None:
3537 spec['type'] = ['g', 'G'][context.capitals]
3538 elif spec['type'] == '%':
3539 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3540
3541 # round if necessary, taking rounding mode from the context
3542 rounding = context.rounding
3543 precision = spec['precision']
3544 if precision is not None:
3545 if spec['type'] in 'eE':
3546 self = self._round(precision+1, rounding)
3547 elif spec['type'] in 'gG':
3548 if len(self._int) > precision:
3549 self = self._round(precision, rounding)
3550 elif spec['type'] in 'fF%':
3551 self = self._rescale(-precision, rounding)
3552 # special case: zeros with a positive exponent can't be
3553 # represented in fixed point; rescale them to 0e0.
3554 elif not self and self._exp > 0 and spec['type'] in 'fF%':
3555 self = self._rescale(0, rounding)
3556
3557 # figure out placement of the decimal point
3558 leftdigits = self._exp + len(self._int)
3559 if spec['type'] in 'fF%':
3560 dotplace = leftdigits
3561 elif spec['type'] in 'eE':
3562 if not self and precision is not None:
3563 dotplace = 1 - precision
3564 else:
3565 dotplace = 1
3566 elif spec['type'] in 'gG':
3567 if self._exp <= 0 and leftdigits > -6:
3568 dotplace = leftdigits
3569 else:
3570 dotplace = 1
3571
3572 # figure out main part of numeric string...
3573 if dotplace <= 0:
3574 num = '0.' + '0'*(-dotplace) + self._int
3575 elif dotplace >= len(self._int):
3576 # make sure we're not padding a '0' with extra zeros on the right
3577 assert dotplace==len(self._int) or self._int != '0'
3578 num = self._int + '0'*(dotplace-len(self._int))
3579 else:
3580 num = self._int[:dotplace] + '.' + self._int[dotplace:]
3581
3582 # ...then the trailing exponent, or trailing '%'
3583 if leftdigits != dotplace or spec['type'] in 'eE':
3584 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
3585 num = num + "{0}{1:+}".format(echar, leftdigits-dotplace)
3586 elif spec['type'] == '%':
3587 num = num + '%'
3588
3589 # add sign
3590 if self._sign == 1:
3591 num = '-' + num
3592 return _format_align(num, spec)
3593
3594
Facundo Batista72bc54f2007-11-23 17:59:00 +00003595def _dec_from_triple(sign, coefficient, exponent, special=False):
3596 """Create a decimal instance directly, without any validation,
3597 normalization (e.g. removal of leading zeros) or argument
3598 conversion.
3599
3600 This function is for *internal use only*.
3601 """
3602
3603 self = object.__new__(Decimal)
3604 self._sign = sign
3605 self._int = coefficient
3606 self._exp = exponent
3607 self._is_special = special
3608
3609 return self
3610
Facundo Batista59c58842007-04-10 12:58:45 +00003611##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003612
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003613
3614# get rounding method function:
Facundo Batista59c58842007-04-10 12:58:45 +00003615rounding_functions = [name for name in Decimal.__dict__.keys()
3616 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003617for name in rounding_functions:
Facundo Batista59c58842007-04-10 12:58:45 +00003618 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003619 globalname = name[1:].upper()
3620 val = globals()[globalname]
3621 Decimal._pick_rounding_function[val] = name
3622
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003623del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003624
Nick Coghlanced12182006-09-02 03:54:17 +00003625class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003626 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003627
Nick Coghlanced12182006-09-02 03:54:17 +00003628 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003629 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003630 """
3631 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003632 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003633 def __enter__(self):
3634 self.saved_context = getcontext()
3635 setcontext(self.new_context)
3636 return self.new_context
3637 def __exit__(self, t, v, tb):
3638 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003639
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003640class Context(object):
3641 """Contains the context for a Decimal instance.
3642
3643 Contains:
3644 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003645 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003646 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003647 raised when it is caused. Otherwise, a value is
3648 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003649 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003650 (Whether or not the trap_enabler is set)
3651 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003652 Emin - Minimum exponent
3653 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003654 capitals - If 1, 1*10^1 is printed as 1E+1.
3655 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003656 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003657 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003658
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003659 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003660 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003661 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003662 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003663 _ignored_flags=None):
3664 if flags is None:
3665 flags = []
3666 if _ignored_flags is None:
3667 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003668 if not isinstance(flags, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003669 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003670 del s
Raymond Hettingerbf440692004-07-10 14:14:37 +00003671 if traps is not None and not isinstance(traps, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003672 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003673 del s
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003674 for name, val in locals().items():
3675 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003676 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003677 else:
3678 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003679 del self.self
3680
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003681 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003682 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003683 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003684 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3685 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3686 % vars(self))
3687 names = [f.__name__ for f, v in self.flags.items() if v]
3688 s.append('flags=[' + ', '.join(names) + ']')
3689 names = [t.__name__ for t, v in self.traps.items() if v]
3690 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003691 return ', '.join(s) + ')'
3692
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003693 def clear_flags(self):
3694 """Reset all flags to zero"""
3695 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003696 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003697
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003698 def _shallow_copy(self):
3699 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003700 nc = Context(self.prec, self.rounding, self.traps,
3701 self.flags, self.Emin, self.Emax,
3702 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003703 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003704
3705 def copy(self):
3706 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003707 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003708 self.flags.copy(), self.Emin, self.Emax,
3709 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003710 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003711 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003712
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003713 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003714 """Handles an error
3715
3716 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003717 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003718 trap_enabler is set, it reaises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003719 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003720 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003721 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003722 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003723 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003724 return error().handle(self, *args)
3725
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003726 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003727 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003728 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003729 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003730
3731 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003732 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003733 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003734
3735 def _ignore_all_flags(self):
3736 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003737 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003738
3739 def _ignore_flags(self, *flags):
3740 """Ignore the flags, if they are raised"""
3741 # Do not mutate-- This way, copies of a context leave the original
3742 # alone.
3743 self._ignored_flags = (self._ignored_flags + list(flags))
3744 return list(flags)
3745
3746 def _regard_flags(self, *flags):
3747 """Stop ignoring the flags, if they are raised"""
3748 if flags and isinstance(flags[0], (tuple,list)):
3749 flags = flags[0]
3750 for flag in flags:
3751 self._ignored_flags.remove(flag)
3752
Nick Coghlan53663a62008-07-15 14:27:37 +00003753 # We inherit object.__hash__, so we must deny this explicitly
3754 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003755
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003756 def Etiny(self):
3757 """Returns Etiny (= Emin - prec + 1)"""
3758 return int(self.Emin - self.prec + 1)
3759
3760 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003761 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003762 return int(self.Emax - self.prec + 1)
3763
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003764 def _set_rounding(self, type):
3765 """Sets the rounding type.
3766
3767 Sets the rounding type, and returns the current (previous)
3768 rounding type. Often used like:
3769
3770 context = context.copy()
3771 # so you don't change the calling context
3772 # if an error occurs in the middle.
3773 rounding = context._set_rounding(ROUND_UP)
3774 val = self.__sub__(other, context=context)
3775 context._set_rounding(rounding)
3776
3777 This will make it round up for that operation.
3778 """
3779 rounding = self.rounding
3780 self.rounding= type
3781 return rounding
3782
Raymond Hettingerfed52962004-07-14 15:41:57 +00003783 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003784 """Creates a new Decimal instance but using self as context.
3785
3786 This method implements the to-number operation of the
3787 IBM Decimal specification."""
3788
3789 if isinstance(num, basestring) and num != num.strip():
3790 return self._raise_error(ConversionSyntax,
3791 "no trailing or leading whitespace is "
3792 "permitted.")
3793
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003794 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003795 if d._isnan() and len(d._int) > self.prec - self._clamp:
3796 return self._raise_error(ConversionSyntax,
3797 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003798 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003799
Raymond Hettingerf4d85972009-01-03 19:02:23 +00003800 def create_decimal_from_float(self, f):
3801 """Creates a new Decimal instance from a float but rounding using self
3802 as the context.
3803
3804 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3805 >>> context.create_decimal_from_float(3.1415926535897932)
3806 Decimal('3.1415')
3807 >>> context = Context(prec=5, traps=[Inexact])
3808 >>> context.create_decimal_from_float(3.1415926535897932)
3809 Traceback (most recent call last):
3810 ...
3811 Inexact: None
3812
3813 """
3814 d = Decimal.from_float(f) # An exact conversion
3815 return d._fix(self) # Apply the context rounding
3816
Facundo Batista59c58842007-04-10 12:58:45 +00003817 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003818 def abs(self, a):
3819 """Returns the absolute value of the operand.
3820
3821 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003822 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003823 the plus operation on the operand.
3824
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003825 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003826 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003827 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003828 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003829 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003830 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003831 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003832 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003833 """
3834 return a.__abs__(context=self)
3835
3836 def add(self, a, b):
3837 """Return the sum of the two operands.
3838
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003839 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003840 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003841 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003842 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003843 """
3844 return a.__add__(b, context=self)
3845
3846 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003847 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003848
Facundo Batista353750c2007-09-13 18:13:15 +00003849 def canonical(self, a):
3850 """Returns the same Decimal object.
3851
3852 As we do not have different encodings for the same number, the
3853 received object already is in its canonical form.
3854
3855 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003856 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003857 """
3858 return a.canonical(context=self)
3859
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003860 def compare(self, a, b):
3861 """Compares values numerically.
3862
3863 If the signs of the operands differ, a value representing each operand
3864 ('-1' if the operand is less than zero, '0' if the operand is zero or
3865 negative zero, or '1' if the operand is greater than zero) is used in
3866 place of that operand for the comparison instead of the actual
3867 operand.
3868
3869 The comparison is then effected by subtracting the second operand from
3870 the first and then returning a value according to the result of the
3871 subtraction: '-1' if the result is less than zero, '0' if the result is
3872 zero or negative zero, or '1' if the result is greater than zero.
3873
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003874 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003875 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003876 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003877 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003878 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003879 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003880 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003881 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003882 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003883 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003884 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003885 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003886 """
3887 return a.compare(b, context=self)
3888
Facundo Batista353750c2007-09-13 18:13:15 +00003889 def compare_signal(self, a, b):
3890 """Compares the values of the two operands numerically.
3891
3892 It's pretty much like compare(), but all NaNs signal, with signaling
3893 NaNs taking precedence over quiet NaNs.
3894
3895 >>> c = ExtendedContext
3896 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003897 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003898 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003899 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003900 >>> c.flags[InvalidOperation] = 0
3901 >>> print c.flags[InvalidOperation]
3902 0
3903 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003904 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003905 >>> print c.flags[InvalidOperation]
3906 1
3907 >>> c.flags[InvalidOperation] = 0
3908 >>> print c.flags[InvalidOperation]
3909 0
3910 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003911 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003912 >>> print c.flags[InvalidOperation]
3913 1
3914 """
3915 return a.compare_signal(b, context=self)
3916
3917 def compare_total(self, a, b):
3918 """Compares two operands using their abstract representation.
3919
3920 This is not like the standard compare, which use their numerical
3921 value. Note that a total ordering is defined for all possible abstract
3922 representations.
3923
3924 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003925 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003926 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003927 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003928 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003929 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003930 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003931 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003932 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003933 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00003934 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003935 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003936 """
3937 return a.compare_total(b)
3938
3939 def compare_total_mag(self, a, b):
3940 """Compares two operands using their abstract representation ignoring sign.
3941
3942 Like compare_total, but with operand's sign ignored and assumed to be 0.
3943 """
3944 return a.compare_total_mag(b)
3945
3946 def copy_abs(self, a):
3947 """Returns a copy of the operand with the sign set to 0.
3948
3949 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003950 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003951 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003952 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00003953 """
3954 return a.copy_abs()
3955
3956 def copy_decimal(self, a):
3957 """Returns a copy of the decimal objet.
3958
3959 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003960 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003961 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003962 Decimal('-1.00')
Facundo Batista353750c2007-09-13 18:13:15 +00003963 """
Facundo Batista6c398da2007-09-17 17:30:13 +00003964 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00003965
3966 def copy_negate(self, a):
3967 """Returns a copy of the operand with the sign inverted.
3968
3969 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003970 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003971 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003972 Decimal('101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003973 """
3974 return a.copy_negate()
3975
3976 def copy_sign(self, a, b):
3977 """Copies the second operand's sign to the first one.
3978
3979 In detail, it returns a copy of the first operand with the sign
3980 equal to the sign of the second operand.
3981
3982 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003983 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003984 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003985 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003986 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003987 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003988 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003989 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003990 """
3991 return a.copy_sign(b)
3992
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003993 def divide(self, a, b):
3994 """Decimal division in a specified context.
3995
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003996 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003997 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003998 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003999 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004000 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004001 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004002 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004003 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004004 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004005 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004006 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004007 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004008 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004009 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004010 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004011 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004012 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004013 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004014 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004015 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004016 """
4017 return a.__div__(b, context=self)
4018
4019 def divide_int(self, a, b):
4020 """Divides two numbers and returns the integer part of the result.
4021
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004022 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004023 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004024 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004025 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004026 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004027 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004028 """
4029 return a.__floordiv__(b, context=self)
4030
4031 def divmod(self, a, b):
4032 return a.__divmod__(b, context=self)
4033
Facundo Batista353750c2007-09-13 18:13:15 +00004034 def exp(self, a):
4035 """Returns e ** a.
4036
4037 >>> c = ExtendedContext.copy()
4038 >>> c.Emin = -999
4039 >>> c.Emax = 999
4040 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004041 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004042 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004043 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00004044 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004045 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004046 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004047 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00004048 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004049 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004050 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004051 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004052 """
4053 return a.exp(context=self)
4054
4055 def fma(self, a, b, c):
4056 """Returns a multiplied by b, plus c.
4057
4058 The first two operands are multiplied together, using multiply,
4059 the third operand is then added to the result of that
4060 multiplication, using add, all with only one final rounding.
4061
4062 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004063 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004064 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004065 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004066 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004067 Decimal('1.38435736E+12')
Facundo Batista353750c2007-09-13 18:13:15 +00004068 """
4069 return a.fma(b, c, context=self)
4070
4071 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004072 """Return True if the operand is canonical; otherwise return False.
4073
4074 Currently, the encoding of a Decimal instance is always
4075 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004076
4077 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004078 True
Facundo Batista353750c2007-09-13 18:13:15 +00004079 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004080 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004081
4082 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004083 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004084
Facundo Batista1a191df2007-10-02 17:01:24 +00004085 A Decimal instance is considered finite if it is neither
4086 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004087
4088 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004089 True
Facundo Batista353750c2007-09-13 18:13:15 +00004090 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004091 True
Facundo Batista353750c2007-09-13 18:13:15 +00004092 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004093 True
Facundo Batista353750c2007-09-13 18:13:15 +00004094 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004095 False
Facundo Batista353750c2007-09-13 18:13:15 +00004096 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004097 False
Facundo Batista353750c2007-09-13 18:13:15 +00004098 """
4099 return a.is_finite()
4100
4101 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004102 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004103
4104 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004105 False
Facundo Batista353750c2007-09-13 18:13:15 +00004106 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004107 True
Facundo Batista353750c2007-09-13 18:13:15 +00004108 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004109 False
Facundo Batista353750c2007-09-13 18:13:15 +00004110 """
4111 return a.is_infinite()
4112
4113 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004114 """Return True if the operand is a qNaN or sNaN;
4115 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004116
4117 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004118 False
Facundo Batista353750c2007-09-13 18:13:15 +00004119 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004120 True
Facundo Batista353750c2007-09-13 18:13:15 +00004121 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004122 True
Facundo Batista353750c2007-09-13 18:13:15 +00004123 """
4124 return a.is_nan()
4125
4126 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004127 """Return True if the operand is a normal number;
4128 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004129
4130 >>> c = ExtendedContext.copy()
4131 >>> c.Emin = -999
4132 >>> c.Emax = 999
4133 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004134 True
Facundo Batista353750c2007-09-13 18:13:15 +00004135 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004136 False
Facundo Batista353750c2007-09-13 18:13:15 +00004137 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004138 False
Facundo Batista353750c2007-09-13 18:13:15 +00004139 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004140 False
Facundo Batista353750c2007-09-13 18:13:15 +00004141 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004142 False
Facundo Batista353750c2007-09-13 18:13:15 +00004143 """
4144 return a.is_normal(context=self)
4145
4146 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004147 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004148
4149 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004150 False
Facundo Batista353750c2007-09-13 18:13:15 +00004151 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004152 True
Facundo Batista353750c2007-09-13 18:13:15 +00004153 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004154 False
Facundo Batista353750c2007-09-13 18:13:15 +00004155 """
4156 return a.is_qnan()
4157
4158 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004159 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004160
4161 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004162 False
Facundo Batista353750c2007-09-13 18:13:15 +00004163 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004164 True
Facundo Batista353750c2007-09-13 18:13:15 +00004165 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004166 True
Facundo Batista353750c2007-09-13 18:13:15 +00004167 """
4168 return a.is_signed()
4169
4170 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004171 """Return True if the operand is a signaling NaN;
4172 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004173
4174 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004175 False
Facundo Batista353750c2007-09-13 18:13:15 +00004176 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004177 False
Facundo Batista353750c2007-09-13 18:13:15 +00004178 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004179 True
Facundo Batista353750c2007-09-13 18:13:15 +00004180 """
4181 return a.is_snan()
4182
4183 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004184 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004185
4186 >>> c = ExtendedContext.copy()
4187 >>> c.Emin = -999
4188 >>> c.Emax = 999
4189 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004190 False
Facundo Batista353750c2007-09-13 18:13:15 +00004191 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004192 True
Facundo Batista353750c2007-09-13 18:13:15 +00004193 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004194 False
Facundo Batista353750c2007-09-13 18:13:15 +00004195 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004196 False
Facundo Batista353750c2007-09-13 18:13:15 +00004197 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004198 False
Facundo Batista353750c2007-09-13 18:13:15 +00004199 """
4200 return a.is_subnormal(context=self)
4201
4202 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004203 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004204
4205 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004206 True
Facundo Batista353750c2007-09-13 18:13:15 +00004207 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004208 False
Facundo Batista353750c2007-09-13 18:13:15 +00004209 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004210 True
Facundo Batista353750c2007-09-13 18:13:15 +00004211 """
4212 return a.is_zero()
4213
4214 def ln(self, a):
4215 """Returns the natural (base e) logarithm of the operand.
4216
4217 >>> c = ExtendedContext.copy()
4218 >>> c.Emin = -999
4219 >>> c.Emax = 999
4220 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004221 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004222 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004223 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004224 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004225 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004226 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004227 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004228 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004229 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004230 """
4231 return a.ln(context=self)
4232
4233 def log10(self, a):
4234 """Returns the base 10 logarithm of the operand.
4235
4236 >>> c = ExtendedContext.copy()
4237 >>> c.Emin = -999
4238 >>> c.Emax = 999
4239 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004240 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004241 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004242 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004243 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004244 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004245 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004246 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004247 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004248 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004249 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004250 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004251 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004252 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004253 """
4254 return a.log10(context=self)
4255
4256 def logb(self, a):
4257 """ Returns the exponent of the magnitude of the operand's MSD.
4258
4259 The result is the integer which is the exponent of the magnitude
4260 of the most significant digit of the operand (as though the
4261 operand were truncated to a single digit while maintaining the
4262 value of that digit and without limiting the resulting exponent).
4263
4264 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004265 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004266 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004267 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004268 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004269 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004270 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004271 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004272 """
4273 return a.logb(context=self)
4274
4275 def logical_and(self, a, b):
4276 """Applies the logical operation 'and' between each operand's digits.
4277
4278 The operands must be both logical numbers.
4279
4280 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004281 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004282 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004283 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004284 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004285 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004286 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004287 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004288 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004289 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004290 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004291 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004292 """
4293 return a.logical_and(b, context=self)
4294
4295 def logical_invert(self, a):
4296 """Invert all the digits in the operand.
4297
4298 The operand must be a logical number.
4299
4300 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004301 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004302 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004303 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004304 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004305 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004306 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004307 Decimal('10101010')
Facundo Batista353750c2007-09-13 18:13:15 +00004308 """
4309 return a.logical_invert(context=self)
4310
4311 def logical_or(self, a, b):
4312 """Applies the logical operation 'or' between each operand's digits.
4313
4314 The operands must be both logical numbers.
4315
4316 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004317 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004318 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004319 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004320 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004321 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004322 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004323 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004324 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004325 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004326 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004327 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004328 """
4329 return a.logical_or(b, context=self)
4330
4331 def logical_xor(self, a, b):
4332 """Applies the logical operation 'xor' between each operand's digits.
4333
4334 The operands must be both logical numbers.
4335
4336 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004337 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004338 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004339 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004340 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004341 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004342 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004343 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004344 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004345 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004346 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004347 Decimal('1101')
Facundo Batista353750c2007-09-13 18:13:15 +00004348 """
4349 return a.logical_xor(b, context=self)
4350
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004351 def max(self, a,b):
4352 """max compares two values numerically and returns the maximum.
4353
4354 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004355 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004356 operation. If they are numerically equal then the left-hand operand
4357 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004358 infinity) of the two operands is chosen as the result.
4359
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004360 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004361 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004362 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004363 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004364 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004365 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004366 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004367 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004368 """
4369 return a.max(b, context=self)
4370
Facundo Batista353750c2007-09-13 18:13:15 +00004371 def max_mag(self, a, b):
4372 """Compares the values numerically with their sign ignored."""
4373 return a.max_mag(b, context=self)
4374
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004375 def min(self, a,b):
4376 """min compares two values numerically and returns the minimum.
4377
4378 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004379 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004380 operation. If they are numerically equal then the left-hand operand
4381 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004382 infinity) of the two operands is chosen as the result.
4383
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004384 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004385 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004386 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004387 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004388 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004389 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004390 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004391 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004392 """
4393 return a.min(b, context=self)
4394
Facundo Batista353750c2007-09-13 18:13:15 +00004395 def min_mag(self, a, b):
4396 """Compares the values numerically with their sign ignored."""
4397 return a.min_mag(b, context=self)
4398
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004399 def minus(self, a):
4400 """Minus corresponds to unary prefix minus in Python.
4401
4402 The operation is evaluated using the same rules as subtract; the
4403 operation minus(a) is calculated as subtract('0', a) where the '0'
4404 has the same exponent as the operand.
4405
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004406 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004407 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004408 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004409 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004410 """
4411 return a.__neg__(context=self)
4412
4413 def multiply(self, a, b):
4414 """multiply multiplies two operands.
4415
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004416 If either operand is a special value then the general rules apply.
4417 Otherwise, the operands are multiplied together ('long multiplication'),
4418 resulting in a number which may be as long as the sum of the lengths
4419 of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004420
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004421 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004422 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004423 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004424 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004425 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004426 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004427 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004428 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004429 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004430 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004431 """
4432 return a.__mul__(b, context=self)
4433
Facundo Batista353750c2007-09-13 18:13:15 +00004434 def next_minus(self, a):
4435 """Returns the largest representable number smaller than a.
4436
4437 >>> c = ExtendedContext.copy()
4438 >>> c.Emin = -999
4439 >>> c.Emax = 999
4440 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004441 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004442 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004443 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004444 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004445 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004446 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004447 Decimal('9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004448 """
4449 return a.next_minus(context=self)
4450
4451 def next_plus(self, a):
4452 """Returns the smallest representable number larger than a.
4453
4454 >>> c = ExtendedContext.copy()
4455 >>> c.Emin = -999
4456 >>> c.Emax = 999
4457 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004458 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004459 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004460 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004461 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004462 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004463 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004464 Decimal('-9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004465 """
4466 return a.next_plus(context=self)
4467
4468 def next_toward(self, a, b):
4469 """Returns the number closest to a, in direction towards b.
4470
4471 The result is the closest representable number from the first
4472 operand (but not the first operand) that is in the direction
4473 towards the second operand, unless the operands have the same
4474 value.
4475
4476 >>> c = ExtendedContext.copy()
4477 >>> c.Emin = -999
4478 >>> c.Emax = 999
4479 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004480 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004481 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004482 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004483 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004484 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004485 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004486 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004487 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004488 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004489 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004490 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004491 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004492 Decimal('-0.00')
Facundo Batista353750c2007-09-13 18:13:15 +00004493 """
4494 return a.next_toward(b, context=self)
4495
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004496 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004497 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004498
4499 Essentially a plus operation with all trailing zeros removed from the
4500 result.
4501
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004502 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004503 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004504 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004505 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004506 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004507 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004508 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004509 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004510 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004511 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004512 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004513 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004514 """
4515 return a.normalize(context=self)
4516
Facundo Batista353750c2007-09-13 18:13:15 +00004517 def number_class(self, a):
4518 """Returns an indication of the class of the operand.
4519
4520 The class is one of the following strings:
4521 -sNaN
4522 -NaN
4523 -Infinity
4524 -Normal
4525 -Subnormal
4526 -Zero
4527 +Zero
4528 +Subnormal
4529 +Normal
4530 +Infinity
4531
4532 >>> c = Context(ExtendedContext)
4533 >>> c.Emin = -999
4534 >>> c.Emax = 999
4535 >>> c.number_class(Decimal('Infinity'))
4536 '+Infinity'
4537 >>> c.number_class(Decimal('1E-10'))
4538 '+Normal'
4539 >>> c.number_class(Decimal('2.50'))
4540 '+Normal'
4541 >>> c.number_class(Decimal('0.1E-999'))
4542 '+Subnormal'
4543 >>> c.number_class(Decimal('0'))
4544 '+Zero'
4545 >>> c.number_class(Decimal('-0'))
4546 '-Zero'
4547 >>> c.number_class(Decimal('-0.1E-999'))
4548 '-Subnormal'
4549 >>> c.number_class(Decimal('-1E-10'))
4550 '-Normal'
4551 >>> c.number_class(Decimal('-2.50'))
4552 '-Normal'
4553 >>> c.number_class(Decimal('-Infinity'))
4554 '-Infinity'
4555 >>> c.number_class(Decimal('NaN'))
4556 'NaN'
4557 >>> c.number_class(Decimal('-NaN'))
4558 'NaN'
4559 >>> c.number_class(Decimal('sNaN'))
4560 'sNaN'
4561 """
4562 return a.number_class(context=self)
4563
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004564 def plus(self, a):
4565 """Plus corresponds to unary prefix plus in Python.
4566
4567 The operation is evaluated using the same rules as add; the
4568 operation plus(a) is calculated as add('0', a) where the '0'
4569 has the same exponent as the operand.
4570
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004571 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004572 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004573 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004574 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004575 """
4576 return a.__pos__(context=self)
4577
4578 def power(self, a, b, modulo=None):
4579 """Raises a to the power of b, to modulo if given.
4580
Facundo Batista353750c2007-09-13 18:13:15 +00004581 With two arguments, compute a**b. If a is negative then b
4582 must be integral. The result will be inexact unless b is
4583 integral and the result is finite and can be expressed exactly
4584 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004585
Facundo Batista353750c2007-09-13 18:13:15 +00004586 With three arguments, compute (a**b) % modulo. For the
4587 three argument form, the following restrictions on the
4588 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004589
Facundo Batista353750c2007-09-13 18:13:15 +00004590 - all three arguments must be integral
4591 - b must be nonnegative
4592 - at least one of a or b must be nonzero
4593 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004594
Facundo Batista353750c2007-09-13 18:13:15 +00004595 The result of pow(a, b, modulo) is identical to the result
4596 that would be obtained by computing (a**b) % modulo with
4597 unbounded precision, but is computed more efficiently. It is
4598 always exact.
4599
4600 >>> c = ExtendedContext.copy()
4601 >>> c.Emin = -999
4602 >>> c.Emax = 999
4603 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004604 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004605 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004606 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004607 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004608 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004609 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004610 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004611 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004612 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004613 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004614 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004615 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004616 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004617 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004618 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004619 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004620 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004621 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004622 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004623 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004624 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004625 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004626 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004627 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004628 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004629
4630 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004631 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004632 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004633 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00004634 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004635 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004636 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004637 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004638 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004639 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00004640 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004641 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004642 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004643 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004644 """
4645 return a.__pow__(b, modulo, context=self)
4646
4647 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00004648 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004649
4650 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00004651 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004652 exponent is being increased), multiplied by a positive power of ten (if
4653 the exponent is being decreased), or is unchanged (if the exponent is
4654 already equal to that of the right-hand operand).
4655
4656 Unlike other operations, if the length of the coefficient after the
4657 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00004658 operation condition is raised. This guarantees that, unless there is
4659 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004660 equal to that of the right-hand operand.
4661
4662 Also unlike other operations, quantize will never raise Underflow, even
4663 if the result is subnormal and inexact.
4664
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004665 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004666 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004667 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004668 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004669 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004670 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004671 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004672 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004673 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004674 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004675 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004676 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004677 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004678 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004679 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004680 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004681 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004682 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004683 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004684 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004685 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004686 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004687 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004688 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004689 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004690 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004691 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004692 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004693 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004694 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004695 """
4696 return a.quantize(b, context=self)
4697
Facundo Batista353750c2007-09-13 18:13:15 +00004698 def radix(self):
4699 """Just returns 10, as this is Decimal, :)
4700
4701 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00004702 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004703 """
4704 return Decimal(10)
4705
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004706 def remainder(self, a, b):
4707 """Returns the remainder from integer division.
4708
4709 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00004710 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00004711 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00004712 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004713
4714 This operation will fail under the same conditions as integer division
4715 (that is, if integer division on the same two operands would fail, the
4716 remainder cannot be calculated).
4717
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004718 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004719 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004720 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004721 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004722 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004723 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004724 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004725 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004726 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004727 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004728 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004729 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004730 """
4731 return a.__mod__(b, context=self)
4732
4733 def remainder_near(self, a, b):
4734 """Returns to be "a - b * n", where n is the integer nearest the exact
4735 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00004736 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004737 sign of a.
4738
4739 This operation will fail under the same conditions as integer division
4740 (that is, if integer division on the same two operands would fail, the
4741 remainder cannot be calculated).
4742
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004743 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004744 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004745 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004746 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004747 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004748 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004749 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004750 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004751 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004752 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004753 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004754 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004755 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004756 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004757 """
4758 return a.remainder_near(b, context=self)
4759
Facundo Batista353750c2007-09-13 18:13:15 +00004760 def rotate(self, a, b):
4761 """Returns a rotated copy of a, b times.
4762
4763 The coefficient of the result is a rotated copy of the digits in
4764 the coefficient of the first operand. The number of places of
4765 rotation is taken from the absolute value of the second operand,
4766 with the rotation being to the left if the second operand is
4767 positive or to the right otherwise.
4768
4769 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004770 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00004771 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004772 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00004773 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004774 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004775 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004776 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004777 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004778 Decimal('345678912')
Facundo Batista353750c2007-09-13 18:13:15 +00004779 """
4780 return a.rotate(b, context=self)
4781
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004782 def same_quantum(self, a, b):
4783 """Returns True if the two operands have the same exponent.
4784
4785 The result is never affected by either the sign or the coefficient of
4786 either operand.
4787
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004788 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004789 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004790 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004791 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004792 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004793 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004794 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004795 True
4796 """
4797 return a.same_quantum(b)
4798
Facundo Batista353750c2007-09-13 18:13:15 +00004799 def scaleb (self, a, b):
4800 """Returns the first operand after adding the second value its exp.
4801
4802 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004803 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00004804 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004805 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004806 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004807 Decimal('7.50E+3')
Facundo Batista353750c2007-09-13 18:13:15 +00004808 """
4809 return a.scaleb (b, context=self)
4810
4811 def shift(self, a, b):
4812 """Returns a shifted copy of a, b times.
4813
4814 The coefficient of the result is a shifted copy of the digits
4815 in the coefficient of the first operand. The number of places
4816 to shift is taken from the absolute value of the second operand,
4817 with the shift being to the left if the second operand is
4818 positive or to the right otherwise. Digits shifted into the
4819 coefficient are zeros.
4820
4821 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004822 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004823 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004824 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004825 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004826 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004827 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004828 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004829 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004830 Decimal('345678900')
Facundo Batista353750c2007-09-13 18:13:15 +00004831 """
4832 return a.shift(b, context=self)
4833
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004834 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00004835 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004836
4837 If the result must be inexact, it is rounded using the round-half-even
4838 algorithm.
4839
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004840 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004841 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004842 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004843 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004844 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004845 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004846 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004847 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004848 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004849 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004850 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004851 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004852 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004853 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004854 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004855 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004856 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004857 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004858 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00004859 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004860 """
4861 return a.sqrt(context=self)
4862
4863 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00004864 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004865
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004866 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004867 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004868 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004869 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004870 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004871 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004872 """
4873 return a.__sub__(b, context=self)
4874
4875 def to_eng_string(self, a):
4876 """Converts a number to a string, using scientific notation.
4877
4878 The operation is not affected by the context.
4879 """
4880 return a.to_eng_string(context=self)
4881
4882 def to_sci_string(self, a):
4883 """Converts a number to a string, using scientific notation.
4884
4885 The operation is not affected by the context.
4886 """
4887 return a.__str__(context=self)
4888
Facundo Batista353750c2007-09-13 18:13:15 +00004889 def to_integral_exact(self, a):
4890 """Rounds to an integer.
4891
4892 When the operand has a negative exponent, the result is the same
4893 as using the quantize() operation using the given operand as the
4894 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4895 of the operand as the precision setting; Inexact and Rounded flags
4896 are allowed in this operation. The rounding mode is taken from the
4897 context.
4898
4899 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004900 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004901 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004902 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004903 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004904 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004905 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004906 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004907 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004908 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004909 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004910 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004911 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004912 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004913 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004914 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004915 """
4916 return a.to_integral_exact(context=self)
4917
4918 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004919 """Rounds to an integer.
4920
4921 When the operand has a negative exponent, the result is the same
4922 as using the quantize() operation using the given operand as the
4923 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4924 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00004925 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004926
Facundo Batista353750c2007-09-13 18:13:15 +00004927 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004928 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004929 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004930 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004931 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004932 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004933 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004934 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004935 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004936 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004937 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004938 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004939 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004940 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004941 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004942 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004943 """
Facundo Batista353750c2007-09-13 18:13:15 +00004944 return a.to_integral_value(context=self)
4945
4946 # the method name changed, but we provide also the old one, for compatibility
4947 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004948
4949class _WorkRep(object):
4950 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00004951 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004952 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004953 # exp: None, int, or string
4954
4955 def __init__(self, value=None):
4956 if value is None:
4957 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004958 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004959 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00004960 elif isinstance(value, Decimal):
4961 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00004962 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004963 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00004964 else:
4965 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004966 self.sign = value[0]
4967 self.int = value[1]
4968 self.exp = value[2]
4969
4970 def __repr__(self):
4971 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
4972
4973 __str__ = __repr__
4974
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004975
4976
Facundo Batistae64acfa2007-12-17 14:18:42 +00004977def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004978 """Normalizes op1, op2 to have the same exp and length of coefficient.
4979
4980 Done during addition.
4981 """
Facundo Batista353750c2007-09-13 18:13:15 +00004982 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004983 tmp = op2
4984 other = op1
4985 else:
4986 tmp = op1
4987 other = op2
4988
Facundo Batista353750c2007-09-13 18:13:15 +00004989 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
4990 # Then adding 10**exp to tmp has the same effect (after rounding)
4991 # as adding any positive quantity smaller than 10**exp; similarly
4992 # for subtraction. So if other is smaller than 10**exp we replace
4993 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00004994 tmp_len = len(str(tmp.int))
4995 other_len = len(str(other.int))
4996 exp = tmp.exp + min(-1, tmp_len - prec - 2)
4997 if other_len + other.exp - 1 < exp:
4998 other.int = 1
4999 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005000
Facundo Batista353750c2007-09-13 18:13:15 +00005001 tmp.int *= 10 ** (tmp.exp - other.exp)
5002 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005003 return op1, op2
5004
Facundo Batista353750c2007-09-13 18:13:15 +00005005##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
5006
5007# This function from Tim Peters was taken from here:
5008# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5009# The correction being in the function definition is for speed, and
5010# the whole function is not resolved with math.log because of avoiding
5011# the use of floats.
5012def _nbits(n, correction = {
5013 '0': 4, '1': 3, '2': 2, '3': 2,
5014 '4': 1, '5': 1, '6': 1, '7': 1,
5015 '8': 0, '9': 0, 'a': 0, 'b': 0,
5016 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5017 """Number of bits in binary representation of the positive integer n,
5018 or 0 if n == 0.
5019 """
5020 if n < 0:
5021 raise ValueError("The argument to _nbits should be nonnegative.")
5022 hex_n = "%x" % n
5023 return 4*len(hex_n) - correction[hex_n[0]]
5024
5025def _sqrt_nearest(n, a):
5026 """Closest integer to the square root of the positive integer n. a is
5027 an initial approximation to the square root. Any positive integer
5028 will do for a, but the closer a is to the square root of n the
5029 faster convergence will be.
5030
5031 """
5032 if n <= 0 or a <= 0:
5033 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5034
5035 b=0
5036 while a != b:
5037 b, a = a, a--n//a>>1
5038 return a
5039
5040def _rshift_nearest(x, shift):
5041 """Given an integer x and a nonnegative integer shift, return closest
5042 integer to x / 2**shift; use round-to-even in case of a tie.
5043
5044 """
5045 b, q = 1L << shift, x >> shift
5046 return q + (2*(x & (b-1)) + (q&1) > b)
5047
5048def _div_nearest(a, b):
5049 """Closest integer to a/b, a and b positive integers; rounds to even
5050 in the case of a tie.
5051
5052 """
5053 q, r = divmod(a, b)
5054 return q + (2*r + (q&1) > b)
5055
5056def _ilog(x, M, L = 8):
5057 """Integer approximation to M*log(x/M), with absolute error boundable
5058 in terms only of x/M.
5059
5060 Given positive integers x and M, return an integer approximation to
5061 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5062 between the approximation and the exact result is at most 22. For
5063 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5064 both cases these are upper bounds on the error; it will usually be
5065 much smaller."""
5066
5067 # The basic algorithm is the following: let log1p be the function
5068 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5069 # the reduction
5070 #
5071 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5072 #
5073 # repeatedly until the argument to log1p is small (< 2**-L in
5074 # absolute value). For small y we can use the Taylor series
5075 # expansion
5076 #
5077 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5078 #
5079 # truncating at T such that y**T is small enough. The whole
5080 # computation is carried out in a form of fixed-point arithmetic,
5081 # with a real number z being represented by an integer
5082 # approximation to z*M. To avoid loss of precision, the y below
5083 # is actually an integer approximation to 2**R*y*M, where R is the
5084 # number of reductions performed so far.
5085
5086 y = x-M
5087 # argument reduction; R = number of reductions performed
5088 R = 0
5089 while (R <= L and long(abs(y)) << L-R >= M or
5090 R > L and abs(y) >> R-L >= M):
5091 y = _div_nearest(long(M*y) << 1,
5092 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5093 R += 1
5094
5095 # Taylor series with T terms
5096 T = -int(-10*len(str(M))//(3*L))
5097 yshift = _rshift_nearest(y, R)
5098 w = _div_nearest(M, T)
5099 for k in xrange(T-1, 0, -1):
5100 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5101
5102 return _div_nearest(w*y, M)
5103
5104def _dlog10(c, e, p):
5105 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5106 approximation to 10**p * log10(c*10**e), with an absolute error of
5107 at most 1. Assumes that c*10**e is not exactly 1."""
5108
5109 # increase precision by 2; compensate for this by dividing
5110 # final result by 100
5111 p += 2
5112
5113 # write c*10**e as d*10**f with either:
5114 # f >= 0 and 1 <= d <= 10, or
5115 # f <= 0 and 0.1 <= d <= 1.
5116 # Thus for c*10**e close to 1, f = 0
5117 l = len(str(c))
5118 f = e+l - (e+l >= 1)
5119
5120 if p > 0:
5121 M = 10**p
5122 k = e+p-f
5123 if k >= 0:
5124 c *= 10**k
5125 else:
5126 c = _div_nearest(c, 10**-k)
5127
5128 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005129 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005130 log_d = _div_nearest(log_d*M, log_10)
5131 log_tenpower = f*M # exact
5132 else:
5133 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005134 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005135
5136 return _div_nearest(log_tenpower+log_d, 100)
5137
5138def _dlog(c, e, p):
5139 """Given integers c, e and p with c > 0, compute an integer
5140 approximation to 10**p * log(c*10**e), with an absolute error of
5141 at most 1. Assumes that c*10**e is not exactly 1."""
5142
5143 # Increase precision by 2. The precision increase is compensated
5144 # for at the end with a division by 100.
5145 p += 2
5146
5147 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5148 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5149 # as 10**p * log(d) + 10**p*f * log(10).
5150 l = len(str(c))
5151 f = e+l - (e+l >= 1)
5152
5153 # compute approximation to 10**p*log(d), with error < 27
5154 if p > 0:
5155 k = e+p-f
5156 if k >= 0:
5157 c *= 10**k
5158 else:
5159 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5160
5161 # _ilog magnifies existing error in c by a factor of at most 10
5162 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5163 else:
5164 # p <= 0: just approximate the whole thing by 0; error < 2.31
5165 log_d = 0
5166
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005167 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005168 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005169 extra = len(str(abs(f)))-1
5170 if p + extra >= 0:
5171 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5172 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5173 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005174 else:
5175 f_log_ten = 0
5176 else:
5177 f_log_ten = 0
5178
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005179 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005180 return _div_nearest(f_log_ten + log_d, 100)
5181
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005182class _Log10Memoize(object):
5183 """Class to compute, store, and allow retrieval of, digits of the
5184 constant log(10) = 2.302585.... This constant is needed by
5185 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5186 def __init__(self):
5187 self.digits = "23025850929940456840179914546843642076011014886"
5188
5189 def getdigits(self, p):
5190 """Given an integer p >= 0, return floor(10**p)*log(10).
5191
5192 For example, self.getdigits(3) returns 2302.
5193 """
5194 # digits are stored as a string, for quick conversion to
5195 # integer in the case that we've already computed enough
5196 # digits; the stored digits should always be correct
5197 # (truncated, not rounded to nearest).
5198 if p < 0:
5199 raise ValueError("p should be nonnegative")
5200
5201 if p >= len(self.digits):
5202 # compute p+3, p+6, p+9, ... digits; continue until at
5203 # least one of the extra digits is nonzero
5204 extra = 3
5205 while True:
5206 # compute p+extra digits, correct to within 1ulp
5207 M = 10**(p+extra+2)
5208 digits = str(_div_nearest(_ilog(10*M, M), 100))
5209 if digits[-extra:] != '0'*extra:
5210 break
5211 extra += 3
5212 # keep all reliable digits so far; remove trailing zeros
5213 # and next nonzero digit
5214 self.digits = digits.rstrip('0')[:-1]
5215 return int(self.digits[:p+1])
5216
5217_log10_digits = _Log10Memoize().getdigits
5218
Facundo Batista353750c2007-09-13 18:13:15 +00005219def _iexp(x, M, L=8):
5220 """Given integers x and M, M > 0, such that x/M is small in absolute
5221 value, compute an integer approximation to M*exp(x/M). For 0 <=
5222 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5223 is usually much smaller)."""
5224
5225 # Algorithm: to compute exp(z) for a real number z, first divide z
5226 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5227 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5228 # series
5229 #
5230 # expm1(x) = x + x**2/2! + x**3/3! + ...
5231 #
5232 # Now use the identity
5233 #
5234 # expm1(2x) = expm1(x)*(expm1(x)+2)
5235 #
5236 # R times to compute the sequence expm1(z/2**R),
5237 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5238
5239 # Find R such that x/2**R/M <= 2**-L
5240 R = _nbits((long(x)<<L)//M)
5241
5242 # Taylor series. (2**L)**T > M
5243 T = -int(-10*len(str(M))//(3*L))
5244 y = _div_nearest(x, T)
5245 Mshift = long(M)<<R
5246 for i in xrange(T-1, 0, -1):
5247 y = _div_nearest(x*(Mshift + y), Mshift * i)
5248
5249 # Expansion
5250 for k in xrange(R-1, -1, -1):
5251 Mshift = long(M)<<(k+2)
5252 y = _div_nearest(y*(y+Mshift), Mshift)
5253
5254 return M+y
5255
5256def _dexp(c, e, p):
5257 """Compute an approximation to exp(c*10**e), with p decimal places of
5258 precision.
5259
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005260 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005261
5262 10**(p-1) <= d <= 10**p, and
5263 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5264
5265 In other words, d*10**f is an approximation to exp(c*10**e) with p
5266 digits of precision, and with an error in d of at most 1. This is
5267 almost, but not quite, the same as the error being < 1ulp: when d
5268 = 10**(p-1) the error could be up to 10 ulp."""
5269
5270 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5271 p += 2
5272
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005273 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005274 extra = max(0, e + len(str(c)) - 1)
5275 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005276
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005277 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005278 # rounding down
5279 shift = e+q
5280 if shift >= 0:
5281 cshift = c*10**shift
5282 else:
5283 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005284 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005285
5286 # reduce remainder back to original precision
5287 rem = _div_nearest(rem, 10**extra)
5288
5289 # error in result of _iexp < 120; error after division < 0.62
5290 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5291
5292def _dpower(xc, xe, yc, ye, p):
5293 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5294 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5295
5296 10**(p-1) <= c <= 10**p, and
5297 (c-1)*10**e < x**y < (c+1)*10**e
5298
5299 in other words, c*10**e is an approximation to x**y with p digits
5300 of precision, and with an error in c of at most 1. (This is
5301 almost, but not quite, the same as the error being < 1ulp: when c
5302 == 10**(p-1) we can only guarantee error < 10ulp.)
5303
5304 We assume that: x is positive and not equal to 1, and y is nonzero.
5305 """
5306
5307 # Find b such that 10**(b-1) <= |y| <= 10**b
5308 b = len(str(abs(yc))) + ye
5309
5310 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5311 lxc = _dlog(xc, xe, p+b+1)
5312
5313 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5314 shift = ye-b
5315 if shift >= 0:
5316 pc = lxc*yc*10**shift
5317 else:
5318 pc = _div_nearest(lxc*yc, 10**-shift)
5319
5320 if pc == 0:
5321 # we prefer a result that isn't exactly 1; this makes it
5322 # easier to compute a correctly rounded result in __pow__
5323 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5324 coeff, exp = 10**(p-1)+1, 1-p
5325 else:
5326 coeff, exp = 10**p-1, -p
5327 else:
5328 coeff, exp = _dexp(pc, -(p+1), p+1)
5329 coeff = _div_nearest(coeff, 10)
5330 exp += 1
5331
5332 return coeff, exp
5333
5334def _log10_lb(c, correction = {
5335 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5336 '6': 23, '7': 16, '8': 10, '9': 5}):
5337 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5338 if c <= 0:
5339 raise ValueError("The argument to _log10_lb should be nonnegative.")
5340 str_c = str(c)
5341 return 100*len(str_c) - correction[str_c[0]]
5342
Facundo Batista59c58842007-04-10 12:58:45 +00005343##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005344
Facundo Batista353750c2007-09-13 18:13:15 +00005345def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005346 """Convert other to Decimal.
5347
5348 Verifies that it's ok to use in an implicit construction.
5349 """
5350 if isinstance(other, Decimal):
5351 return other
5352 if isinstance(other, (int, long)):
5353 return Decimal(other)
Facundo Batista353750c2007-09-13 18:13:15 +00005354 if raiseit:
5355 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005356 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005357
Facundo Batista59c58842007-04-10 12:58:45 +00005358##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005359
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005360# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005361# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005362
5363DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005364 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005365 traps=[DivisionByZero, Overflow, InvalidOperation],
5366 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005367 Emax=999999999,
5368 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005369 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005370)
5371
5372# Pre-made alternate contexts offered by the specification
5373# Don't change these; the user should be able to select these
5374# contexts and be able to reproduce results from other implementations
5375# of the spec.
5376
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005377BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005378 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005379 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5380 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005381)
5382
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005383ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005384 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005385 traps=[],
5386 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005387)
5388
5389
Facundo Batista72bc54f2007-11-23 17:59:00 +00005390##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005391#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005392# Regular expression used for parsing numeric strings. Additional
5393# comments:
5394#
5395# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5396# whitespace. But note that the specification disallows whitespace in
5397# a numeric string.
5398#
5399# 2. For finite numbers (not infinities and NaNs) the body of the
5400# number between the optional sign and the optional exponent must have
5401# at least one decimal digit, possibly after the decimal point. The
5402# lookahead expression '(?=\d|\.\d)' checks this.
5403#
5404# As the flag UNICODE is not enabled here, we're explicitly avoiding any
5405# other meaning for \d than the numbers [0-9].
5406
5407import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005408_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005409# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005410 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005411 (
Mark Dickinson70c32892008-07-02 09:37:01 +00005412 (?=[0-9]|\.[0-9]) # ...a number (with at least one digit)
5413 (?P<int>[0-9]*) # having a (possibly empty) integer part
5414 (\.(?P<frac>[0-9]*))? # followed by an optional fractional part
5415 (E(?P<exp>[-+]?[0-9]+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005416 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005417 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005418 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005419 (?P<signal>s)? # ...an (optionally signaling)
5420 NaN # NaN
5421 (?P<diag>[0-9]*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005422 )
5423# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005424 \Z
Facundo Batista72bc54f2007-11-23 17:59:00 +00005425""", re.VERBOSE | re.IGNORECASE).match
5426
Facundo Batista2ec74152007-12-03 17:55:00 +00005427_all_zeros = re.compile('0*$').match
5428_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005429
5430##### PEP3101 support functions ##############################################
5431# The functions parse_format_specifier and format_align have little to do
5432# with the Decimal class, and could potentially be reused for other pure
5433# Python numeric classes that want to implement __format__
5434#
5435# A format specifier for Decimal looks like:
5436#
5437# [[fill]align][sign][0][minimumwidth][.precision][type]
5438#
5439
5440_parse_format_specifier_regex = re.compile(r"""\A
5441(?:
5442 (?P<fill>.)?
5443 (?P<align>[<>=^])
5444)?
5445(?P<sign>[-+ ])?
5446(?P<zeropad>0)?
5447(?P<minimumwidth>(?!0)\d+)?
5448(?:\.(?P<precision>0|(?!0)\d+))?
5449(?P<type>[eEfFgG%])?
5450\Z
5451""", re.VERBOSE)
5452
Facundo Batista72bc54f2007-11-23 17:59:00 +00005453del re
5454
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005455def _parse_format_specifier(format_spec):
5456 """Parse and validate a format specifier.
5457
5458 Turns a standard numeric format specifier into a dict, with the
5459 following entries:
5460
5461 fill: fill character to pad field to minimum width
5462 align: alignment type, either '<', '>', '=' or '^'
5463 sign: either '+', '-' or ' '
5464 minimumwidth: nonnegative integer giving minimum width
5465 precision: nonnegative integer giving precision, or None
5466 type: one of the characters 'eEfFgG%', or None
5467 unicode: either True or False (always True for Python 3.x)
5468
5469 """
5470 m = _parse_format_specifier_regex.match(format_spec)
5471 if m is None:
5472 raise ValueError("Invalid format specifier: " + format_spec)
5473
5474 # get the dictionary
5475 format_dict = m.groupdict()
5476
5477 # defaults for fill and alignment
5478 fill = format_dict['fill']
5479 align = format_dict['align']
5480 if format_dict.pop('zeropad') is not None:
5481 # in the face of conflict, refuse the temptation to guess
5482 if fill is not None and fill != '0':
5483 raise ValueError("Fill character conflicts with '0'"
5484 " in format specifier: " + format_spec)
5485 if align is not None and align != '=':
5486 raise ValueError("Alignment conflicts with '0' in "
5487 "format specifier: " + format_spec)
5488 fill = '0'
5489 align = '='
5490 format_dict['fill'] = fill or ' '
5491 format_dict['align'] = align or '<'
5492
5493 if format_dict['sign'] is None:
5494 format_dict['sign'] = '-'
5495
5496 # turn minimumwidth and precision entries into integers.
5497 # minimumwidth defaults to 0; precision remains None if not given
5498 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5499 if format_dict['precision'] is not None:
5500 format_dict['precision'] = int(format_dict['precision'])
5501
5502 # if format type is 'g' or 'G' then a precision of 0 makes little
5503 # sense; convert it to 1. Same if format type is unspecified.
5504 if format_dict['precision'] == 0:
5505 if format_dict['type'] in 'gG' or format_dict['type'] is None:
5506 format_dict['precision'] = 1
5507
5508 # record whether return type should be str or unicode
5509 format_dict['unicode'] = isinstance(format_spec, unicode)
5510
5511 return format_dict
5512
5513def _format_align(body, spec_dict):
5514 """Given an unpadded, non-aligned numeric string, add padding and
5515 aligment to conform with the given format specifier dictionary (as
5516 output from parse_format_specifier).
5517
5518 It's assumed that if body is negative then it starts with '-'.
5519 Any leading sign ('-' or '+') is stripped from the body before
5520 applying the alignment and padding rules, and replaced in the
5521 appropriate position.
5522
5523 """
5524 # figure out the sign; we only examine the first character, so if
5525 # body has leading whitespace the results may be surprising.
5526 if len(body) > 0 and body[0] in '-+':
5527 sign = body[0]
5528 body = body[1:]
5529 else:
5530 sign = ''
5531
5532 if sign != '-':
5533 if spec_dict['sign'] in ' +':
5534 sign = spec_dict['sign']
5535 else:
5536 sign = ''
5537
5538 # how much extra space do we have to play with?
5539 minimumwidth = spec_dict['minimumwidth']
5540 fill = spec_dict['fill']
5541 padding = fill*(max(minimumwidth - (len(sign+body)), 0))
5542
5543 align = spec_dict['align']
5544 if align == '<':
5545 result = padding + sign + body
5546 elif align == '>':
5547 result = sign + body + padding
5548 elif align == '=':
5549 result = sign + padding + body
5550 else: #align == '^'
5551 half = len(padding)//2
5552 result = padding[:half] + sign + body + padding[half:]
5553
5554 # make sure that result is unicode if necessary
5555 if spec_dict['unicode']:
5556 result = unicode(result)
5557
5558 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00005559
Facundo Batista59c58842007-04-10 12:58:45 +00005560##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005561
Facundo Batista59c58842007-04-10 12:58:45 +00005562# Reusable defaults
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00005563_Infinity = Decimal('Inf')
5564_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonc5de0962009-01-02 23:07:08 +00005565_NaN = Decimal('NaN')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00005566_Zero = Decimal(0)
5567_One = Decimal(1)
5568_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005569
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00005570# _SignedInfinity[sign] is infinity w/ that sign
5571_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005572
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005573
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005574
5575if __name__ == '__main__':
5576 import doctest, sys
5577 doctest.testmod(sys.modules[__name__])