blob: 523d2523a3bd68bb3f4a4f83b225012341e22ca1 [file] [log] [blame]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001# Copyright (c) 2004 Python Software Foundation.
2# All rights reserved.
3
4# Written by Eric Price <eprice at tjhsst.edu>
5# and Facundo Batista <facundo at taniquetil.com.ar>
6# and Raymond Hettinger <python at rcn.com>
Fred Drake1f34eb12004-07-01 14:28:36 +00007# and Aahz <aahz at pobox.com>
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00008# and Tim Peters
9
Raymond Hettinger27dbcf22004-08-19 22:39:55 +000010# This module is currently Py2.3 compatible and should be kept that way
11# unless a major compelling advantage arises. IOW, 2.3 compatibility is
12# strongly preferred, but not guaranteed.
13
14# Also, this module should be kept in sync with the latest updates of
15# the IBM specification as it evolves. Those updates will be treated
16# as bug fixes (deviation from the spec is a compatibility, usability
17# bug) and will be backported. At this point the spec is stabilizing
18# and the updates are becoming fewer, smaller, and less significant.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000019
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000020"""
21This is a Py2.3 implementation of decimal floating point arithmetic based on
22the General Decimal Arithmetic Specification:
23
24 www2.hursley.ibm.com/decimal/decarith.html
25
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000026and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000027
28 www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html
29
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030Decimal floating point has finite precision with arbitrarily large bounds.
31
Facundo Batista59c58842007-04-10 12:58:45 +000032The purpose of this module is to support arithmetic using familiar
33"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000034issues associated with binary floating point. The package is especially
35useful for financial applications or for contexts where users have
36expectations that are at odds with binary floating point (for instance,
37in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Raymond Hettingerabe32372008-02-14 02:41:22 +000038of the expected Decimal('0.00') returned by decimal floating point).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000039
40Here are some examples of using the decimal module:
41
42>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000043>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000044>>> Decimal(0)
Raymond Hettingerabe32372008-02-14 02:41:22 +000045Decimal('0')
46>>> Decimal('1')
47Decimal('1')
48>>> Decimal('-.0123')
49Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000050>>> Decimal(123456)
Raymond Hettingerabe32372008-02-14 02:41:22 +000051Decimal('123456')
52>>> Decimal('123.45e12345678901234567890')
53Decimal('1.2345E+12345678901234567892')
54>>> Decimal('1.33') + Decimal('1.27')
55Decimal('2.60')
56>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
57Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000058>>> dig = Decimal(1)
59>>> print dig / Decimal(3)
600.333333333
61>>> getcontext().prec = 18
62>>> print dig / Decimal(3)
630.333333333333333333
64>>> print dig.sqrt()
651
66>>> print Decimal(3).sqrt()
671.73205080756887729
68>>> print Decimal(3) ** 123
694.85192780976896427E+58
70>>> inf = Decimal(1) / Decimal(0)
71>>> print inf
72Infinity
73>>> neginf = Decimal(-1) / Decimal(0)
74>>> print neginf
75-Infinity
76>>> print neginf + inf
77NaN
78>>> print neginf * inf
79-Infinity
80>>> print dig / 0
81Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000082>>> getcontext().traps[DivisionByZero] = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000083>>> print dig / 0
84Traceback (most recent call last):
85 ...
86 ...
87 ...
88DivisionByZero: x / 0
89>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000090>>> c.traps[InvalidOperation] = 0
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000091>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
93>>> c.divide(Decimal(0), Decimal(0))
Raymond Hettingerabe32372008-02-14 02:41:22 +000094Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000095>>> c.traps[InvalidOperation] = 1
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000096>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000971
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000098>>> c.flags[InvalidOperation] = 0
99>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000
101>>> print c.divide(Decimal(0), Decimal(0))
102Traceback (most recent call last):
103 ...
104 ...
105 ...
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000106InvalidOperation: 0 / 0
107>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001081
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000109>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000110>>> c.traps[InvalidOperation] = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000111>>> print c.divide(Decimal(0), Decimal(0))
112NaN
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000113>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001141
115>>>
116"""
117
118__all__ = [
119 # Two major classes
120 'Decimal', 'Context',
121
122 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000123 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000124
125 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000126 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
127 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000128
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000129 # Constants for use in setting up contexts
130 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Facundo Batista353750c2007-09-13 18:13:15 +0000131 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000132
133 # Functions for manipulating contexts
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000134 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000135]
136
Raymond Hettingereb260842005-06-07 18:52:34 +0000137import copy as _copy
Raymond Hettinger45fd4762009-02-03 03:42:07 +0000138import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000139
Raymond Hettinger097a1902008-01-11 02:24:13 +0000140try:
141 from collections import namedtuple as _namedtuple
142 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
143except ImportError:
144 DecimalTuple = lambda *args: args
145
Facundo Batista59c58842007-04-10 12:58:45 +0000146# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000147ROUND_DOWN = 'ROUND_DOWN'
148ROUND_HALF_UP = 'ROUND_HALF_UP'
149ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
150ROUND_CEILING = 'ROUND_CEILING'
151ROUND_FLOOR = 'ROUND_FLOOR'
152ROUND_UP = 'ROUND_UP'
153ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Facundo Batista353750c2007-09-13 18:13:15 +0000154ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000155
Facundo Batista59c58842007-04-10 12:58:45 +0000156# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000157
158class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000159 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000160
161 Used exceptions derive from this.
162 If an exception derives from another exception besides this (such as
163 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
164 called if the others are present. This isn't actually used for
165 anything, though.
166
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000167 handle -- Called when context._raise_error is called and the
168 trap_enabler is set. First argument is self, second is the
169 context. More arguments can be given, those being after
170 the explanation in _raise_error (For example,
171 context._raise_error(NewError, '(-x)!', self._sign) would
172 call NewError().handle(context, self._sign).)
173
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000174 To define a new exception, it should be sufficient to have it derive
175 from DecimalException.
176 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000177 def handle(self, context, *args):
178 pass
179
180
181class Clamped(DecimalException):
182 """Exponent of a 0 changed to fit bounds.
183
184 This occurs and signals clamped if the exponent of a result has been
185 altered in order to fit the constraints of a specific concrete
Facundo Batista59c58842007-04-10 12:58:45 +0000186 representation. This may occur when the exponent of a zero result would
187 be outside the bounds of a representation, or when a large normal
188 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000189 this latter case, the exponent is reduced to fit and the corresponding
190 number of zero digits are appended to the coefficient ("fold-down").
191 """
192
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000193class InvalidOperation(DecimalException):
194 """An invalid operation was performed.
195
196 Various bad things cause this:
197
198 Something creates a signaling NaN
199 -INF + INF
Facundo Batista59c58842007-04-10 12:58:45 +0000200 0 * (+-)INF
201 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000202 x % 0
203 (+-)INF % x
204 x._rescale( non-integer )
205 sqrt(-x) , x > 0
206 0 ** 0
207 x ** (non-integer)
208 x ** (+-)INF
209 An operand is invalid
Facundo Batista353750c2007-09-13 18:13:15 +0000210
211 The result of the operation after these is a quiet positive NaN,
212 except when the cause is a signaling NaN, in which case the result is
213 also a quiet NaN, but with the original sign, and an optional
214 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000215 """
216 def handle(self, context, *args):
217 if args:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000218 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
219 return ans._fix_nan(context)
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000220 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000221
222class ConversionSyntax(InvalidOperation):
223 """Trying to convert badly formed string.
224
225 This occurs and signals invalid-operation if an string is being
226 converted to a number and it does not conform to the numeric string
Facundo Batista59c58842007-04-10 12:58:45 +0000227 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000228 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000229 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000230 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000231
232class DivisionByZero(DecimalException, ZeroDivisionError):
233 """Division by 0.
234
235 This occurs and signals division-by-zero if division of a finite number
236 by zero was attempted (during a divide-integer or divide operation, or a
237 power operation with negative right-hand operand), and the dividend was
238 not zero.
239
240 The result of the operation is [sign,inf], where sign is the exclusive
241 or of the signs of the operands for divide, or is 1 for an odd power of
242 -0, for power.
243 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000244
Facundo Batistacce8df22007-09-18 16:53:18 +0000245 def handle(self, context, sign, *args):
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000246 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000247
248class DivisionImpossible(InvalidOperation):
249 """Cannot perform the division adequately.
250
251 This occurs and signals invalid-operation if the integer result of a
252 divide-integer or remainder operation had too many digits (would be
Facundo Batista59c58842007-04-10 12:58:45 +0000253 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000254 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000255
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000256 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000257 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000258
259class DivisionUndefined(InvalidOperation, ZeroDivisionError):
260 """Undefined result of division.
261
262 This occurs and signals invalid-operation if division by zero was
263 attempted (during a divide-integer, divide, or remainder operation), and
Facundo Batista59c58842007-04-10 12:58:45 +0000264 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000265 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000266
Facundo Batistacce8df22007-09-18 16:53:18 +0000267 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000268 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000269
270class Inexact(DecimalException):
271 """Had to round, losing information.
272
273 This occurs and signals inexact whenever the result of an operation is
274 not exact (that is, it needed to be rounded and any discarded digits
Facundo Batista59c58842007-04-10 12:58:45 +0000275 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000276 result in all cases is unchanged.
277
278 The inexact signal may be tested (or trapped) to determine if a given
279 operation (or sequence of operations) was inexact.
280 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000281
282class InvalidContext(InvalidOperation):
283 """Invalid context. Unknown rounding, for example.
284
285 This occurs and signals invalid-operation if an invalid context was
Facundo Batista59c58842007-04-10 12:58:45 +0000286 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000287 on creation and either the precision exceeds the capability of the
288 underlying concrete representation or an unknown or unsupported rounding
Facundo Batista59c58842007-04-10 12:58:45 +0000289 was specified. These aspects of the context need only be checked when
290 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000291 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000292
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000293 def handle(self, context, *args):
Mark Dickinsonfd6032d2009-01-02 23:16:51 +0000294 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000295
296class Rounded(DecimalException):
297 """Number got rounded (not necessarily changed during rounding).
298
299 This occurs and signals rounded whenever the result of an operation is
300 rounded (that is, some zero or non-zero digits were discarded from the
Facundo Batista59c58842007-04-10 12:58:45 +0000301 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000302 result in all cases is unchanged.
303
304 The rounded signal may be tested (or trapped) to determine if a given
305 operation (or sequence of operations) caused a loss of precision.
306 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000307
308class Subnormal(DecimalException):
309 """Exponent < Emin before rounding.
310
311 This occurs and signals subnormal whenever the result of a conversion or
312 operation is subnormal (that is, its adjusted exponent is less than
Facundo Batista59c58842007-04-10 12:58:45 +0000313 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000314
315 The subnormal signal may be tested (or trapped) to determine if a given
316 or operation (or sequence of operations) yielded a subnormal result.
317 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000318
319class Overflow(Inexact, Rounded):
320 """Numerical overflow.
321
322 This occurs and signals overflow if the adjusted exponent of a result
323 (from a conversion or from an operation that is not an attempt to divide
324 by zero), after rounding, would be greater than the largest value that
325 can be handled by the implementation (the value Emax).
326
327 The result depends on the rounding mode:
328
329 For round-half-up and round-half-even (and for round-half-down and
330 round-up, if implemented), the result of the operation is [sign,inf],
Facundo Batista59c58842007-04-10 12:58:45 +0000331 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000332 result is the largest finite number that can be represented in the
Facundo Batista59c58842007-04-10 12:58:45 +0000333 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000334 round-ceiling, the result is the same as for round-down if the sign of
Facundo Batista59c58842007-04-10 12:58:45 +0000335 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000336 the result is the same as for round-down if the sign of the intermediate
Facundo Batista59c58842007-04-10 12:58:45 +0000337 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000338 will also be raised.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000339 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000340
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000341 def handle(self, context, sign, *args):
342 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Facundo Batista353750c2007-09-13 18:13:15 +0000343 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000344 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000345 if sign == 0:
346 if context.rounding == ROUND_CEILING:
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000347 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000348 return _dec_from_triple(sign, '9'*context.prec,
349 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000350 if sign == 1:
351 if context.rounding == ROUND_FLOOR:
Mark Dickinsone4d46b22009-01-03 12:09:22 +0000352 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000353 return _dec_from_triple(sign, '9'*context.prec,
354 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000355
356
357class Underflow(Inexact, Rounded, Subnormal):
358 """Numerical underflow with result rounded to 0.
359
360 This occurs and signals underflow if a result is inexact and the
361 adjusted exponent of the result would be smaller (more negative) than
362 the smallest value that can be handled by the implementation (the value
Facundo Batista59c58842007-04-10 12:58:45 +0000363 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000364
365 The result after an underflow will be a subnormal number rounded, if
Facundo Batista59c58842007-04-10 12:58:45 +0000366 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000367 in 0 with the sign of the intermediate result and an exponent of Etiny.
368
369 In all cases, Inexact, Rounded, and Subnormal will also be raised.
370 """
371
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000372# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000373_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000374 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000375
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000376# Map conditions (per the spec) to signals
377_condition_map = {ConversionSyntax:InvalidOperation,
378 DivisionImpossible:InvalidOperation,
379 DivisionUndefined:InvalidOperation,
380 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000381
Facundo Batista59c58842007-04-10 12:58:45 +0000382##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000383
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000384# The getcontext() and setcontext() function manage access to a thread-local
385# current context. Py2.4 offers direct support for thread locals. If that
386# is not available, use threading.currentThread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000387# work for older Pythons. If threads are not part of the build, create a
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000388# mock threading object with threading.local() returning the module namespace.
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000389
390try:
391 import threading
392except ImportError:
393 # Python was compiled without threads; create a mock object instead
394 import sys
Facundo Batista59c58842007-04-10 12:58:45 +0000395 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000396 def local(self, sys=sys):
397 return sys.modules[__name__]
398 threading = MockThreading()
399 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000400
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000401try:
402 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000403
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000404except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000405
Facundo Batista59c58842007-04-10 12:58:45 +0000406 # To fix reloading, force it to create a new context
407 # Old contexts have different exceptions in their dicts, making problems.
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000408 if hasattr(threading.currentThread(), '__decimal_context__'):
409 del threading.currentThread().__decimal_context__
410
411 def setcontext(context):
412 """Set this thread's context to context."""
413 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000414 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000415 context.clear_flags()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000416 threading.currentThread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000417
418 def getcontext():
419 """Returns this thread's context.
420
421 If this thread does not yet have a context, returns
422 a new context and sets this thread's context.
423 New contexts are copies of DefaultContext.
424 """
425 try:
426 return threading.currentThread().__decimal_context__
427 except AttributeError:
428 context = Context()
429 threading.currentThread().__decimal_context__ = context
430 return context
431
432else:
433
434 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000435 if hasattr(local, '__decimal_context__'):
436 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000437
438 def getcontext(_local=local):
439 """Returns this thread's context.
440
441 If this thread does not yet have a context, returns
442 a new context and sets this thread's context.
443 New contexts are copies of DefaultContext.
444 """
445 try:
446 return _local.__decimal_context__
447 except AttributeError:
448 context = Context()
449 _local.__decimal_context__ = context
450 return context
451
452 def setcontext(context, _local=local):
453 """Set this thread's context to context."""
454 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000455 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000456 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000457 _local.__decimal_context__ = context
458
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000459 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000460
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000461def localcontext(ctx=None):
462 """Return a context manager for a copy of the supplied context
463
464 Uses a copy of the current context if no context is specified
465 The returned context manager creates a local decimal context
466 in a with statement:
467 def sin(x):
468 with localcontext() as ctx:
469 ctx.prec += 2
470 # Rest of sin calculation algorithm
471 # uses a precision 2 greater than normal
Facundo Batista59c58842007-04-10 12:58:45 +0000472 return +s # Convert result to normal precision
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000473
474 def sin(x):
475 with localcontext(ExtendedContext):
476 # Rest of sin calculation algorithm
477 # uses the Extended Context from the
478 # General Decimal Arithmetic Specification
Facundo Batista59c58842007-04-10 12:58:45 +0000479 return +s # Convert result to normal context
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000480
Facundo Batistaee340e52008-05-02 17:39:00 +0000481 >>> setcontext(DefaultContext)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000482 >>> print getcontext().prec
483 28
484 >>> with localcontext():
485 ... ctx = getcontext()
Raymond Hettinger495df472007-02-08 01:42:35 +0000486 ... ctx.prec += 2
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000487 ... print ctx.prec
488 ...
489 30
490 >>> with localcontext(ExtendedContext):
491 ... print getcontext().prec
492 ...
493 9
494 >>> print getcontext().prec
495 28
496 """
Nick Coghlanced12182006-09-02 03:54:17 +0000497 if ctx is None: ctx = getcontext()
498 return _ContextManager(ctx)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000499
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000500
Facundo Batista59c58842007-04-10 12:58:45 +0000501##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000502
503class Decimal(object):
504 """Floating point class for decimal arithmetic."""
505
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000506 __slots__ = ('_exp','_int','_sign', '_is_special')
507 # Generally, the value of the Decimal instance is given by
508 # (-1)**_sign * _int * 10**_exp
509 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000510
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000511 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000512 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000513 """Create a decimal point instance.
514
515 >>> Decimal('3.14') # string input
Raymond Hettingerabe32372008-02-14 02:41:22 +0000516 Decimal('3.14')
Facundo Batista59c58842007-04-10 12:58:45 +0000517 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Raymond Hettingerabe32372008-02-14 02:41:22 +0000518 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000519 >>> Decimal(314) # int or long
Raymond Hettingerabe32372008-02-14 02:41:22 +0000520 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000521 >>> Decimal(Decimal(314)) # another decimal instance
Raymond Hettingerabe32372008-02-14 02:41:22 +0000522 Decimal('314')
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000523 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Raymond Hettingerabe32372008-02-14 02:41:22 +0000524 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000525 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000526
Facundo Batista72bc54f2007-11-23 17:59:00 +0000527 # Note that the coefficient, self._int, is actually stored as
528 # a string rather than as a tuple of digits. This speeds up
529 # the "digits to integer" and "integer to digits" conversions
530 # that are used in almost every arithmetic operation on
531 # Decimals. This is an internal detail: the as_tuple function
532 # and the Decimal constructor still deal with tuples of
533 # digits.
534
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000535 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000536
Facundo Batista0d157a02007-11-30 17:15:25 +0000537 # From a string
538 # REs insist on real strings, so we can too.
539 if isinstance(value, basestring):
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000540 m = _parser(value.strip())
Facundo Batista0d157a02007-11-30 17:15:25 +0000541 if m is None:
542 if context is None:
543 context = getcontext()
544 return context._raise_error(ConversionSyntax,
545 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000546
Facundo Batista0d157a02007-11-30 17:15:25 +0000547 if m.group('sign') == "-":
548 self._sign = 1
549 else:
550 self._sign = 0
551 intpart = m.group('int')
552 if intpart is not None:
553 # finite number
Mark Dickinson9a6e6452009-08-02 11:01:01 +0000554 fracpart = m.group('frac') or ''
Facundo Batista0d157a02007-11-30 17:15:25 +0000555 exp = int(m.group('exp') or '0')
Mark Dickinson9a6e6452009-08-02 11:01:01 +0000556 self._int = str(int(intpart+fracpart))
557 self._exp = exp - len(fracpart)
Facundo Batista0d157a02007-11-30 17:15:25 +0000558 self._is_special = False
559 else:
560 diag = m.group('diag')
561 if diag is not None:
562 # NaN
Mark Dickinson9a6e6452009-08-02 11:01:01 +0000563 self._int = str(int(diag or '0')).lstrip('0')
Facundo Batista0d157a02007-11-30 17:15:25 +0000564 if m.group('signal'):
565 self._exp = 'N'
566 else:
567 self._exp = 'n'
568 else:
569 # infinity
570 self._int = '0'
571 self._exp = 'F'
572 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000573 return self
574
575 # From an integer
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000576 if isinstance(value, (int,long)):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000577 if value >= 0:
578 self._sign = 0
579 else:
580 self._sign = 1
581 self._exp = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +0000582 self._int = str(abs(value))
Facundo Batista0d157a02007-11-30 17:15:25 +0000583 self._is_special = False
584 return self
585
586 # From another decimal
587 if isinstance(value, Decimal):
588 self._exp = value._exp
589 self._sign = value._sign
590 self._int = value._int
591 self._is_special = value._is_special
592 return self
593
594 # From an internal working value
595 if isinstance(value, _WorkRep):
596 self._sign = value.sign
597 self._int = str(value.int)
598 self._exp = int(value.exp)
599 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000600 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000601
602 # tuple/list conversion (possibly from as_tuple())
603 if isinstance(value, (list,tuple)):
604 if len(value) != 3:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000605 raise ValueError('Invalid tuple size in creation of Decimal '
606 'from list or tuple. The list or tuple '
607 'should have exactly three elements.')
608 # process sign. The isinstance test rejects floats
609 if not (isinstance(value[0], (int, long)) and value[0] in (0,1)):
610 raise ValueError("Invalid sign. The first value in the tuple "
611 "should be an integer; either 0 for a "
612 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000613 self._sign = value[0]
Facundo Batista9b5e2312007-10-19 19:25:57 +0000614 if value[2] == 'F':
615 # infinity: value[1] is ignored
Facundo Batista72bc54f2007-11-23 17:59:00 +0000616 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000617 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000618 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000619 else:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000620 # process and validate the digits in value[1]
621 digits = []
622 for digit in value[1]:
623 if isinstance(digit, (int, long)) and 0 <= digit <= 9:
624 # skip leading zeros
625 if digits or digit != 0:
626 digits.append(digit)
627 else:
628 raise ValueError("The second value in the tuple must "
629 "be composed of integers in the range "
630 "0 through 9.")
631 if value[2] in ('n', 'N'):
632 # NaN: digits form the diagnostic
Facundo Batista72bc54f2007-11-23 17:59:00 +0000633 self._int = ''.join(map(str, digits))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000634 self._exp = value[2]
635 self._is_special = True
636 elif isinstance(value[2], (int, long)):
637 # finite number: digits give the coefficient
Facundo Batista72bc54f2007-11-23 17:59:00 +0000638 self._int = ''.join(map(str, digits or [0]))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000639 self._exp = value[2]
640 self._is_special = False
641 else:
642 raise ValueError("The third value in the tuple must "
643 "be an integer, or one of the "
644 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000645 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000646
Raymond Hettingerbf440692004-07-10 14:14:37 +0000647 if isinstance(value, float):
648 raise TypeError("Cannot convert float to Decimal. " +
649 "First convert the float to a string")
650
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000651 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000652
653 def _isnan(self):
654 """Returns whether the number is not actually one.
655
656 0 if a number
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000657 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000658 2 if sNaN
659 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000660 if self._is_special:
661 exp = self._exp
662 if exp == 'n':
663 return 1
664 elif exp == 'N':
665 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000666 return 0
667
668 def _isinfinity(self):
669 """Returns whether the number is infinite
670
671 0 if finite or not a number
672 1 if +INF
673 -1 if -INF
674 """
675 if self._exp == 'F':
676 if self._sign:
677 return -1
678 return 1
679 return 0
680
Facundo Batista353750c2007-09-13 18:13:15 +0000681 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000682 """Returns whether the number is not actually one.
683
684 if self, other are sNaN, signal
685 if self, other are NaN return nan
686 return 0
687
688 Done before operations.
689 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000690
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000691 self_is_nan = self._isnan()
692 if other is None:
693 other_is_nan = False
694 else:
695 other_is_nan = other._isnan()
696
697 if self_is_nan or other_is_nan:
698 if context is None:
699 context = getcontext()
700
701 if self_is_nan == 2:
702 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000703 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000704 if other_is_nan == 2:
705 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000706 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000707 if self_is_nan:
Facundo Batista353750c2007-09-13 18:13:15 +0000708 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000709
Facundo Batista353750c2007-09-13 18:13:15 +0000710 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000711 return 0
712
Mark Dickinson2fc92632008-02-06 22:10:50 +0000713 def _compare_check_nans(self, other, context):
714 """Version of _check_nans used for the signaling comparisons
715 compare_signal, __le__, __lt__, __ge__, __gt__.
716
717 Signal InvalidOperation if either self or other is a (quiet
718 or signaling) NaN. Signaling NaNs take precedence over quiet
719 NaNs.
720
721 Return 0 if neither operand is a NaN.
722
723 """
724 if context is None:
725 context = getcontext()
726
727 if self._is_special or other._is_special:
728 if self.is_snan():
729 return context._raise_error(InvalidOperation,
730 'comparison involving sNaN',
731 self)
732 elif other.is_snan():
733 return context._raise_error(InvalidOperation,
734 'comparison involving sNaN',
735 other)
736 elif self.is_qnan():
737 return context._raise_error(InvalidOperation,
738 'comparison involving NaN',
739 self)
740 elif other.is_qnan():
741 return context._raise_error(InvalidOperation,
742 'comparison involving NaN',
743 other)
744 return 0
745
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000746 def __nonzero__(self):
Facundo Batista1a191df2007-10-02 17:01:24 +0000747 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000748
Facundo Batista1a191df2007-10-02 17:01:24 +0000749 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000750 """
Facundo Batista72bc54f2007-11-23 17:59:00 +0000751 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000752
Mark Dickinson2fc92632008-02-06 22:10:50 +0000753 def _cmp(self, other):
754 """Compare the two non-NaN decimal instances self and other.
755
756 Returns -1 if self < other, 0 if self == other and 1
757 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000758
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000759 if self._is_special or other._is_special:
Mark Dickinson8ec69bc2009-01-25 10:47:45 +0000760 self_inf = self._isinfinity()
761 other_inf = other._isinfinity()
762 if self_inf == other_inf:
763 return 0
764 elif self_inf < other_inf:
765 return -1
766 else:
767 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000768
Mark Dickinson8ec69bc2009-01-25 10:47:45 +0000769 # check for zeros; Decimal('0') == Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +0000770 if not self:
771 if not other:
772 return 0
773 else:
774 return -((-1)**other._sign)
775 if not other:
776 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000777
Facundo Batista59c58842007-04-10 12:58:45 +0000778 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000779 if other._sign < self._sign:
780 return -1
781 if self._sign < other._sign:
782 return 1
783
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000784 self_adjusted = self.adjusted()
785 other_adjusted = other.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +0000786 if self_adjusted == other_adjusted:
Facundo Batista72bc54f2007-11-23 17:59:00 +0000787 self_padded = self._int + '0'*(self._exp - other._exp)
788 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinson8ec69bc2009-01-25 10:47:45 +0000789 if self_padded == other_padded:
790 return 0
791 elif self_padded < other_padded:
792 return -(-1)**self._sign
793 else:
794 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000795 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000796 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000797 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000798 return -((-1)**self._sign)
799
Mark Dickinson2fc92632008-02-06 22:10:50 +0000800 # Note: The Decimal standard doesn't cover rich comparisons for
801 # Decimals. In particular, the specification is silent on the
802 # subject of what should happen for a comparison involving a NaN.
803 # We take the following approach:
804 #
805 # == comparisons involving a NaN always return False
806 # != comparisons involving a NaN always return True
807 # <, >, <= and >= comparisons involving a (quiet or signaling)
808 # NaN signal InvalidOperation, and return False if the
Mark Dickinson3a94ee02008-02-10 15:19:58 +0000809 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000810 #
811 # This behavior is designed to conform as closely as possible to
812 # that specified by IEEE 754.
813
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000814 def __eq__(self, other):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000815 other = _convert_other(other)
816 if other is NotImplemented:
817 return other
818 if self.is_nan() or other.is_nan():
819 return False
820 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000821
822 def __ne__(self, other):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000823 other = _convert_other(other)
824 if other is NotImplemented:
825 return other
826 if self.is_nan() or other.is_nan():
827 return True
828 return self._cmp(other) != 0
829
830 def __lt__(self, other, context=None):
831 other = _convert_other(other)
832 if other is NotImplemented:
833 return other
834 ans = self._compare_check_nans(other, context)
835 if ans:
836 return False
837 return self._cmp(other) < 0
838
839 def __le__(self, other, context=None):
840 other = _convert_other(other)
841 if other is NotImplemented:
842 return other
843 ans = self._compare_check_nans(other, context)
844 if ans:
845 return False
846 return self._cmp(other) <= 0
847
848 def __gt__(self, other, context=None):
849 other = _convert_other(other)
850 if other is NotImplemented:
851 return other
852 ans = self._compare_check_nans(other, context)
853 if ans:
854 return False
855 return self._cmp(other) > 0
856
857 def __ge__(self, other, context=None):
858 other = _convert_other(other)
859 if other is NotImplemented:
860 return other
861 ans = self._compare_check_nans(other, context)
862 if ans:
863 return False
864 return self._cmp(other) >= 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000865
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000866 def compare(self, other, context=None):
867 """Compares one to another.
868
869 -1 => a < b
870 0 => a = b
871 1 => a > b
872 NaN => one is NaN
873 Like __cmp__, but returns Decimal instances.
874 """
Facundo Batista353750c2007-09-13 18:13:15 +0000875 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000876
Facundo Batista59c58842007-04-10 12:58:45 +0000877 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000878 if (self._is_special or other and other._is_special):
879 ans = self._check_nans(other, context)
880 if ans:
881 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000882
Mark Dickinson2fc92632008-02-06 22:10:50 +0000883 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000884
885 def __hash__(self):
886 """x.__hash__() <==> hash(x)"""
887 # Decimal integers must hash the same as the ints
Facundo Batista52b25792008-01-08 12:25:20 +0000888 #
889 # The hash of a nonspecial noninteger Decimal must depend only
890 # on the value of that Decimal, and not on its representation.
Raymond Hettingerabe32372008-02-14 02:41:22 +0000891 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000892 if self._is_special:
893 if self._isnan():
894 raise TypeError('Cannot hash a NaN value.')
895 return hash(str(self))
Facundo Batista8c202442007-09-19 17:53:25 +0000896 if not self:
897 return 0
898 if self._isinteger():
899 op = _WorkRep(self.to_integral_value())
900 # to make computation feasible for Decimals with large
901 # exponent, we use the fact that hash(n) == hash(m) for
902 # any two nonzero integers n and m such that (i) n and m
903 # have the same sign, and (ii) n is congruent to m modulo
904 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
905 # hash((-1)**s*c*pow(10, e, 2**64-1).
906 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Facundo Batista52b25792008-01-08 12:25:20 +0000907 # The value of a nonzero nonspecial Decimal instance is
908 # faithfully represented by the triple consisting of its sign,
909 # its adjusted exponent, and its coefficient with trailing
910 # zeros removed.
911 return hash((self._sign,
912 self._exp+len(self._int),
913 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000914
915 def as_tuple(self):
916 """Represents the number as a triple tuple.
917
918 To show the internals exactly as they are.
919 """
Raymond Hettinger097a1902008-01-11 02:24:13 +0000920 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000921
922 def __repr__(self):
923 """Represents the number as an instance of Decimal."""
924 # Invariant: eval(repr(d)) == d
Raymond Hettingerabe32372008-02-14 02:41:22 +0000925 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000926
Facundo Batista353750c2007-09-13 18:13:15 +0000927 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000928 """Return string representation of the number in scientific notation.
929
930 Captures all of the information in the underlying representation.
931 """
932
Facundo Batista62edb712007-12-03 16:29:52 +0000933 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000934 if self._is_special:
Facundo Batista62edb712007-12-03 16:29:52 +0000935 if self._exp == 'F':
936 return sign + 'Infinity'
937 elif self._exp == 'n':
938 return sign + 'NaN' + self._int
939 else: # self._exp == 'N'
940 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000941
Facundo Batista62edb712007-12-03 16:29:52 +0000942 # number of digits of self._int to left of decimal point
943 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000944
Facundo Batista62edb712007-12-03 16:29:52 +0000945 # dotplace is number of digits of self._int to the left of the
946 # decimal point in the mantissa of the output string (that is,
947 # after adjusting the exponent)
948 if self._exp <= 0 and leftdigits > -6:
949 # no exponent required
950 dotplace = leftdigits
951 elif not eng:
952 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000953 dotplace = 1
Facundo Batista62edb712007-12-03 16:29:52 +0000954 elif self._int == '0':
955 # engineering notation, zero
956 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000957 else:
Facundo Batista62edb712007-12-03 16:29:52 +0000958 # engineering notation, nonzero
959 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000960
Facundo Batista62edb712007-12-03 16:29:52 +0000961 if dotplace <= 0:
962 intpart = '0'
963 fracpart = '.' + '0'*(-dotplace) + self._int
964 elif dotplace >= len(self._int):
965 intpart = self._int+'0'*(dotplace-len(self._int))
966 fracpart = ''
967 else:
968 intpart = self._int[:dotplace]
969 fracpart = '.' + self._int[dotplace:]
970 if leftdigits == dotplace:
971 exp = ''
972 else:
973 if context is None:
974 context = getcontext()
975 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
976
977 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000978
979 def to_eng_string(self, context=None):
980 """Convert to engineering-type string.
981
982 Engineering notation has an exponent which is a multiple of 3, so there
983 are up to 3 digits left of the decimal place.
984
985 Same rules for when in exponential and when as a value as in __str__.
986 """
Facundo Batista353750c2007-09-13 18:13:15 +0000987 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000988
989 def __neg__(self, context=None):
990 """Returns a copy with the sign switched.
991
992 Rounds, if it has reason.
993 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000994 if self._is_special:
995 ans = self._check_nans(context=context)
996 if ans:
997 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000998
999 if not self:
1000 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001001 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001002 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001003 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001004
1005 if context is None:
1006 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001007 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001008
1009 def __pos__(self, context=None):
1010 """Returns a copy, unless it is a sNaN.
1011
1012 Rounds the number (if more then precision digits)
1013 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001014 if self._is_special:
1015 ans = self._check_nans(context=context)
1016 if ans:
1017 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001018
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001019 if not self:
1020 # + (-0) = 0
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001021 ans = self.copy_abs()
Facundo Batista353750c2007-09-13 18:13:15 +00001022 else:
1023 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001024
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001025 if context is None:
1026 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001027 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001028
Facundo Batistae64acfa2007-12-17 14:18:42 +00001029 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001030 """Returns the absolute value of self.
1031
Facundo Batistae64acfa2007-12-17 14:18:42 +00001032 If the keyword argument 'round' is false, do not round. The
1033 expression self.__abs__(round=False) is equivalent to
1034 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001035 """
Facundo Batistae64acfa2007-12-17 14:18:42 +00001036 if not round:
1037 return self.copy_abs()
1038
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001039 if self._is_special:
1040 ans = self._check_nans(context=context)
1041 if ans:
1042 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001043
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001044 if self._sign:
1045 ans = self.__neg__(context=context)
1046 else:
1047 ans = self.__pos__(context=context)
1048
1049 return ans
1050
1051 def __add__(self, other, context=None):
1052 """Returns self + other.
1053
1054 -INF + INF (or the reverse) cause InvalidOperation errors.
1055 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001056 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001057 if other is NotImplemented:
1058 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001059
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001060 if context is None:
1061 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001062
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001063 if self._is_special or other._is_special:
1064 ans = self._check_nans(other, context)
1065 if ans:
1066 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001067
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001068 if self._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001069 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001070 if self._sign != other._sign and other._isinfinity():
1071 return context._raise_error(InvalidOperation, '-INF + INF')
1072 return Decimal(self)
1073 if other._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001074 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001075
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001076 exp = min(self._exp, other._exp)
1077 negativezero = 0
1078 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Facundo Batista59c58842007-04-10 12:58:45 +00001079 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001080 negativezero = 1
1081
1082 if not self and not other:
1083 sign = min(self._sign, other._sign)
1084 if negativezero:
1085 sign = 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00001086 ans = _dec_from_triple(sign, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001087 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001088 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001089 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001090 exp = max(exp, other._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001091 ans = other._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001092 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001093 return ans
1094 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001095 exp = max(exp, self._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001096 ans = self._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001097 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001098 return ans
1099
1100 op1 = _WorkRep(self)
1101 op2 = _WorkRep(other)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001102 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001103
1104 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001105 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001106 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001107 if op1.int == op2.int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001108 ans = _dec_from_triple(negativezero, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001109 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001110 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001111 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001112 op1, op2 = op2, op1
Facundo Batista59c58842007-04-10 12:58:45 +00001113 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001114 if op1.sign == 1:
1115 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001116 op1.sign, op2.sign = op2.sign, op1.sign
1117 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001118 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001119 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001120 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001121 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001122 op1.sign, op2.sign = (0, 0)
1123 else:
1124 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001125 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001126
Raymond Hettinger17931de2004-10-27 06:21:46 +00001127 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001128 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001129 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001130 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001131
1132 result.exp = op1.exp
1133 ans = Decimal(result)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001134 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001135 return ans
1136
1137 __radd__ = __add__
1138
1139 def __sub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001140 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001141 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001142 if other is NotImplemented:
1143 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001144
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001145 if self._is_special or other._is_special:
1146 ans = self._check_nans(other, context=context)
1147 if ans:
1148 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149
Facundo Batista353750c2007-09-13 18:13:15 +00001150 # self - other is computed as self + other.copy_negate()
1151 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001152
1153 def __rsub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001154 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001155 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001156 if other is NotImplemented:
1157 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001158
Facundo Batista353750c2007-09-13 18:13:15 +00001159 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001160
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001161 def __mul__(self, other, context=None):
1162 """Return self * other.
1163
1164 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1165 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001166 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001167 if other is NotImplemented:
1168 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001169
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001170 if context is None:
1171 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001172
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001173 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001174
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001175 if self._is_special or other._is_special:
1176 ans = self._check_nans(other, context)
1177 if ans:
1178 return ans
1179
1180 if self._isinfinity():
1181 if not other:
1182 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001183 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001184
1185 if other._isinfinity():
1186 if not self:
1187 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001188 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001189
1190 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001191
1192 # Special case for multiplying by zero
1193 if not self or not other:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001194 ans = _dec_from_triple(resultsign, '0', resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001195 # Fixing in case the exponent is out of bounds
1196 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001197 return ans
1198
1199 # Special case for multiplying by power of 10
Facundo Batista72bc54f2007-11-23 17:59:00 +00001200 if self._int == '1':
1201 ans = _dec_from_triple(resultsign, other._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001202 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001203 return ans
Facundo Batista72bc54f2007-11-23 17:59:00 +00001204 if other._int == '1':
1205 ans = _dec_from_triple(resultsign, self._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001206 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001207 return ans
1208
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001209 op1 = _WorkRep(self)
1210 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001211
Facundo Batista72bc54f2007-11-23 17:59:00 +00001212 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001213 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001214
1215 return ans
1216 __rmul__ = __mul__
1217
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001218 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001219 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001220 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001221 if other is NotImplemented:
Facundo Batistacce8df22007-09-18 16:53:18 +00001222 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001223
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001224 if context is None:
1225 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001226
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001227 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001228
1229 if self._is_special or other._is_special:
1230 ans = self._check_nans(other, context)
1231 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001232 return ans
1233
1234 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001236
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001237 if self._isinfinity():
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001238 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001239
1240 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001241 context._raise_error(Clamped, 'Division by infinity')
Facundo Batista72bc54f2007-11-23 17:59:00 +00001242 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001243
1244 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001245 if not other:
Facundo Batistacce8df22007-09-18 16:53:18 +00001246 if not self:
1247 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001248 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001249
Facundo Batistacce8df22007-09-18 16:53:18 +00001250 if not self:
1251 exp = self._exp - other._exp
1252 coeff = 0
1253 else:
1254 # OK, so neither = 0, INF or NaN
1255 shift = len(other._int) - len(self._int) + context.prec + 1
1256 exp = self._exp - other._exp - shift
1257 op1 = _WorkRep(self)
1258 op2 = _WorkRep(other)
1259 if shift >= 0:
1260 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1261 else:
1262 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1263 if remainder:
1264 # result is not exact; adjust to ensure correct rounding
1265 if coeff % 5 == 0:
1266 coeff += 1
1267 else:
1268 # result is exact; get as close to ideal exponent as possible
1269 ideal_exp = self._exp - other._exp
1270 while exp < ideal_exp and coeff % 10 == 0:
1271 coeff //= 10
1272 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001273
Facundo Batista72bc54f2007-11-23 17:59:00 +00001274 ans = _dec_from_triple(sign, str(coeff), exp)
Facundo Batistacce8df22007-09-18 16:53:18 +00001275 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001276
Facundo Batistacce8df22007-09-18 16:53:18 +00001277 def _divide(self, other, context):
1278 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001279
Facundo Batistacce8df22007-09-18 16:53:18 +00001280 Assumes that neither self nor other is a NaN, that self is not
1281 infinite and that other is nonzero.
1282 """
1283 sign = self._sign ^ other._sign
1284 if other._isinfinity():
1285 ideal_exp = self._exp
1286 else:
1287 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001288
Facundo Batistacce8df22007-09-18 16:53:18 +00001289 expdiff = self.adjusted() - other.adjusted()
1290 if not self or other._isinfinity() or expdiff <= -2:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001291 return (_dec_from_triple(sign, '0', 0),
Facundo Batistacce8df22007-09-18 16:53:18 +00001292 self._rescale(ideal_exp, context.rounding))
1293 if expdiff <= context.prec:
1294 op1 = _WorkRep(self)
1295 op2 = _WorkRep(other)
1296 if op1.exp >= op2.exp:
1297 op1.int *= 10**(op1.exp - op2.exp)
1298 else:
1299 op2.int *= 10**(op2.exp - op1.exp)
1300 q, r = divmod(op1.int, op2.int)
1301 if q < 10**context.prec:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001302 return (_dec_from_triple(sign, str(q), 0),
1303 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001304
Facundo Batistacce8df22007-09-18 16:53:18 +00001305 # Here the quotient is too large to be representable
1306 ans = context._raise_error(DivisionImpossible,
1307 'quotient too large in //, % or divmod')
1308 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001309
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001310 def __rtruediv__(self, other, context=None):
1311 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001312 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001313 if other is NotImplemented:
1314 return other
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001315 return other.__truediv__(self, context=context)
1316
1317 __div__ = __truediv__
1318 __rdiv__ = __rtruediv__
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001319
1320 def __divmod__(self, other, context=None):
1321 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001322 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001323 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001324 other = _convert_other(other)
1325 if other is NotImplemented:
1326 return other
1327
1328 if context is None:
1329 context = getcontext()
1330
1331 ans = self._check_nans(other, context)
1332 if ans:
1333 return (ans, ans)
1334
1335 sign = self._sign ^ other._sign
1336 if self._isinfinity():
1337 if other._isinfinity():
1338 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1339 return ans, ans
1340 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001341 return (_SignedInfinity[sign],
Facundo Batistacce8df22007-09-18 16:53:18 +00001342 context._raise_error(InvalidOperation, 'INF % x'))
1343
1344 if not other:
1345 if not self:
1346 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1347 return ans, ans
1348 else:
1349 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1350 context._raise_error(InvalidOperation, 'x % 0'))
1351
1352 quotient, remainder = self._divide(other, context)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001353 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001354 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001355
1356 def __rdivmod__(self, other, context=None):
1357 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001358 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001359 if other is NotImplemented:
1360 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001361 return other.__divmod__(self, context=context)
1362
1363 def __mod__(self, other, context=None):
1364 """
1365 self % other
1366 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001367 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001368 if other is NotImplemented:
1369 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001370
Facundo Batistacce8df22007-09-18 16:53:18 +00001371 if context is None:
1372 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001373
Facundo Batistacce8df22007-09-18 16:53:18 +00001374 ans = self._check_nans(other, context)
1375 if ans:
1376 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001377
Facundo Batistacce8df22007-09-18 16:53:18 +00001378 if self._isinfinity():
1379 return context._raise_error(InvalidOperation, 'INF % x')
1380 elif not other:
1381 if self:
1382 return context._raise_error(InvalidOperation, 'x % 0')
1383 else:
1384 return context._raise_error(DivisionUndefined, '0 % 0')
1385
1386 remainder = self._divide(other, context)[1]
Facundo Batistae64acfa2007-12-17 14:18:42 +00001387 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001388 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001389
1390 def __rmod__(self, other, context=None):
1391 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001392 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001393 if other is NotImplemented:
1394 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001395 return other.__mod__(self, context=context)
1396
1397 def remainder_near(self, other, context=None):
1398 """
1399 Remainder nearest to 0- abs(remainder-near) <= other/2
1400 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001401 if context is None:
1402 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001403
Facundo Batista353750c2007-09-13 18:13:15 +00001404 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001405
Facundo Batista353750c2007-09-13 18:13:15 +00001406 ans = self._check_nans(other, context)
1407 if ans:
1408 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001409
Facundo Batista353750c2007-09-13 18:13:15 +00001410 # self == +/-infinity -> InvalidOperation
1411 if self._isinfinity():
1412 return context._raise_error(InvalidOperation,
1413 'remainder_near(infinity, x)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001414
Facundo Batista353750c2007-09-13 18:13:15 +00001415 # other == 0 -> either InvalidOperation or DivisionUndefined
1416 if not other:
1417 if self:
1418 return context._raise_error(InvalidOperation,
1419 'remainder_near(x, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001420 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001421 return context._raise_error(DivisionUndefined,
1422 'remainder_near(0, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001423
Facundo Batista353750c2007-09-13 18:13:15 +00001424 # other = +/-infinity -> remainder = self
1425 if other._isinfinity():
1426 ans = Decimal(self)
1427 return ans._fix(context)
1428
1429 # self = 0 -> remainder = self, with ideal exponent
1430 ideal_exponent = min(self._exp, other._exp)
1431 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001432 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001433 return ans._fix(context)
1434
1435 # catch most cases of large or small quotient
1436 expdiff = self.adjusted() - other.adjusted()
1437 if expdiff >= context.prec + 1:
1438 # expdiff >= prec+1 => abs(self/other) > 10**prec
Facundo Batistacce8df22007-09-18 16:53:18 +00001439 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001440 if expdiff <= -2:
1441 # expdiff <= -2 => abs(self/other) < 0.1
1442 ans = self._rescale(ideal_exponent, context.rounding)
1443 return ans._fix(context)
1444
1445 # adjust both arguments to have the same exponent, then divide
1446 op1 = _WorkRep(self)
1447 op2 = _WorkRep(other)
1448 if op1.exp >= op2.exp:
1449 op1.int *= 10**(op1.exp - op2.exp)
1450 else:
1451 op2.int *= 10**(op2.exp - op1.exp)
1452 q, r = divmod(op1.int, op2.int)
1453 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1454 # 10**ideal_exponent. Apply correction to ensure that
1455 # abs(remainder) <= abs(other)/2
1456 if 2*r + (q&1) > op2.int:
1457 r -= op2.int
1458 q += 1
1459
1460 if q >= 10**context.prec:
Facundo Batistacce8df22007-09-18 16:53:18 +00001461 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001462
1463 # result has same sign as self unless r is negative
1464 sign = self._sign
1465 if r < 0:
1466 sign = 1-sign
1467 r = -r
1468
Facundo Batista72bc54f2007-11-23 17:59:00 +00001469 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001470 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001471
1472 def __floordiv__(self, other, context=None):
1473 """self // other"""
Facundo Batistacce8df22007-09-18 16:53:18 +00001474 other = _convert_other(other)
1475 if other is NotImplemented:
1476 return other
1477
1478 if context is None:
1479 context = getcontext()
1480
1481 ans = self._check_nans(other, context)
1482 if ans:
1483 return ans
1484
1485 if self._isinfinity():
1486 if other._isinfinity():
1487 return context._raise_error(InvalidOperation, 'INF // INF')
1488 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001489 return _SignedInfinity[self._sign ^ other._sign]
Facundo Batistacce8df22007-09-18 16:53:18 +00001490
1491 if not other:
1492 if self:
1493 return context._raise_error(DivisionByZero, 'x // 0',
1494 self._sign ^ other._sign)
1495 else:
1496 return context._raise_error(DivisionUndefined, '0 // 0')
1497
1498 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001499
1500 def __rfloordiv__(self, other, context=None):
1501 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001502 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001503 if other is NotImplemented:
1504 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001505 return other.__floordiv__(self, context=context)
1506
1507 def __float__(self):
1508 """Float representation."""
1509 return float(str(self))
1510
1511 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001512 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001513 if self._is_special:
1514 if self._isnan():
Mark Dickinsonc05b7892009-09-08 19:22:18 +00001515 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001516 elif self._isinfinity():
Mark Dickinsonc05b7892009-09-08 19:22:18 +00001517 raise OverflowError("Cannot convert infinity to integer")
Facundo Batista353750c2007-09-13 18:13:15 +00001518 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001519 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001520 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001521 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001522 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001523
Raymond Hettinger5a053642008-01-24 19:05:29 +00001524 __trunc__ = __int__
1525
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001526 def real(self):
1527 return self
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00001528 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001529
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001530 def imag(self):
1531 return Decimal(0)
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00001532 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001533
1534 def conjugate(self):
1535 return self
1536
1537 def __complex__(self):
1538 return complex(float(self))
1539
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001540 def __long__(self):
1541 """Converts to a long.
1542
1543 Equivalent to long(int(self))
1544 """
1545 return long(self.__int__())
1546
Facundo Batista353750c2007-09-13 18:13:15 +00001547 def _fix_nan(self, context):
1548 """Decapitate the payload of a NaN to fit the context"""
1549 payload = self._int
1550
1551 # maximum length of payload is precision if _clamp=0,
1552 # precision-1 if _clamp=1.
1553 max_payload_len = context.prec - context._clamp
1554 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001555 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1556 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001557 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001558
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001559 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001560 """Round if it is necessary to keep self within prec precision.
1561
1562 Rounds and fixes the exponent. Does not raise on a sNaN.
1563
1564 Arguments:
1565 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001566 context - context used.
1567 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001568
Facundo Batista353750c2007-09-13 18:13:15 +00001569 if self._is_special:
1570 if self._isnan():
1571 # decapitate payload if necessary
1572 return self._fix_nan(context)
1573 else:
1574 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001575 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001576
Facundo Batista353750c2007-09-13 18:13:15 +00001577 # if self is zero then exponent should be between Etiny and
1578 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1579 Etiny = context.Etiny()
1580 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001581 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001582 exp_max = [context.Emax, Etop][context._clamp]
1583 new_exp = min(max(self._exp, Etiny), exp_max)
1584 if new_exp != self._exp:
1585 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001586 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001587 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001588 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001589
1590 # exp_min is the smallest allowable exponent of the result,
1591 # equal to max(self.adjusted()-context.prec+1, Etiny)
1592 exp_min = len(self._int) + self._exp - context.prec
1593 if exp_min > Etop:
1594 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00001595 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00001596 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001597 context._raise_error(Rounded)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00001598 return ans
1599
Facundo Batista353750c2007-09-13 18:13:15 +00001600 self_is_subnormal = exp_min < Etiny
1601 if self_is_subnormal:
Facundo Batista353750c2007-09-13 18:13:15 +00001602 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001603
Facundo Batista353750c2007-09-13 18:13:15 +00001604 # round if self has too many digits
1605 if self._exp < exp_min:
Facundo Batista2ec74152007-12-03 17:55:00 +00001606 digits = len(self._int) + self._exp - exp_min
1607 if digits < 0:
1608 self = _dec_from_triple(self._sign, '1', exp_min-1)
1609 digits = 0
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00001610 rounding_method = self._pick_rounding_function[context.rounding]
1611 changed = getattr(self, rounding_method)(digits)
Facundo Batista2ec74152007-12-03 17:55:00 +00001612 coeff = self._int[:digits] or '0'
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00001613 if changed > 0:
Facundo Batista2ec74152007-12-03 17:55:00 +00001614 coeff = str(int(coeff)+1)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00001615 if len(coeff) > context.prec:
1616 coeff = coeff[:-1]
1617 exp_min += 1
Facundo Batista2ec74152007-12-03 17:55:00 +00001618
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00001619 # check whether the rounding pushed the exponent out of range
1620 if exp_min > Etop:
1621 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1622 else:
1623 ans = _dec_from_triple(self._sign, coeff, exp_min)
1624
1625 # raise the appropriate signals, taking care to respect
1626 # the precedence described in the specification
1627 if changed and self_is_subnormal:
1628 context._raise_error(Underflow)
1629 if self_is_subnormal:
1630 context._raise_error(Subnormal)
Facundo Batista2ec74152007-12-03 17:55:00 +00001631 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001632 context._raise_error(Inexact)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00001633 context._raise_error(Rounded)
1634 if not ans:
1635 # raise Clamped on underflow to 0
1636 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001637 return ans
1638
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00001639 if self_is_subnormal:
1640 context._raise_error(Subnormal)
1641
Facundo Batista353750c2007-09-13 18:13:15 +00001642 # fold down if _clamp == 1 and self has too few digits
1643 if context._clamp == 1 and self._exp > Etop:
1644 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001645 self_padded = self._int + '0'*(self._exp - Etop)
1646 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001647
Facundo Batista353750c2007-09-13 18:13:15 +00001648 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001649 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001650
1651 _pick_rounding_function = {}
1652
Facundo Batista353750c2007-09-13 18:13:15 +00001653 # for each of the rounding functions below:
1654 # self is a finite, nonzero Decimal
1655 # prec is an integer satisfying 0 <= prec < len(self._int)
Facundo Batista2ec74152007-12-03 17:55:00 +00001656 #
1657 # each function returns either -1, 0, or 1, as follows:
1658 # 1 indicates that self should be rounded up (away from zero)
1659 # 0 indicates that self should be truncated, and that all the
1660 # digits to be truncated are zeros (so the value is unchanged)
1661 # -1 indicates that there are nonzero digits to be truncated
Facundo Batista353750c2007-09-13 18:13:15 +00001662
1663 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001664 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001665 if _all_zeros(self._int, prec):
1666 return 0
1667 else:
1668 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001669
Facundo Batista353750c2007-09-13 18:13:15 +00001670 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001671 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001672 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001673
Facundo Batista353750c2007-09-13 18:13:15 +00001674 def _round_half_up(self, prec):
1675 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001676 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001677 return 1
1678 elif _all_zeros(self._int, prec):
1679 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001680 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001681 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001682
1683 def _round_half_down(self, prec):
1684 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001685 if _exact_half(self._int, prec):
1686 return -1
1687 else:
1688 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001689
1690 def _round_half_even(self, prec):
1691 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001692 if _exact_half(self._int, prec) and \
1693 (prec == 0 or self._int[prec-1] in '02468'):
1694 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001695 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001696 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001697
1698 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001699 """Rounds up (not away from 0 if negative.)"""
1700 if self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001701 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001702 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001703 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001704
Facundo Batista353750c2007-09-13 18:13:15 +00001705 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001706 """Rounds down (not towards 0 if negative)"""
1707 if not self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001708 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001709 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001710 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001711
Facundo Batista353750c2007-09-13 18:13:15 +00001712 def _round_05up(self, prec):
1713 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001714 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001715 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001716 else:
1717 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001718
Facundo Batista353750c2007-09-13 18:13:15 +00001719 def fma(self, other, third, context=None):
1720 """Fused multiply-add.
1721
1722 Returns self*other+third with no rounding of the intermediate
1723 product self*other.
1724
1725 self and other are multiplied together, with no rounding of
1726 the result. The third operand is then added to the result,
1727 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001728 """
Facundo Batista353750c2007-09-13 18:13:15 +00001729
1730 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001731
1732 # compute product; raise InvalidOperation if either operand is
1733 # a signaling NaN or if the product is zero times infinity.
1734 if self._is_special or other._is_special:
1735 if context is None:
1736 context = getcontext()
1737 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001738 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001739 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001740 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001741 if self._exp == 'n':
1742 product = self
1743 elif other._exp == 'n':
1744 product = other
1745 elif self._exp == 'F':
1746 if not other:
1747 return context._raise_error(InvalidOperation,
1748 'INF * 0 in fma')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001749 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001750 elif other._exp == 'F':
1751 if not self:
1752 return context._raise_error(InvalidOperation,
1753 '0 * INF in fma')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00001754 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001755 else:
1756 product = _dec_from_triple(self._sign ^ other._sign,
1757 str(int(self._int) * int(other._int)),
1758 self._exp + other._exp)
1759
Facundo Batista353750c2007-09-13 18:13:15 +00001760 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001761 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001762
Facundo Batista353750c2007-09-13 18:13:15 +00001763 def _power_modulo(self, other, modulo, context=None):
1764 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001765
Facundo Batista353750c2007-09-13 18:13:15 +00001766 # if can't convert other and modulo to Decimal, raise
1767 # TypeError; there's no point returning NotImplemented (no
1768 # equivalent of __rpow__ for three argument pow)
1769 other = _convert_other(other, raiseit=True)
1770 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001771
Facundo Batista353750c2007-09-13 18:13:15 +00001772 if context is None:
1773 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001774
Facundo Batista353750c2007-09-13 18:13:15 +00001775 # deal with NaNs: if there are any sNaNs then first one wins,
1776 # (i.e. behaviour for NaNs is identical to that of fma)
1777 self_is_nan = self._isnan()
1778 other_is_nan = other._isnan()
1779 modulo_is_nan = modulo._isnan()
1780 if self_is_nan or other_is_nan or modulo_is_nan:
1781 if self_is_nan == 2:
1782 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001783 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001784 if other_is_nan == 2:
1785 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001786 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001787 if modulo_is_nan == 2:
1788 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001789 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001790 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001791 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001792 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001793 return other._fix_nan(context)
1794 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001795
Facundo Batista353750c2007-09-13 18:13:15 +00001796 # check inputs: we apply same restrictions as Python's pow()
1797 if not (self._isinteger() and
1798 other._isinteger() and
1799 modulo._isinteger()):
1800 return context._raise_error(InvalidOperation,
1801 'pow() 3rd argument not allowed '
1802 'unless all arguments are integers')
1803 if other < 0:
1804 return context._raise_error(InvalidOperation,
1805 'pow() 2nd argument cannot be '
1806 'negative when 3rd argument specified')
1807 if not modulo:
1808 return context._raise_error(InvalidOperation,
1809 'pow() 3rd argument cannot be 0')
1810
1811 # additional restriction for decimal: the modulus must be less
1812 # than 10**prec in absolute value
1813 if modulo.adjusted() >= context.prec:
1814 return context._raise_error(InvalidOperation,
1815 'insufficient precision: pow() 3rd '
1816 'argument must not have more than '
1817 'precision digits')
1818
1819 # define 0**0 == NaN, for consistency with two-argument pow
1820 # (even though it hurts!)
1821 if not other and not self:
1822 return context._raise_error(InvalidOperation,
1823 'at least one of pow() 1st argument '
1824 'and 2nd argument must be nonzero ;'
1825 '0**0 is not defined')
1826
1827 # compute sign of result
1828 if other._iseven():
1829 sign = 0
1830 else:
1831 sign = self._sign
1832
1833 # convert modulo to a Python integer, and self and other to
1834 # Decimal integers (i.e. force their exponents to be >= 0)
1835 modulo = abs(int(modulo))
1836 base = _WorkRep(self.to_integral_value())
1837 exponent = _WorkRep(other.to_integral_value())
1838
1839 # compute result using integer pow()
1840 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1841 for i in xrange(exponent.exp):
1842 base = pow(base, 10, modulo)
1843 base = pow(base, exponent.int, modulo)
1844
Facundo Batista72bc54f2007-11-23 17:59:00 +00001845 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001846
1847 def _power_exact(self, other, p):
1848 """Attempt to compute self**other exactly.
1849
1850 Given Decimals self and other and an integer p, attempt to
1851 compute an exact result for the power self**other, with p
1852 digits of precision. Return None if self**other is not
1853 exactly representable in p digits.
1854
1855 Assumes that elimination of special cases has already been
1856 performed: self and other must both be nonspecial; self must
1857 be positive and not numerically equal to 1; other must be
1858 nonzero. For efficiency, other._exp should not be too large,
1859 so that 10**abs(other._exp) is a feasible calculation."""
1860
1861 # In the comments below, we write x for the value of self and
1862 # y for the value of other. Write x = xc*10**xe and y =
1863 # yc*10**ye.
1864
1865 # The main purpose of this method is to identify the *failure*
1866 # of x**y to be exactly representable with as little effort as
1867 # possible. So we look for cheap and easy tests that
1868 # eliminate the possibility of x**y being exact. Only if all
1869 # these tests are passed do we go on to actually compute x**y.
1870
1871 # Here's the main idea. First normalize both x and y. We
1872 # express y as a rational m/n, with m and n relatively prime
1873 # and n>0. Then for x**y to be exactly representable (at
1874 # *any* precision), xc must be the nth power of a positive
1875 # integer and xe must be divisible by n. If m is negative
1876 # then additionally xc must be a power of either 2 or 5, hence
1877 # a power of 2**n or 5**n.
1878 #
1879 # There's a limit to how small |y| can be: if y=m/n as above
1880 # then:
1881 #
1882 # (1) if xc != 1 then for the result to be representable we
1883 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1884 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1885 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1886 # representable.
1887 #
1888 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1889 # |y| < 1/|xe| then the result is not representable.
1890 #
1891 # Note that since x is not equal to 1, at least one of (1) and
1892 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1893 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1894 #
1895 # There's also a limit to how large y can be, at least if it's
1896 # positive: the normalized result will have coefficient xc**y,
1897 # so if it's representable then xc**y < 10**p, and y <
1898 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1899 # not exactly representable.
1900
1901 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1902 # so |y| < 1/xe and the result is not representable.
1903 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1904 # < 1/nbits(xc).
1905
1906 x = _WorkRep(self)
1907 xc, xe = x.int, x.exp
1908 while xc % 10 == 0:
1909 xc //= 10
1910 xe += 1
1911
1912 y = _WorkRep(other)
1913 yc, ye = y.int, y.exp
1914 while yc % 10 == 0:
1915 yc //= 10
1916 ye += 1
1917
1918 # case where xc == 1: result is 10**(xe*y), with xe*y
1919 # required to be an integer
1920 if xc == 1:
1921 if ye >= 0:
1922 exponent = xe*yc*10**ye
1923 else:
1924 exponent, remainder = divmod(xe*yc, 10**-ye)
1925 if remainder:
1926 return None
1927 if y.sign == 1:
1928 exponent = -exponent
1929 # if other is a nonnegative integer, use ideal exponent
1930 if other._isinteger() and other._sign == 0:
1931 ideal_exponent = self._exp*int(other)
1932 zeros = min(exponent-ideal_exponent, p-1)
1933 else:
1934 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00001935 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00001936
1937 # case where y is negative: xc must be either a power
1938 # of 2 or a power of 5.
1939 if y.sign == 1:
1940 last_digit = xc % 10
1941 if last_digit in (2,4,6,8):
1942 # quick test for power of 2
1943 if xc & -xc != xc:
1944 return None
1945 # now xc is a power of 2; e is its exponent
1946 e = _nbits(xc)-1
1947 # find e*y and xe*y; both must be integers
1948 if ye >= 0:
1949 y_as_int = yc*10**ye
1950 e = e*y_as_int
1951 xe = xe*y_as_int
1952 else:
1953 ten_pow = 10**-ye
1954 e, remainder = divmod(e*yc, ten_pow)
1955 if remainder:
1956 return None
1957 xe, remainder = divmod(xe*yc, ten_pow)
1958 if remainder:
1959 return None
1960
1961 if e*65 >= p*93: # 93/65 > log(10)/log(5)
1962 return None
1963 xc = 5**e
1964
1965 elif last_digit == 5:
1966 # e >= log_5(xc) if xc is a power of 5; we have
1967 # equality all the way up to xc=5**2658
1968 e = _nbits(xc)*28//65
1969 xc, remainder = divmod(5**e, xc)
1970 if remainder:
1971 return None
1972 while xc % 5 == 0:
1973 xc //= 5
1974 e -= 1
1975 if ye >= 0:
1976 y_as_integer = yc*10**ye
1977 e = e*y_as_integer
1978 xe = xe*y_as_integer
1979 else:
1980 ten_pow = 10**-ye
1981 e, remainder = divmod(e*yc, ten_pow)
1982 if remainder:
1983 return None
1984 xe, remainder = divmod(xe*yc, ten_pow)
1985 if remainder:
1986 return None
1987 if e*3 >= p*10: # 10/3 > log(10)/log(2)
1988 return None
1989 xc = 2**e
1990 else:
1991 return None
1992
1993 if xc >= 10**p:
1994 return None
1995 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00001996 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00001997
1998 # now y is positive; find m and n such that y = m/n
1999 if ye >= 0:
2000 m, n = yc*10**ye, 1
2001 else:
2002 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2003 return None
2004 xc_bits = _nbits(xc)
2005 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2006 return None
2007 m, n = yc, 10**(-ye)
2008 while m % 2 == n % 2 == 0:
2009 m //= 2
2010 n //= 2
2011 while m % 5 == n % 5 == 0:
2012 m //= 5
2013 n //= 5
2014
2015 # compute nth root of xc*10**xe
2016 if n > 1:
2017 # if 1 < xc < 2**n then xc isn't an nth power
2018 if xc != 1 and xc_bits <= n:
2019 return None
2020
2021 xe, rem = divmod(xe, n)
2022 if rem != 0:
2023 return None
2024
2025 # compute nth root of xc using Newton's method
2026 a = 1L << -(-_nbits(xc)//n) # initial estimate
2027 while True:
2028 q, r = divmod(xc, a**(n-1))
2029 if a <= q:
2030 break
2031 else:
2032 a = (a*(n-1) + q)//n
2033 if not (a == q and r == 0):
2034 return None
2035 xc = a
2036
2037 # now xc*10**xe is the nth root of the original xc*10**xe
2038 # compute mth power of xc*10**xe
2039
2040 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2041 # 10**p and the result is not representable.
2042 if xc > 1 and m > p*100//_log10_lb(xc):
2043 return None
2044 xc = xc**m
2045 xe *= m
2046 if xc > 10**p:
2047 return None
2048
2049 # by this point the result *is* exactly representable
2050 # adjust the exponent to get as close as possible to the ideal
2051 # exponent, if necessary
2052 str_xc = str(xc)
2053 if other._isinteger() and other._sign == 0:
2054 ideal_exponent = self._exp*int(other)
2055 zeros = min(xe-ideal_exponent, p-len(str_xc))
2056 else:
2057 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002058 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002059
2060 def __pow__(self, other, modulo=None, context=None):
2061 """Return self ** other [ % modulo].
2062
2063 With two arguments, compute self**other.
2064
2065 With three arguments, compute (self**other) % modulo. For the
2066 three argument form, the following restrictions on the
2067 arguments hold:
2068
2069 - all three arguments must be integral
2070 - other must be nonnegative
2071 - either self or other (or both) must be nonzero
2072 - modulo must be nonzero and must have at most p digits,
2073 where p is the context precision.
2074
2075 If any of these restrictions is violated the InvalidOperation
2076 flag is raised.
2077
2078 The result of pow(self, other, modulo) is identical to the
2079 result that would be obtained by computing (self**other) %
2080 modulo with unbounded precision, but is computed more
2081 efficiently. It is always exact.
2082 """
2083
2084 if modulo is not None:
2085 return self._power_modulo(other, modulo, context)
2086
2087 other = _convert_other(other)
2088 if other is NotImplemented:
2089 return other
2090
2091 if context is None:
2092 context = getcontext()
2093
2094 # either argument is a NaN => result is NaN
2095 ans = self._check_nans(other, context)
2096 if ans:
2097 return ans
2098
2099 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2100 if not other:
2101 if not self:
2102 return context._raise_error(InvalidOperation, '0 ** 0')
2103 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002104 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002105
2106 # result has sign 1 iff self._sign is 1 and other is an odd integer
2107 result_sign = 0
2108 if self._sign == 1:
2109 if other._isinteger():
2110 if not other._iseven():
2111 result_sign = 1
2112 else:
2113 # -ve**noninteger = NaN
2114 # (-0)**noninteger = 0**noninteger
2115 if self:
2116 return context._raise_error(InvalidOperation,
2117 'x ** y with x negative and y not an integer')
2118 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002119 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002120
2121 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2122 if not self:
2123 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002124 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002125 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002126 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002127
2128 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002129 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002130 if other._sign == 0:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002131 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002132 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002133 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002134
Facundo Batista353750c2007-09-13 18:13:15 +00002135 # 1**other = 1, but the choice of exponent and the flags
2136 # depend on the exponent of self, and on whether other is a
2137 # positive integer, a negative integer, or neither
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002138 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002139 if other._isinteger():
2140 # exp = max(self._exp*max(int(other), 0),
2141 # 1-context.prec) but evaluating int(other) directly
2142 # is dangerous until we know other is small (other
2143 # could be 1e999999999)
2144 if other._sign == 1:
2145 multiplier = 0
2146 elif other > context.prec:
2147 multiplier = context.prec
2148 else:
2149 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002150
Facundo Batista353750c2007-09-13 18:13:15 +00002151 exp = self._exp * multiplier
2152 if exp < 1-context.prec:
2153 exp = 1-context.prec
2154 context._raise_error(Rounded)
2155 else:
2156 context._raise_error(Inexact)
2157 context._raise_error(Rounded)
2158 exp = 1-context.prec
2159
Facundo Batista72bc54f2007-11-23 17:59:00 +00002160 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002161
2162 # compute adjusted exponent of self
2163 self_adj = self.adjusted()
2164
2165 # self ** infinity is infinity if self > 1, 0 if self < 1
2166 # self ** -infinity is infinity if self < 1, 0 if self > 1
2167 if other._isinfinity():
2168 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002169 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002170 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002171 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002172
2173 # from here on, the result always goes through the call
2174 # to _fix at the end of this function.
2175 ans = None
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002176 exact = False
Facundo Batista353750c2007-09-13 18:13:15 +00002177
2178 # crude test to catch cases of extreme overflow/underflow. If
2179 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2180 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2181 # self**other >= 10**(Emax+1), so overflow occurs. The test
2182 # for underflow is similar.
2183 bound = self._log10_exp_bound() + other.adjusted()
2184 if (self_adj >= 0) == (other._sign == 0):
2185 # self > 1 and other +ve, or self < 1 and other -ve
2186 # possibility of overflow
2187 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002188 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002189 else:
2190 # self > 1 and other -ve, or self < 1 and other +ve
2191 # possibility of underflow to 0
2192 Etiny = context.Etiny()
2193 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002194 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002195
2196 # try for an exact result with precision +1
2197 if ans is None:
2198 ans = self._power_exact(other, context.prec + 1)
2199 if ans is not None and result_sign == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002200 ans = _dec_from_triple(1, ans._int, ans._exp)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002201 exact = True
Facundo Batista353750c2007-09-13 18:13:15 +00002202
2203 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2204 if ans is None:
2205 p = context.prec
2206 x = _WorkRep(self)
2207 xc, xe = x.int, x.exp
2208 y = _WorkRep(other)
2209 yc, ye = y.int, y.exp
2210 if y.sign == 1:
2211 yc = -yc
2212
2213 # compute correctly rounded result: start with precision +3,
2214 # then increase precision until result is unambiguously roundable
2215 extra = 3
2216 while True:
2217 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2218 if coeff % (5*10**(len(str(coeff))-p-1)):
2219 break
2220 extra += 3
2221
Facundo Batista72bc54f2007-11-23 17:59:00 +00002222 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002223
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002224 # unlike exp, ln and log10, the power function respects the
2225 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2226
2227 # There's a difficulty here when 'other' is not an integer and
2228 # the result is exact. In this case, the specification
2229 # requires that the Inexact flag be raised (in spite of
2230 # exactness), but since the result is exact _fix won't do this
2231 # for us. (Correspondingly, the Underflow signal should also
2232 # be raised for subnormal results.) We can't directly raise
2233 # these signals either before or after calling _fix, since
2234 # that would violate the precedence for signals. So we wrap
2235 # the ._fix call in a temporary context, and reraise
2236 # afterwards.
2237 if exact and not other._isinteger():
2238 # pad with zeros up to length context.prec+1 if necessary; this
2239 # ensures that the Rounded signal will be raised.
Facundo Batista353750c2007-09-13 18:13:15 +00002240 if len(ans._int) <= context.prec:
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002241 expdiff = context.prec + 1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002242 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2243 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002244
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002245 # create a copy of the current context, with cleared flags/traps
2246 newcontext = context.copy()
2247 newcontext.clear_flags()
2248 for exception in _signals:
2249 newcontext.traps[exception] = 0
2250
2251 # round in the new context
2252 ans = ans._fix(newcontext)
2253
2254 # raise Inexact, and if necessary, Underflow
2255 newcontext._raise_error(Inexact)
2256 if newcontext.flags[Subnormal]:
2257 newcontext._raise_error(Underflow)
2258
2259 # propagate signals to the original context; _fix could
2260 # have raised any of Overflow, Underflow, Subnormal,
2261 # Inexact, Rounded, Clamped. Overflow needs the correct
2262 # arguments. Note that the order of the exceptions is
2263 # important here.
2264 if newcontext.flags[Overflow]:
2265 context._raise_error(Overflow, 'above Emax', ans._sign)
2266 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2267 if newcontext.flags[exception]:
2268 context._raise_error(exception)
2269
2270 else:
2271 ans = ans._fix(context)
2272
Facundo Batista353750c2007-09-13 18:13:15 +00002273 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002274
2275 def __rpow__(self, other, context=None):
2276 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002277 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002278 if other is NotImplemented:
2279 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002280 return other.__pow__(self, context=context)
2281
2282 def normalize(self, context=None):
2283 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002284
Facundo Batista353750c2007-09-13 18:13:15 +00002285 if context is None:
2286 context = getcontext()
2287
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002288 if self._is_special:
2289 ans = self._check_nans(context=context)
2290 if ans:
2291 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002292
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002293 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002294 if dup._isinfinity():
2295 return dup
2296
2297 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002298 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002299 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002300 end = len(dup._int)
2301 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002302 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002303 exp += 1
2304 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002305 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002306
Facundo Batistabd2fe832007-09-13 18:42:09 +00002307 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002308 """Quantize self so its exponent is the same as that of exp.
2309
2310 Similar to self._rescale(exp._exp) but with error checking.
2311 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002312 exp = _convert_other(exp, raiseit=True)
2313
Facundo Batista353750c2007-09-13 18:13:15 +00002314 if context is None:
2315 context = getcontext()
2316 if rounding is None:
2317 rounding = context.rounding
2318
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002319 if self._is_special or exp._is_special:
2320 ans = self._check_nans(exp, context)
2321 if ans:
2322 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002323
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002324 if exp._isinfinity() or self._isinfinity():
2325 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002326 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002327 return context._raise_error(InvalidOperation,
2328 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002329
Facundo Batistabd2fe832007-09-13 18:42:09 +00002330 # if we're not watching exponents, do a simple rescale
2331 if not watchexp:
2332 ans = self._rescale(exp._exp, rounding)
2333 # raise Inexact and Rounded where appropriate
2334 if ans._exp > self._exp:
2335 context._raise_error(Rounded)
2336 if ans != self:
2337 context._raise_error(Inexact)
2338 return ans
2339
Facundo Batista353750c2007-09-13 18:13:15 +00002340 # exp._exp should be between Etiny and Emax
2341 if not (context.Etiny() <= exp._exp <= context.Emax):
2342 return context._raise_error(InvalidOperation,
2343 'target exponent out of bounds in quantize')
2344
2345 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002346 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002347 return ans._fix(context)
2348
2349 self_adjusted = self.adjusted()
2350 if self_adjusted > context.Emax:
2351 return context._raise_error(InvalidOperation,
2352 'exponent of quantize result too large for current context')
2353 if self_adjusted - exp._exp + 1 > context.prec:
2354 return context._raise_error(InvalidOperation,
2355 'quantize result has too many digits for current context')
2356
2357 ans = self._rescale(exp._exp, rounding)
2358 if ans.adjusted() > context.Emax:
2359 return context._raise_error(InvalidOperation,
2360 'exponent of quantize result too large for current context')
2361 if len(ans._int) > context.prec:
2362 return context._raise_error(InvalidOperation,
2363 'quantize result has too many digits for current context')
2364
2365 # raise appropriate flags
Facundo Batista353750c2007-09-13 18:13:15 +00002366 if ans and ans.adjusted() < context.Emin:
2367 context._raise_error(Subnormal)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002368 if ans._exp > self._exp:
2369 if ans != self:
2370 context._raise_error(Inexact)
2371 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00002372
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002373 # call to fix takes care of any necessary folddown, and
2374 # signals Clamped if necessary
Facundo Batista353750c2007-09-13 18:13:15 +00002375 ans = ans._fix(context)
2376 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002377
2378 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002379 """Return True if self and other have the same exponent; otherwise
2380 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002381
Facundo Batista1a191df2007-10-02 17:01:24 +00002382 If either operand is a special value, the following rules are used:
2383 * return True if both operands are infinities
2384 * return True if both operands are NaNs
2385 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002386 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002387 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002388 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002389 return (self.is_nan() and other.is_nan() or
2390 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002391 return self._exp == other._exp
2392
Facundo Batista353750c2007-09-13 18:13:15 +00002393 def _rescale(self, exp, rounding):
2394 """Rescale self so that the exponent is exp, either by padding with zeros
2395 or by truncating digits, using the given rounding mode.
2396
2397 Specials are returned without change. This operation is
2398 quiet: it raises no flags, and uses no information from the
2399 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002400
2401 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002402 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002403 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002404 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002405 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002406 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002407 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002408
Facundo Batista353750c2007-09-13 18:13:15 +00002409 if self._exp >= exp:
2410 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002411 return _dec_from_triple(self._sign,
2412 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002413
Facundo Batista353750c2007-09-13 18:13:15 +00002414 # too many digits; round and lose data. If self.adjusted() <
2415 # exp-1, replace self by 10**(exp-1) before rounding
2416 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002417 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002418 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002419 digits = 0
2420 this_function = getattr(self, self._pick_rounding_function[rounding])
Facundo Batista2ec74152007-12-03 17:55:00 +00002421 changed = this_function(digits)
2422 coeff = self._int[:digits] or '0'
2423 if changed == 1:
2424 coeff = str(int(coeff)+1)
2425 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002426
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002427 def _round(self, places, rounding):
2428 """Round a nonzero, nonspecial Decimal to a fixed number of
2429 significant figures, using the given rounding mode.
2430
2431 Infinities, NaNs and zeros are returned unaltered.
2432
2433 This operation is quiet: it raises no flags, and uses no
2434 information from the context.
2435
2436 """
2437 if places <= 0:
2438 raise ValueError("argument should be at least 1 in _round")
2439 if self._is_special or not self:
2440 return Decimal(self)
2441 ans = self._rescale(self.adjusted()+1-places, rounding)
2442 # it can happen that the rescale alters the adjusted exponent;
2443 # for example when rounding 99.97 to 3 significant figures.
2444 # When this happens we end up with an extra 0 at the end of
2445 # the number; a second rescale fixes this.
2446 if ans.adjusted() != self.adjusted():
2447 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2448 return ans
2449
Facundo Batista353750c2007-09-13 18:13:15 +00002450 def to_integral_exact(self, rounding=None, context=None):
2451 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002452
Facundo Batista353750c2007-09-13 18:13:15 +00002453 If no rounding mode is specified, take the rounding mode from
2454 the context. This method raises the Rounded and Inexact flags
2455 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002456
Facundo Batista353750c2007-09-13 18:13:15 +00002457 See also: to_integral_value, which does exactly the same as
2458 this method except that it doesn't raise Inexact or Rounded.
2459 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002460 if self._is_special:
2461 ans = self._check_nans(context=context)
2462 if ans:
2463 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002464 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002465 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002466 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002467 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002468 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002469 if context is None:
2470 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002471 if rounding is None:
2472 rounding = context.rounding
Facundo Batista353750c2007-09-13 18:13:15 +00002473 ans = self._rescale(0, rounding)
2474 if ans != self:
2475 context._raise_error(Inexact)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002476 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002477 return ans
2478
Facundo Batista353750c2007-09-13 18:13:15 +00002479 def to_integral_value(self, rounding=None, context=None):
2480 """Rounds to the nearest integer, without raising inexact, rounded."""
2481 if context is None:
2482 context = getcontext()
2483 if rounding is None:
2484 rounding = context.rounding
2485 if self._is_special:
2486 ans = self._check_nans(context=context)
2487 if ans:
2488 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002489 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002490 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002491 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002492 else:
2493 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002494
Facundo Batista353750c2007-09-13 18:13:15 +00002495 # the method name changed, but we provide also the old one, for compatibility
2496 to_integral = to_integral_value
2497
2498 def sqrt(self, context=None):
2499 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002500 if context is None:
2501 context = getcontext()
2502
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002503 if self._is_special:
2504 ans = self._check_nans(context=context)
2505 if ans:
2506 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002507
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002508 if self._isinfinity() and self._sign == 0:
2509 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002510
2511 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002512 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002513 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002514 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002515
2516 if self._sign == 1:
2517 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2518
Facundo Batista353750c2007-09-13 18:13:15 +00002519 # At this point self represents a positive number. Let p be
2520 # the desired precision and express self in the form c*100**e
2521 # with c a positive real number and e an integer, c and e
2522 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2523 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2524 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2525 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2526 # the closest integer to sqrt(c) with the even integer chosen
2527 # in the case of a tie.
2528 #
2529 # To ensure correct rounding in all cases, we use the
2530 # following trick: we compute the square root to an extra
2531 # place (precision p+1 instead of precision p), rounding down.
2532 # Then, if the result is inexact and its last digit is 0 or 5,
2533 # we increase the last digit to 1 or 6 respectively; if it's
2534 # exact we leave the last digit alone. Now the final round to
2535 # p places (or fewer in the case of underflow) will round
2536 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002537
Facundo Batista353750c2007-09-13 18:13:15 +00002538 # use an extra digit of precision
2539 prec = context.prec+1
2540
2541 # write argument in the form c*100**e where e = self._exp//2
2542 # is the 'ideal' exponent, to be used if the square root is
2543 # exactly representable. l is the number of 'digits' of c in
2544 # base 100, so that 100**(l-1) <= c < 100**l.
2545 op = _WorkRep(self)
2546 e = op.exp >> 1
2547 if op.exp & 1:
2548 c = op.int * 10
2549 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002550 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002551 c = op.int
2552 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002553
Facundo Batista353750c2007-09-13 18:13:15 +00002554 # rescale so that c has exactly prec base 100 'digits'
2555 shift = prec-l
2556 if shift >= 0:
2557 c *= 100**shift
2558 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002559 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002560 c, remainder = divmod(c, 100**-shift)
2561 exact = not remainder
2562 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002563
Facundo Batista353750c2007-09-13 18:13:15 +00002564 # find n = floor(sqrt(c)) using Newton's method
2565 n = 10**prec
2566 while True:
2567 q = c//n
2568 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002569 break
Facundo Batista353750c2007-09-13 18:13:15 +00002570 else:
2571 n = n + q >> 1
2572 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002573
Facundo Batista353750c2007-09-13 18:13:15 +00002574 if exact:
2575 # result is exact; rescale to use ideal exponent e
2576 if shift >= 0:
2577 # assert n % 10**shift == 0
2578 n //= 10**shift
2579 else:
2580 n *= 10**-shift
2581 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002582 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002583 # result is not exact; fix last digit as described above
2584 if n % 5 == 0:
2585 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002586
Facundo Batista72bc54f2007-11-23 17:59:00 +00002587 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002588
Facundo Batista353750c2007-09-13 18:13:15 +00002589 # round, and fit to current context
2590 context = context._shallow_copy()
2591 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002592 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002593 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002594
Facundo Batista353750c2007-09-13 18:13:15 +00002595 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002596
2597 def max(self, other, context=None):
2598 """Returns the larger value.
2599
Facundo Batista353750c2007-09-13 18:13:15 +00002600 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002601 NaN (and signals if one is sNaN). Also rounds.
2602 """
Facundo Batista353750c2007-09-13 18:13:15 +00002603 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002604
Facundo Batista6c398da2007-09-17 17:30:13 +00002605 if context is None:
2606 context = getcontext()
2607
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002608 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002609 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002610 # number is always returned
2611 sn = self._isnan()
2612 on = other._isnan()
2613 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00002614 if on == 1 and sn == 0:
2615 return self._fix(context)
2616 if sn == 1 and on == 0:
2617 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002618 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002619
Mark Dickinson2fc92632008-02-06 22:10:50 +00002620 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002621 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002622 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002623 # then an ordering is applied:
2624 #
Facundo Batista59c58842007-04-10 12:58:45 +00002625 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002626 # positive sign and min returns the operand with the negative sign
2627 #
Facundo Batista59c58842007-04-10 12:58:45 +00002628 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002629 # the result. This is exactly the ordering used in compare_total.
2630 c = self.compare_total(other)
2631
2632 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002633 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002634 else:
2635 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002636
Facundo Batistae64acfa2007-12-17 14:18:42 +00002637 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002638
2639 def min(self, other, context=None):
2640 """Returns the smaller value.
2641
Facundo Batista59c58842007-04-10 12:58:45 +00002642 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002643 NaN (and signals if one is sNaN). Also rounds.
2644 """
Facundo Batista353750c2007-09-13 18:13:15 +00002645 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002646
Facundo Batista6c398da2007-09-17 17:30:13 +00002647 if context is None:
2648 context = getcontext()
2649
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002650 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002651 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002652 # number is always returned
2653 sn = self._isnan()
2654 on = other._isnan()
2655 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00002656 if on == 1 and sn == 0:
2657 return self._fix(context)
2658 if sn == 1 and on == 0:
2659 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002660 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002661
Mark Dickinson2fc92632008-02-06 22:10:50 +00002662 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002663 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002664 c = self.compare_total(other)
2665
2666 if c == -1:
2667 ans = self
2668 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002669 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002670
Facundo Batistae64acfa2007-12-17 14:18:42 +00002671 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002672
2673 def _isinteger(self):
2674 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002675 if self._is_special:
2676 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002677 if self._exp >= 0:
2678 return True
2679 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002680 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002681
2682 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002683 """Returns True if self is even. Assumes self is an integer."""
2684 if not self or self._exp > 0:
2685 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002686 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002687
2688 def adjusted(self):
2689 """Return the adjusted exponent of self"""
2690 try:
2691 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002692 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002693 except TypeError:
2694 return 0
2695
Facundo Batista353750c2007-09-13 18:13:15 +00002696 def canonical(self, context=None):
2697 """Returns the same Decimal object.
2698
2699 As we do not have different encodings for the same number, the
2700 received object already is in its canonical form.
2701 """
2702 return self
2703
2704 def compare_signal(self, other, context=None):
2705 """Compares self to the other operand numerically.
2706
2707 It's pretty much like compare(), but all NaNs signal, with signaling
2708 NaNs taking precedence over quiet NaNs.
2709 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002710 other = _convert_other(other, raiseit = True)
2711 ans = self._compare_check_nans(other, context)
2712 if ans:
2713 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002714 return self.compare(other, context=context)
2715
2716 def compare_total(self, other):
2717 """Compares self to other using the abstract representations.
2718
2719 This is not like the standard compare, which use their numerical
2720 value. Note that a total ordering is defined for all possible abstract
2721 representations.
2722 """
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00002723 other = _convert_other(other, raiseit=True)
2724
Facundo Batista353750c2007-09-13 18:13:15 +00002725 # if one is negative and the other is positive, it's easy
2726 if self._sign and not other._sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002727 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002728 if not self._sign and other._sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002729 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002730 sign = self._sign
2731
2732 # let's handle both NaN types
2733 self_nan = self._isnan()
2734 other_nan = other._isnan()
2735 if self_nan or other_nan:
2736 if self_nan == other_nan:
Mark Dickinson7f265b72009-08-28 13:35:02 +00002737 # compare payloads as though they're integers
2738 self_key = len(self._int), self._int
2739 other_key = len(other._int), other._int
2740 if self_key < other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002741 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002742 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002743 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002744 return _NegativeOne
Mark Dickinson7f265b72009-08-28 13:35:02 +00002745 if self_key > other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002746 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002747 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002748 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002749 return _One
2750 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002751
2752 if sign:
2753 if self_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002754 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002755 if other_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002756 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002757 if self_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002758 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002759 if other_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002760 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002761 else:
2762 if self_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002763 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002764 if other_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002765 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002766 if self_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002767 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002768 if other_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002769 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002770
2771 if self < other:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002772 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002773 if self > other:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002774 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002775
2776 if self._exp < other._exp:
2777 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002778 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002779 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002780 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002781 if self._exp > other._exp:
2782 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002783 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002784 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +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 """
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00002794 other = _convert_other(other, raiseit=True)
2795
Facundo Batista353750c2007-09-13 18:13:15 +00002796 s = self.copy_abs()
2797 o = other.copy_abs()
2798 return s.compare_total(o)
2799
2800 def copy_abs(self):
2801 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002802 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002803
2804 def copy_negate(self):
2805 """Returns a copy with the sign inverted."""
2806 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002807 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002808 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002809 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002810
2811 def copy_sign(self, other):
2812 """Returns self with the sign of other."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002813 return _dec_from_triple(other._sign, self._int,
2814 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002815
2816 def exp(self, context=None):
2817 """Returns e ** self."""
2818
2819 if context is None:
2820 context = getcontext()
2821
2822 # exp(NaN) = NaN
2823 ans = self._check_nans(context=context)
2824 if ans:
2825 return ans
2826
2827 # exp(-Infinity) = 0
2828 if self._isinfinity() == -1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002829 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002830
2831 # exp(0) = 1
2832 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002833 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002834
2835 # exp(Infinity) = Infinity
2836 if self._isinfinity() == 1:
2837 return Decimal(self)
2838
2839 # the result is now guaranteed to be inexact (the true
2840 # mathematical result is transcendental). There's no need to
2841 # raise Rounded and Inexact here---they'll always be raised as
2842 # a result of the call to _fix.
2843 p = context.prec
2844 adj = self.adjusted()
2845
2846 # we only need to do any computation for quite a small range
2847 # of adjusted exponents---for example, -29 <= adj <= 10 for
2848 # the default context. For smaller exponent the result is
2849 # indistinguishable from 1 at the given precision, while for
2850 # larger exponent the result either overflows or underflows.
2851 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2852 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002853 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002854 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2855 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002856 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002857 elif self._sign == 0 and adj < -p:
2858 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002859 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002860 elif self._sign == 1 and adj < -p-1:
2861 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002862 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002863 # general case
2864 else:
2865 op = _WorkRep(self)
2866 c, e = op.int, op.exp
2867 if op.sign == 1:
2868 c = -c
2869
2870 # compute correctly rounded result: increase precision by
2871 # 3 digits at a time until we get an unambiguously
2872 # roundable result
2873 extra = 3
2874 while True:
2875 coeff, exp = _dexp(c, e, p+extra)
2876 if coeff % (5*10**(len(str(coeff))-p-1)):
2877 break
2878 extra += 3
2879
Facundo Batista72bc54f2007-11-23 17:59:00 +00002880 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002881
2882 # at this stage, ans should round correctly with *any*
2883 # rounding mode, not just with ROUND_HALF_EVEN
2884 context = context._shallow_copy()
2885 rounding = context._set_rounding(ROUND_HALF_EVEN)
2886 ans = ans._fix(context)
2887 context.rounding = rounding
2888
2889 return ans
2890
2891 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002892 """Return True if self is canonical; otherwise return False.
2893
2894 Currently, the encoding of a Decimal instance is always
2895 canonical, so this method returns True for any Decimal.
2896 """
2897 return True
Facundo Batista353750c2007-09-13 18:13:15 +00002898
2899 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002900 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00002901
Facundo Batista1a191df2007-10-02 17:01:24 +00002902 A Decimal instance is considered finite if it is neither
2903 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00002904 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002905 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00002906
2907 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002908 """Return True if self is infinite; otherwise return False."""
2909 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00002910
2911 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002912 """Return True if self is a qNaN or sNaN; otherwise return False."""
2913 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00002914
2915 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002916 """Return True if self is a normal number; otherwise return False."""
2917 if self._is_special or not self:
2918 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002919 if context is None:
2920 context = getcontext()
Mark Dickinson20a7cfc2009-10-27 18:27:53 +00002921 return context.Emin <= self.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +00002922
2923 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002924 """Return True if self is a quiet NaN; otherwise return False."""
2925 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00002926
2927 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002928 """Return True if self is negative; otherwise return False."""
2929 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00002930
2931 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002932 """Return True if self is a signaling NaN; otherwise return False."""
2933 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00002934
2935 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002936 """Return True if self is subnormal; otherwise return False."""
2937 if self._is_special or not self:
2938 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002939 if context is None:
2940 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002941 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00002942
2943 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002944 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002945 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00002946
2947 def _ln_exp_bound(self):
2948 """Compute a lower bound for the adjusted exponent of self.ln().
2949 In other words, compute r such that self.ln() >= 10**r. Assumes
2950 that self is finite and positive and that self != 1.
2951 """
2952
2953 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
2954 adj = self._exp + len(self._int) - 1
2955 if adj >= 1:
2956 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
2957 return len(str(adj*23//10)) - 1
2958 if adj <= -2:
2959 # argument <= 0.1
2960 return len(str((-1-adj)*23//10)) - 1
2961 op = _WorkRep(self)
2962 c, e = op.int, op.exp
2963 if adj == 0:
2964 # 1 < self < 10
2965 num = str(c-10**-e)
2966 den = str(c)
2967 return len(num) - len(den) - (num < den)
2968 # adj == -1, 0.1 <= self < 1
2969 return e + len(str(10**-e - c)) - 1
2970
2971
2972 def ln(self, context=None):
2973 """Returns the natural (base e) logarithm of self."""
2974
2975 if context is None:
2976 context = getcontext()
2977
2978 # ln(NaN) = NaN
2979 ans = self._check_nans(context=context)
2980 if ans:
2981 return ans
2982
2983 # ln(0.0) == -Infinity
2984 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002985 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00002986
2987 # ln(Infinity) = Infinity
2988 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002989 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00002990
2991 # ln(1.0) == 0.0
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002992 if self == _One:
2993 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002994
2995 # ln(negative) raises InvalidOperation
2996 if self._sign == 1:
2997 return context._raise_error(InvalidOperation,
2998 'ln of a negative value')
2999
3000 # result is irrational, so necessarily inexact
3001 op = _WorkRep(self)
3002 c, e = op.int, op.exp
3003 p = context.prec
3004
3005 # correctly rounded result: repeatedly increase precision by 3
3006 # until we get an unambiguously roundable result
3007 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3008 while True:
3009 coeff = _dlog(c, e, places)
3010 # assert len(str(abs(coeff)))-p >= 1
3011 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3012 break
3013 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003014 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003015
3016 context = context._shallow_copy()
3017 rounding = context._set_rounding(ROUND_HALF_EVEN)
3018 ans = ans._fix(context)
3019 context.rounding = rounding
3020 return ans
3021
3022 def _log10_exp_bound(self):
3023 """Compute a lower bound for the adjusted exponent of self.log10().
3024 In other words, find r such that self.log10() >= 10**r.
3025 Assumes that self is finite and positive and that self != 1.
3026 """
3027
3028 # For x >= 10 or x < 0.1 we only need a bound on the integer
3029 # part of log10(self), and this comes directly from the
3030 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3031 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3032 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3033
3034 adj = self._exp + len(self._int) - 1
3035 if adj >= 1:
3036 # self >= 10
3037 return len(str(adj))-1
3038 if adj <= -2:
3039 # self < 0.1
3040 return len(str(-1-adj))-1
3041 op = _WorkRep(self)
3042 c, e = op.int, op.exp
3043 if adj == 0:
3044 # 1 < self < 10
3045 num = str(c-10**-e)
3046 den = str(231*c)
3047 return len(num) - len(den) - (num < den) + 2
3048 # adj == -1, 0.1 <= self < 1
3049 num = str(10**-e-c)
3050 return len(num) + e - (num < "231") - 1
3051
3052 def log10(self, context=None):
3053 """Returns the base 10 logarithm of self."""
3054
3055 if context is None:
3056 context = getcontext()
3057
3058 # log10(NaN) = NaN
3059 ans = self._check_nans(context=context)
3060 if ans:
3061 return ans
3062
3063 # log10(0.0) == -Infinity
3064 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003065 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003066
3067 # log10(Infinity) = Infinity
3068 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003069 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003070
3071 # log10(negative or -Infinity) raises InvalidOperation
3072 if self._sign == 1:
3073 return context._raise_error(InvalidOperation,
3074 'log10 of a negative value')
3075
3076 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003077 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003078 # answer may need rounding
3079 ans = Decimal(self._exp + len(self._int) - 1)
3080 else:
3081 # result is irrational, so necessarily inexact
3082 op = _WorkRep(self)
3083 c, e = op.int, op.exp
3084 p = context.prec
3085
3086 # correctly rounded result: repeatedly increase precision
3087 # until result is unambiguously roundable
3088 places = p-self._log10_exp_bound()+2
3089 while True:
3090 coeff = _dlog10(c, e, places)
3091 # assert len(str(abs(coeff)))-p >= 1
3092 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3093 break
3094 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003095 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003096
3097 context = context._shallow_copy()
3098 rounding = context._set_rounding(ROUND_HALF_EVEN)
3099 ans = ans._fix(context)
3100 context.rounding = rounding
3101 return ans
3102
3103 def logb(self, context=None):
3104 """ Returns the exponent of the magnitude of self's MSD.
3105
3106 The result is the integer which is the exponent of the magnitude
3107 of the most significant digit of self (as though it were truncated
3108 to a single digit while maintaining the value of that digit and
3109 without limiting the resulting exponent).
3110 """
3111 # logb(NaN) = NaN
3112 ans = self._check_nans(context=context)
3113 if ans:
3114 return ans
3115
3116 if context is None:
3117 context = getcontext()
3118
3119 # logb(+/-Inf) = +Inf
3120 if self._isinfinity():
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003121 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003122
3123 # logb(0) = -Inf, DivisionByZero
3124 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003125 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003126
3127 # otherwise, simply return the adjusted exponent of self, as a
3128 # Decimal. Note that no attempt is made to fit the result
3129 # into the current context.
Mark Dickinson5e672d02009-10-27 16:54:45 +00003130 ans = Decimal(self.adjusted())
3131 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003132
3133 def _islogical(self):
3134 """Return True if self is a logical operand.
3135
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003136 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003137 an exponent of 0, and a coefficient whose digits must all be
3138 either 0 or 1.
3139 """
3140 if self._sign != 0 or self._exp != 0:
3141 return False
3142 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003143 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003144 return False
3145 return True
3146
3147 def _fill_logical(self, context, opa, opb):
3148 dif = context.prec - len(opa)
3149 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003150 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003151 elif dif < 0:
3152 opa = opa[-context.prec:]
3153 dif = context.prec - len(opb)
3154 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003155 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003156 elif dif < 0:
3157 opb = opb[-context.prec:]
3158 return opa, opb
3159
3160 def logical_and(self, other, context=None):
3161 """Applies an 'and' operation between self and other's digits."""
3162 if context is None:
3163 context = getcontext()
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003164
3165 other = _convert_other(other, raiseit=True)
3166
Facundo Batista353750c2007-09-13 18:13:15 +00003167 if not self._islogical() or not other._islogical():
3168 return context._raise_error(InvalidOperation)
3169
3170 # fill to context.prec
3171 (opa, opb) = self._fill_logical(context, self._int, other._int)
3172
3173 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003174 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3175 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003176
3177 def logical_invert(self, context=None):
3178 """Invert all its digits."""
3179 if context is None:
3180 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003181 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3182 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003183
3184 def logical_or(self, other, context=None):
3185 """Applies an 'or' operation between self and other's digits."""
3186 if context is None:
3187 context = getcontext()
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003188
3189 other = _convert_other(other, raiseit=True)
3190
Facundo Batista353750c2007-09-13 18:13:15 +00003191 if not self._islogical() or not other._islogical():
3192 return context._raise_error(InvalidOperation)
3193
3194 # fill to context.prec
3195 (opa, opb) = self._fill_logical(context, self._int, other._int)
3196
3197 # make the operation, and clean starting zeroes
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00003198 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003199 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003200
3201 def logical_xor(self, other, context=None):
3202 """Applies an 'xor' operation between self and other's digits."""
3203 if context is None:
3204 context = getcontext()
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003205
3206 other = _convert_other(other, raiseit=True)
3207
Facundo Batista353750c2007-09-13 18:13:15 +00003208 if not self._islogical() or not other._islogical():
3209 return context._raise_error(InvalidOperation)
3210
3211 # fill to context.prec
3212 (opa, opb) = self._fill_logical(context, self._int, other._int)
3213
3214 # make the operation, and clean starting zeroes
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00003215 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003216 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003217
3218 def max_mag(self, other, context=None):
3219 """Compares the values numerically with their sign ignored."""
3220 other = _convert_other(other, raiseit=True)
3221
Facundo Batista6c398da2007-09-17 17:30:13 +00003222 if context is None:
3223 context = getcontext()
3224
Facundo Batista353750c2007-09-13 18:13:15 +00003225 if self._is_special or other._is_special:
3226 # If one operand is a quiet NaN and the other is number, then the
3227 # number is always returned
3228 sn = self._isnan()
3229 on = other._isnan()
3230 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00003231 if on == 1 and sn == 0:
3232 return self._fix(context)
3233 if sn == 1 and on == 0:
3234 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003235 return self._check_nans(other, context)
3236
Mark Dickinson2fc92632008-02-06 22:10:50 +00003237 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003238 if c == 0:
3239 c = self.compare_total(other)
3240
3241 if c == -1:
3242 ans = other
3243 else:
3244 ans = self
3245
Facundo Batistae64acfa2007-12-17 14:18:42 +00003246 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003247
3248 def min_mag(self, other, context=None):
3249 """Compares the values numerically with their sign ignored."""
3250 other = _convert_other(other, raiseit=True)
3251
Facundo Batista6c398da2007-09-17 17:30:13 +00003252 if context is None:
3253 context = getcontext()
3254
Facundo Batista353750c2007-09-13 18:13:15 +00003255 if self._is_special or other._is_special:
3256 # If one operand is a quiet NaN and the other is number, then the
3257 # number is always returned
3258 sn = self._isnan()
3259 on = other._isnan()
3260 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00003261 if on == 1 and sn == 0:
3262 return self._fix(context)
3263 if sn == 1 and on == 0:
3264 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003265 return self._check_nans(other, context)
3266
Mark Dickinson2fc92632008-02-06 22:10:50 +00003267 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003268 if c == 0:
3269 c = self.compare_total(other)
3270
3271 if c == -1:
3272 ans = self
3273 else:
3274 ans = other
3275
Facundo Batistae64acfa2007-12-17 14:18:42 +00003276 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003277
3278 def next_minus(self, context=None):
3279 """Returns the largest representable number smaller than itself."""
3280 if context is None:
3281 context = getcontext()
3282
3283 ans = self._check_nans(context=context)
3284 if ans:
3285 return ans
3286
3287 if self._isinfinity() == -1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003288 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003289 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003290 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003291
3292 context = context.copy()
3293 context._set_rounding(ROUND_FLOOR)
3294 context._ignore_all_flags()
3295 new_self = self._fix(context)
3296 if new_self != self:
3297 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003298 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3299 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003300
3301 def next_plus(self, context=None):
3302 """Returns the smallest representable number larger than itself."""
3303 if context is None:
3304 context = getcontext()
3305
3306 ans = self._check_nans(context=context)
3307 if ans:
3308 return ans
3309
3310 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003311 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003312 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003313 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003314
3315 context = context.copy()
3316 context._set_rounding(ROUND_CEILING)
3317 context._ignore_all_flags()
3318 new_self = self._fix(context)
3319 if new_self != self:
3320 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003321 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3322 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003323
3324 def next_toward(self, other, context=None):
3325 """Returns the number closest to self, in the direction towards other.
3326
3327 The result is the closest representable number to self
3328 (excluding self) that is in the direction towards other,
3329 unless both have the same value. If the two operands are
3330 numerically equal, then the result is a copy of self with the
3331 sign set to be the same as the sign of other.
3332 """
3333 other = _convert_other(other, raiseit=True)
3334
3335 if context is None:
3336 context = getcontext()
3337
3338 ans = self._check_nans(other, context)
3339 if ans:
3340 return ans
3341
Mark Dickinson2fc92632008-02-06 22:10:50 +00003342 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003343 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003344 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003345
3346 if comparison == -1:
3347 ans = self.next_plus(context)
3348 else: # comparison == 1
3349 ans = self.next_minus(context)
3350
3351 # decide which flags to raise using value of ans
3352 if ans._isinfinity():
3353 context._raise_error(Overflow,
3354 'Infinite result from next_toward',
3355 ans._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00003356 context._raise_error(Inexact)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00003357 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003358 elif ans.adjusted() < context.Emin:
3359 context._raise_error(Underflow)
3360 context._raise_error(Subnormal)
Facundo Batista353750c2007-09-13 18:13:15 +00003361 context._raise_error(Inexact)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00003362 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003363 # if precision == 1 then we don't raise Clamped for a
3364 # result 0E-Etiny.
3365 if not ans:
3366 context._raise_error(Clamped)
3367
3368 return ans
3369
3370 def number_class(self, context=None):
3371 """Returns an indication of the class of self.
3372
3373 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003374 sNaN
3375 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003376 -Infinity
3377 -Normal
3378 -Subnormal
3379 -Zero
3380 +Zero
3381 +Subnormal
3382 +Normal
3383 +Infinity
3384 """
3385 if self.is_snan():
3386 return "sNaN"
3387 if self.is_qnan():
3388 return "NaN"
3389 inf = self._isinfinity()
3390 if inf == 1:
3391 return "+Infinity"
3392 if inf == -1:
3393 return "-Infinity"
3394 if self.is_zero():
3395 if self._sign:
3396 return "-Zero"
3397 else:
3398 return "+Zero"
3399 if context is None:
3400 context = getcontext()
3401 if self.is_subnormal(context=context):
3402 if self._sign:
3403 return "-Subnormal"
3404 else:
3405 return "+Subnormal"
3406 # just a normal, regular, boring number, :)
3407 if self._sign:
3408 return "-Normal"
3409 else:
3410 return "+Normal"
3411
3412 def radix(self):
3413 """Just returns 10, as this is Decimal, :)"""
3414 return Decimal(10)
3415
3416 def rotate(self, other, context=None):
3417 """Returns a rotated copy of self, value-of-other times."""
3418 if context is None:
3419 context = getcontext()
3420
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003421 other = _convert_other(other, raiseit=True)
3422
Facundo Batista353750c2007-09-13 18:13:15 +00003423 ans = self._check_nans(other, context)
3424 if ans:
3425 return ans
3426
3427 if other._exp != 0:
3428 return context._raise_error(InvalidOperation)
3429 if not (-context.prec <= int(other) <= context.prec):
3430 return context._raise_error(InvalidOperation)
3431
3432 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003433 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003434
3435 # get values, pad if necessary
3436 torot = int(other)
3437 rotdig = self._int
3438 topad = context.prec - len(rotdig)
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003439 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003440 rotdig = '0'*topad + rotdig
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003441 elif topad < 0:
3442 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003443
3444 # let's rotate!
3445 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003446 return _dec_from_triple(self._sign,
3447 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003448
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003449 def scaleb(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00003450 """Returns self operand after adding the second value to its exp."""
3451 if context is None:
3452 context = getcontext()
3453
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003454 other = _convert_other(other, raiseit=True)
3455
Facundo Batista353750c2007-09-13 18:13:15 +00003456 ans = self._check_nans(other, context)
3457 if ans:
3458 return ans
3459
3460 if other._exp != 0:
3461 return context._raise_error(InvalidOperation)
3462 liminf = -2 * (context.Emax + context.prec)
3463 limsup = 2 * (context.Emax + context.prec)
3464 if not (liminf <= int(other) <= limsup):
3465 return context._raise_error(InvalidOperation)
3466
3467 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003468 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003469
Facundo Batista72bc54f2007-11-23 17:59:00 +00003470 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003471 d = d._fix(context)
3472 return d
3473
3474 def shift(self, other, context=None):
3475 """Returns a shifted copy of self, value-of-other times."""
3476 if context is None:
3477 context = getcontext()
3478
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003479 other = _convert_other(other, raiseit=True)
3480
Facundo Batista353750c2007-09-13 18:13:15 +00003481 ans = self._check_nans(other, context)
3482 if ans:
3483 return ans
3484
3485 if other._exp != 0:
3486 return context._raise_error(InvalidOperation)
3487 if not (-context.prec <= int(other) <= context.prec):
3488 return context._raise_error(InvalidOperation)
3489
3490 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003491 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003492
3493 # get values, pad if necessary
3494 torot = int(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003495 rotdig = self._int
3496 topad = context.prec - len(rotdig)
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003497 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003498 rotdig = '0'*topad + rotdig
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003499 elif topad < 0:
3500 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003501
3502 # let's shift!
3503 if torot < 0:
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003504 shifted = rotdig[:torot]
Facundo Batista353750c2007-09-13 18:13:15 +00003505 else:
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003506 shifted = rotdig + '0'*torot
3507 shifted = shifted[-context.prec:]
Facundo Batista353750c2007-09-13 18:13:15 +00003508
Facundo Batista72bc54f2007-11-23 17:59:00 +00003509 return _dec_from_triple(self._sign,
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003510 shifted.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003511
Facundo Batista59c58842007-04-10 12:58:45 +00003512 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003513 def __reduce__(self):
3514 return (self.__class__, (str(self),))
3515
3516 def __copy__(self):
3517 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003518 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003519 return self.__class__(str(self))
3520
3521 def __deepcopy__(self, memo):
3522 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003523 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003524 return self.__class__(str(self))
3525
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003526 # PEP 3101 support. See also _parse_format_specifier and _format_align
3527 def __format__(self, specifier, context=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003528 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003529
3530 The specifier should be a standard format specifier, with the
3531 form described in PEP 3101. Formatting types 'e', 'E', 'f',
3532 'F', 'g', 'G', and '%' are supported. If the formatting type
3533 is omitted it defaults to 'g' or 'G', depending on the value
3534 of context.capitals.
3535
3536 At this time the 'n' format specifier type (which is supposed
3537 to use the current locale) is not supported.
3538 """
3539
3540 # Note: PEP 3101 says that if the type is not present then
3541 # there should be at least one digit after the decimal point.
3542 # We take the liberty of ignoring this requirement for
3543 # Decimal---it's presumably there to make sure that
3544 # format(float, '') behaves similarly to str(float).
3545 if context is None:
3546 context = getcontext()
3547
3548 spec = _parse_format_specifier(specifier)
3549
3550 # special values don't care about the type or precision...
3551 if self._is_special:
3552 return _format_align(str(self), spec)
3553
3554 # a type of None defaults to 'g' or 'G', depending on context
3555 # if type is '%', adjust exponent of self accordingly
3556 if spec['type'] is None:
3557 spec['type'] = ['g', 'G'][context.capitals]
3558 elif spec['type'] == '%':
3559 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3560
3561 # round if necessary, taking rounding mode from the context
3562 rounding = context.rounding
3563 precision = spec['precision']
3564 if precision is not None:
3565 if spec['type'] in 'eE':
3566 self = self._round(precision+1, rounding)
3567 elif spec['type'] in 'gG':
3568 if len(self._int) > precision:
3569 self = self._round(precision, rounding)
3570 elif spec['type'] in 'fF%':
3571 self = self._rescale(-precision, rounding)
3572 # special case: zeros with a positive exponent can't be
3573 # represented in fixed point; rescale them to 0e0.
3574 elif not self and self._exp > 0 and spec['type'] in 'fF%':
3575 self = self._rescale(0, rounding)
3576
3577 # figure out placement of the decimal point
3578 leftdigits = self._exp + len(self._int)
3579 if spec['type'] in 'fF%':
3580 dotplace = leftdigits
3581 elif spec['type'] in 'eE':
3582 if not self and precision is not None:
3583 dotplace = 1 - precision
3584 else:
3585 dotplace = 1
3586 elif spec['type'] in 'gG':
3587 if self._exp <= 0 and leftdigits > -6:
3588 dotplace = leftdigits
3589 else:
3590 dotplace = 1
3591
3592 # figure out main part of numeric string...
3593 if dotplace <= 0:
3594 num = '0.' + '0'*(-dotplace) + self._int
3595 elif dotplace >= len(self._int):
3596 # make sure we're not padding a '0' with extra zeros on the right
3597 assert dotplace==len(self._int) or self._int != '0'
3598 num = self._int + '0'*(dotplace-len(self._int))
3599 else:
3600 num = self._int[:dotplace] + '.' + self._int[dotplace:]
3601
3602 # ...then the trailing exponent, or trailing '%'
3603 if leftdigits != dotplace or spec['type'] in 'eE':
3604 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
3605 num = num + "{0}{1:+}".format(echar, leftdigits-dotplace)
3606 elif spec['type'] == '%':
3607 num = num + '%'
3608
3609 # add sign
3610 if self._sign == 1:
3611 num = '-' + num
3612 return _format_align(num, spec)
3613
3614
Facundo Batista72bc54f2007-11-23 17:59:00 +00003615def _dec_from_triple(sign, coefficient, exponent, special=False):
3616 """Create a decimal instance directly, without any validation,
3617 normalization (e.g. removal of leading zeros) or argument
3618 conversion.
3619
3620 This function is for *internal use only*.
3621 """
3622
3623 self = object.__new__(Decimal)
3624 self._sign = sign
3625 self._int = coefficient
3626 self._exp = exponent
3627 self._is_special = special
3628
3629 return self
3630
Raymond Hettinger45fd4762009-02-03 03:42:07 +00003631# Register Decimal as a kind of Number (an abstract base class).
3632# However, do not register it as Real (because Decimals are not
3633# interoperable with floats).
3634_numbers.Number.register(Decimal)
3635
3636
Facundo Batista59c58842007-04-10 12:58:45 +00003637##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003638
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003639
3640# get rounding method function:
Facundo Batista59c58842007-04-10 12:58:45 +00003641rounding_functions = [name for name in Decimal.__dict__.keys()
3642 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003643for name in rounding_functions:
Facundo Batista59c58842007-04-10 12:58:45 +00003644 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003645 globalname = name[1:].upper()
3646 val = globals()[globalname]
3647 Decimal._pick_rounding_function[val] = name
3648
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003649del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003650
Nick Coghlanced12182006-09-02 03:54:17 +00003651class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003652 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003653
Nick Coghlanced12182006-09-02 03:54:17 +00003654 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003655 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003656 """
3657 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003658 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003659 def __enter__(self):
3660 self.saved_context = getcontext()
3661 setcontext(self.new_context)
3662 return self.new_context
3663 def __exit__(self, t, v, tb):
3664 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003665
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003666class Context(object):
3667 """Contains the context for a Decimal instance.
3668
3669 Contains:
3670 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003671 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003672 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003673 raised when it is caused. Otherwise, a value is
3674 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003675 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003676 (Whether or not the trap_enabler is set)
3677 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003678 Emin - Minimum exponent
3679 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003680 capitals - If 1, 1*10^1 is printed as 1E+1.
3681 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003682 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003683 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003684
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003685 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003686 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003687 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003688 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003689 _ignored_flags=None):
3690 if flags is None:
3691 flags = []
3692 if _ignored_flags is None:
3693 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003694 if not isinstance(flags, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003695 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003696 del s
Raymond Hettingerbf440692004-07-10 14:14:37 +00003697 if traps is not None and not isinstance(traps, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003698 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003699 del s
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003700 for name, val in locals().items():
3701 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003702 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003703 else:
3704 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003705 del self.self
3706
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003707 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003708 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003709 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003710 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3711 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3712 % vars(self))
3713 names = [f.__name__ for f, v in self.flags.items() if v]
3714 s.append('flags=[' + ', '.join(names) + ']')
3715 names = [t.__name__ for t, v in self.traps.items() if v]
3716 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003717 return ', '.join(s) + ')'
3718
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003719 def clear_flags(self):
3720 """Reset all flags to zero"""
3721 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003722 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003723
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003724 def _shallow_copy(self):
3725 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003726 nc = Context(self.prec, self.rounding, self.traps,
3727 self.flags, self.Emin, self.Emax,
3728 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003729 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003730
3731 def copy(self):
3732 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003733 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003734 self.flags.copy(), self.Emin, self.Emax,
3735 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003736 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003737 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003738
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003739 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003740 """Handles an error
3741
3742 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003743 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003744 trap_enabler is set, it reaises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003745 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003746 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003747 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003748 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003749 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003750 return error().handle(self, *args)
3751
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003752 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003753 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003754 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003755 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003756
3757 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003758 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003759 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003760
3761 def _ignore_all_flags(self):
3762 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003763 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003764
3765 def _ignore_flags(self, *flags):
3766 """Ignore the flags, if they are raised"""
3767 # Do not mutate-- This way, copies of a context leave the original
3768 # alone.
3769 self._ignored_flags = (self._ignored_flags + list(flags))
3770 return list(flags)
3771
3772 def _regard_flags(self, *flags):
3773 """Stop ignoring the flags, if they are raised"""
3774 if flags and isinstance(flags[0], (tuple,list)):
3775 flags = flags[0]
3776 for flag in flags:
3777 self._ignored_flags.remove(flag)
3778
Nick Coghlan53663a62008-07-15 14:27:37 +00003779 # We inherit object.__hash__, so we must deny this explicitly
3780 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003781
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003782 def Etiny(self):
3783 """Returns Etiny (= Emin - prec + 1)"""
3784 return int(self.Emin - self.prec + 1)
3785
3786 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003787 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003788 return int(self.Emax - self.prec + 1)
3789
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003790 def _set_rounding(self, type):
3791 """Sets the rounding type.
3792
3793 Sets the rounding type, and returns the current (previous)
3794 rounding type. Often used like:
3795
3796 context = context.copy()
3797 # so you don't change the calling context
3798 # if an error occurs in the middle.
3799 rounding = context._set_rounding(ROUND_UP)
3800 val = self.__sub__(other, context=context)
3801 context._set_rounding(rounding)
3802
3803 This will make it round up for that operation.
3804 """
3805 rounding = self.rounding
3806 self.rounding= type
3807 return rounding
3808
Raymond Hettingerfed52962004-07-14 15:41:57 +00003809 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003810 """Creates a new Decimal instance but using self as context.
3811
3812 This method implements the to-number operation of the
3813 IBM Decimal specification."""
3814
3815 if isinstance(num, basestring) and num != num.strip():
3816 return self._raise_error(ConversionSyntax,
3817 "no trailing or leading whitespace is "
3818 "permitted.")
3819
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003820 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003821 if d._isnan() and len(d._int) > self.prec - self._clamp:
3822 return self._raise_error(ConversionSyntax,
3823 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003824 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003825
Facundo Batista59c58842007-04-10 12:58:45 +00003826 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003827 def abs(self, a):
3828 """Returns the absolute value of the operand.
3829
3830 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003831 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003832 the plus operation on the operand.
3833
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003834 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003835 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003836 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003837 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003838 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003839 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003840 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003841 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003842 """
3843 return a.__abs__(context=self)
3844
3845 def add(self, a, b):
3846 """Return the sum of the two operands.
3847
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003848 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003849 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003850 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003851 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003852 """
3853 return a.__add__(b, context=self)
3854
3855 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003856 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003857
Facundo Batista353750c2007-09-13 18:13:15 +00003858 def canonical(self, a):
3859 """Returns the same Decimal object.
3860
3861 As we do not have different encodings for the same number, the
3862 received object already is in its canonical form.
3863
3864 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003865 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003866 """
3867 return a.canonical(context=self)
3868
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003869 def compare(self, a, b):
3870 """Compares values numerically.
3871
3872 If the signs of the operands differ, a value representing each operand
3873 ('-1' if the operand is less than zero, '0' if the operand is zero or
3874 negative zero, or '1' if the operand is greater than zero) is used in
3875 place of that operand for the comparison instead of the actual
3876 operand.
3877
3878 The comparison is then effected by subtracting the second operand from
3879 the first and then returning a value according to the result of the
3880 subtraction: '-1' if the result is less than zero, '0' if the result is
3881 zero or negative zero, or '1' if the result is greater than zero.
3882
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003883 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003884 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003885 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003886 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003887 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003888 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003889 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003890 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003891 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003892 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003893 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003894 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003895 """
3896 return a.compare(b, context=self)
3897
Facundo Batista353750c2007-09-13 18:13:15 +00003898 def compare_signal(self, a, b):
3899 """Compares the values of the two operands numerically.
3900
3901 It's pretty much like compare(), but all NaNs signal, with signaling
3902 NaNs taking precedence over quiet NaNs.
3903
3904 >>> c = ExtendedContext
3905 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003906 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003907 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003908 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003909 >>> c.flags[InvalidOperation] = 0
3910 >>> print c.flags[InvalidOperation]
3911 0
3912 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003913 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003914 >>> print c.flags[InvalidOperation]
3915 1
3916 >>> c.flags[InvalidOperation] = 0
3917 >>> print c.flags[InvalidOperation]
3918 0
3919 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003920 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003921 >>> print c.flags[InvalidOperation]
3922 1
3923 """
3924 return a.compare_signal(b, context=self)
3925
3926 def compare_total(self, a, b):
3927 """Compares two operands using their abstract representation.
3928
3929 This is not like the standard compare, which use their numerical
3930 value. Note that a total ordering is defined for all possible abstract
3931 representations.
3932
3933 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003934 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003935 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003936 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003937 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003938 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003939 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003940 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003941 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003942 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00003943 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003944 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003945 """
3946 return a.compare_total(b)
3947
3948 def compare_total_mag(self, a, b):
3949 """Compares two operands using their abstract representation ignoring sign.
3950
3951 Like compare_total, but with operand's sign ignored and assumed to be 0.
3952 """
3953 return a.compare_total_mag(b)
3954
3955 def copy_abs(self, a):
3956 """Returns a copy of the operand with the sign set to 0.
3957
3958 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003959 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003960 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003961 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00003962 """
3963 return a.copy_abs()
3964
3965 def copy_decimal(self, a):
3966 """Returns a copy of the decimal objet.
3967
3968 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003969 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003970 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003971 Decimal('-1.00')
Facundo Batista353750c2007-09-13 18:13:15 +00003972 """
Facundo Batista6c398da2007-09-17 17:30:13 +00003973 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00003974
3975 def copy_negate(self, a):
3976 """Returns a copy of the operand with the sign inverted.
3977
3978 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003979 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003980 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003981 Decimal('101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003982 """
3983 return a.copy_negate()
3984
3985 def copy_sign(self, a, b):
3986 """Copies the second operand's sign to the first one.
3987
3988 In detail, it returns a copy of the first operand with the sign
3989 equal to the sign of the second operand.
3990
3991 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003992 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003993 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003994 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003995 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003996 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003997 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003998 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003999 """
4000 return a.copy_sign(b)
4001
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004002 def divide(self, a, b):
4003 """Decimal division in a specified context.
4004
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004005 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004006 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004007 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004008 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004009 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004010 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004011 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004012 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004013 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004014 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004015 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004016 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004017 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004018 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004019 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004020 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004021 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004022 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004023 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004024 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004025 """
4026 return a.__div__(b, context=self)
4027
4028 def divide_int(self, a, b):
4029 """Divides two numbers and returns the integer part of the result.
4030
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004031 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004032 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004033 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004034 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004035 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004036 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004037 """
4038 return a.__floordiv__(b, context=self)
4039
4040 def divmod(self, a, b):
Mark Dickinson8b1587f2010-01-06 16:21:27 +00004041 """Return (a // b, a % b)
4042
4043 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4044 (Decimal('2'), Decimal('2'))
4045 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4046 (Decimal('2'), Decimal('0'))
4047 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004048 return a.__divmod__(b, context=self)
4049
Facundo Batista353750c2007-09-13 18:13:15 +00004050 def exp(self, a):
4051 """Returns e ** a.
4052
4053 >>> c = ExtendedContext.copy()
4054 >>> c.Emin = -999
4055 >>> c.Emax = 999
4056 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004057 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004058 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004059 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00004060 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004061 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004062 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004063 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00004064 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004065 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004066 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004067 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004068 """
4069 return a.exp(context=self)
4070
4071 def fma(self, a, b, c):
4072 """Returns a multiplied by b, plus c.
4073
4074 The first two operands are multiplied together, using multiply,
4075 the third operand is then added to the result of that
4076 multiplication, using add, all with only one final rounding.
4077
4078 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004079 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004080 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004081 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004082 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004083 Decimal('1.38435736E+12')
Facundo Batista353750c2007-09-13 18:13:15 +00004084 """
4085 return a.fma(b, c, context=self)
4086
4087 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004088 """Return True if the operand is canonical; otherwise return False.
4089
4090 Currently, the encoding of a Decimal instance is always
4091 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004092
4093 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004094 True
Facundo Batista353750c2007-09-13 18:13:15 +00004095 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004096 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004097
4098 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004099 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004100
Facundo Batista1a191df2007-10-02 17:01:24 +00004101 A Decimal instance is considered finite if it is neither
4102 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004103
4104 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004105 True
Facundo Batista353750c2007-09-13 18:13:15 +00004106 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004107 True
Facundo Batista353750c2007-09-13 18:13:15 +00004108 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004109 True
Facundo Batista353750c2007-09-13 18:13:15 +00004110 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004111 False
Facundo Batista353750c2007-09-13 18:13:15 +00004112 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004113 False
Facundo Batista353750c2007-09-13 18:13:15 +00004114 """
4115 return a.is_finite()
4116
4117 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004118 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004119
4120 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004121 False
Facundo Batista353750c2007-09-13 18:13:15 +00004122 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004123 True
Facundo Batista353750c2007-09-13 18:13:15 +00004124 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004125 False
Facundo Batista353750c2007-09-13 18:13:15 +00004126 """
4127 return a.is_infinite()
4128
4129 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004130 """Return True if the operand is a qNaN or sNaN;
4131 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004132
4133 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004134 False
Facundo Batista353750c2007-09-13 18:13:15 +00004135 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004136 True
Facundo Batista353750c2007-09-13 18:13:15 +00004137 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004138 True
Facundo Batista353750c2007-09-13 18:13:15 +00004139 """
4140 return a.is_nan()
4141
4142 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004143 """Return True if the operand is a normal number;
4144 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004145
4146 >>> c = ExtendedContext.copy()
4147 >>> c.Emin = -999
4148 >>> c.Emax = 999
4149 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004150 True
Facundo Batista353750c2007-09-13 18:13:15 +00004151 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004152 False
Facundo Batista353750c2007-09-13 18:13:15 +00004153 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004154 False
Facundo Batista353750c2007-09-13 18:13:15 +00004155 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004156 False
Facundo Batista353750c2007-09-13 18:13:15 +00004157 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004158 False
Facundo Batista353750c2007-09-13 18:13:15 +00004159 """
4160 return a.is_normal(context=self)
4161
4162 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004163 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004164
4165 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004166 False
Facundo Batista353750c2007-09-13 18:13:15 +00004167 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004168 True
Facundo Batista353750c2007-09-13 18:13:15 +00004169 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004170 False
Facundo Batista353750c2007-09-13 18:13:15 +00004171 """
4172 return a.is_qnan()
4173
4174 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004175 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004176
4177 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004178 False
Facundo Batista353750c2007-09-13 18:13:15 +00004179 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004180 True
Facundo Batista353750c2007-09-13 18:13:15 +00004181 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004182 True
Facundo Batista353750c2007-09-13 18:13:15 +00004183 """
4184 return a.is_signed()
4185
4186 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004187 """Return True if the operand is a signaling NaN;
4188 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004189
4190 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004191 False
Facundo Batista353750c2007-09-13 18:13:15 +00004192 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004193 False
Facundo Batista353750c2007-09-13 18:13:15 +00004194 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004195 True
Facundo Batista353750c2007-09-13 18:13:15 +00004196 """
4197 return a.is_snan()
4198
4199 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004200 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004201
4202 >>> c = ExtendedContext.copy()
4203 >>> c.Emin = -999
4204 >>> c.Emax = 999
4205 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004206 False
Facundo Batista353750c2007-09-13 18:13:15 +00004207 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004208 True
Facundo Batista353750c2007-09-13 18:13:15 +00004209 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004210 False
Facundo Batista353750c2007-09-13 18:13:15 +00004211 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004212 False
Facundo Batista353750c2007-09-13 18:13:15 +00004213 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004214 False
Facundo Batista353750c2007-09-13 18:13:15 +00004215 """
4216 return a.is_subnormal(context=self)
4217
4218 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004219 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004220
4221 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004222 True
Facundo Batista353750c2007-09-13 18:13:15 +00004223 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004224 False
Facundo Batista353750c2007-09-13 18:13:15 +00004225 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004226 True
Facundo Batista353750c2007-09-13 18:13:15 +00004227 """
4228 return a.is_zero()
4229
4230 def ln(self, a):
4231 """Returns the natural (base e) logarithm of the operand.
4232
4233 >>> c = ExtendedContext.copy()
4234 >>> c.Emin = -999
4235 >>> c.Emax = 999
4236 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004237 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004238 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004239 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004240 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004241 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004242 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004243 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004244 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004245 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004246 """
4247 return a.ln(context=self)
4248
4249 def log10(self, a):
4250 """Returns the base 10 logarithm of the operand.
4251
4252 >>> c = ExtendedContext.copy()
4253 >>> c.Emin = -999
4254 >>> c.Emax = 999
4255 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004256 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004257 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004258 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004259 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004260 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004261 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004262 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004263 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004264 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004265 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004266 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004267 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004268 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004269 """
4270 return a.log10(context=self)
4271
4272 def logb(self, a):
4273 """ Returns the exponent of the magnitude of the operand's MSD.
4274
4275 The result is the integer which is the exponent of the magnitude
4276 of the most significant digit of the operand (as though the
4277 operand were truncated to a single digit while maintaining the
4278 value of that digit and without limiting the resulting exponent).
4279
4280 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004281 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004282 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004283 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004284 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004285 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004286 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004287 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004288 """
4289 return a.logb(context=self)
4290
4291 def logical_and(self, a, b):
4292 """Applies the logical operation 'and' between each operand's digits.
4293
4294 The operands must be both logical numbers.
4295
4296 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004297 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004298 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004299 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004300 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004301 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004302 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004303 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004304 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004305 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004306 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004307 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004308 """
4309 return a.logical_and(b, context=self)
4310
4311 def logical_invert(self, a):
4312 """Invert all the digits in the operand.
4313
4314 The operand must be a logical number.
4315
4316 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004317 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004318 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004319 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004320 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004321 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004322 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004323 Decimal('10101010')
Facundo Batista353750c2007-09-13 18:13:15 +00004324 """
4325 return a.logical_invert(context=self)
4326
4327 def logical_or(self, a, b):
4328 """Applies the logical operation 'or' between each operand's digits.
4329
4330 The operands must be both logical numbers.
4331
4332 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004333 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004334 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004335 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004336 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004337 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004338 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004339 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004340 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004341 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004342 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004343 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004344 """
4345 return a.logical_or(b, context=self)
4346
4347 def logical_xor(self, a, b):
4348 """Applies the logical operation 'xor' between each operand's digits.
4349
4350 The operands must be both logical numbers.
4351
4352 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004353 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004354 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004355 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004356 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004357 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004358 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004359 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004360 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004361 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004362 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004363 Decimal('1101')
Facundo Batista353750c2007-09-13 18:13:15 +00004364 """
4365 return a.logical_xor(b, context=self)
4366
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004367 def max(self, a,b):
4368 """max compares two values numerically and returns the maximum.
4369
4370 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004371 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004372 operation. If they are numerically equal then the left-hand operand
4373 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004374 infinity) of the two operands is chosen as the result.
4375
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004376 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004377 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004378 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004379 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004380 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004381 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004382 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004383 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004384 """
4385 return a.max(b, context=self)
4386
Facundo Batista353750c2007-09-13 18:13:15 +00004387 def max_mag(self, a, b):
4388 """Compares the values numerically with their sign ignored."""
4389 return a.max_mag(b, context=self)
4390
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004391 def min(self, a,b):
4392 """min compares two values numerically and returns the minimum.
4393
4394 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004395 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004396 operation. If they are numerically equal then the left-hand operand
4397 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004398 infinity) of the two operands is chosen as the result.
4399
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004400 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004401 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004402 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004403 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004404 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004405 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004406 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004407 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004408 """
4409 return a.min(b, context=self)
4410
Facundo Batista353750c2007-09-13 18:13:15 +00004411 def min_mag(self, a, b):
4412 """Compares the values numerically with their sign ignored."""
4413 return a.min_mag(b, context=self)
4414
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004415 def minus(self, a):
4416 """Minus corresponds to unary prefix minus in Python.
4417
4418 The operation is evaluated using the same rules as subtract; the
4419 operation minus(a) is calculated as subtract('0', a) where the '0'
4420 has the same exponent as the operand.
4421
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004422 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004423 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004424 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004425 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004426 """
4427 return a.__neg__(context=self)
4428
4429 def multiply(self, a, b):
4430 """multiply multiplies two operands.
4431
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004432 If either operand is a special value then the general rules apply.
4433 Otherwise, the operands are multiplied together ('long multiplication'),
4434 resulting in a number which may be as long as the sum of the lengths
4435 of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004436
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004437 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004438 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004439 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004440 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004441 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004442 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004443 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004444 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004445 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004446 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004447 """
4448 return a.__mul__(b, context=self)
4449
Facundo Batista353750c2007-09-13 18:13:15 +00004450 def next_minus(self, a):
4451 """Returns the largest representable number smaller than a.
4452
4453 >>> c = ExtendedContext.copy()
4454 >>> c.Emin = -999
4455 >>> c.Emax = 999
4456 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004457 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004458 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004459 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004460 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004461 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004462 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004463 Decimal('9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004464 """
4465 return a.next_minus(context=self)
4466
4467 def next_plus(self, a):
4468 """Returns the smallest representable number larger than a.
4469
4470 >>> c = ExtendedContext.copy()
4471 >>> c.Emin = -999
4472 >>> c.Emax = 999
4473 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004474 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004475 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004476 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004477 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004478 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004479 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004480 Decimal('-9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004481 """
4482 return a.next_plus(context=self)
4483
4484 def next_toward(self, a, b):
4485 """Returns the number closest to a, in direction towards b.
4486
4487 The result is the closest representable number from the first
4488 operand (but not the first operand) that is in the direction
4489 towards the second operand, unless the operands have the same
4490 value.
4491
4492 >>> c = ExtendedContext.copy()
4493 >>> c.Emin = -999
4494 >>> c.Emax = 999
4495 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004496 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004497 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004498 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004499 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004500 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004501 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004502 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004503 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004504 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004505 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004506 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004507 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004508 Decimal('-0.00')
Facundo Batista353750c2007-09-13 18:13:15 +00004509 """
4510 return a.next_toward(b, context=self)
4511
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004512 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004513 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004514
4515 Essentially a plus operation with all trailing zeros removed from the
4516 result.
4517
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004518 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004519 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004520 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004521 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004522 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004523 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004524 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004525 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004526 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004527 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004528 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004529 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004530 """
4531 return a.normalize(context=self)
4532
Facundo Batista353750c2007-09-13 18:13:15 +00004533 def number_class(self, a):
4534 """Returns an indication of the class of the operand.
4535
4536 The class is one of the following strings:
4537 -sNaN
4538 -NaN
4539 -Infinity
4540 -Normal
4541 -Subnormal
4542 -Zero
4543 +Zero
4544 +Subnormal
4545 +Normal
4546 +Infinity
4547
4548 >>> c = Context(ExtendedContext)
4549 >>> c.Emin = -999
4550 >>> c.Emax = 999
4551 >>> c.number_class(Decimal('Infinity'))
4552 '+Infinity'
4553 >>> c.number_class(Decimal('1E-10'))
4554 '+Normal'
4555 >>> c.number_class(Decimal('2.50'))
4556 '+Normal'
4557 >>> c.number_class(Decimal('0.1E-999'))
4558 '+Subnormal'
4559 >>> c.number_class(Decimal('0'))
4560 '+Zero'
4561 >>> c.number_class(Decimal('-0'))
4562 '-Zero'
4563 >>> c.number_class(Decimal('-0.1E-999'))
4564 '-Subnormal'
4565 >>> c.number_class(Decimal('-1E-10'))
4566 '-Normal'
4567 >>> c.number_class(Decimal('-2.50'))
4568 '-Normal'
4569 >>> c.number_class(Decimal('-Infinity'))
4570 '-Infinity'
4571 >>> c.number_class(Decimal('NaN'))
4572 'NaN'
4573 >>> c.number_class(Decimal('-NaN'))
4574 'NaN'
4575 >>> c.number_class(Decimal('sNaN'))
4576 'sNaN'
4577 """
4578 return a.number_class(context=self)
4579
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004580 def plus(self, a):
4581 """Plus corresponds to unary prefix plus in Python.
4582
4583 The operation is evaluated using the same rules as add; the
4584 operation plus(a) is calculated as add('0', a) where the '0'
4585 has the same exponent as the operand.
4586
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004587 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004588 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004589 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004590 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004591 """
4592 return a.__pos__(context=self)
4593
4594 def power(self, a, b, modulo=None):
4595 """Raises a to the power of b, to modulo if given.
4596
Facundo Batista353750c2007-09-13 18:13:15 +00004597 With two arguments, compute a**b. If a is negative then b
4598 must be integral. The result will be inexact unless b is
4599 integral and the result is finite and can be expressed exactly
4600 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004601
Facundo Batista353750c2007-09-13 18:13:15 +00004602 With three arguments, compute (a**b) % modulo. For the
4603 three argument form, the following restrictions on the
4604 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004605
Facundo Batista353750c2007-09-13 18:13:15 +00004606 - all three arguments must be integral
4607 - b must be nonnegative
4608 - at least one of a or b must be nonzero
4609 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004610
Facundo Batista353750c2007-09-13 18:13:15 +00004611 The result of pow(a, b, modulo) is identical to the result
4612 that would be obtained by computing (a**b) % modulo with
4613 unbounded precision, but is computed more efficiently. It is
4614 always exact.
4615
4616 >>> c = ExtendedContext.copy()
4617 >>> c.Emin = -999
4618 >>> c.Emax = 999
4619 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004620 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004621 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004622 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004623 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004624 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004625 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004626 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004627 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004628 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004629 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004630 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004631 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004632 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004633 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004634 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004635 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004636 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004637 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004638 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004639 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004640 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004641 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004642 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004643 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004644 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004645
4646 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004647 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004648 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004649 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00004650 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004651 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004652 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004653 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004654 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004655 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00004656 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004657 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004658 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004659 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004660 """
4661 return a.__pow__(b, modulo, context=self)
4662
4663 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00004664 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004665
4666 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00004667 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004668 exponent is being increased), multiplied by a positive power of ten (if
4669 the exponent is being decreased), or is unchanged (if the exponent is
4670 already equal to that of the right-hand operand).
4671
4672 Unlike other operations, if the length of the coefficient after the
4673 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00004674 operation condition is raised. This guarantees that, unless there is
4675 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004676 equal to that of the right-hand operand.
4677
4678 Also unlike other operations, quantize will never raise Underflow, even
4679 if the result is subnormal and inexact.
4680
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004681 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004682 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004683 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004684 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004685 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004686 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004687 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004688 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004689 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004690 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004691 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004692 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004693 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004694 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004695 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004696 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004697 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004698 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004699 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004700 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004701 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004702 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004703 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004704 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004705 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004706 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004707 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004708 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004709 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004710 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004711 """
4712 return a.quantize(b, context=self)
4713
Facundo Batista353750c2007-09-13 18:13:15 +00004714 def radix(self):
4715 """Just returns 10, as this is Decimal, :)
4716
4717 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00004718 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004719 """
4720 return Decimal(10)
4721
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004722 def remainder(self, a, b):
4723 """Returns the remainder from integer division.
4724
4725 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00004726 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00004727 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00004728 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004729
4730 This operation will fail under the same conditions as integer division
4731 (that is, if integer division on the same two operands would fail, the
4732 remainder cannot be calculated).
4733
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004734 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004735 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004736 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004737 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004738 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004739 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004740 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004741 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004742 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004743 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004744 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004745 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004746 """
4747 return a.__mod__(b, context=self)
4748
4749 def remainder_near(self, a, b):
4750 """Returns to be "a - b * n", where n is the integer nearest the exact
4751 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00004752 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004753 sign of a.
4754
4755 This operation will fail under the same conditions as integer division
4756 (that is, if integer division on the same two operands would fail, the
4757 remainder cannot be calculated).
4758
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004759 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004760 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004761 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004762 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004763 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004764 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004765 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004766 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004767 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004768 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004769 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004770 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004771 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004772 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004773 """
4774 return a.remainder_near(b, context=self)
4775
Facundo Batista353750c2007-09-13 18:13:15 +00004776 def rotate(self, a, b):
4777 """Returns a rotated copy of a, b times.
4778
4779 The coefficient of the result is a rotated copy of the digits in
4780 the coefficient of the first operand. The number of places of
4781 rotation is taken from the absolute value of the second operand,
4782 with the rotation being to the left if the second operand is
4783 positive or to the right otherwise.
4784
4785 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004786 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00004787 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004788 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00004789 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004790 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004791 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004792 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004793 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004794 Decimal('345678912')
Facundo Batista353750c2007-09-13 18:13:15 +00004795 """
4796 return a.rotate(b, context=self)
4797
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004798 def same_quantum(self, a, b):
4799 """Returns True if the two operands have the same exponent.
4800
4801 The result is never affected by either the sign or the coefficient of
4802 either operand.
4803
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004804 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004805 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004806 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004807 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004808 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004809 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004810 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004811 True
4812 """
4813 return a.same_quantum(b)
4814
Facundo Batista353750c2007-09-13 18:13:15 +00004815 def scaleb (self, a, b):
4816 """Returns the first operand after adding the second value its exp.
4817
4818 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004819 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00004820 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004821 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004822 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004823 Decimal('7.50E+3')
Facundo Batista353750c2007-09-13 18:13:15 +00004824 """
4825 return a.scaleb (b, context=self)
4826
4827 def shift(self, a, b):
4828 """Returns a shifted copy of a, b times.
4829
4830 The coefficient of the result is a shifted copy of the digits
4831 in the coefficient of the first operand. The number of places
4832 to shift is taken from the absolute value of the second operand,
4833 with the shift being to the left if the second operand is
4834 positive or to the right otherwise. Digits shifted into the
4835 coefficient are zeros.
4836
4837 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004838 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004839 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004840 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004841 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004842 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004843 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004844 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004845 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004846 Decimal('345678900')
Facundo Batista353750c2007-09-13 18:13:15 +00004847 """
4848 return a.shift(b, context=self)
4849
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004850 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00004851 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004852
4853 If the result must be inexact, it is rounded using the round-half-even
4854 algorithm.
4855
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004856 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004857 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004858 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004859 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004860 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004861 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004862 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004863 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004864 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004865 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004866 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004867 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004868 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004869 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004870 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004871 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004872 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004873 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004874 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00004875 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004876 """
4877 return a.sqrt(context=self)
4878
4879 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00004880 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004881
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004882 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004883 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004884 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004885 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004886 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004887 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004888 """
4889 return a.__sub__(b, context=self)
4890
4891 def to_eng_string(self, a):
4892 """Converts a number to a string, using scientific notation.
4893
4894 The operation is not affected by the context.
4895 """
4896 return a.to_eng_string(context=self)
4897
4898 def to_sci_string(self, a):
4899 """Converts a number to a string, using scientific notation.
4900
4901 The operation is not affected by the context.
4902 """
4903 return a.__str__(context=self)
4904
Facundo Batista353750c2007-09-13 18:13:15 +00004905 def to_integral_exact(self, a):
4906 """Rounds to an integer.
4907
4908 When the operand has a negative exponent, the result is the same
4909 as using the quantize() operation using the given operand as the
4910 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4911 of the operand as the precision setting; Inexact and Rounded flags
4912 are allowed in this operation. The rounding mode is taken from the
4913 context.
4914
4915 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004916 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004917 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004918 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004919 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004920 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004921 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004922 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004923 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004924 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004925 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004926 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004927 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004928 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004929 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004930 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004931 """
4932 return a.to_integral_exact(context=self)
4933
4934 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004935 """Rounds to an integer.
4936
4937 When the operand has a negative exponent, the result is the same
4938 as using the quantize() operation using the given operand as the
4939 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4940 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00004941 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004942
Facundo Batista353750c2007-09-13 18:13:15 +00004943 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004944 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004945 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004946 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004947 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004948 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004949 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004950 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004951 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004952 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004953 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004954 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004955 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004956 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004957 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004958 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004959 """
Facundo Batista353750c2007-09-13 18:13:15 +00004960 return a.to_integral_value(context=self)
4961
4962 # the method name changed, but we provide also the old one, for compatibility
4963 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004964
4965class _WorkRep(object):
4966 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00004967 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004968 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004969 # exp: None, int, or string
4970
4971 def __init__(self, value=None):
4972 if value is None:
4973 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004974 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004975 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00004976 elif isinstance(value, Decimal):
4977 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00004978 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004979 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00004980 else:
4981 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004982 self.sign = value[0]
4983 self.int = value[1]
4984 self.exp = value[2]
4985
4986 def __repr__(self):
4987 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
4988
4989 __str__ = __repr__
4990
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004991
4992
Facundo Batistae64acfa2007-12-17 14:18:42 +00004993def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004994 """Normalizes op1, op2 to have the same exp and length of coefficient.
4995
4996 Done during addition.
4997 """
Facundo Batista353750c2007-09-13 18:13:15 +00004998 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004999 tmp = op2
5000 other = op1
5001 else:
5002 tmp = op1
5003 other = op2
5004
Facundo Batista353750c2007-09-13 18:13:15 +00005005 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5006 # Then adding 10**exp to tmp has the same effect (after rounding)
5007 # as adding any positive quantity smaller than 10**exp; similarly
5008 # for subtraction. So if other is smaller than 10**exp we replace
5009 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00005010 tmp_len = len(str(tmp.int))
5011 other_len = len(str(other.int))
5012 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5013 if other_len + other.exp - 1 < exp:
5014 other.int = 1
5015 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005016
Facundo Batista353750c2007-09-13 18:13:15 +00005017 tmp.int *= 10 ** (tmp.exp - other.exp)
5018 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005019 return op1, op2
5020
Facundo Batista353750c2007-09-13 18:13:15 +00005021##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
5022
5023# This function from Tim Peters was taken from here:
5024# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5025# The correction being in the function definition is for speed, and
5026# the whole function is not resolved with math.log because of avoiding
5027# the use of floats.
5028def _nbits(n, correction = {
5029 '0': 4, '1': 3, '2': 2, '3': 2,
5030 '4': 1, '5': 1, '6': 1, '7': 1,
5031 '8': 0, '9': 0, 'a': 0, 'b': 0,
5032 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5033 """Number of bits in binary representation of the positive integer n,
5034 or 0 if n == 0.
5035 """
5036 if n < 0:
5037 raise ValueError("The argument to _nbits should be nonnegative.")
5038 hex_n = "%x" % n
5039 return 4*len(hex_n) - correction[hex_n[0]]
5040
5041def _sqrt_nearest(n, a):
5042 """Closest integer to the square root of the positive integer n. a is
5043 an initial approximation to the square root. Any positive integer
5044 will do for a, but the closer a is to the square root of n the
5045 faster convergence will be.
5046
5047 """
5048 if n <= 0 or a <= 0:
5049 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5050
5051 b=0
5052 while a != b:
5053 b, a = a, a--n//a>>1
5054 return a
5055
5056def _rshift_nearest(x, shift):
5057 """Given an integer x and a nonnegative integer shift, return closest
5058 integer to x / 2**shift; use round-to-even in case of a tie.
5059
5060 """
5061 b, q = 1L << shift, x >> shift
5062 return q + (2*(x & (b-1)) + (q&1) > b)
5063
5064def _div_nearest(a, b):
5065 """Closest integer to a/b, a and b positive integers; rounds to even
5066 in the case of a tie.
5067
5068 """
5069 q, r = divmod(a, b)
5070 return q + (2*r + (q&1) > b)
5071
5072def _ilog(x, M, L = 8):
5073 """Integer approximation to M*log(x/M), with absolute error boundable
5074 in terms only of x/M.
5075
5076 Given positive integers x and M, return an integer approximation to
5077 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5078 between the approximation and the exact result is at most 22. For
5079 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5080 both cases these are upper bounds on the error; it will usually be
5081 much smaller."""
5082
5083 # The basic algorithm is the following: let log1p be the function
5084 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5085 # the reduction
5086 #
5087 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5088 #
5089 # repeatedly until the argument to log1p is small (< 2**-L in
5090 # absolute value). For small y we can use the Taylor series
5091 # expansion
5092 #
5093 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5094 #
5095 # truncating at T such that y**T is small enough. The whole
5096 # computation is carried out in a form of fixed-point arithmetic,
5097 # with a real number z being represented by an integer
5098 # approximation to z*M. To avoid loss of precision, the y below
5099 # is actually an integer approximation to 2**R*y*M, where R is the
5100 # number of reductions performed so far.
5101
5102 y = x-M
5103 # argument reduction; R = number of reductions performed
5104 R = 0
5105 while (R <= L and long(abs(y)) << L-R >= M or
5106 R > L and abs(y) >> R-L >= M):
5107 y = _div_nearest(long(M*y) << 1,
5108 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5109 R += 1
5110
5111 # Taylor series with T terms
5112 T = -int(-10*len(str(M))//(3*L))
5113 yshift = _rshift_nearest(y, R)
5114 w = _div_nearest(M, T)
5115 for k in xrange(T-1, 0, -1):
5116 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5117
5118 return _div_nearest(w*y, M)
5119
5120def _dlog10(c, e, p):
5121 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5122 approximation to 10**p * log10(c*10**e), with an absolute error of
5123 at most 1. Assumes that c*10**e is not exactly 1."""
5124
5125 # increase precision by 2; compensate for this by dividing
5126 # final result by 100
5127 p += 2
5128
5129 # write c*10**e as d*10**f with either:
5130 # f >= 0 and 1 <= d <= 10, or
5131 # f <= 0 and 0.1 <= d <= 1.
5132 # Thus for c*10**e close to 1, f = 0
5133 l = len(str(c))
5134 f = e+l - (e+l >= 1)
5135
5136 if p > 0:
5137 M = 10**p
5138 k = e+p-f
5139 if k >= 0:
5140 c *= 10**k
5141 else:
5142 c = _div_nearest(c, 10**-k)
5143
5144 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005145 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005146 log_d = _div_nearest(log_d*M, log_10)
5147 log_tenpower = f*M # exact
5148 else:
5149 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005150 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005151
5152 return _div_nearest(log_tenpower+log_d, 100)
5153
5154def _dlog(c, e, p):
5155 """Given integers c, e and p with c > 0, compute an integer
5156 approximation to 10**p * log(c*10**e), with an absolute error of
5157 at most 1. Assumes that c*10**e is not exactly 1."""
5158
5159 # Increase precision by 2. The precision increase is compensated
5160 # for at the end with a division by 100.
5161 p += 2
5162
5163 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5164 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5165 # as 10**p * log(d) + 10**p*f * log(10).
5166 l = len(str(c))
5167 f = e+l - (e+l >= 1)
5168
5169 # compute approximation to 10**p*log(d), with error < 27
5170 if p > 0:
5171 k = e+p-f
5172 if k >= 0:
5173 c *= 10**k
5174 else:
5175 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5176
5177 # _ilog magnifies existing error in c by a factor of at most 10
5178 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5179 else:
5180 # p <= 0: just approximate the whole thing by 0; error < 2.31
5181 log_d = 0
5182
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005183 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005184 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005185 extra = len(str(abs(f)))-1
5186 if p + extra >= 0:
5187 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5188 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5189 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005190 else:
5191 f_log_ten = 0
5192 else:
5193 f_log_ten = 0
5194
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005195 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005196 return _div_nearest(f_log_ten + log_d, 100)
5197
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005198class _Log10Memoize(object):
5199 """Class to compute, store, and allow retrieval of, digits of the
5200 constant log(10) = 2.302585.... This constant is needed by
5201 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5202 def __init__(self):
5203 self.digits = "23025850929940456840179914546843642076011014886"
5204
5205 def getdigits(self, p):
5206 """Given an integer p >= 0, return floor(10**p)*log(10).
5207
5208 For example, self.getdigits(3) returns 2302.
5209 """
5210 # digits are stored as a string, for quick conversion to
5211 # integer in the case that we've already computed enough
5212 # digits; the stored digits should always be correct
5213 # (truncated, not rounded to nearest).
5214 if p < 0:
5215 raise ValueError("p should be nonnegative")
5216
5217 if p >= len(self.digits):
5218 # compute p+3, p+6, p+9, ... digits; continue until at
5219 # least one of the extra digits is nonzero
5220 extra = 3
5221 while True:
5222 # compute p+extra digits, correct to within 1ulp
5223 M = 10**(p+extra+2)
5224 digits = str(_div_nearest(_ilog(10*M, M), 100))
5225 if digits[-extra:] != '0'*extra:
5226 break
5227 extra += 3
5228 # keep all reliable digits so far; remove trailing zeros
5229 # and next nonzero digit
5230 self.digits = digits.rstrip('0')[:-1]
5231 return int(self.digits[:p+1])
5232
5233_log10_digits = _Log10Memoize().getdigits
5234
Facundo Batista353750c2007-09-13 18:13:15 +00005235def _iexp(x, M, L=8):
5236 """Given integers x and M, M > 0, such that x/M is small in absolute
5237 value, compute an integer approximation to M*exp(x/M). For 0 <=
5238 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5239 is usually much smaller)."""
5240
5241 # Algorithm: to compute exp(z) for a real number z, first divide z
5242 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5243 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5244 # series
5245 #
5246 # expm1(x) = x + x**2/2! + x**3/3! + ...
5247 #
5248 # Now use the identity
5249 #
5250 # expm1(2x) = expm1(x)*(expm1(x)+2)
5251 #
5252 # R times to compute the sequence expm1(z/2**R),
5253 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5254
5255 # Find R such that x/2**R/M <= 2**-L
5256 R = _nbits((long(x)<<L)//M)
5257
5258 # Taylor series. (2**L)**T > M
5259 T = -int(-10*len(str(M))//(3*L))
5260 y = _div_nearest(x, T)
5261 Mshift = long(M)<<R
5262 for i in xrange(T-1, 0, -1):
5263 y = _div_nearest(x*(Mshift + y), Mshift * i)
5264
5265 # Expansion
5266 for k in xrange(R-1, -1, -1):
5267 Mshift = long(M)<<(k+2)
5268 y = _div_nearest(y*(y+Mshift), Mshift)
5269
5270 return M+y
5271
5272def _dexp(c, e, p):
5273 """Compute an approximation to exp(c*10**e), with p decimal places of
5274 precision.
5275
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005276 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005277
5278 10**(p-1) <= d <= 10**p, and
5279 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5280
5281 In other words, d*10**f is an approximation to exp(c*10**e) with p
5282 digits of precision, and with an error in d of at most 1. This is
5283 almost, but not quite, the same as the error being < 1ulp: when d
5284 = 10**(p-1) the error could be up to 10 ulp."""
5285
5286 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5287 p += 2
5288
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005289 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005290 extra = max(0, e + len(str(c)) - 1)
5291 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005292
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005293 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005294 # rounding down
5295 shift = e+q
5296 if shift >= 0:
5297 cshift = c*10**shift
5298 else:
5299 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005300 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005301
5302 # reduce remainder back to original precision
5303 rem = _div_nearest(rem, 10**extra)
5304
5305 # error in result of _iexp < 120; error after division < 0.62
5306 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5307
5308def _dpower(xc, xe, yc, ye, p):
5309 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5310 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5311
5312 10**(p-1) <= c <= 10**p, and
5313 (c-1)*10**e < x**y < (c+1)*10**e
5314
5315 in other words, c*10**e is an approximation to x**y with p digits
5316 of precision, and with an error in c of at most 1. (This is
5317 almost, but not quite, the same as the error being < 1ulp: when c
5318 == 10**(p-1) we can only guarantee error < 10ulp.)
5319
5320 We assume that: x is positive and not equal to 1, and y is nonzero.
5321 """
5322
5323 # Find b such that 10**(b-1) <= |y| <= 10**b
5324 b = len(str(abs(yc))) + ye
5325
5326 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5327 lxc = _dlog(xc, xe, p+b+1)
5328
5329 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5330 shift = ye-b
5331 if shift >= 0:
5332 pc = lxc*yc*10**shift
5333 else:
5334 pc = _div_nearest(lxc*yc, 10**-shift)
5335
5336 if pc == 0:
5337 # we prefer a result that isn't exactly 1; this makes it
5338 # easier to compute a correctly rounded result in __pow__
5339 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5340 coeff, exp = 10**(p-1)+1, 1-p
5341 else:
5342 coeff, exp = 10**p-1, -p
5343 else:
5344 coeff, exp = _dexp(pc, -(p+1), p+1)
5345 coeff = _div_nearest(coeff, 10)
5346 exp += 1
5347
5348 return coeff, exp
5349
5350def _log10_lb(c, correction = {
5351 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5352 '6': 23, '7': 16, '8': 10, '9': 5}):
5353 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5354 if c <= 0:
5355 raise ValueError("The argument to _log10_lb should be nonnegative.")
5356 str_c = str(c)
5357 return 100*len(str_c) - correction[str_c[0]]
5358
Facundo Batista59c58842007-04-10 12:58:45 +00005359##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005360
Facundo Batista353750c2007-09-13 18:13:15 +00005361def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005362 """Convert other to Decimal.
5363
5364 Verifies that it's ok to use in an implicit construction.
5365 """
5366 if isinstance(other, Decimal):
5367 return other
5368 if isinstance(other, (int, long)):
5369 return Decimal(other)
Facundo Batista353750c2007-09-13 18:13:15 +00005370 if raiseit:
5371 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005372 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005373
Facundo Batista59c58842007-04-10 12:58:45 +00005374##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005375
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005376# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005377# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005378
5379DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005380 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005381 traps=[DivisionByZero, Overflow, InvalidOperation],
5382 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005383 Emax=999999999,
5384 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005385 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005386)
5387
5388# Pre-made alternate contexts offered by the specification
5389# Don't change these; the user should be able to select these
5390# contexts and be able to reproduce results from other implementations
5391# of the spec.
5392
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005393BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005394 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005395 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5396 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005397)
5398
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005399ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005400 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005401 traps=[],
5402 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005403)
5404
5405
Facundo Batista72bc54f2007-11-23 17:59:00 +00005406##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005407#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005408# Regular expression used for parsing numeric strings. Additional
5409# comments:
5410#
5411# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5412# whitespace. But note that the specification disallows whitespace in
5413# a numeric string.
5414#
5415# 2. For finite numbers (not infinities and NaNs) the body of the
5416# number between the optional sign and the optional exponent must have
5417# at least one decimal digit, possibly after the decimal point. The
5418# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005419
5420import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005421_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005422# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005423 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005424 (
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005425 (?=\d|\.\d) # ...a number (with at least one digit)
5426 (?P<int>\d*) # having a (possibly empty) integer part
5427 (\.(?P<frac>\d*))? # followed by an optional fractional part
5428 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005429 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005430 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005431 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005432 (?P<signal>s)? # ...an (optionally signaling)
5433 NaN # NaN
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005434 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005435 )
5436# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005437 \Z
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005438""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005439
Facundo Batista2ec74152007-12-03 17:55:00 +00005440_all_zeros = re.compile('0*$').match
5441_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005442
5443##### PEP3101 support functions ##############################################
5444# The functions parse_format_specifier and format_align have little to do
5445# with the Decimal class, and could potentially be reused for other pure
5446# Python numeric classes that want to implement __format__
5447#
5448# A format specifier for Decimal looks like:
5449#
5450# [[fill]align][sign][0][minimumwidth][.precision][type]
5451#
5452
5453_parse_format_specifier_regex = re.compile(r"""\A
5454(?:
5455 (?P<fill>.)?
5456 (?P<align>[<>=^])
5457)?
5458(?P<sign>[-+ ])?
5459(?P<zeropad>0)?
5460(?P<minimumwidth>(?!0)\d+)?
5461(?:\.(?P<precision>0|(?!0)\d+))?
5462(?P<type>[eEfFgG%])?
5463\Z
5464""", re.VERBOSE)
5465
Facundo Batista72bc54f2007-11-23 17:59:00 +00005466del re
5467
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005468def _parse_format_specifier(format_spec):
5469 """Parse and validate a format specifier.
5470
5471 Turns a standard numeric format specifier into a dict, with the
5472 following entries:
5473
5474 fill: fill character to pad field to minimum width
5475 align: alignment type, either '<', '>', '=' or '^'
5476 sign: either '+', '-' or ' '
5477 minimumwidth: nonnegative integer giving minimum width
5478 precision: nonnegative integer giving precision, or None
5479 type: one of the characters 'eEfFgG%', or None
5480 unicode: either True or False (always True for Python 3.x)
5481
5482 """
5483 m = _parse_format_specifier_regex.match(format_spec)
5484 if m is None:
5485 raise ValueError("Invalid format specifier: " + format_spec)
5486
5487 # get the dictionary
5488 format_dict = m.groupdict()
5489
5490 # defaults for fill and alignment
5491 fill = format_dict['fill']
5492 align = format_dict['align']
5493 if format_dict.pop('zeropad') is not None:
5494 # in the face of conflict, refuse the temptation to guess
5495 if fill is not None and fill != '0':
5496 raise ValueError("Fill character conflicts with '0'"
5497 " in format specifier: " + format_spec)
5498 if align is not None and align != '=':
5499 raise ValueError("Alignment conflicts with '0' in "
5500 "format specifier: " + format_spec)
5501 fill = '0'
5502 align = '='
5503 format_dict['fill'] = fill or ' '
5504 format_dict['align'] = align or '<'
5505
5506 if format_dict['sign'] is None:
5507 format_dict['sign'] = '-'
5508
5509 # turn minimumwidth and precision entries into integers.
5510 # minimumwidth defaults to 0; precision remains None if not given
5511 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5512 if format_dict['precision'] is not None:
5513 format_dict['precision'] = int(format_dict['precision'])
5514
5515 # if format type is 'g' or 'G' then a precision of 0 makes little
5516 # sense; convert it to 1. Same if format type is unspecified.
5517 if format_dict['precision'] == 0:
Mark Dickinsonc3c112d2009-09-07 16:19:35 +00005518 if format_dict['type'] is None or format_dict['type'] in 'gG':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005519 format_dict['precision'] = 1
5520
5521 # record whether return type should be str or unicode
5522 format_dict['unicode'] = isinstance(format_spec, unicode)
5523
5524 return format_dict
5525
5526def _format_align(body, spec_dict):
5527 """Given an unpadded, non-aligned numeric string, add padding and
5528 aligment to conform with the given format specifier dictionary (as
5529 output from parse_format_specifier).
5530
5531 It's assumed that if body is negative then it starts with '-'.
5532 Any leading sign ('-' or '+') is stripped from the body before
5533 applying the alignment and padding rules, and replaced in the
5534 appropriate position.
5535
5536 """
5537 # figure out the sign; we only examine the first character, so if
5538 # body has leading whitespace the results may be surprising.
5539 if len(body) > 0 and body[0] in '-+':
5540 sign = body[0]
5541 body = body[1:]
5542 else:
5543 sign = ''
5544
5545 if sign != '-':
5546 if spec_dict['sign'] in ' +':
5547 sign = spec_dict['sign']
5548 else:
5549 sign = ''
5550
5551 # how much extra space do we have to play with?
5552 minimumwidth = spec_dict['minimumwidth']
5553 fill = spec_dict['fill']
5554 padding = fill*(max(minimumwidth - (len(sign+body)), 0))
5555
5556 align = spec_dict['align']
5557 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005558 result = sign + body + padding
Mark Dickinson71416822009-03-17 18:07:41 +00005559 elif align == '>':
5560 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005561 elif align == '=':
5562 result = sign + padding + body
5563 else: #align == '^'
5564 half = len(padding)//2
5565 result = padding[:half] + sign + body + padding[half:]
5566
5567 # make sure that result is unicode if necessary
5568 if spec_dict['unicode']:
5569 result = unicode(result)
5570
5571 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00005572
Facundo Batista59c58842007-04-10 12:58:45 +00005573##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005574
Facundo Batista59c58842007-04-10 12:58:45 +00005575# Reusable defaults
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005576_Infinity = Decimal('Inf')
5577_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonfd6032d2009-01-02 23:16:51 +00005578_NaN = Decimal('NaN')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005579_Zero = Decimal(0)
5580_One = Decimal(1)
5581_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005582
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005583# _SignedInfinity[sign] is infinity w/ that sign
5584_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005585
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005586
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005587
5588if __name__ == '__main__':
5589 import doctest, sys
5590 doctest.testmod(sys.modules[__name__])