blob: b3bdc7f0c5d5fcf33b8a304e204ee492f7dd312c [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
Stefan Krah94908512010-05-19 15:50:05 +0000168 trap_enabler is not set. First argument is self, second is the
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000169 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:
Mark Dickinson060d6552010-07-08 19:27:24 +00001921 xe *= yc
1922 # result is now 10**(xe * 10**ye); xe * 10**ye must be integral
1923 while xe % 10 == 0:
1924 xe //= 10
1925 ye += 1
1926 if ye < 0:
1927 return None
1928 exponent = xe * 10**ye
Facundo Batista353750c2007-09-13 18:13:15 +00001929 if y.sign == 1:
1930 exponent = -exponent
1931 # if other is a nonnegative integer, use ideal exponent
1932 if other._isinteger() and other._sign == 0:
1933 ideal_exponent = self._exp*int(other)
1934 zeros = min(exponent-ideal_exponent, p-1)
1935 else:
1936 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00001937 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00001938
1939 # case where y is negative: xc must be either a power
1940 # of 2 or a power of 5.
1941 if y.sign == 1:
1942 last_digit = xc % 10
1943 if last_digit in (2,4,6,8):
1944 # quick test for power of 2
1945 if xc & -xc != xc:
1946 return None
1947 # now xc is a power of 2; e is its exponent
1948 e = _nbits(xc)-1
1949 # find e*y and xe*y; both must be integers
1950 if ye >= 0:
1951 y_as_int = yc*10**ye
1952 e = e*y_as_int
1953 xe = xe*y_as_int
1954 else:
1955 ten_pow = 10**-ye
1956 e, remainder = divmod(e*yc, ten_pow)
1957 if remainder:
1958 return None
1959 xe, remainder = divmod(xe*yc, ten_pow)
1960 if remainder:
1961 return None
1962
1963 if e*65 >= p*93: # 93/65 > log(10)/log(5)
1964 return None
1965 xc = 5**e
1966
1967 elif last_digit == 5:
1968 # e >= log_5(xc) if xc is a power of 5; we have
1969 # equality all the way up to xc=5**2658
1970 e = _nbits(xc)*28//65
1971 xc, remainder = divmod(5**e, xc)
1972 if remainder:
1973 return None
1974 while xc % 5 == 0:
1975 xc //= 5
1976 e -= 1
1977 if ye >= 0:
1978 y_as_integer = yc*10**ye
1979 e = e*y_as_integer
1980 xe = xe*y_as_integer
1981 else:
1982 ten_pow = 10**-ye
1983 e, remainder = divmod(e*yc, ten_pow)
1984 if remainder:
1985 return None
1986 xe, remainder = divmod(xe*yc, ten_pow)
1987 if remainder:
1988 return None
1989 if e*3 >= p*10: # 10/3 > log(10)/log(2)
1990 return None
1991 xc = 2**e
1992 else:
1993 return None
1994
1995 if xc >= 10**p:
1996 return None
1997 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00001998 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00001999
2000 # now y is positive; find m and n such that y = m/n
2001 if ye >= 0:
2002 m, n = yc*10**ye, 1
2003 else:
2004 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2005 return None
2006 xc_bits = _nbits(xc)
2007 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2008 return None
2009 m, n = yc, 10**(-ye)
2010 while m % 2 == n % 2 == 0:
2011 m //= 2
2012 n //= 2
2013 while m % 5 == n % 5 == 0:
2014 m //= 5
2015 n //= 5
2016
2017 # compute nth root of xc*10**xe
2018 if n > 1:
2019 # if 1 < xc < 2**n then xc isn't an nth power
2020 if xc != 1 and xc_bits <= n:
2021 return None
2022
2023 xe, rem = divmod(xe, n)
2024 if rem != 0:
2025 return None
2026
2027 # compute nth root of xc using Newton's method
2028 a = 1L << -(-_nbits(xc)//n) # initial estimate
2029 while True:
2030 q, r = divmod(xc, a**(n-1))
2031 if a <= q:
2032 break
2033 else:
2034 a = (a*(n-1) + q)//n
2035 if not (a == q and r == 0):
2036 return None
2037 xc = a
2038
2039 # now xc*10**xe is the nth root of the original xc*10**xe
2040 # compute mth power of xc*10**xe
2041
2042 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2043 # 10**p and the result is not representable.
2044 if xc > 1 and m > p*100//_log10_lb(xc):
2045 return None
2046 xc = xc**m
2047 xe *= m
2048 if xc > 10**p:
2049 return None
2050
2051 # by this point the result *is* exactly representable
2052 # adjust the exponent to get as close as possible to the ideal
2053 # exponent, if necessary
2054 str_xc = str(xc)
2055 if other._isinteger() and other._sign == 0:
2056 ideal_exponent = self._exp*int(other)
2057 zeros = min(xe-ideal_exponent, p-len(str_xc))
2058 else:
2059 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002060 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002061
2062 def __pow__(self, other, modulo=None, context=None):
2063 """Return self ** other [ % modulo].
2064
2065 With two arguments, compute self**other.
2066
2067 With three arguments, compute (self**other) % modulo. For the
2068 three argument form, the following restrictions on the
2069 arguments hold:
2070
2071 - all three arguments must be integral
2072 - other must be nonnegative
2073 - either self or other (or both) must be nonzero
2074 - modulo must be nonzero and must have at most p digits,
2075 where p is the context precision.
2076
2077 If any of these restrictions is violated the InvalidOperation
2078 flag is raised.
2079
2080 The result of pow(self, other, modulo) is identical to the
2081 result that would be obtained by computing (self**other) %
2082 modulo with unbounded precision, but is computed more
2083 efficiently. It is always exact.
2084 """
2085
2086 if modulo is not None:
2087 return self._power_modulo(other, modulo, context)
2088
2089 other = _convert_other(other)
2090 if other is NotImplemented:
2091 return other
2092
2093 if context is None:
2094 context = getcontext()
2095
2096 # either argument is a NaN => result is NaN
2097 ans = self._check_nans(other, context)
2098 if ans:
2099 return ans
2100
2101 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2102 if not other:
2103 if not self:
2104 return context._raise_error(InvalidOperation, '0 ** 0')
2105 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002106 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002107
2108 # result has sign 1 iff self._sign is 1 and other is an odd integer
2109 result_sign = 0
2110 if self._sign == 1:
2111 if other._isinteger():
2112 if not other._iseven():
2113 result_sign = 1
2114 else:
2115 # -ve**noninteger = NaN
2116 # (-0)**noninteger = 0**noninteger
2117 if self:
2118 return context._raise_error(InvalidOperation,
2119 'x ** y with x negative and y not an integer')
2120 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002121 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002122
2123 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2124 if not self:
2125 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002126 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002127 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002128 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002129
2130 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002131 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002132 if other._sign == 0:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002133 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002134 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002135 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002136
Facundo Batista353750c2007-09-13 18:13:15 +00002137 # 1**other = 1, but the choice of exponent and the flags
2138 # depend on the exponent of self, and on whether other is a
2139 # positive integer, a negative integer, or neither
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002140 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002141 if other._isinteger():
2142 # exp = max(self._exp*max(int(other), 0),
2143 # 1-context.prec) but evaluating int(other) directly
2144 # is dangerous until we know other is small (other
2145 # could be 1e999999999)
2146 if other._sign == 1:
2147 multiplier = 0
2148 elif other > context.prec:
2149 multiplier = context.prec
2150 else:
2151 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002152
Facundo Batista353750c2007-09-13 18:13:15 +00002153 exp = self._exp * multiplier
2154 if exp < 1-context.prec:
2155 exp = 1-context.prec
2156 context._raise_error(Rounded)
2157 else:
2158 context._raise_error(Inexact)
2159 context._raise_error(Rounded)
2160 exp = 1-context.prec
2161
Facundo Batista72bc54f2007-11-23 17:59:00 +00002162 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002163
2164 # compute adjusted exponent of self
2165 self_adj = self.adjusted()
2166
2167 # self ** infinity is infinity if self > 1, 0 if self < 1
2168 # self ** -infinity is infinity if self < 1, 0 if self > 1
2169 if other._isinfinity():
2170 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002171 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002172 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002173 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002174
2175 # from here on, the result always goes through the call
2176 # to _fix at the end of this function.
2177 ans = None
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002178 exact = False
Facundo Batista353750c2007-09-13 18:13:15 +00002179
2180 # crude test to catch cases of extreme overflow/underflow. If
2181 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2182 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2183 # self**other >= 10**(Emax+1), so overflow occurs. The test
2184 # for underflow is similar.
2185 bound = self._log10_exp_bound() + other.adjusted()
2186 if (self_adj >= 0) == (other._sign == 0):
2187 # self > 1 and other +ve, or self < 1 and other -ve
2188 # possibility of overflow
2189 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002190 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002191 else:
2192 # self > 1 and other -ve, or self < 1 and other +ve
2193 # possibility of underflow to 0
2194 Etiny = context.Etiny()
2195 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002196 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002197
2198 # try for an exact result with precision +1
2199 if ans is None:
2200 ans = self._power_exact(other, context.prec + 1)
Mark Dickinson060d6552010-07-08 19:27:24 +00002201 if ans is not None:
2202 if result_sign == 1:
2203 ans = _dec_from_triple(1, ans._int, ans._exp)
2204 exact = True
Facundo Batista353750c2007-09-13 18:13:15 +00002205
2206 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2207 if ans is None:
2208 p = context.prec
2209 x = _WorkRep(self)
2210 xc, xe = x.int, x.exp
2211 y = _WorkRep(other)
2212 yc, ye = y.int, y.exp
2213 if y.sign == 1:
2214 yc = -yc
2215
2216 # compute correctly rounded result: start with precision +3,
2217 # then increase precision until result is unambiguously roundable
2218 extra = 3
2219 while True:
2220 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2221 if coeff % (5*10**(len(str(coeff))-p-1)):
2222 break
2223 extra += 3
2224
Facundo Batista72bc54f2007-11-23 17:59:00 +00002225 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002226
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002227 # unlike exp, ln and log10, the power function respects the
2228 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2229
2230 # There's a difficulty here when 'other' is not an integer and
2231 # the result is exact. In this case, the specification
2232 # requires that the Inexact flag be raised (in spite of
2233 # exactness), but since the result is exact _fix won't do this
2234 # for us. (Correspondingly, the Underflow signal should also
2235 # be raised for subnormal results.) We can't directly raise
2236 # these signals either before or after calling _fix, since
2237 # that would violate the precedence for signals. So we wrap
2238 # the ._fix call in a temporary context, and reraise
2239 # afterwards.
2240 if exact and not other._isinteger():
2241 # pad with zeros up to length context.prec+1 if necessary; this
2242 # ensures that the Rounded signal will be raised.
Facundo Batista353750c2007-09-13 18:13:15 +00002243 if len(ans._int) <= context.prec:
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002244 expdiff = context.prec + 1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002245 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2246 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002247
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002248 # create a copy of the current context, with cleared flags/traps
2249 newcontext = context.copy()
2250 newcontext.clear_flags()
2251 for exception in _signals:
2252 newcontext.traps[exception] = 0
2253
2254 # round in the new context
2255 ans = ans._fix(newcontext)
2256
2257 # raise Inexact, and if necessary, Underflow
2258 newcontext._raise_error(Inexact)
2259 if newcontext.flags[Subnormal]:
2260 newcontext._raise_error(Underflow)
2261
2262 # propagate signals to the original context; _fix could
2263 # have raised any of Overflow, Underflow, Subnormal,
2264 # Inexact, Rounded, Clamped. Overflow needs the correct
2265 # arguments. Note that the order of the exceptions is
2266 # important here.
2267 if newcontext.flags[Overflow]:
2268 context._raise_error(Overflow, 'above Emax', ans._sign)
2269 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2270 if newcontext.flags[exception]:
2271 context._raise_error(exception)
2272
2273 else:
2274 ans = ans._fix(context)
2275
Facundo Batista353750c2007-09-13 18:13:15 +00002276 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002277
2278 def __rpow__(self, other, context=None):
2279 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002280 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002281 if other is NotImplemented:
2282 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002283 return other.__pow__(self, context=context)
2284
2285 def normalize(self, context=None):
2286 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002287
Facundo Batista353750c2007-09-13 18:13:15 +00002288 if context is None:
2289 context = getcontext()
2290
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002291 if self._is_special:
2292 ans = self._check_nans(context=context)
2293 if ans:
2294 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002295
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002296 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002297 if dup._isinfinity():
2298 return dup
2299
2300 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002301 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002302 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002303 end = len(dup._int)
2304 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002305 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002306 exp += 1
2307 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002308 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002309
Facundo Batistabd2fe832007-09-13 18:42:09 +00002310 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002311 """Quantize self so its exponent is the same as that of exp.
2312
2313 Similar to self._rescale(exp._exp) but with error checking.
2314 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002315 exp = _convert_other(exp, raiseit=True)
2316
Facundo Batista353750c2007-09-13 18:13:15 +00002317 if context is None:
2318 context = getcontext()
2319 if rounding is None:
2320 rounding = context.rounding
2321
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002322 if self._is_special or exp._is_special:
2323 ans = self._check_nans(exp, context)
2324 if ans:
2325 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002326
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002327 if exp._isinfinity() or self._isinfinity():
2328 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002329 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002330 return context._raise_error(InvalidOperation,
2331 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002332
Facundo Batistabd2fe832007-09-13 18:42:09 +00002333 # if we're not watching exponents, do a simple rescale
2334 if not watchexp:
2335 ans = self._rescale(exp._exp, rounding)
2336 # raise Inexact and Rounded where appropriate
2337 if ans._exp > self._exp:
2338 context._raise_error(Rounded)
2339 if ans != self:
2340 context._raise_error(Inexact)
2341 return ans
2342
Facundo Batista353750c2007-09-13 18:13:15 +00002343 # exp._exp should be between Etiny and Emax
2344 if not (context.Etiny() <= exp._exp <= context.Emax):
2345 return context._raise_error(InvalidOperation,
2346 'target exponent out of bounds in quantize')
2347
2348 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002349 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002350 return ans._fix(context)
2351
2352 self_adjusted = self.adjusted()
2353 if self_adjusted > context.Emax:
2354 return context._raise_error(InvalidOperation,
2355 'exponent of quantize result too large for current context')
2356 if self_adjusted - exp._exp + 1 > context.prec:
2357 return context._raise_error(InvalidOperation,
2358 'quantize result has too many digits for current context')
2359
2360 ans = self._rescale(exp._exp, rounding)
2361 if ans.adjusted() > context.Emax:
2362 return context._raise_error(InvalidOperation,
2363 'exponent of quantize result too large for current context')
2364 if len(ans._int) > context.prec:
2365 return context._raise_error(InvalidOperation,
2366 'quantize result has too many digits for current context')
2367
2368 # raise appropriate flags
Facundo Batista353750c2007-09-13 18:13:15 +00002369 if ans and ans.adjusted() < context.Emin:
2370 context._raise_error(Subnormal)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002371 if ans._exp > self._exp:
2372 if ans != self:
2373 context._raise_error(Inexact)
2374 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00002375
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002376 # call to fix takes care of any necessary folddown, and
2377 # signals Clamped if necessary
Facundo Batista353750c2007-09-13 18:13:15 +00002378 ans = ans._fix(context)
2379 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002380
2381 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002382 """Return True if self and other have the same exponent; otherwise
2383 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002384
Facundo Batista1a191df2007-10-02 17:01:24 +00002385 If either operand is a special value, the following rules are used:
2386 * return True if both operands are infinities
2387 * return True if both operands are NaNs
2388 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002389 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002390 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002391 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002392 return (self.is_nan() and other.is_nan() or
2393 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002394 return self._exp == other._exp
2395
Facundo Batista353750c2007-09-13 18:13:15 +00002396 def _rescale(self, exp, rounding):
2397 """Rescale self so that the exponent is exp, either by padding with zeros
2398 or by truncating digits, using the given rounding mode.
2399
2400 Specials are returned without change. This operation is
2401 quiet: it raises no flags, and uses no information from the
2402 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002403
2404 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002405 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002406 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002407 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002408 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002409 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002410 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002411
Facundo Batista353750c2007-09-13 18:13:15 +00002412 if self._exp >= exp:
2413 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002414 return _dec_from_triple(self._sign,
2415 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002416
Facundo Batista353750c2007-09-13 18:13:15 +00002417 # too many digits; round and lose data. If self.adjusted() <
2418 # exp-1, replace self by 10**(exp-1) before rounding
2419 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002420 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002421 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002422 digits = 0
2423 this_function = getattr(self, self._pick_rounding_function[rounding])
Facundo Batista2ec74152007-12-03 17:55:00 +00002424 changed = this_function(digits)
2425 coeff = self._int[:digits] or '0'
2426 if changed == 1:
2427 coeff = str(int(coeff)+1)
2428 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002429
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002430 def _round(self, places, rounding):
2431 """Round a nonzero, nonspecial Decimal to a fixed number of
2432 significant figures, using the given rounding mode.
2433
2434 Infinities, NaNs and zeros are returned unaltered.
2435
2436 This operation is quiet: it raises no flags, and uses no
2437 information from the context.
2438
2439 """
2440 if places <= 0:
2441 raise ValueError("argument should be at least 1 in _round")
2442 if self._is_special or not self:
2443 return Decimal(self)
2444 ans = self._rescale(self.adjusted()+1-places, rounding)
2445 # it can happen that the rescale alters the adjusted exponent;
2446 # for example when rounding 99.97 to 3 significant figures.
2447 # When this happens we end up with an extra 0 at the end of
2448 # the number; a second rescale fixes this.
2449 if ans.adjusted() != self.adjusted():
2450 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2451 return ans
2452
Facundo Batista353750c2007-09-13 18:13:15 +00002453 def to_integral_exact(self, rounding=None, context=None):
2454 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002455
Facundo Batista353750c2007-09-13 18:13:15 +00002456 If no rounding mode is specified, take the rounding mode from
2457 the context. This method raises the Rounded and Inexact flags
2458 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002459
Facundo Batista353750c2007-09-13 18:13:15 +00002460 See also: to_integral_value, which does exactly the same as
2461 this method except that it doesn't raise Inexact or Rounded.
2462 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002463 if self._is_special:
2464 ans = self._check_nans(context=context)
2465 if ans:
2466 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002467 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002468 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002469 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002470 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002471 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002472 if context is None:
2473 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002474 if rounding is None:
2475 rounding = context.rounding
Facundo Batista353750c2007-09-13 18:13:15 +00002476 ans = self._rescale(0, rounding)
2477 if ans != self:
2478 context._raise_error(Inexact)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00002479 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002480 return ans
2481
Facundo Batista353750c2007-09-13 18:13:15 +00002482 def to_integral_value(self, rounding=None, context=None):
2483 """Rounds to the nearest integer, without raising inexact, rounded."""
2484 if context is None:
2485 context = getcontext()
2486 if rounding is None:
2487 rounding = context.rounding
2488 if self._is_special:
2489 ans = self._check_nans(context=context)
2490 if ans:
2491 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002492 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002493 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002494 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002495 else:
2496 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002497
Facundo Batista353750c2007-09-13 18:13:15 +00002498 # the method name changed, but we provide also the old one, for compatibility
2499 to_integral = to_integral_value
2500
2501 def sqrt(self, context=None):
2502 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002503 if context is None:
2504 context = getcontext()
2505
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002506 if self._is_special:
2507 ans = self._check_nans(context=context)
2508 if ans:
2509 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002510
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002511 if self._isinfinity() and self._sign == 0:
2512 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002513
2514 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002515 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002516 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002517 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002518
2519 if self._sign == 1:
2520 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2521
Facundo Batista353750c2007-09-13 18:13:15 +00002522 # At this point self represents a positive number. Let p be
2523 # the desired precision and express self in the form c*100**e
2524 # with c a positive real number and e an integer, c and e
2525 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2526 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2527 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2528 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2529 # the closest integer to sqrt(c) with the even integer chosen
2530 # in the case of a tie.
2531 #
2532 # To ensure correct rounding in all cases, we use the
2533 # following trick: we compute the square root to an extra
2534 # place (precision p+1 instead of precision p), rounding down.
2535 # Then, if the result is inexact and its last digit is 0 or 5,
2536 # we increase the last digit to 1 or 6 respectively; if it's
2537 # exact we leave the last digit alone. Now the final round to
2538 # p places (or fewer in the case of underflow) will round
2539 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002540
Facundo Batista353750c2007-09-13 18:13:15 +00002541 # use an extra digit of precision
2542 prec = context.prec+1
2543
2544 # write argument in the form c*100**e where e = self._exp//2
2545 # is the 'ideal' exponent, to be used if the square root is
2546 # exactly representable. l is the number of 'digits' of c in
2547 # base 100, so that 100**(l-1) <= c < 100**l.
2548 op = _WorkRep(self)
2549 e = op.exp >> 1
2550 if op.exp & 1:
2551 c = op.int * 10
2552 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002553 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002554 c = op.int
2555 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002556
Facundo Batista353750c2007-09-13 18:13:15 +00002557 # rescale so that c has exactly prec base 100 'digits'
2558 shift = prec-l
2559 if shift >= 0:
2560 c *= 100**shift
2561 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002562 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002563 c, remainder = divmod(c, 100**-shift)
2564 exact = not remainder
2565 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002566
Facundo Batista353750c2007-09-13 18:13:15 +00002567 # find n = floor(sqrt(c)) using Newton's method
2568 n = 10**prec
2569 while True:
2570 q = c//n
2571 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002572 break
Facundo Batista353750c2007-09-13 18:13:15 +00002573 else:
2574 n = n + q >> 1
2575 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002576
Facundo Batista353750c2007-09-13 18:13:15 +00002577 if exact:
2578 # result is exact; rescale to use ideal exponent e
2579 if shift >= 0:
2580 # assert n % 10**shift == 0
2581 n //= 10**shift
2582 else:
2583 n *= 10**-shift
2584 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002585 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002586 # result is not exact; fix last digit as described above
2587 if n % 5 == 0:
2588 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002589
Facundo Batista72bc54f2007-11-23 17:59:00 +00002590 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002591
Facundo Batista353750c2007-09-13 18:13:15 +00002592 # round, and fit to current context
2593 context = context._shallow_copy()
2594 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002595 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002596 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002597
Facundo Batista353750c2007-09-13 18:13:15 +00002598 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002599
2600 def max(self, other, context=None):
2601 """Returns the larger value.
2602
Facundo Batista353750c2007-09-13 18:13:15 +00002603 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002604 NaN (and signals if one is sNaN). Also rounds.
2605 """
Facundo Batista353750c2007-09-13 18:13:15 +00002606 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002607
Facundo Batista6c398da2007-09-17 17:30:13 +00002608 if context is None:
2609 context = getcontext()
2610
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002611 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002612 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002613 # number is always returned
2614 sn = self._isnan()
2615 on = other._isnan()
2616 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00002617 if on == 1 and sn == 0:
2618 return self._fix(context)
2619 if sn == 1 and on == 0:
2620 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002621 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002622
Mark Dickinson2fc92632008-02-06 22:10:50 +00002623 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002624 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002625 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002626 # then an ordering is applied:
2627 #
Facundo Batista59c58842007-04-10 12:58:45 +00002628 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002629 # positive sign and min returns the operand with the negative sign
2630 #
Facundo Batista59c58842007-04-10 12:58:45 +00002631 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002632 # the result. This is exactly the ordering used in compare_total.
2633 c = self.compare_total(other)
2634
2635 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002636 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002637 else:
2638 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002639
Facundo Batistae64acfa2007-12-17 14:18:42 +00002640 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002641
2642 def min(self, other, context=None):
2643 """Returns the smaller value.
2644
Facundo Batista59c58842007-04-10 12:58:45 +00002645 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002646 NaN (and signals if one is sNaN). Also rounds.
2647 """
Facundo Batista353750c2007-09-13 18:13:15 +00002648 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002649
Facundo Batista6c398da2007-09-17 17:30:13 +00002650 if context is None:
2651 context = getcontext()
2652
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002653 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002654 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002655 # number is always returned
2656 sn = self._isnan()
2657 on = other._isnan()
2658 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00002659 if on == 1 and sn == 0:
2660 return self._fix(context)
2661 if sn == 1 and on == 0:
2662 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002663 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002664
Mark Dickinson2fc92632008-02-06 22:10:50 +00002665 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002666 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002667 c = self.compare_total(other)
2668
2669 if c == -1:
2670 ans = self
2671 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002672 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002673
Facundo Batistae64acfa2007-12-17 14:18:42 +00002674 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002675
2676 def _isinteger(self):
2677 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002678 if self._is_special:
2679 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002680 if self._exp >= 0:
2681 return True
2682 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002683 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002684
2685 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002686 """Returns True if self is even. Assumes self is an integer."""
2687 if not self or self._exp > 0:
2688 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002689 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002690
2691 def adjusted(self):
2692 """Return the adjusted exponent of self"""
2693 try:
2694 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002695 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002696 except TypeError:
2697 return 0
2698
Facundo Batista353750c2007-09-13 18:13:15 +00002699 def canonical(self, context=None):
2700 """Returns the same Decimal object.
2701
2702 As we do not have different encodings for the same number, the
2703 received object already is in its canonical form.
2704 """
2705 return self
2706
2707 def compare_signal(self, other, context=None):
2708 """Compares self to the other operand numerically.
2709
2710 It's pretty much like compare(), but all NaNs signal, with signaling
2711 NaNs taking precedence over quiet NaNs.
2712 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002713 other = _convert_other(other, raiseit = True)
2714 ans = self._compare_check_nans(other, context)
2715 if ans:
2716 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002717 return self.compare(other, context=context)
2718
2719 def compare_total(self, other):
2720 """Compares self to other using the abstract representations.
2721
2722 This is not like the standard compare, which use their numerical
2723 value. Note that a total ordering is defined for all possible abstract
2724 representations.
2725 """
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00002726 other = _convert_other(other, raiseit=True)
2727
Facundo Batista353750c2007-09-13 18:13:15 +00002728 # if one is negative and the other is positive, it's easy
2729 if self._sign and not other._sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002730 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002731 if not self._sign and other._sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002732 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002733 sign = self._sign
2734
2735 # let's handle both NaN types
2736 self_nan = self._isnan()
2737 other_nan = other._isnan()
2738 if self_nan or other_nan:
2739 if self_nan == other_nan:
Mark Dickinson7f265b72009-08-28 13:35:02 +00002740 # compare payloads as though they're integers
2741 self_key = len(self._int), self._int
2742 other_key = len(other._int), other._int
2743 if self_key < other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002744 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002745 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002746 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002747 return _NegativeOne
Mark Dickinson7f265b72009-08-28 13:35:02 +00002748 if self_key > other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002749 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002750 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002751 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002752 return _One
2753 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002754
2755 if sign:
2756 if self_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002757 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002758 if other_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002759 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002760 if self_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002761 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002762 if other_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002763 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002764 else:
2765 if self_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002766 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002767 if other_nan == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002768 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002769 if self_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002770 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002771 if other_nan == 2:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002772 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002773
2774 if self < other:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002775 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002776 if self > other:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002777 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002778
2779 if self._exp < other._exp:
2780 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002781 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002782 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002783 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002784 if self._exp > other._exp:
2785 if sign:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002786 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002787 else:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002788 return _One
2789 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002790
2791
2792 def compare_total_mag(self, other):
2793 """Compares self to other using abstract repr., ignoring sign.
2794
2795 Like compare_total, but with operand's sign ignored and assumed to be 0.
2796 """
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00002797 other = _convert_other(other, raiseit=True)
2798
Facundo Batista353750c2007-09-13 18:13:15 +00002799 s = self.copy_abs()
2800 o = other.copy_abs()
2801 return s.compare_total(o)
2802
2803 def copy_abs(self):
2804 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002805 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002806
2807 def copy_negate(self):
2808 """Returns a copy with the sign inverted."""
2809 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002810 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002811 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002812 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002813
2814 def copy_sign(self, other):
2815 """Returns self with the sign of other."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002816 return _dec_from_triple(other._sign, self._int,
2817 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002818
2819 def exp(self, context=None):
2820 """Returns e ** self."""
2821
2822 if context is None:
2823 context = getcontext()
2824
2825 # exp(NaN) = NaN
2826 ans = self._check_nans(context=context)
2827 if ans:
2828 return ans
2829
2830 # exp(-Infinity) = 0
2831 if self._isinfinity() == -1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002832 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002833
2834 # exp(0) = 1
2835 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002836 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002837
2838 # exp(Infinity) = Infinity
2839 if self._isinfinity() == 1:
2840 return Decimal(self)
2841
2842 # the result is now guaranteed to be inexact (the true
2843 # mathematical result is transcendental). There's no need to
2844 # raise Rounded and Inexact here---they'll always be raised as
2845 # a result of the call to _fix.
2846 p = context.prec
2847 adj = self.adjusted()
2848
2849 # we only need to do any computation for quite a small range
2850 # of adjusted exponents---for example, -29 <= adj <= 10 for
2851 # the default context. For smaller exponent the result is
2852 # indistinguishable from 1 at the given precision, while for
2853 # larger exponent the result either overflows or underflows.
2854 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2855 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002856 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002857 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2858 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002859 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002860 elif self._sign == 0 and adj < -p:
2861 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002862 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002863 elif self._sign == 1 and adj < -p-1:
2864 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002865 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002866 # general case
2867 else:
2868 op = _WorkRep(self)
2869 c, e = op.int, op.exp
2870 if op.sign == 1:
2871 c = -c
2872
2873 # compute correctly rounded result: increase precision by
2874 # 3 digits at a time until we get an unambiguously
2875 # roundable result
2876 extra = 3
2877 while True:
2878 coeff, exp = _dexp(c, e, p+extra)
2879 if coeff % (5*10**(len(str(coeff))-p-1)):
2880 break
2881 extra += 3
2882
Facundo Batista72bc54f2007-11-23 17:59:00 +00002883 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002884
2885 # at this stage, ans should round correctly with *any*
2886 # rounding mode, not just with ROUND_HALF_EVEN
2887 context = context._shallow_copy()
2888 rounding = context._set_rounding(ROUND_HALF_EVEN)
2889 ans = ans._fix(context)
2890 context.rounding = rounding
2891
2892 return ans
2893
2894 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002895 """Return True if self is canonical; otherwise return False.
2896
2897 Currently, the encoding of a Decimal instance is always
2898 canonical, so this method returns True for any Decimal.
2899 """
2900 return True
Facundo Batista353750c2007-09-13 18:13:15 +00002901
2902 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002903 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00002904
Facundo Batista1a191df2007-10-02 17:01:24 +00002905 A Decimal instance is considered finite if it is neither
2906 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00002907 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002908 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00002909
2910 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002911 """Return True if self is infinite; otherwise return False."""
2912 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00002913
2914 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002915 """Return True if self is a qNaN or sNaN; otherwise return False."""
2916 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00002917
2918 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002919 """Return True if self is a normal number; otherwise return False."""
2920 if self._is_special or not self:
2921 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002922 if context is None:
2923 context = getcontext()
Mark Dickinson20a7cfc2009-10-27 18:27:53 +00002924 return context.Emin <= self.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +00002925
2926 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002927 """Return True if self is a quiet NaN; otherwise return False."""
2928 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00002929
2930 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002931 """Return True if self is negative; otherwise return False."""
2932 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00002933
2934 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002935 """Return True if self is a signaling NaN; otherwise return False."""
2936 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00002937
2938 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002939 """Return True if self is subnormal; otherwise return False."""
2940 if self._is_special or not self:
2941 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002942 if context is None:
2943 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002944 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00002945
2946 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002947 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002948 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00002949
2950 def _ln_exp_bound(self):
2951 """Compute a lower bound for the adjusted exponent of self.ln().
2952 In other words, compute r such that self.ln() >= 10**r. Assumes
2953 that self is finite and positive and that self != 1.
2954 """
2955
2956 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
2957 adj = self._exp + len(self._int) - 1
2958 if adj >= 1:
2959 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
2960 return len(str(adj*23//10)) - 1
2961 if adj <= -2:
2962 # argument <= 0.1
2963 return len(str((-1-adj)*23//10)) - 1
2964 op = _WorkRep(self)
2965 c, e = op.int, op.exp
2966 if adj == 0:
2967 # 1 < self < 10
2968 num = str(c-10**-e)
2969 den = str(c)
2970 return len(num) - len(den) - (num < den)
2971 # adj == -1, 0.1 <= self < 1
2972 return e + len(str(10**-e - c)) - 1
2973
2974
2975 def ln(self, context=None):
2976 """Returns the natural (base e) logarithm of self."""
2977
2978 if context is None:
2979 context = getcontext()
2980
2981 # ln(NaN) = NaN
2982 ans = self._check_nans(context=context)
2983 if ans:
2984 return ans
2985
2986 # ln(0.0) == -Infinity
2987 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002988 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00002989
2990 # ln(Infinity) = Infinity
2991 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002992 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00002993
2994 # ln(1.0) == 0.0
Mark Dickinsone4d46b22009-01-03 12:09:22 +00002995 if self == _One:
2996 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002997
2998 # ln(negative) raises InvalidOperation
2999 if self._sign == 1:
3000 return context._raise_error(InvalidOperation,
3001 'ln of a negative value')
3002
3003 # result is irrational, so necessarily inexact
3004 op = _WorkRep(self)
3005 c, e = op.int, op.exp
3006 p = context.prec
3007
3008 # correctly rounded result: repeatedly increase precision by 3
3009 # until we get an unambiguously roundable result
3010 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3011 while True:
3012 coeff = _dlog(c, e, places)
3013 # assert len(str(abs(coeff)))-p >= 1
3014 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3015 break
3016 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003017 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003018
3019 context = context._shallow_copy()
3020 rounding = context._set_rounding(ROUND_HALF_EVEN)
3021 ans = ans._fix(context)
3022 context.rounding = rounding
3023 return ans
3024
3025 def _log10_exp_bound(self):
3026 """Compute a lower bound for the adjusted exponent of self.log10().
3027 In other words, find r such that self.log10() >= 10**r.
3028 Assumes that self is finite and positive and that self != 1.
3029 """
3030
3031 # For x >= 10 or x < 0.1 we only need a bound on the integer
3032 # part of log10(self), and this comes directly from the
3033 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3034 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3035 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3036
3037 adj = self._exp + len(self._int) - 1
3038 if adj >= 1:
3039 # self >= 10
3040 return len(str(adj))-1
3041 if adj <= -2:
3042 # self < 0.1
3043 return len(str(-1-adj))-1
3044 op = _WorkRep(self)
3045 c, e = op.int, op.exp
3046 if adj == 0:
3047 # 1 < self < 10
3048 num = str(c-10**-e)
3049 den = str(231*c)
3050 return len(num) - len(den) - (num < den) + 2
3051 # adj == -1, 0.1 <= self < 1
3052 num = str(10**-e-c)
3053 return len(num) + e - (num < "231") - 1
3054
3055 def log10(self, context=None):
3056 """Returns the base 10 logarithm of self."""
3057
3058 if context is None:
3059 context = getcontext()
3060
3061 # log10(NaN) = NaN
3062 ans = self._check_nans(context=context)
3063 if ans:
3064 return ans
3065
3066 # log10(0.0) == -Infinity
3067 if not self:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003068 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003069
3070 # log10(Infinity) = Infinity
3071 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003072 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003073
3074 # log10(negative or -Infinity) raises InvalidOperation
3075 if self._sign == 1:
3076 return context._raise_error(InvalidOperation,
3077 'log10 of a negative value')
3078
3079 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003080 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003081 # answer may need rounding
3082 ans = Decimal(self._exp + len(self._int) - 1)
3083 else:
3084 # result is irrational, so necessarily inexact
3085 op = _WorkRep(self)
3086 c, e = op.int, op.exp
3087 p = context.prec
3088
3089 # correctly rounded result: repeatedly increase precision
3090 # until result is unambiguously roundable
3091 places = p-self._log10_exp_bound()+2
3092 while True:
3093 coeff = _dlog10(c, e, places)
3094 # assert len(str(abs(coeff)))-p >= 1
3095 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3096 break
3097 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003098 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003099
3100 context = context._shallow_copy()
3101 rounding = context._set_rounding(ROUND_HALF_EVEN)
3102 ans = ans._fix(context)
3103 context.rounding = rounding
3104 return ans
3105
3106 def logb(self, context=None):
3107 """ Returns the exponent of the magnitude of self's MSD.
3108
3109 The result is the integer which is the exponent of the magnitude
3110 of the most significant digit of self (as though it were truncated
3111 to a single digit while maintaining the value of that digit and
3112 without limiting the resulting exponent).
3113 """
3114 # logb(NaN) = NaN
3115 ans = self._check_nans(context=context)
3116 if ans:
3117 return ans
3118
3119 if context is None:
3120 context = getcontext()
3121
3122 # logb(+/-Inf) = +Inf
3123 if self._isinfinity():
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003124 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003125
3126 # logb(0) = -Inf, DivisionByZero
3127 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003128 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003129
3130 # otherwise, simply return the adjusted exponent of self, as a
3131 # Decimal. Note that no attempt is made to fit the result
3132 # into the current context.
Mark Dickinson5e672d02009-10-27 16:54:45 +00003133 ans = Decimal(self.adjusted())
3134 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003135
3136 def _islogical(self):
3137 """Return True if self is a logical operand.
3138
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003139 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003140 an exponent of 0, and a coefficient whose digits must all be
3141 either 0 or 1.
3142 """
3143 if self._sign != 0 or self._exp != 0:
3144 return False
3145 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003146 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003147 return False
3148 return True
3149
3150 def _fill_logical(self, context, opa, opb):
3151 dif = context.prec - len(opa)
3152 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003153 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003154 elif dif < 0:
3155 opa = opa[-context.prec:]
3156 dif = context.prec - len(opb)
3157 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003158 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003159 elif dif < 0:
3160 opb = opb[-context.prec:]
3161 return opa, opb
3162
3163 def logical_and(self, other, context=None):
3164 """Applies an 'and' operation between self and other's digits."""
3165 if context is None:
3166 context = getcontext()
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003167
3168 other = _convert_other(other, raiseit=True)
3169
Facundo Batista353750c2007-09-13 18:13:15 +00003170 if not self._islogical() or not other._islogical():
3171 return context._raise_error(InvalidOperation)
3172
3173 # fill to context.prec
3174 (opa, opb) = self._fill_logical(context, self._int, other._int)
3175
3176 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003177 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3178 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003179
3180 def logical_invert(self, context=None):
3181 """Invert all its digits."""
3182 if context is None:
3183 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003184 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3185 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003186
3187 def logical_or(self, other, context=None):
3188 """Applies an 'or' operation between self and other's digits."""
3189 if context is None:
3190 context = getcontext()
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003191
3192 other = _convert_other(other, raiseit=True)
3193
Facundo Batista353750c2007-09-13 18:13:15 +00003194 if not self._islogical() or not other._islogical():
3195 return context._raise_error(InvalidOperation)
3196
3197 # fill to context.prec
3198 (opa, opb) = self._fill_logical(context, self._int, other._int)
3199
3200 # make the operation, and clean starting zeroes
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00003201 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003202 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003203
3204 def logical_xor(self, other, context=None):
3205 """Applies an 'xor' operation between self and other's digits."""
3206 if context is None:
3207 context = getcontext()
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003208
3209 other = _convert_other(other, raiseit=True)
3210
Facundo Batista353750c2007-09-13 18:13:15 +00003211 if not self._islogical() or not other._islogical():
3212 return context._raise_error(InvalidOperation)
3213
3214 # fill to context.prec
3215 (opa, opb) = self._fill_logical(context, self._int, other._int)
3216
3217 # make the operation, and clean starting zeroes
Mark Dickinsonc95c6f12009-01-04 21:30:17 +00003218 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003219 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003220
3221 def max_mag(self, other, context=None):
3222 """Compares the values numerically with their sign ignored."""
3223 other = _convert_other(other, raiseit=True)
3224
Facundo Batista6c398da2007-09-17 17:30:13 +00003225 if context is None:
3226 context = getcontext()
3227
Facundo Batista353750c2007-09-13 18:13:15 +00003228 if self._is_special or other._is_special:
3229 # If one operand is a quiet NaN and the other is number, then the
3230 # number is always returned
3231 sn = self._isnan()
3232 on = other._isnan()
3233 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00003234 if on == 1 and sn == 0:
3235 return self._fix(context)
3236 if sn == 1 and on == 0:
3237 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003238 return self._check_nans(other, context)
3239
Mark Dickinson2fc92632008-02-06 22:10:50 +00003240 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003241 if c == 0:
3242 c = self.compare_total(other)
3243
3244 if c == -1:
3245 ans = other
3246 else:
3247 ans = self
3248
Facundo Batistae64acfa2007-12-17 14:18:42 +00003249 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003250
3251 def min_mag(self, other, context=None):
3252 """Compares the values numerically with their sign ignored."""
3253 other = _convert_other(other, raiseit=True)
3254
Facundo Batista6c398da2007-09-17 17:30:13 +00003255 if context is None:
3256 context = getcontext()
3257
Facundo Batista353750c2007-09-13 18:13:15 +00003258 if self._is_special or other._is_special:
3259 # If one operand is a quiet NaN and the other is number, then the
3260 # number is always returned
3261 sn = self._isnan()
3262 on = other._isnan()
3263 if sn or on:
Mark Dickinson7c62f892008-12-11 09:17:40 +00003264 if on == 1 and sn == 0:
3265 return self._fix(context)
3266 if sn == 1 and on == 0:
3267 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003268 return self._check_nans(other, context)
3269
Mark Dickinson2fc92632008-02-06 22:10:50 +00003270 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003271 if c == 0:
3272 c = self.compare_total(other)
3273
3274 if c == -1:
3275 ans = self
3276 else:
3277 ans = other
3278
Facundo Batistae64acfa2007-12-17 14:18:42 +00003279 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003280
3281 def next_minus(self, context=None):
3282 """Returns the largest representable number smaller than itself."""
3283 if context is None:
3284 context = getcontext()
3285
3286 ans = self._check_nans(context=context)
3287 if ans:
3288 return ans
3289
3290 if self._isinfinity() == -1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003291 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003292 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003293 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003294
3295 context = context.copy()
3296 context._set_rounding(ROUND_FLOOR)
3297 context._ignore_all_flags()
3298 new_self = self._fix(context)
3299 if new_self != self:
3300 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003301 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3302 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003303
3304 def next_plus(self, context=None):
3305 """Returns the smallest representable number larger than itself."""
3306 if context is None:
3307 context = getcontext()
3308
3309 ans = self._check_nans(context=context)
3310 if ans:
3311 return ans
3312
3313 if self._isinfinity() == 1:
Mark Dickinsone4d46b22009-01-03 12:09:22 +00003314 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003315 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003316 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003317
3318 context = context.copy()
3319 context._set_rounding(ROUND_CEILING)
3320 context._ignore_all_flags()
3321 new_self = self._fix(context)
3322 if new_self != self:
3323 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003324 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3325 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003326
3327 def next_toward(self, other, context=None):
3328 """Returns the number closest to self, in the direction towards other.
3329
3330 The result is the closest representable number to self
3331 (excluding self) that is in the direction towards other,
3332 unless both have the same value. If the two operands are
3333 numerically equal, then the result is a copy of self with the
3334 sign set to be the same as the sign of other.
3335 """
3336 other = _convert_other(other, raiseit=True)
3337
3338 if context is None:
3339 context = getcontext()
3340
3341 ans = self._check_nans(other, context)
3342 if ans:
3343 return ans
3344
Mark Dickinson2fc92632008-02-06 22:10:50 +00003345 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003346 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003347 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003348
3349 if comparison == -1:
3350 ans = self.next_plus(context)
3351 else: # comparison == 1
3352 ans = self.next_minus(context)
3353
3354 # decide which flags to raise using value of ans
3355 if ans._isinfinity():
3356 context._raise_error(Overflow,
3357 'Infinite result from next_toward',
3358 ans._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00003359 context._raise_error(Inexact)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00003360 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003361 elif ans.adjusted() < context.Emin:
3362 context._raise_error(Underflow)
3363 context._raise_error(Subnormal)
Facundo Batista353750c2007-09-13 18:13:15 +00003364 context._raise_error(Inexact)
Mark Dickinson1cdfa5f2010-05-04 14:30:32 +00003365 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003366 # if precision == 1 then we don't raise Clamped for a
3367 # result 0E-Etiny.
3368 if not ans:
3369 context._raise_error(Clamped)
3370
3371 return ans
3372
3373 def number_class(self, context=None):
3374 """Returns an indication of the class of self.
3375
3376 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003377 sNaN
3378 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003379 -Infinity
3380 -Normal
3381 -Subnormal
3382 -Zero
3383 +Zero
3384 +Subnormal
3385 +Normal
3386 +Infinity
3387 """
3388 if self.is_snan():
3389 return "sNaN"
3390 if self.is_qnan():
3391 return "NaN"
3392 inf = self._isinfinity()
3393 if inf == 1:
3394 return "+Infinity"
3395 if inf == -1:
3396 return "-Infinity"
3397 if self.is_zero():
3398 if self._sign:
3399 return "-Zero"
3400 else:
3401 return "+Zero"
3402 if context is None:
3403 context = getcontext()
3404 if self.is_subnormal(context=context):
3405 if self._sign:
3406 return "-Subnormal"
3407 else:
3408 return "+Subnormal"
3409 # just a normal, regular, boring number, :)
3410 if self._sign:
3411 return "-Normal"
3412 else:
3413 return "+Normal"
3414
3415 def radix(self):
3416 """Just returns 10, as this is Decimal, :)"""
3417 return Decimal(10)
3418
3419 def rotate(self, other, context=None):
3420 """Returns a rotated copy of self, value-of-other times."""
3421 if context is None:
3422 context = getcontext()
3423
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003424 other = _convert_other(other, raiseit=True)
3425
Facundo Batista353750c2007-09-13 18:13:15 +00003426 ans = self._check_nans(other, context)
3427 if ans:
3428 return ans
3429
3430 if other._exp != 0:
3431 return context._raise_error(InvalidOperation)
3432 if not (-context.prec <= int(other) <= context.prec):
3433 return context._raise_error(InvalidOperation)
3434
3435 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003436 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003437
3438 # get values, pad if necessary
3439 torot = int(other)
3440 rotdig = self._int
3441 topad = context.prec - len(rotdig)
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003442 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003443 rotdig = '0'*topad + rotdig
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003444 elif topad < 0:
3445 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003446
3447 # let's rotate!
3448 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003449 return _dec_from_triple(self._sign,
3450 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003451
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003452 def scaleb(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00003453 """Returns self operand after adding the second value to its exp."""
3454 if context is None:
3455 context = getcontext()
3456
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003457 other = _convert_other(other, raiseit=True)
3458
Facundo Batista353750c2007-09-13 18:13:15 +00003459 ans = self._check_nans(other, context)
3460 if ans:
3461 return ans
3462
3463 if other._exp != 0:
3464 return context._raise_error(InvalidOperation)
3465 liminf = -2 * (context.Emax + context.prec)
3466 limsup = 2 * (context.Emax + context.prec)
3467 if not (liminf <= int(other) <= limsup):
3468 return context._raise_error(InvalidOperation)
3469
3470 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003471 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003472
Facundo Batista72bc54f2007-11-23 17:59:00 +00003473 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003474 d = d._fix(context)
3475 return d
3476
3477 def shift(self, other, context=None):
3478 """Returns a shifted copy of self, value-of-other times."""
3479 if context is None:
3480 context = getcontext()
3481
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003482 other = _convert_other(other, raiseit=True)
3483
Facundo Batista353750c2007-09-13 18:13:15 +00003484 ans = self._check_nans(other, context)
3485 if ans:
3486 return ans
3487
3488 if other._exp != 0:
3489 return context._raise_error(InvalidOperation)
3490 if not (-context.prec <= int(other) <= context.prec):
3491 return context._raise_error(InvalidOperation)
3492
3493 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003494 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003495
3496 # get values, pad if necessary
3497 torot = int(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003498 rotdig = self._int
3499 topad = context.prec - len(rotdig)
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003500 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003501 rotdig = '0'*topad + rotdig
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003502 elif topad < 0:
3503 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003504
3505 # let's shift!
3506 if torot < 0:
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003507 shifted = rotdig[:torot]
Facundo Batista353750c2007-09-13 18:13:15 +00003508 else:
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003509 shifted = rotdig + '0'*torot
3510 shifted = shifted[-context.prec:]
Facundo Batista353750c2007-09-13 18:13:15 +00003511
Facundo Batista72bc54f2007-11-23 17:59:00 +00003512 return _dec_from_triple(self._sign,
Mark Dickinsond8a2e2b2009-10-29 12:16:15 +00003513 shifted.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003514
Facundo Batista59c58842007-04-10 12:58:45 +00003515 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003516 def __reduce__(self):
3517 return (self.__class__, (str(self),))
3518
3519 def __copy__(self):
3520 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003521 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003522 return self.__class__(str(self))
3523
3524 def __deepcopy__(self, memo):
3525 if type(self) == Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003526 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003527 return self.__class__(str(self))
3528
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003529 # PEP 3101 support. See also _parse_format_specifier and _format_align
3530 def __format__(self, specifier, context=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003531 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003532
3533 The specifier should be a standard format specifier, with the
3534 form described in PEP 3101. Formatting types 'e', 'E', 'f',
3535 'F', 'g', 'G', and '%' are supported. If the formatting type
3536 is omitted it defaults to 'g' or 'G', depending on the value
3537 of context.capitals.
3538
3539 At this time the 'n' format specifier type (which is supposed
3540 to use the current locale) is not supported.
3541 """
3542
3543 # Note: PEP 3101 says that if the type is not present then
3544 # there should be at least one digit after the decimal point.
3545 # We take the liberty of ignoring this requirement for
3546 # Decimal---it's presumably there to make sure that
3547 # format(float, '') behaves similarly to str(float).
3548 if context is None:
3549 context = getcontext()
3550
3551 spec = _parse_format_specifier(specifier)
3552
3553 # special values don't care about the type or precision...
3554 if self._is_special:
3555 return _format_align(str(self), spec)
3556
3557 # a type of None defaults to 'g' or 'G', depending on context
3558 # if type is '%', adjust exponent of self accordingly
3559 if spec['type'] is None:
3560 spec['type'] = ['g', 'G'][context.capitals]
3561 elif spec['type'] == '%':
3562 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3563
3564 # round if necessary, taking rounding mode from the context
3565 rounding = context.rounding
3566 precision = spec['precision']
3567 if precision is not None:
3568 if spec['type'] in 'eE':
3569 self = self._round(precision+1, rounding)
3570 elif spec['type'] in 'gG':
3571 if len(self._int) > precision:
3572 self = self._round(precision, rounding)
3573 elif spec['type'] in 'fF%':
3574 self = self._rescale(-precision, rounding)
3575 # special case: zeros with a positive exponent can't be
3576 # represented in fixed point; rescale them to 0e0.
3577 elif not self and self._exp > 0 and spec['type'] in 'fF%':
3578 self = self._rescale(0, rounding)
3579
3580 # figure out placement of the decimal point
3581 leftdigits = self._exp + len(self._int)
3582 if spec['type'] in 'fF%':
3583 dotplace = leftdigits
3584 elif spec['type'] in 'eE':
3585 if not self and precision is not None:
3586 dotplace = 1 - precision
3587 else:
3588 dotplace = 1
3589 elif spec['type'] in 'gG':
3590 if self._exp <= 0 and leftdigits > -6:
3591 dotplace = leftdigits
3592 else:
3593 dotplace = 1
3594
3595 # figure out main part of numeric string...
3596 if dotplace <= 0:
3597 num = '0.' + '0'*(-dotplace) + self._int
3598 elif dotplace >= len(self._int):
3599 # make sure we're not padding a '0' with extra zeros on the right
3600 assert dotplace==len(self._int) or self._int != '0'
3601 num = self._int + '0'*(dotplace-len(self._int))
3602 else:
3603 num = self._int[:dotplace] + '.' + self._int[dotplace:]
3604
3605 # ...then the trailing exponent, or trailing '%'
3606 if leftdigits != dotplace or spec['type'] in 'eE':
3607 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
3608 num = num + "{0}{1:+}".format(echar, leftdigits-dotplace)
3609 elif spec['type'] == '%':
3610 num = num + '%'
3611
3612 # add sign
3613 if self._sign == 1:
3614 num = '-' + num
3615 return _format_align(num, spec)
3616
3617
Facundo Batista72bc54f2007-11-23 17:59:00 +00003618def _dec_from_triple(sign, coefficient, exponent, special=False):
3619 """Create a decimal instance directly, without any validation,
3620 normalization (e.g. removal of leading zeros) or argument
3621 conversion.
3622
3623 This function is for *internal use only*.
3624 """
3625
3626 self = object.__new__(Decimal)
3627 self._sign = sign
3628 self._int = coefficient
3629 self._exp = exponent
3630 self._is_special = special
3631
3632 return self
3633
Raymond Hettinger45fd4762009-02-03 03:42:07 +00003634# Register Decimal as a kind of Number (an abstract base class).
3635# However, do not register it as Real (because Decimals are not
3636# interoperable with floats).
3637_numbers.Number.register(Decimal)
3638
3639
Facundo Batista59c58842007-04-10 12:58:45 +00003640##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003641
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003642
3643# get rounding method function:
Facundo Batista59c58842007-04-10 12:58:45 +00003644rounding_functions = [name for name in Decimal.__dict__.keys()
3645 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003646for name in rounding_functions:
Facundo Batista59c58842007-04-10 12:58:45 +00003647 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003648 globalname = name[1:].upper()
3649 val = globals()[globalname]
3650 Decimal._pick_rounding_function[val] = name
3651
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003652del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003653
Nick Coghlanced12182006-09-02 03:54:17 +00003654class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003655 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003656
Nick Coghlanced12182006-09-02 03:54:17 +00003657 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003658 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003659 """
3660 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003661 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003662 def __enter__(self):
3663 self.saved_context = getcontext()
3664 setcontext(self.new_context)
3665 return self.new_context
3666 def __exit__(self, t, v, tb):
3667 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003668
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003669class Context(object):
3670 """Contains the context for a Decimal instance.
3671
3672 Contains:
3673 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003674 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003675 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003676 raised when it is caused. Otherwise, a value is
3677 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003678 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003679 (Whether or not the trap_enabler is set)
3680 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003681 Emin - Minimum exponent
3682 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003683 capitals - If 1, 1*10^1 is printed as 1E+1.
3684 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003685 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003686 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003687
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003688 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003689 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003690 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003691 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003692 _ignored_flags=None):
Mark Dickinson58338cc2010-07-08 21:27:05 +00003693 # Set defaults; for everything except flags and _ignored_flags,
3694 # inherit from DefaultContext.
3695 try:
3696 dc = DefaultContext
3697 except NameError:
3698 pass
3699
3700 self.prec = prec if prec is not None else dc.prec
3701 self.rounding = rounding if rounding is not None else dc.rounding
3702 self.Emin = Emin if Emin is not None else dc.Emin
3703 self.Emax = Emax if Emax is not None else dc.Emax
3704 self.capitals = capitals if capitals is not None else dc.capitals
3705 self._clamp = _clamp if _clamp is not None else dc._clamp
3706
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003707 if _ignored_flags is None:
Mark Dickinson58338cc2010-07-08 21:27:05 +00003708 self._ignored_flags = []
3709 else:
3710 self._ignored_flags = _ignored_flags
3711
3712 if traps is None:
3713 self.traps = dc.traps.copy()
3714 elif not isinstance(traps, dict):
3715 self.traps = dict((s, int(s in traps)) for s in _signals)
3716 else:
3717 self.traps = traps
3718
3719 if flags is None:
3720 self.flags = dict.fromkeys(_signals, 0)
3721 elif not isinstance(flags, dict):
3722 self.flags = dict((s, int(s in flags)) for s in _signals)
3723 else:
3724 self.flags = flags
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003725
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003726 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003727 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003728 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003729 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3730 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3731 % vars(self))
3732 names = [f.__name__ for f, v in self.flags.items() if v]
3733 s.append('flags=[' + ', '.join(names) + ']')
3734 names = [t.__name__ for t, v in self.traps.items() if v]
3735 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003736 return ', '.join(s) + ')'
3737
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003738 def clear_flags(self):
3739 """Reset all flags to zero"""
3740 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003741 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003742
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003743 def _shallow_copy(self):
3744 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003745 nc = Context(self.prec, self.rounding, self.traps,
3746 self.flags, self.Emin, self.Emax,
3747 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003748 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003749
3750 def copy(self):
3751 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003752 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003753 self.flags.copy(), self.Emin, self.Emax,
3754 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003755 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003756 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003757
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003758 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003759 """Handles an error
3760
3761 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003762 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah94908512010-05-19 15:50:05 +00003763 trap_enabler is set, it reraises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003764 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003765 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003766 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003767 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003768 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003769 return error().handle(self, *args)
3770
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003771 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003772 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003773 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003774 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003775
3776 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003777 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003778 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003779
3780 def _ignore_all_flags(self):
3781 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003782 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003783
3784 def _ignore_flags(self, *flags):
3785 """Ignore the flags, if they are raised"""
3786 # Do not mutate-- This way, copies of a context leave the original
3787 # alone.
3788 self._ignored_flags = (self._ignored_flags + list(flags))
3789 return list(flags)
3790
3791 def _regard_flags(self, *flags):
3792 """Stop ignoring the flags, if they are raised"""
3793 if flags and isinstance(flags[0], (tuple,list)):
3794 flags = flags[0]
3795 for flag in flags:
3796 self._ignored_flags.remove(flag)
3797
Nick Coghlan53663a62008-07-15 14:27:37 +00003798 # We inherit object.__hash__, so we must deny this explicitly
3799 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003800
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003801 def Etiny(self):
3802 """Returns Etiny (= Emin - prec + 1)"""
3803 return int(self.Emin - self.prec + 1)
3804
3805 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003806 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003807 return int(self.Emax - self.prec + 1)
3808
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003809 def _set_rounding(self, type):
3810 """Sets the rounding type.
3811
3812 Sets the rounding type, and returns the current (previous)
3813 rounding type. Often used like:
3814
3815 context = context.copy()
3816 # so you don't change the calling context
3817 # if an error occurs in the middle.
3818 rounding = context._set_rounding(ROUND_UP)
3819 val = self.__sub__(other, context=context)
3820 context._set_rounding(rounding)
3821
3822 This will make it round up for that operation.
3823 """
3824 rounding = self.rounding
3825 self.rounding= type
3826 return rounding
3827
Raymond Hettingerfed52962004-07-14 15:41:57 +00003828 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003829 """Creates a new Decimal instance but using self as context.
3830
3831 This method implements the to-number operation of the
3832 IBM Decimal specification."""
3833
3834 if isinstance(num, basestring) and num != num.strip():
3835 return self._raise_error(ConversionSyntax,
3836 "no trailing or leading whitespace is "
3837 "permitted.")
3838
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003839 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003840 if d._isnan() and len(d._int) > self.prec - self._clamp:
3841 return self._raise_error(ConversionSyntax,
3842 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003843 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003844
Facundo Batista59c58842007-04-10 12:58:45 +00003845 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003846 def abs(self, a):
3847 """Returns the absolute value of the operand.
3848
3849 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003850 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003851 the plus operation on the operand.
3852
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003853 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003854 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003855 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003856 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003857 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003858 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003859 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003860 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003861 """
3862 return a.__abs__(context=self)
3863
3864 def add(self, a, b):
3865 """Return the sum of the two operands.
3866
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003867 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003868 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003869 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003870 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003871 """
3872 return a.__add__(b, context=self)
3873
3874 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003875 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003876
Facundo Batista353750c2007-09-13 18:13:15 +00003877 def canonical(self, a):
3878 """Returns the same Decimal object.
3879
3880 As we do not have different encodings for the same number, the
3881 received object already is in its canonical form.
3882
3883 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003884 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003885 """
3886 return a.canonical(context=self)
3887
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003888 def compare(self, a, b):
3889 """Compares values numerically.
3890
3891 If the signs of the operands differ, a value representing each operand
3892 ('-1' if the operand is less than zero, '0' if the operand is zero or
3893 negative zero, or '1' if the operand is greater than zero) is used in
3894 place of that operand for the comparison instead of the actual
3895 operand.
3896
3897 The comparison is then effected by subtracting the second operand from
3898 the first and then returning a value according to the result of the
3899 subtraction: '-1' if the result is less than zero, '0' if the result is
3900 zero or negative zero, or '1' if the result is greater than zero.
3901
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003902 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003903 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003904 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003905 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003906 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003907 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003908 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003909 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003910 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003911 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003912 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003913 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003914 """
3915 return a.compare(b, context=self)
3916
Facundo Batista353750c2007-09-13 18:13:15 +00003917 def compare_signal(self, a, b):
3918 """Compares the values of the two operands numerically.
3919
3920 It's pretty much like compare(), but all NaNs signal, with signaling
3921 NaNs taking precedence over quiet NaNs.
3922
3923 >>> c = ExtendedContext
3924 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003925 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003926 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003927 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003928 >>> c.flags[InvalidOperation] = 0
3929 >>> print c.flags[InvalidOperation]
3930 0
3931 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003932 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003933 >>> print c.flags[InvalidOperation]
3934 1
3935 >>> c.flags[InvalidOperation] = 0
3936 >>> print c.flags[InvalidOperation]
3937 0
3938 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003939 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003940 >>> print c.flags[InvalidOperation]
3941 1
3942 """
3943 return a.compare_signal(b, context=self)
3944
3945 def compare_total(self, a, b):
3946 """Compares two operands using their abstract representation.
3947
3948 This is not like the standard compare, which use their numerical
3949 value. Note that a total ordering is defined for all possible abstract
3950 representations.
3951
3952 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003953 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003954 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003955 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003956 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003957 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003958 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003959 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003960 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003961 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00003962 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003963 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003964 """
3965 return a.compare_total(b)
3966
3967 def compare_total_mag(self, a, b):
3968 """Compares two operands using their abstract representation ignoring sign.
3969
3970 Like compare_total, but with operand's sign ignored and assumed to be 0.
3971 """
3972 return a.compare_total_mag(b)
3973
3974 def copy_abs(self, a):
3975 """Returns a copy of the operand with the sign set to 0.
3976
3977 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003978 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003979 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003980 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00003981 """
3982 return a.copy_abs()
3983
3984 def copy_decimal(self, a):
3985 """Returns a copy of the decimal objet.
3986
3987 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003988 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00003989 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003990 Decimal('-1.00')
Facundo Batista353750c2007-09-13 18:13:15 +00003991 """
Facundo Batista6c398da2007-09-17 17:30:13 +00003992 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00003993
3994 def copy_negate(self, a):
3995 """Returns a copy of the operand with the sign inverted.
3996
3997 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003998 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00003999 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004000 Decimal('101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00004001 """
4002 return a.copy_negate()
4003
4004 def copy_sign(self, a, b):
4005 """Copies the second operand's sign to the first one.
4006
4007 In detail, it returns a copy of the first operand with the sign
4008 equal to the sign of the second operand.
4009
4010 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004011 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004012 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004013 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004014 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004015 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004016 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004017 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004018 """
4019 return a.copy_sign(b)
4020
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004021 def divide(self, a, b):
4022 """Decimal division in a specified context.
4023
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004024 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004025 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004026 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004027 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004028 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004029 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004030 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004031 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004032 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004033 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004034 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004035 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004036 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004037 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004038 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004039 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004040 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004041 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004042 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004043 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004044 """
4045 return a.__div__(b, context=self)
4046
4047 def divide_int(self, a, b):
4048 """Divides two numbers and returns the integer part of the result.
4049
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004050 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004051 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004052 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004053 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004054 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004055 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004056 """
4057 return a.__floordiv__(b, context=self)
4058
4059 def divmod(self, a, b):
Mark Dickinson8b1587f2010-01-06 16:21:27 +00004060 """Return (a // b, a % b)
4061
4062 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4063 (Decimal('2'), Decimal('2'))
4064 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4065 (Decimal('2'), Decimal('0'))
4066 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004067 return a.__divmod__(b, context=self)
4068
Facundo Batista353750c2007-09-13 18:13:15 +00004069 def exp(self, a):
4070 """Returns e ** a.
4071
4072 >>> c = ExtendedContext.copy()
4073 >>> c.Emin = -999
4074 >>> c.Emax = 999
4075 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004076 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004077 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004078 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00004079 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004080 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004081 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004082 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00004083 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004084 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004085 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004086 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004087 """
4088 return a.exp(context=self)
4089
4090 def fma(self, a, b, c):
4091 """Returns a multiplied by b, plus c.
4092
4093 The first two operands are multiplied together, using multiply,
4094 the third operand is then added to the result of that
4095 multiplication, using add, all with only one final rounding.
4096
4097 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004098 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004099 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004100 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004101 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004102 Decimal('1.38435736E+12')
Facundo Batista353750c2007-09-13 18:13:15 +00004103 """
4104 return a.fma(b, c, context=self)
4105
4106 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004107 """Return True if the operand is canonical; otherwise return False.
4108
4109 Currently, the encoding of a Decimal instance is always
4110 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004111
4112 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004113 True
Facundo Batista353750c2007-09-13 18:13:15 +00004114 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004115 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004116
4117 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004118 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004119
Facundo Batista1a191df2007-10-02 17:01:24 +00004120 A Decimal instance is considered finite if it is neither
4121 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004122
4123 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004124 True
Facundo Batista353750c2007-09-13 18:13:15 +00004125 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004126 True
Facundo Batista353750c2007-09-13 18:13:15 +00004127 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004128 True
Facundo Batista353750c2007-09-13 18:13:15 +00004129 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004130 False
Facundo Batista353750c2007-09-13 18:13:15 +00004131 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004132 False
Facundo Batista353750c2007-09-13 18:13:15 +00004133 """
4134 return a.is_finite()
4135
4136 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004137 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004138
4139 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004140 False
Facundo Batista353750c2007-09-13 18:13:15 +00004141 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004142 True
Facundo Batista353750c2007-09-13 18:13:15 +00004143 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004144 False
Facundo Batista353750c2007-09-13 18:13:15 +00004145 """
4146 return a.is_infinite()
4147
4148 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004149 """Return True if the operand is a qNaN or sNaN;
4150 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004151
4152 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004153 False
Facundo Batista353750c2007-09-13 18:13:15 +00004154 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004155 True
Facundo Batista353750c2007-09-13 18:13:15 +00004156 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004157 True
Facundo Batista353750c2007-09-13 18:13:15 +00004158 """
4159 return a.is_nan()
4160
4161 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004162 """Return True if the operand is a normal number;
4163 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004164
4165 >>> c = ExtendedContext.copy()
4166 >>> c.Emin = -999
4167 >>> c.Emax = 999
4168 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004169 True
Facundo Batista353750c2007-09-13 18:13:15 +00004170 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004171 False
Facundo Batista353750c2007-09-13 18:13:15 +00004172 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004173 False
Facundo Batista353750c2007-09-13 18:13:15 +00004174 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004175 False
Facundo Batista353750c2007-09-13 18:13:15 +00004176 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004177 False
Facundo Batista353750c2007-09-13 18:13:15 +00004178 """
4179 return a.is_normal(context=self)
4180
4181 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004182 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004183
4184 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004185 False
Facundo Batista353750c2007-09-13 18:13:15 +00004186 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004187 True
Facundo Batista353750c2007-09-13 18:13:15 +00004188 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004189 False
Facundo Batista353750c2007-09-13 18:13:15 +00004190 """
4191 return a.is_qnan()
4192
4193 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004194 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004195
4196 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004197 False
Facundo Batista353750c2007-09-13 18:13:15 +00004198 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004199 True
Facundo Batista353750c2007-09-13 18:13:15 +00004200 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004201 True
Facundo Batista353750c2007-09-13 18:13:15 +00004202 """
4203 return a.is_signed()
4204
4205 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004206 """Return True if the operand is a signaling NaN;
4207 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004208
4209 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004210 False
Facundo Batista353750c2007-09-13 18:13:15 +00004211 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004212 False
Facundo Batista353750c2007-09-13 18:13:15 +00004213 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004214 True
Facundo Batista353750c2007-09-13 18:13:15 +00004215 """
4216 return a.is_snan()
4217
4218 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004219 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004220
4221 >>> c = ExtendedContext.copy()
4222 >>> c.Emin = -999
4223 >>> c.Emax = 999
4224 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004225 False
Facundo Batista353750c2007-09-13 18:13:15 +00004226 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004227 True
Facundo Batista353750c2007-09-13 18:13:15 +00004228 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004229 False
Facundo Batista353750c2007-09-13 18:13:15 +00004230 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004231 False
Facundo Batista353750c2007-09-13 18:13:15 +00004232 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004233 False
Facundo Batista353750c2007-09-13 18:13:15 +00004234 """
4235 return a.is_subnormal(context=self)
4236
4237 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004238 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004239
4240 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004241 True
Facundo Batista353750c2007-09-13 18:13:15 +00004242 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004243 False
Facundo Batista353750c2007-09-13 18:13:15 +00004244 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004245 True
Facundo Batista353750c2007-09-13 18:13:15 +00004246 """
4247 return a.is_zero()
4248
4249 def ln(self, a):
4250 """Returns the natural (base e) logarithm of the operand.
4251
4252 >>> c = ExtendedContext.copy()
4253 >>> c.Emin = -999
4254 >>> c.Emax = 999
4255 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004256 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004257 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004258 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004259 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004260 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004261 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004262 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004263 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004264 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004265 """
4266 return a.ln(context=self)
4267
4268 def log10(self, a):
4269 """Returns the base 10 logarithm of the operand.
4270
4271 >>> c = ExtendedContext.copy()
4272 >>> c.Emin = -999
4273 >>> c.Emax = 999
4274 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004275 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004276 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004277 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004278 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004279 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004280 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004281 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004282 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004283 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004284 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004285 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004286 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004287 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004288 """
4289 return a.log10(context=self)
4290
4291 def logb(self, a):
4292 """ Returns the exponent of the magnitude of the operand's MSD.
4293
4294 The result is the integer which is the exponent of the magnitude
4295 of the most significant digit of the operand (as though the
4296 operand were truncated to a single digit while maintaining the
4297 value of that digit and without limiting the resulting exponent).
4298
4299 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004300 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004301 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004302 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004303 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004304 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004305 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004306 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004307 """
4308 return a.logb(context=self)
4309
4310 def logical_and(self, a, b):
4311 """Applies the logical operation 'and' between each operand's digits.
4312
4313 The operands must be both logical numbers.
4314
4315 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004316 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004317 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004318 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004319 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004320 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004321 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004322 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004323 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004324 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004325 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004326 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004327 """
4328 return a.logical_and(b, context=self)
4329
4330 def logical_invert(self, a):
4331 """Invert all the digits in the operand.
4332
4333 The operand must be a logical number.
4334
4335 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004336 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004337 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004338 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004339 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004340 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004341 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004342 Decimal('10101010')
Facundo Batista353750c2007-09-13 18:13:15 +00004343 """
4344 return a.logical_invert(context=self)
4345
4346 def logical_or(self, a, b):
4347 """Applies the logical operation 'or' between each operand's digits.
4348
4349 The operands must be both logical numbers.
4350
4351 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004352 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004353 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004354 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004355 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004356 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004357 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004358 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004359 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004360 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004361 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004362 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004363 """
4364 return a.logical_or(b, context=self)
4365
4366 def logical_xor(self, a, b):
4367 """Applies the logical operation 'xor' between each operand's digits.
4368
4369 The operands must be both logical numbers.
4370
4371 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004372 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004373 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004374 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004375 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004376 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004377 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004378 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004379 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004380 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004381 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004382 Decimal('1101')
Facundo Batista353750c2007-09-13 18:13:15 +00004383 """
4384 return a.logical_xor(b, context=self)
4385
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004386 def max(self, a,b):
4387 """max compares two values numerically and returns the maximum.
4388
4389 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004390 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004391 operation. If they are numerically equal then the left-hand operand
4392 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004393 infinity) of the two operands is chosen as the result.
4394
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004395 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004396 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004397 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004398 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004399 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004400 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004401 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004402 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004403 """
4404 return a.max(b, context=self)
4405
Facundo Batista353750c2007-09-13 18:13:15 +00004406 def max_mag(self, a, b):
4407 """Compares the values numerically with their sign ignored."""
4408 return a.max_mag(b, context=self)
4409
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004410 def min(self, a,b):
4411 """min compares two values numerically and returns the minimum.
4412
4413 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004414 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004415 operation. If they are numerically equal then the left-hand operand
4416 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004417 infinity) of the two operands is chosen as the result.
4418
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004419 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004420 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004421 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004422 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004423 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004424 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004425 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004426 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004427 """
4428 return a.min(b, context=self)
4429
Facundo Batista353750c2007-09-13 18:13:15 +00004430 def min_mag(self, a, b):
4431 """Compares the values numerically with their sign ignored."""
4432 return a.min_mag(b, context=self)
4433
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004434 def minus(self, a):
4435 """Minus corresponds to unary prefix minus in Python.
4436
4437 The operation is evaluated using the same rules as subtract; the
4438 operation minus(a) is calculated as subtract('0', a) where the '0'
4439 has the same exponent as the operand.
4440
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004441 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004442 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004443 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004444 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004445 """
4446 return a.__neg__(context=self)
4447
4448 def multiply(self, a, b):
4449 """multiply multiplies two operands.
4450
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004451 If either operand is a special value then the general rules apply.
4452 Otherwise, the operands are multiplied together ('long multiplication'),
4453 resulting in a number which may be as long as the sum of the lengths
4454 of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004455
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004456 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004457 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004458 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004459 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004460 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004461 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004462 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004463 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004464 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004465 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004466 """
4467 return a.__mul__(b, context=self)
4468
Facundo Batista353750c2007-09-13 18:13:15 +00004469 def next_minus(self, a):
4470 """Returns the largest representable number smaller than a.
4471
4472 >>> c = ExtendedContext.copy()
4473 >>> c.Emin = -999
4474 >>> c.Emax = 999
4475 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004476 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004477 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004478 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004479 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004480 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004481 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004482 Decimal('9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004483 """
4484 return a.next_minus(context=self)
4485
4486 def next_plus(self, a):
4487 """Returns the smallest representable number larger than a.
4488
4489 >>> c = ExtendedContext.copy()
4490 >>> c.Emin = -999
4491 >>> c.Emax = 999
4492 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004493 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004494 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004495 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004496 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004497 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004498 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004499 Decimal('-9.99999999E+999')
Facundo Batista353750c2007-09-13 18:13:15 +00004500 """
4501 return a.next_plus(context=self)
4502
4503 def next_toward(self, a, b):
4504 """Returns the number closest to a, in direction towards b.
4505
4506 The result is the closest representable number from the first
4507 operand (but not the first operand) that is in the direction
4508 towards the second operand, unless the operands have the same
4509 value.
4510
4511 >>> c = ExtendedContext.copy()
4512 >>> c.Emin = -999
4513 >>> c.Emax = 999
4514 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004515 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004516 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004517 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004518 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004519 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004520 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004521 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004522 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004523 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004524 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004525 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004526 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004527 Decimal('-0.00')
Facundo Batista353750c2007-09-13 18:13:15 +00004528 """
4529 return a.next_toward(b, context=self)
4530
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004531 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004532 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004533
4534 Essentially a plus operation with all trailing zeros removed from the
4535 result.
4536
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004537 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004538 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004539 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004540 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004541 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004542 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004543 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004544 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004545 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004546 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004547 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004548 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004549 """
4550 return a.normalize(context=self)
4551
Facundo Batista353750c2007-09-13 18:13:15 +00004552 def number_class(self, a):
4553 """Returns an indication of the class of the operand.
4554
4555 The class is one of the following strings:
4556 -sNaN
4557 -NaN
4558 -Infinity
4559 -Normal
4560 -Subnormal
4561 -Zero
4562 +Zero
4563 +Subnormal
4564 +Normal
4565 +Infinity
4566
4567 >>> c = Context(ExtendedContext)
4568 >>> c.Emin = -999
4569 >>> c.Emax = 999
4570 >>> c.number_class(Decimal('Infinity'))
4571 '+Infinity'
4572 >>> c.number_class(Decimal('1E-10'))
4573 '+Normal'
4574 >>> c.number_class(Decimal('2.50'))
4575 '+Normal'
4576 >>> c.number_class(Decimal('0.1E-999'))
4577 '+Subnormal'
4578 >>> c.number_class(Decimal('0'))
4579 '+Zero'
4580 >>> c.number_class(Decimal('-0'))
4581 '-Zero'
4582 >>> c.number_class(Decimal('-0.1E-999'))
4583 '-Subnormal'
4584 >>> c.number_class(Decimal('-1E-10'))
4585 '-Normal'
4586 >>> c.number_class(Decimal('-2.50'))
4587 '-Normal'
4588 >>> c.number_class(Decimal('-Infinity'))
4589 '-Infinity'
4590 >>> c.number_class(Decimal('NaN'))
4591 'NaN'
4592 >>> c.number_class(Decimal('-NaN'))
4593 'NaN'
4594 >>> c.number_class(Decimal('sNaN'))
4595 'sNaN'
4596 """
4597 return a.number_class(context=self)
4598
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004599 def plus(self, a):
4600 """Plus corresponds to unary prefix plus in Python.
4601
4602 The operation is evaluated using the same rules as add; the
4603 operation plus(a) is calculated as add('0', a) where the '0'
4604 has the same exponent as the operand.
4605
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004606 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004607 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004608 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004609 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004610 """
4611 return a.__pos__(context=self)
4612
4613 def power(self, a, b, modulo=None):
4614 """Raises a to the power of b, to modulo if given.
4615
Facundo Batista353750c2007-09-13 18:13:15 +00004616 With two arguments, compute a**b. If a is negative then b
4617 must be integral. The result will be inexact unless b is
4618 integral and the result is finite and can be expressed exactly
4619 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004620
Facundo Batista353750c2007-09-13 18:13:15 +00004621 With three arguments, compute (a**b) % modulo. For the
4622 three argument form, the following restrictions on the
4623 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004624
Facundo Batista353750c2007-09-13 18:13:15 +00004625 - all three arguments must be integral
4626 - b must be nonnegative
4627 - at least one of a or b must be nonzero
4628 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004629
Facundo Batista353750c2007-09-13 18:13:15 +00004630 The result of pow(a, b, modulo) is identical to the result
4631 that would be obtained by computing (a**b) % modulo with
4632 unbounded precision, but is computed more efficiently. It is
4633 always exact.
4634
4635 >>> c = ExtendedContext.copy()
4636 >>> c.Emin = -999
4637 >>> c.Emax = 999
4638 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004639 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004640 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004641 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004642 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004643 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004644 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004645 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004646 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004647 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004648 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004649 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004650 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004651 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004652 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004653 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004654 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004655 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004656 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004657 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004658 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004659 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004660 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004661 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004662 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004663 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004664
4665 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004666 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004667 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004668 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00004669 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004670 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004671 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004672 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004673 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004674 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00004675 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004676 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004677 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004678 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004679 """
4680 return a.__pow__(b, modulo, context=self)
4681
4682 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00004683 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004684
4685 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00004686 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004687 exponent is being increased), multiplied by a positive power of ten (if
4688 the exponent is being decreased), or is unchanged (if the exponent is
4689 already equal to that of the right-hand operand).
4690
4691 Unlike other operations, if the length of the coefficient after the
4692 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00004693 operation condition is raised. This guarantees that, unless there is
4694 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004695 equal to that of the right-hand operand.
4696
4697 Also unlike other operations, quantize will never raise Underflow, even
4698 if the result is subnormal and inexact.
4699
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004700 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004701 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004702 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004703 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004704 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004705 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004706 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004707 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004708 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004709 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004710 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004711 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004712 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004713 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004714 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004715 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004716 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004717 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004718 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004719 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004720 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004721 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004722 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004723 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004724 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004725 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004726 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004727 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004728 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004729 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004730 """
4731 return a.quantize(b, context=self)
4732
Facundo Batista353750c2007-09-13 18:13:15 +00004733 def radix(self):
4734 """Just returns 10, as this is Decimal, :)
4735
4736 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00004737 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00004738 """
4739 return Decimal(10)
4740
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004741 def remainder(self, a, b):
4742 """Returns the remainder from integer division.
4743
4744 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00004745 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00004746 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00004747 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004748
4749 This operation will fail under the same conditions as integer division
4750 (that is, if integer division on the same two operands would fail, the
4751 remainder cannot be calculated).
4752
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004753 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004754 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004755 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004756 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004757 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004758 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004759 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004760 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004761 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004762 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004763 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004764 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004765 """
4766 return a.__mod__(b, context=self)
4767
4768 def remainder_near(self, a, b):
4769 """Returns to be "a - b * n", where n is the integer nearest the exact
4770 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00004771 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004772 sign of a.
4773
4774 This operation will fail under the same conditions as integer division
4775 (that is, if integer division on the same two operands would fail, the
4776 remainder cannot be calculated).
4777
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004778 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004779 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004780 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004781 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004782 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004783 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004784 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004785 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004786 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004787 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004788 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004789 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004790 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004791 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004792 """
4793 return a.remainder_near(b, context=self)
4794
Facundo Batista353750c2007-09-13 18:13:15 +00004795 def rotate(self, a, b):
4796 """Returns a rotated copy of a, b times.
4797
4798 The coefficient of the result is a rotated copy of the digits in
4799 the coefficient of the first operand. The number of places of
4800 rotation is taken from the absolute value of the second operand,
4801 with the rotation being to the left if the second operand is
4802 positive or to the right otherwise.
4803
4804 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004805 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00004806 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004807 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00004808 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004809 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004810 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004811 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004812 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004813 Decimal('345678912')
Facundo Batista353750c2007-09-13 18:13:15 +00004814 """
4815 return a.rotate(b, context=self)
4816
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004817 def same_quantum(self, a, b):
4818 """Returns True if the two operands have the same exponent.
4819
4820 The result is never affected by either the sign or the coefficient of
4821 either operand.
4822
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004823 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004824 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004825 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004826 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004827 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004828 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004829 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004830 True
4831 """
4832 return a.same_quantum(b)
4833
Facundo Batista353750c2007-09-13 18:13:15 +00004834 def scaleb (self, a, b):
4835 """Returns the first operand after adding the second value its exp.
4836
4837 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004838 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00004839 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004840 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004841 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004842 Decimal('7.50E+3')
Facundo Batista353750c2007-09-13 18:13:15 +00004843 """
4844 return a.scaleb (b, context=self)
4845
4846 def shift(self, a, b):
4847 """Returns a shifted copy of a, b times.
4848
4849 The coefficient of the result is a shifted copy of the digits
4850 in the coefficient of the first operand. The number of places
4851 to shift is taken from the absolute value of the second operand,
4852 with the shift being to the left if the second operand is
4853 positive or to the right otherwise. Digits shifted into the
4854 coefficient are zeros.
4855
4856 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004857 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004858 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004859 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004860 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004861 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00004862 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004863 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00004864 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004865 Decimal('345678900')
Facundo Batista353750c2007-09-13 18:13:15 +00004866 """
4867 return a.shift(b, context=self)
4868
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004869 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00004870 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004871
4872 If the result must be inexact, it is rounded using the round-half-even
4873 algorithm.
4874
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004875 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004876 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004877 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004878 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004879 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004880 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004881 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004882 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004883 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004884 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004885 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004886 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004887 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004888 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004889 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004890 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004891 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004892 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004893 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00004894 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004895 """
4896 return a.sqrt(context=self)
4897
4898 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00004899 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004900
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004901 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004902 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004903 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004904 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004905 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004906 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004907 """
4908 return a.__sub__(b, context=self)
4909
4910 def to_eng_string(self, a):
4911 """Converts a number to a string, using scientific notation.
4912
4913 The operation is not affected by the context.
4914 """
4915 return a.to_eng_string(context=self)
4916
4917 def to_sci_string(self, a):
4918 """Converts a number to a string, using scientific notation.
4919
4920 The operation is not affected by the context.
4921 """
4922 return a.__str__(context=self)
4923
Facundo Batista353750c2007-09-13 18:13:15 +00004924 def to_integral_exact(self, a):
4925 """Rounds to an integer.
4926
4927 When the operand has a negative exponent, the result is the same
4928 as using the quantize() operation using the given operand as the
4929 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4930 of the operand as the precision setting; Inexact and Rounded flags
4931 are allowed in this operation. The rounding mode is taken from the
4932 context.
4933
4934 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004935 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004936 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004937 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004938 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004939 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004940 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004941 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004942 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004943 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004944 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004945 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004946 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004947 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004948 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004949 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004950 """
4951 return a.to_integral_exact(context=self)
4952
4953 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004954 """Rounds to an integer.
4955
4956 When the operand has a negative exponent, the result is the same
4957 as using the quantize() operation using the given operand as the
4958 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4959 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00004960 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004961
Facundo Batista353750c2007-09-13 18:13:15 +00004962 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004963 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004964 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004965 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004966 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004967 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004968 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004969 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00004970 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004971 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00004972 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004973 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00004974 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004975 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00004976 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004977 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004978 """
Facundo Batista353750c2007-09-13 18:13:15 +00004979 return a.to_integral_value(context=self)
4980
4981 # the method name changed, but we provide also the old one, for compatibility
4982 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004983
4984class _WorkRep(object):
4985 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00004986 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004987 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004988 # exp: None, int, or string
4989
4990 def __init__(self, value=None):
4991 if value is None:
4992 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00004993 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004994 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00004995 elif isinstance(value, Decimal):
4996 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00004997 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004998 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00004999 else:
5000 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005001 self.sign = value[0]
5002 self.int = value[1]
5003 self.exp = value[2]
5004
5005 def __repr__(self):
5006 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5007
5008 __str__ = __repr__
5009
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005010
5011
Facundo Batistae64acfa2007-12-17 14:18:42 +00005012def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005013 """Normalizes op1, op2 to have the same exp and length of coefficient.
5014
5015 Done during addition.
5016 """
Facundo Batista353750c2007-09-13 18:13:15 +00005017 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005018 tmp = op2
5019 other = op1
5020 else:
5021 tmp = op1
5022 other = op2
5023
Facundo Batista353750c2007-09-13 18:13:15 +00005024 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5025 # Then adding 10**exp to tmp has the same effect (after rounding)
5026 # as adding any positive quantity smaller than 10**exp; similarly
5027 # for subtraction. So if other is smaller than 10**exp we replace
5028 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00005029 tmp_len = len(str(tmp.int))
5030 other_len = len(str(other.int))
5031 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5032 if other_len + other.exp - 1 < exp:
5033 other.int = 1
5034 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005035
Facundo Batista353750c2007-09-13 18:13:15 +00005036 tmp.int *= 10 ** (tmp.exp - other.exp)
5037 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005038 return op1, op2
5039
Facundo Batista353750c2007-09-13 18:13:15 +00005040##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
5041
5042# This function from Tim Peters was taken from here:
5043# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5044# The correction being in the function definition is for speed, and
5045# the whole function is not resolved with math.log because of avoiding
5046# the use of floats.
5047def _nbits(n, correction = {
5048 '0': 4, '1': 3, '2': 2, '3': 2,
5049 '4': 1, '5': 1, '6': 1, '7': 1,
5050 '8': 0, '9': 0, 'a': 0, 'b': 0,
5051 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5052 """Number of bits in binary representation of the positive integer n,
5053 or 0 if n == 0.
5054 """
5055 if n < 0:
5056 raise ValueError("The argument to _nbits should be nonnegative.")
5057 hex_n = "%x" % n
5058 return 4*len(hex_n) - correction[hex_n[0]]
5059
5060def _sqrt_nearest(n, a):
5061 """Closest integer to the square root of the positive integer n. a is
5062 an initial approximation to the square root. Any positive integer
5063 will do for a, but the closer a is to the square root of n the
5064 faster convergence will be.
5065
5066 """
5067 if n <= 0 or a <= 0:
5068 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5069
5070 b=0
5071 while a != b:
5072 b, a = a, a--n//a>>1
5073 return a
5074
5075def _rshift_nearest(x, shift):
5076 """Given an integer x and a nonnegative integer shift, return closest
5077 integer to x / 2**shift; use round-to-even in case of a tie.
5078
5079 """
5080 b, q = 1L << shift, x >> shift
5081 return q + (2*(x & (b-1)) + (q&1) > b)
5082
5083def _div_nearest(a, b):
5084 """Closest integer to a/b, a and b positive integers; rounds to even
5085 in the case of a tie.
5086
5087 """
5088 q, r = divmod(a, b)
5089 return q + (2*r + (q&1) > b)
5090
5091def _ilog(x, M, L = 8):
5092 """Integer approximation to M*log(x/M), with absolute error boundable
5093 in terms only of x/M.
5094
5095 Given positive integers x and M, return an integer approximation to
5096 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5097 between the approximation and the exact result is at most 22. For
5098 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5099 both cases these are upper bounds on the error; it will usually be
5100 much smaller."""
5101
5102 # The basic algorithm is the following: let log1p be the function
5103 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5104 # the reduction
5105 #
5106 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5107 #
5108 # repeatedly until the argument to log1p is small (< 2**-L in
5109 # absolute value). For small y we can use the Taylor series
5110 # expansion
5111 #
5112 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5113 #
5114 # truncating at T such that y**T is small enough. The whole
5115 # computation is carried out in a form of fixed-point arithmetic,
5116 # with a real number z being represented by an integer
5117 # approximation to z*M. To avoid loss of precision, the y below
5118 # is actually an integer approximation to 2**R*y*M, where R is the
5119 # number of reductions performed so far.
5120
5121 y = x-M
5122 # argument reduction; R = number of reductions performed
5123 R = 0
5124 while (R <= L and long(abs(y)) << L-R >= M or
5125 R > L and abs(y) >> R-L >= M):
5126 y = _div_nearest(long(M*y) << 1,
5127 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5128 R += 1
5129
5130 # Taylor series with T terms
5131 T = -int(-10*len(str(M))//(3*L))
5132 yshift = _rshift_nearest(y, R)
5133 w = _div_nearest(M, T)
5134 for k in xrange(T-1, 0, -1):
5135 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5136
5137 return _div_nearest(w*y, M)
5138
5139def _dlog10(c, e, p):
5140 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5141 approximation to 10**p * log10(c*10**e), with an absolute error of
5142 at most 1. Assumes that c*10**e is not exactly 1."""
5143
5144 # increase precision by 2; compensate for this by dividing
5145 # final result by 100
5146 p += 2
5147
5148 # write c*10**e as d*10**f with either:
5149 # f >= 0 and 1 <= d <= 10, or
5150 # f <= 0 and 0.1 <= d <= 1.
5151 # Thus for c*10**e close to 1, f = 0
5152 l = len(str(c))
5153 f = e+l - (e+l >= 1)
5154
5155 if p > 0:
5156 M = 10**p
5157 k = e+p-f
5158 if k >= 0:
5159 c *= 10**k
5160 else:
5161 c = _div_nearest(c, 10**-k)
5162
5163 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005164 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005165 log_d = _div_nearest(log_d*M, log_10)
5166 log_tenpower = f*M # exact
5167 else:
5168 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005169 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005170
5171 return _div_nearest(log_tenpower+log_d, 100)
5172
5173def _dlog(c, e, p):
5174 """Given integers c, e and p with c > 0, compute an integer
5175 approximation to 10**p * log(c*10**e), with an absolute error of
5176 at most 1. Assumes that c*10**e is not exactly 1."""
5177
5178 # Increase precision by 2. The precision increase is compensated
5179 # for at the end with a division by 100.
5180 p += 2
5181
5182 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5183 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5184 # as 10**p * log(d) + 10**p*f * log(10).
5185 l = len(str(c))
5186 f = e+l - (e+l >= 1)
5187
5188 # compute approximation to 10**p*log(d), with error < 27
5189 if p > 0:
5190 k = e+p-f
5191 if k >= 0:
5192 c *= 10**k
5193 else:
5194 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5195
5196 # _ilog magnifies existing error in c by a factor of at most 10
5197 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5198 else:
5199 # p <= 0: just approximate the whole thing by 0; error < 2.31
5200 log_d = 0
5201
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005202 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005203 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005204 extra = len(str(abs(f)))-1
5205 if p + extra >= 0:
5206 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5207 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5208 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005209 else:
5210 f_log_ten = 0
5211 else:
5212 f_log_ten = 0
5213
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005214 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005215 return _div_nearest(f_log_ten + log_d, 100)
5216
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005217class _Log10Memoize(object):
5218 """Class to compute, store, and allow retrieval of, digits of the
5219 constant log(10) = 2.302585.... This constant is needed by
5220 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5221 def __init__(self):
5222 self.digits = "23025850929940456840179914546843642076011014886"
5223
5224 def getdigits(self, p):
5225 """Given an integer p >= 0, return floor(10**p)*log(10).
5226
5227 For example, self.getdigits(3) returns 2302.
5228 """
5229 # digits are stored as a string, for quick conversion to
5230 # integer in the case that we've already computed enough
5231 # digits; the stored digits should always be correct
5232 # (truncated, not rounded to nearest).
5233 if p < 0:
5234 raise ValueError("p should be nonnegative")
5235
5236 if p >= len(self.digits):
5237 # compute p+3, p+6, p+9, ... digits; continue until at
5238 # least one of the extra digits is nonzero
5239 extra = 3
5240 while True:
5241 # compute p+extra digits, correct to within 1ulp
5242 M = 10**(p+extra+2)
5243 digits = str(_div_nearest(_ilog(10*M, M), 100))
5244 if digits[-extra:] != '0'*extra:
5245 break
5246 extra += 3
5247 # keep all reliable digits so far; remove trailing zeros
5248 # and next nonzero digit
5249 self.digits = digits.rstrip('0')[:-1]
5250 return int(self.digits[:p+1])
5251
5252_log10_digits = _Log10Memoize().getdigits
5253
Facundo Batista353750c2007-09-13 18:13:15 +00005254def _iexp(x, M, L=8):
5255 """Given integers x and M, M > 0, such that x/M is small in absolute
5256 value, compute an integer approximation to M*exp(x/M). For 0 <=
5257 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5258 is usually much smaller)."""
5259
5260 # Algorithm: to compute exp(z) for a real number z, first divide z
5261 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5262 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5263 # series
5264 #
5265 # expm1(x) = x + x**2/2! + x**3/3! + ...
5266 #
5267 # Now use the identity
5268 #
5269 # expm1(2x) = expm1(x)*(expm1(x)+2)
5270 #
5271 # R times to compute the sequence expm1(z/2**R),
5272 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5273
5274 # Find R such that x/2**R/M <= 2**-L
5275 R = _nbits((long(x)<<L)//M)
5276
5277 # Taylor series. (2**L)**T > M
5278 T = -int(-10*len(str(M))//(3*L))
5279 y = _div_nearest(x, T)
5280 Mshift = long(M)<<R
5281 for i in xrange(T-1, 0, -1):
5282 y = _div_nearest(x*(Mshift + y), Mshift * i)
5283
5284 # Expansion
5285 for k in xrange(R-1, -1, -1):
5286 Mshift = long(M)<<(k+2)
5287 y = _div_nearest(y*(y+Mshift), Mshift)
5288
5289 return M+y
5290
5291def _dexp(c, e, p):
5292 """Compute an approximation to exp(c*10**e), with p decimal places of
5293 precision.
5294
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005295 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005296
5297 10**(p-1) <= d <= 10**p, and
5298 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5299
5300 In other words, d*10**f is an approximation to exp(c*10**e) with p
5301 digits of precision, and with an error in d of at most 1. This is
5302 almost, but not quite, the same as the error being < 1ulp: when d
5303 = 10**(p-1) the error could be up to 10 ulp."""
5304
5305 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5306 p += 2
5307
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005308 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005309 extra = max(0, e + len(str(c)) - 1)
5310 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005311
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005312 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005313 # rounding down
5314 shift = e+q
5315 if shift >= 0:
5316 cshift = c*10**shift
5317 else:
5318 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005319 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005320
5321 # reduce remainder back to original precision
5322 rem = _div_nearest(rem, 10**extra)
5323
5324 # error in result of _iexp < 120; error after division < 0.62
5325 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5326
5327def _dpower(xc, xe, yc, ye, p):
5328 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5329 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5330
5331 10**(p-1) <= c <= 10**p, and
5332 (c-1)*10**e < x**y < (c+1)*10**e
5333
5334 in other words, c*10**e is an approximation to x**y with p digits
5335 of precision, and with an error in c of at most 1. (This is
5336 almost, but not quite, the same as the error being < 1ulp: when c
5337 == 10**(p-1) we can only guarantee error < 10ulp.)
5338
5339 We assume that: x is positive and not equal to 1, and y is nonzero.
5340 """
5341
5342 # Find b such that 10**(b-1) <= |y| <= 10**b
5343 b = len(str(abs(yc))) + ye
5344
5345 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5346 lxc = _dlog(xc, xe, p+b+1)
5347
5348 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5349 shift = ye-b
5350 if shift >= 0:
5351 pc = lxc*yc*10**shift
5352 else:
5353 pc = _div_nearest(lxc*yc, 10**-shift)
5354
5355 if pc == 0:
5356 # we prefer a result that isn't exactly 1; this makes it
5357 # easier to compute a correctly rounded result in __pow__
5358 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5359 coeff, exp = 10**(p-1)+1, 1-p
5360 else:
5361 coeff, exp = 10**p-1, -p
5362 else:
5363 coeff, exp = _dexp(pc, -(p+1), p+1)
5364 coeff = _div_nearest(coeff, 10)
5365 exp += 1
5366
5367 return coeff, exp
5368
5369def _log10_lb(c, correction = {
5370 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5371 '6': 23, '7': 16, '8': 10, '9': 5}):
5372 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5373 if c <= 0:
5374 raise ValueError("The argument to _log10_lb should be nonnegative.")
5375 str_c = str(c)
5376 return 100*len(str_c) - correction[str_c[0]]
5377
Facundo Batista59c58842007-04-10 12:58:45 +00005378##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005379
Facundo Batista353750c2007-09-13 18:13:15 +00005380def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005381 """Convert other to Decimal.
5382
5383 Verifies that it's ok to use in an implicit construction.
5384 """
5385 if isinstance(other, Decimal):
5386 return other
5387 if isinstance(other, (int, long)):
5388 return Decimal(other)
Facundo Batista353750c2007-09-13 18:13:15 +00005389 if raiseit:
5390 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005391 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005392
Facundo Batista59c58842007-04-10 12:58:45 +00005393##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005394
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005395# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005396# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005397
5398DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005399 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005400 traps=[DivisionByZero, Overflow, InvalidOperation],
5401 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005402 Emax=999999999,
5403 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005404 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005405)
5406
5407# Pre-made alternate contexts offered by the specification
5408# Don't change these; the user should be able to select these
5409# contexts and be able to reproduce results from other implementations
5410# of the spec.
5411
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005412BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005413 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005414 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5415 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005416)
5417
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005418ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005419 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005420 traps=[],
5421 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005422)
5423
5424
Facundo Batista72bc54f2007-11-23 17:59:00 +00005425##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005426#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005427# Regular expression used for parsing numeric strings. Additional
5428# comments:
5429#
5430# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5431# whitespace. But note that the specification disallows whitespace in
5432# a numeric string.
5433#
5434# 2. For finite numbers (not infinities and NaNs) the body of the
5435# number between the optional sign and the optional exponent must have
5436# at least one decimal digit, possibly after the decimal point. The
5437# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005438
5439import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005440_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005441# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005442 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005443 (
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005444 (?=\d|\.\d) # ...a number (with at least one digit)
5445 (?P<int>\d*) # having a (possibly empty) integer part
5446 (\.(?P<frac>\d*))? # followed by an optional fractional part
5447 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005448 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005449 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005450 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005451 (?P<signal>s)? # ...an (optionally signaling)
5452 NaN # NaN
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005453 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005454 )
5455# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005456 \Z
Mark Dickinson9a6e6452009-08-02 11:01:01 +00005457""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005458
Facundo Batista2ec74152007-12-03 17:55:00 +00005459_all_zeros = re.compile('0*$').match
5460_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005461
5462##### PEP3101 support functions ##############################################
5463# The functions parse_format_specifier and format_align have little to do
5464# with the Decimal class, and could potentially be reused for other pure
5465# Python numeric classes that want to implement __format__
5466#
5467# A format specifier for Decimal looks like:
5468#
5469# [[fill]align][sign][0][minimumwidth][.precision][type]
5470#
5471
5472_parse_format_specifier_regex = re.compile(r"""\A
5473(?:
5474 (?P<fill>.)?
5475 (?P<align>[<>=^])
5476)?
5477(?P<sign>[-+ ])?
5478(?P<zeropad>0)?
5479(?P<minimumwidth>(?!0)\d+)?
5480(?:\.(?P<precision>0|(?!0)\d+))?
5481(?P<type>[eEfFgG%])?
5482\Z
5483""", re.VERBOSE)
5484
Facundo Batista72bc54f2007-11-23 17:59:00 +00005485del re
5486
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005487def _parse_format_specifier(format_spec):
5488 """Parse and validate a format specifier.
5489
5490 Turns a standard numeric format specifier into a dict, with the
5491 following entries:
5492
5493 fill: fill character to pad field to minimum width
5494 align: alignment type, either '<', '>', '=' or '^'
5495 sign: either '+', '-' or ' '
5496 minimumwidth: nonnegative integer giving minimum width
5497 precision: nonnegative integer giving precision, or None
5498 type: one of the characters 'eEfFgG%', or None
5499 unicode: either True or False (always True for Python 3.x)
5500
5501 """
5502 m = _parse_format_specifier_regex.match(format_spec)
5503 if m is None:
5504 raise ValueError("Invalid format specifier: " + format_spec)
5505
5506 # get the dictionary
5507 format_dict = m.groupdict()
5508
5509 # defaults for fill and alignment
5510 fill = format_dict['fill']
5511 align = format_dict['align']
5512 if format_dict.pop('zeropad') is not None:
5513 # in the face of conflict, refuse the temptation to guess
5514 if fill is not None and fill != '0':
5515 raise ValueError("Fill character conflicts with '0'"
5516 " in format specifier: " + format_spec)
5517 if align is not None and align != '=':
5518 raise ValueError("Alignment conflicts with '0' in "
5519 "format specifier: " + format_spec)
5520 fill = '0'
5521 align = '='
5522 format_dict['fill'] = fill or ' '
5523 format_dict['align'] = align or '<'
5524
5525 if format_dict['sign'] is None:
5526 format_dict['sign'] = '-'
5527
5528 # turn minimumwidth and precision entries into integers.
5529 # minimumwidth defaults to 0; precision remains None if not given
5530 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5531 if format_dict['precision'] is not None:
5532 format_dict['precision'] = int(format_dict['precision'])
5533
5534 # if format type is 'g' or 'G' then a precision of 0 makes little
5535 # sense; convert it to 1. Same if format type is unspecified.
5536 if format_dict['precision'] == 0:
Mark Dickinsonc3c112d2009-09-07 16:19:35 +00005537 if format_dict['type'] is None or format_dict['type'] in 'gG':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005538 format_dict['precision'] = 1
5539
5540 # record whether return type should be str or unicode
5541 format_dict['unicode'] = isinstance(format_spec, unicode)
5542
5543 return format_dict
5544
5545def _format_align(body, spec_dict):
5546 """Given an unpadded, non-aligned numeric string, add padding and
5547 aligment to conform with the given format specifier dictionary (as
5548 output from parse_format_specifier).
5549
5550 It's assumed that if body is negative then it starts with '-'.
5551 Any leading sign ('-' or '+') is stripped from the body before
5552 applying the alignment and padding rules, and replaced in the
5553 appropriate position.
5554
5555 """
5556 # figure out the sign; we only examine the first character, so if
5557 # body has leading whitespace the results may be surprising.
5558 if len(body) > 0 and body[0] in '-+':
5559 sign = body[0]
5560 body = body[1:]
5561 else:
5562 sign = ''
5563
5564 if sign != '-':
5565 if spec_dict['sign'] in ' +':
5566 sign = spec_dict['sign']
5567 else:
5568 sign = ''
5569
5570 # how much extra space do we have to play with?
5571 minimumwidth = spec_dict['minimumwidth']
5572 fill = spec_dict['fill']
5573 padding = fill*(max(minimumwidth - (len(sign+body)), 0))
5574
5575 align = spec_dict['align']
5576 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005577 result = sign + body + padding
Mark Dickinson71416822009-03-17 18:07:41 +00005578 elif align == '>':
5579 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005580 elif align == '=':
5581 result = sign + padding + body
5582 else: #align == '^'
5583 half = len(padding)//2
5584 result = padding[:half] + sign + body + padding[half:]
5585
5586 # make sure that result is unicode if necessary
5587 if spec_dict['unicode']:
5588 result = unicode(result)
5589
5590 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00005591
Facundo Batista59c58842007-04-10 12:58:45 +00005592##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005593
Facundo Batista59c58842007-04-10 12:58:45 +00005594# Reusable defaults
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005595_Infinity = Decimal('Inf')
5596_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonfd6032d2009-01-02 23:16:51 +00005597_NaN = Decimal('NaN')
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005598_Zero = Decimal(0)
5599_One = Decimal(1)
5600_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005601
Mark Dickinsone4d46b22009-01-03 12:09:22 +00005602# _SignedInfinity[sign] is infinity w/ that sign
5603_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005604
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005605
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005606
5607if __name__ == '__main__':
5608 import doctest, sys
5609 doctest.testmod(sys.modules[__name__])