blob: 5e2a750924c7a1548db3f2adb924243ec9a8c137 [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 Hettingera016deb2009-04-27 21:12:27 +0000137__version__ = '1.70' # Highest version of the spec this complies with
Raymond Hettingerdaeceb22009-03-10 04:49:21 +0000138
Raymond Hettingereb260842005-06-07 18:52:34 +0000139import copy as _copy
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000140import math as _math
Raymond Hettinger2c8585b2009-02-03 03:37:03 +0000141import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000142
Raymond Hettinger097a1902008-01-11 02:24:13 +0000143try:
144 from collections import namedtuple as _namedtuple
145 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
146except ImportError:
147 DecimalTuple = lambda *args: args
148
Facundo Batista59c58842007-04-10 12:58:45 +0000149# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000150ROUND_DOWN = 'ROUND_DOWN'
151ROUND_HALF_UP = 'ROUND_HALF_UP'
152ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
153ROUND_CEILING = 'ROUND_CEILING'
154ROUND_FLOOR = 'ROUND_FLOOR'
155ROUND_UP = 'ROUND_UP'
156ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Facundo Batista353750c2007-09-13 18:13:15 +0000157ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000158
Facundo Batista59c58842007-04-10 12:58:45 +0000159# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000160
161class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000162 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000163
164 Used exceptions derive from this.
165 If an exception derives from another exception besides this (such as
166 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
167 called if the others are present. This isn't actually used for
168 anything, though.
169
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000170 handle -- Called when context._raise_error is called and the
Stefan Krah8a6f3fe2010-05-19 15:46:39 +0000171 trap_enabler is not set. First argument is self, second is the
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000172 context. More arguments can be given, those being after
173 the explanation in _raise_error (For example,
174 context._raise_error(NewError, '(-x)!', self._sign) would
175 call NewError().handle(context, self._sign).)
176
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000177 To define a new exception, it should be sufficient to have it derive
178 from DecimalException.
179 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000180 def handle(self, context, *args):
181 pass
182
183
184class Clamped(DecimalException):
185 """Exponent of a 0 changed to fit bounds.
186
187 This occurs and signals clamped if the exponent of a result has been
188 altered in order to fit the constraints of a specific concrete
Facundo Batista59c58842007-04-10 12:58:45 +0000189 representation. This may occur when the exponent of a zero result would
190 be outside the bounds of a representation, or when a large normal
191 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000192 this latter case, the exponent is reduced to fit and the corresponding
193 number of zero digits are appended to the coefficient ("fold-down").
194 """
195
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000196class InvalidOperation(DecimalException):
197 """An invalid operation was performed.
198
199 Various bad things cause this:
200
201 Something creates a signaling NaN
202 -INF + INF
Facundo Batista59c58842007-04-10 12:58:45 +0000203 0 * (+-)INF
204 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000205 x % 0
206 (+-)INF % x
207 x._rescale( non-integer )
208 sqrt(-x) , x > 0
209 0 ** 0
210 x ** (non-integer)
211 x ** (+-)INF
212 An operand is invalid
Facundo Batista353750c2007-09-13 18:13:15 +0000213
214 The result of the operation after these is a quiet positive NaN,
215 except when the cause is a signaling NaN, in which case the result is
216 also a quiet NaN, but with the original sign, and an optional
217 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000218 """
219 def handle(self, context, *args):
220 if args:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000221 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
222 return ans._fix_nan(context)
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000223 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000224
225class ConversionSyntax(InvalidOperation):
226 """Trying to convert badly formed string.
227
228 This occurs and signals invalid-operation if an string is being
229 converted to a number and it does not conform to the numeric string
Facundo Batista59c58842007-04-10 12:58:45 +0000230 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000231 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000232 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000233 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000234
235class DivisionByZero(DecimalException, ZeroDivisionError):
236 """Division by 0.
237
238 This occurs and signals division-by-zero if division of a finite number
239 by zero was attempted (during a divide-integer or divide operation, or a
240 power operation with negative right-hand operand), and the dividend was
241 not zero.
242
243 The result of the operation is [sign,inf], where sign is the exclusive
244 or of the signs of the operands for divide, or is 1 for an odd power of
245 -0, for power.
246 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000247
Facundo Batistacce8df22007-09-18 16:53:18 +0000248 def handle(self, context, sign, *args):
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000249 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000250
251class DivisionImpossible(InvalidOperation):
252 """Cannot perform the division adequately.
253
254 This occurs and signals invalid-operation if the integer result of a
255 divide-integer or remainder operation had too many digits (would be
Facundo Batista59c58842007-04-10 12:58:45 +0000256 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000257 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000258
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000259 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000260 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000261
262class DivisionUndefined(InvalidOperation, ZeroDivisionError):
263 """Undefined result of division.
264
265 This occurs and signals invalid-operation if division by zero was
266 attempted (during a divide-integer, divide, or remainder operation), and
Facundo Batista59c58842007-04-10 12:58:45 +0000267 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000268 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000269
Facundo Batistacce8df22007-09-18 16:53:18 +0000270 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000271 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000272
273class Inexact(DecimalException):
274 """Had to round, losing information.
275
276 This occurs and signals inexact whenever the result of an operation is
277 not exact (that is, it needed to be rounded and any discarded digits
Facundo Batista59c58842007-04-10 12:58:45 +0000278 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000279 result in all cases is unchanged.
280
281 The inexact signal may be tested (or trapped) to determine if a given
282 operation (or sequence of operations) was inexact.
283 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000284
285class InvalidContext(InvalidOperation):
286 """Invalid context. Unknown rounding, for example.
287
288 This occurs and signals invalid-operation if an invalid context was
Facundo Batista59c58842007-04-10 12:58:45 +0000289 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000290 on creation and either the precision exceeds the capability of the
291 underlying concrete representation or an unknown or unsupported rounding
Facundo Batista59c58842007-04-10 12:58:45 +0000292 was specified. These aspects of the context need only be checked when
293 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000294 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000295
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000296 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000297 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000298
299class Rounded(DecimalException):
300 """Number got rounded (not necessarily changed during rounding).
301
302 This occurs and signals rounded whenever the result of an operation is
303 rounded (that is, some zero or non-zero digits were discarded from the
Facundo Batista59c58842007-04-10 12:58:45 +0000304 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000305 result in all cases is unchanged.
306
307 The rounded signal may be tested (or trapped) to determine if a given
308 operation (or sequence of operations) caused a loss of precision.
309 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000310
311class Subnormal(DecimalException):
312 """Exponent < Emin before rounding.
313
314 This occurs and signals subnormal whenever the result of a conversion or
315 operation is subnormal (that is, its adjusted exponent is less than
Facundo Batista59c58842007-04-10 12:58:45 +0000316 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000317
318 The subnormal signal may be tested (or trapped) to determine if a given
319 or operation (or sequence of operations) yielded a subnormal result.
320 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000321
322class Overflow(Inexact, Rounded):
323 """Numerical overflow.
324
325 This occurs and signals overflow if the adjusted exponent of a result
326 (from a conversion or from an operation that is not an attempt to divide
327 by zero), after rounding, would be greater than the largest value that
328 can be handled by the implementation (the value Emax).
329
330 The result depends on the rounding mode:
331
332 For round-half-up and round-half-even (and for round-half-down and
333 round-up, if implemented), the result of the operation is [sign,inf],
Facundo Batista59c58842007-04-10 12:58:45 +0000334 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000335 result is the largest finite number that can be represented in the
Facundo Batista59c58842007-04-10 12:58:45 +0000336 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000337 round-ceiling, the result is the same as for round-down if the sign of
Facundo Batista59c58842007-04-10 12:58:45 +0000338 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000339 the result is the same as for round-down if the sign of the intermediate
Facundo Batista59c58842007-04-10 12:58:45 +0000340 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000341 will also be raised.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000342 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000343
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000344 def handle(self, context, sign, *args):
345 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Facundo Batista353750c2007-09-13 18:13:15 +0000346 ROUND_HALF_DOWN, ROUND_UP):
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000347 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000348 if sign == 0:
349 if context.rounding == ROUND_CEILING:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000350 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000351 return _dec_from_triple(sign, '9'*context.prec,
352 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000353 if sign == 1:
354 if context.rounding == ROUND_FLOOR:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000355 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000356 return _dec_from_triple(sign, '9'*context.prec,
357 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000358
359
360class Underflow(Inexact, Rounded, Subnormal):
361 """Numerical underflow with result rounded to 0.
362
363 This occurs and signals underflow if a result is inexact and the
364 adjusted exponent of the result would be smaller (more negative) than
365 the smallest value that can be handled by the implementation (the value
Facundo Batista59c58842007-04-10 12:58:45 +0000366 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000367
368 The result after an underflow will be a subnormal number rounded, if
Facundo Batista59c58842007-04-10 12:58:45 +0000369 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000370 in 0 with the sign of the intermediate result and an exponent of Etiny.
371
372 In all cases, Inexact, Rounded, and Subnormal will also be raised.
373 """
374
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000375# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000376_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000377 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000378
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000379# Map conditions (per the spec) to signals
380_condition_map = {ConversionSyntax:InvalidOperation,
381 DivisionImpossible:InvalidOperation,
382 DivisionUndefined:InvalidOperation,
383 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000384
Facundo Batista59c58842007-04-10 12:58:45 +0000385##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000386
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000387# The getcontext() and setcontext() function manage access to a thread-local
388# current context. Py2.4 offers direct support for thread locals. If that
389# is not available, use threading.currentThread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000390# work for older Pythons. If threads are not part of the build, create a
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000391# mock threading object with threading.local() returning the module namespace.
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000392
393try:
394 import threading
395except ImportError:
396 # Python was compiled without threads; create a mock object instead
397 import sys
Facundo Batista59c58842007-04-10 12:58:45 +0000398 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000399 def local(self, sys=sys):
400 return sys.modules[__name__]
401 threading = MockThreading()
402 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000403
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000404try:
405 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000406
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000407except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000408
Facundo Batista59c58842007-04-10 12:58:45 +0000409 # To fix reloading, force it to create a new context
410 # Old contexts have different exceptions in their dicts, making problems.
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000411 if hasattr(threading.currentThread(), '__decimal_context__'):
412 del threading.currentThread().__decimal_context__
413
414 def setcontext(context):
415 """Set this thread's context to context."""
416 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000417 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000418 context.clear_flags()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000419 threading.currentThread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000420
421 def getcontext():
422 """Returns this thread's context.
423
424 If this thread does not yet have a context, returns
425 a new context and sets this thread's context.
426 New contexts are copies of DefaultContext.
427 """
428 try:
429 return threading.currentThread().__decimal_context__
430 except AttributeError:
431 context = Context()
432 threading.currentThread().__decimal_context__ = context
433 return context
434
435else:
436
437 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000438 if hasattr(local, '__decimal_context__'):
439 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000440
441 def getcontext(_local=local):
442 """Returns this thread's context.
443
444 If this thread does not yet have a context, returns
445 a new context and sets this thread's context.
446 New contexts are copies of DefaultContext.
447 """
448 try:
449 return _local.__decimal_context__
450 except AttributeError:
451 context = Context()
452 _local.__decimal_context__ = context
453 return context
454
455 def setcontext(context, _local=local):
456 """Set this thread's context to context."""
457 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000458 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000459 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000460 _local.__decimal_context__ = context
461
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000462 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000463
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000464def localcontext(ctx=None):
465 """Return a context manager for a copy of the supplied context
466
467 Uses a copy of the current context if no context is specified
468 The returned context manager creates a local decimal context
469 in a with statement:
470 def sin(x):
471 with localcontext() as ctx:
472 ctx.prec += 2
473 # Rest of sin calculation algorithm
474 # uses a precision 2 greater than normal
Facundo Batista59c58842007-04-10 12:58:45 +0000475 return +s # Convert result to normal precision
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000476
477 def sin(x):
478 with localcontext(ExtendedContext):
479 # Rest of sin calculation algorithm
480 # uses the Extended Context from the
481 # General Decimal Arithmetic Specification
Facundo Batista59c58842007-04-10 12:58:45 +0000482 return +s # Convert result to normal context
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000483
Facundo Batistaee340e52008-05-02 17:39:00 +0000484 >>> setcontext(DefaultContext)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000485 >>> print getcontext().prec
486 28
487 >>> with localcontext():
488 ... ctx = getcontext()
Raymond Hettinger495df472007-02-08 01:42:35 +0000489 ... ctx.prec += 2
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000490 ... print ctx.prec
491 ...
492 30
493 >>> with localcontext(ExtendedContext):
494 ... print getcontext().prec
495 ...
496 9
497 >>> print getcontext().prec
498 28
499 """
Nick Coghlanced12182006-09-02 03:54:17 +0000500 if ctx is None: ctx = getcontext()
501 return _ContextManager(ctx)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000502
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000503
Facundo Batista59c58842007-04-10 12:58:45 +0000504##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000505
506class Decimal(object):
507 """Floating point class for decimal arithmetic."""
508
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000509 __slots__ = ('_exp','_int','_sign', '_is_special')
510 # Generally, the value of the Decimal instance is given by
511 # (-1)**_sign * _int * 10**_exp
512 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000513
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000514 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000515 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000516 """Create a decimal point instance.
517
518 >>> Decimal('3.14') # string input
Raymond Hettingerabe32372008-02-14 02:41:22 +0000519 Decimal('3.14')
Facundo Batista59c58842007-04-10 12:58:45 +0000520 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Raymond Hettingerabe32372008-02-14 02:41:22 +0000521 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000522 >>> Decimal(314) # int or long
Raymond Hettingerabe32372008-02-14 02:41:22 +0000523 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000524 >>> Decimal(Decimal(314)) # another decimal instance
Raymond Hettingerabe32372008-02-14 02:41:22 +0000525 Decimal('314')
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000526 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Raymond Hettingerabe32372008-02-14 02:41:22 +0000527 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000528 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000529
Facundo Batista72bc54f2007-11-23 17:59:00 +0000530 # Note that the coefficient, self._int, is actually stored as
531 # a string rather than as a tuple of digits. This speeds up
532 # the "digits to integer" and "integer to digits" conversions
533 # that are used in almost every arithmetic operation on
534 # Decimals. This is an internal detail: the as_tuple function
535 # and the Decimal constructor still deal with tuples of
536 # digits.
537
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000538 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000539
Facundo Batista0d157a02007-11-30 17:15:25 +0000540 # From a string
541 # REs insist on real strings, so we can too.
542 if isinstance(value, basestring):
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000543 m = _parser(value.strip())
Facundo Batista0d157a02007-11-30 17:15:25 +0000544 if m is None:
545 if context is None:
546 context = getcontext()
547 return context._raise_error(ConversionSyntax,
548 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000549
Facundo Batista0d157a02007-11-30 17:15:25 +0000550 if m.group('sign') == "-":
551 self._sign = 1
552 else:
553 self._sign = 0
554 intpart = m.group('int')
555 if intpart is not None:
556 # finite number
Mark Dickinson4326ad82009-08-02 10:59:36 +0000557 fracpart = m.group('frac') or ''
Facundo Batista0d157a02007-11-30 17:15:25 +0000558 exp = int(m.group('exp') or '0')
Mark Dickinson4326ad82009-08-02 10:59:36 +0000559 self._int = str(int(intpart+fracpart))
560 self._exp = exp - len(fracpart)
Facundo Batista0d157a02007-11-30 17:15:25 +0000561 self._is_special = False
562 else:
563 diag = m.group('diag')
564 if diag is not None:
565 # NaN
Mark Dickinson4326ad82009-08-02 10:59:36 +0000566 self._int = str(int(diag or '0')).lstrip('0')
Facundo Batista0d157a02007-11-30 17:15:25 +0000567 if m.group('signal'):
568 self._exp = 'N'
569 else:
570 self._exp = 'n'
571 else:
572 # infinity
573 self._int = '0'
574 self._exp = 'F'
575 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000576 return self
577
578 # From an integer
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000579 if isinstance(value, (int,long)):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000580 if value >= 0:
581 self._sign = 0
582 else:
583 self._sign = 1
584 self._exp = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +0000585 self._int = str(abs(value))
Facundo Batista0d157a02007-11-30 17:15:25 +0000586 self._is_special = False
587 return self
588
589 # From another decimal
590 if isinstance(value, Decimal):
591 self._exp = value._exp
592 self._sign = value._sign
593 self._int = value._int
594 self._is_special = value._is_special
595 return self
596
597 # From an internal working value
598 if isinstance(value, _WorkRep):
599 self._sign = value.sign
600 self._int = str(value.int)
601 self._exp = int(value.exp)
602 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000603 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000604
605 # tuple/list conversion (possibly from as_tuple())
606 if isinstance(value, (list,tuple)):
607 if len(value) != 3:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000608 raise ValueError('Invalid tuple size in creation of Decimal '
609 'from list or tuple. The list or tuple '
610 'should have exactly three elements.')
611 # process sign. The isinstance test rejects floats
612 if not (isinstance(value[0], (int, long)) and value[0] in (0,1)):
613 raise ValueError("Invalid sign. The first value in the tuple "
614 "should be an integer; either 0 for a "
615 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000616 self._sign = value[0]
Facundo Batista9b5e2312007-10-19 19:25:57 +0000617 if value[2] == 'F':
618 # infinity: value[1] is ignored
Facundo Batista72bc54f2007-11-23 17:59:00 +0000619 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000620 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000621 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000622 else:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000623 # process and validate the digits in value[1]
624 digits = []
625 for digit in value[1]:
626 if isinstance(digit, (int, long)) and 0 <= digit <= 9:
627 # skip leading zeros
628 if digits or digit != 0:
629 digits.append(digit)
630 else:
631 raise ValueError("The second value in the tuple must "
632 "be composed of integers in the range "
633 "0 through 9.")
634 if value[2] in ('n', 'N'):
635 # NaN: digits form the diagnostic
Facundo Batista72bc54f2007-11-23 17:59:00 +0000636 self._int = ''.join(map(str, digits))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000637 self._exp = value[2]
638 self._is_special = True
639 elif isinstance(value[2], (int, long)):
640 # finite number: digits give the coefficient
Facundo Batista72bc54f2007-11-23 17:59:00 +0000641 self._int = ''.join(map(str, digits or [0]))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000642 self._exp = value[2]
643 self._is_special = False
644 else:
645 raise ValueError("The third value in the tuple must "
646 "be an integer, or one of the "
647 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000648 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000649
Raymond Hettingerbf440692004-07-10 14:14:37 +0000650 if isinstance(value, float):
Raymond Hettingered171ab2010-04-02 18:39:24 +0000651 value = Decimal.from_float(value)
652 self._exp = value._exp
653 self._sign = value._sign
654 self._int = value._int
655 self._is_special = value._is_special
656 return self
Raymond Hettingerbf440692004-07-10 14:14:37 +0000657
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000658 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000659
Mark Dickinson6a961632009-01-04 21:10:56 +0000660 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
661 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000662 def from_float(cls, f):
663 """Converts a float to a decimal number, exactly.
664
665 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
666 Since 0.1 is not exactly representable in binary floating point, the
667 value is stored as the nearest representable value which is
668 0x1.999999999999ap-4. The exact equivalent of the value in decimal
669 is 0.1000000000000000055511151231257827021181583404541015625.
670
671 >>> Decimal.from_float(0.1)
672 Decimal('0.1000000000000000055511151231257827021181583404541015625')
673 >>> Decimal.from_float(float('nan'))
674 Decimal('NaN')
675 >>> Decimal.from_float(float('inf'))
676 Decimal('Infinity')
677 >>> Decimal.from_float(-float('inf'))
678 Decimal('-Infinity')
679 >>> Decimal.from_float(-0.0)
680 Decimal('-0')
681
682 """
683 if isinstance(f, (int, long)): # handle integer inputs
684 return cls(f)
685 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
686 return cls(repr(f))
Mark Dickinson6a961632009-01-04 21:10:56 +0000687 if _math.copysign(1.0, f) == 1.0:
688 sign = 0
689 else:
690 sign = 1
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000691 n, d = abs(f).as_integer_ratio()
692 k = d.bit_length() - 1
693 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinson6a961632009-01-04 21:10:56 +0000694 if cls is Decimal:
695 return result
696 else:
697 return cls(result)
698 from_float = classmethod(from_float)
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000699
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000700 def _isnan(self):
701 """Returns whether the number is not actually one.
702
703 0 if a number
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000704 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000705 2 if sNaN
706 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000707 if self._is_special:
708 exp = self._exp
709 if exp == 'n':
710 return 1
711 elif exp == 'N':
712 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000713 return 0
714
715 def _isinfinity(self):
716 """Returns whether the number is infinite
717
718 0 if finite or not a number
719 1 if +INF
720 -1 if -INF
721 """
722 if self._exp == 'F':
723 if self._sign:
724 return -1
725 return 1
726 return 0
727
Facundo Batista353750c2007-09-13 18:13:15 +0000728 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000729 """Returns whether the number is not actually one.
730
731 if self, other are sNaN, signal
732 if self, other are NaN return nan
733 return 0
734
735 Done before operations.
736 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000737
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000738 self_is_nan = self._isnan()
739 if other is None:
740 other_is_nan = False
741 else:
742 other_is_nan = other._isnan()
743
744 if self_is_nan or other_is_nan:
745 if context is None:
746 context = getcontext()
747
748 if self_is_nan == 2:
749 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000750 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000751 if other_is_nan == 2:
752 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000753 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000754 if self_is_nan:
Facundo Batista353750c2007-09-13 18:13:15 +0000755 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000756
Facundo Batista353750c2007-09-13 18:13:15 +0000757 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000758 return 0
759
Mark Dickinson2fc92632008-02-06 22:10:50 +0000760 def _compare_check_nans(self, other, context):
761 """Version of _check_nans used for the signaling comparisons
762 compare_signal, __le__, __lt__, __ge__, __gt__.
763
764 Signal InvalidOperation if either self or other is a (quiet
765 or signaling) NaN. Signaling NaNs take precedence over quiet
766 NaNs.
767
768 Return 0 if neither operand is a NaN.
769
770 """
771 if context is None:
772 context = getcontext()
773
774 if self._is_special or other._is_special:
775 if self.is_snan():
776 return context._raise_error(InvalidOperation,
777 'comparison involving sNaN',
778 self)
779 elif other.is_snan():
780 return context._raise_error(InvalidOperation,
781 'comparison involving sNaN',
782 other)
783 elif self.is_qnan():
784 return context._raise_error(InvalidOperation,
785 'comparison involving NaN',
786 self)
787 elif other.is_qnan():
788 return context._raise_error(InvalidOperation,
789 'comparison involving NaN',
790 other)
791 return 0
792
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000793 def __nonzero__(self):
Facundo Batista1a191df2007-10-02 17:01:24 +0000794 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000795
Facundo Batista1a191df2007-10-02 17:01:24 +0000796 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000797 """
Facundo Batista72bc54f2007-11-23 17:59:00 +0000798 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000799
Mark Dickinson2fc92632008-02-06 22:10:50 +0000800 def _cmp(self, other):
801 """Compare the two non-NaN decimal instances self and other.
802
803 Returns -1 if self < other, 0 if self == other and 1
804 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000805
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000806 if self._is_special or other._is_special:
Mark Dickinsone52c3142009-01-25 10:39:15 +0000807 self_inf = self._isinfinity()
808 other_inf = other._isinfinity()
809 if self_inf == other_inf:
810 return 0
811 elif self_inf < other_inf:
812 return -1
813 else:
814 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000815
Mark Dickinsone52c3142009-01-25 10:39:15 +0000816 # check for zeros; Decimal('0') == Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +0000817 if not self:
818 if not other:
819 return 0
820 else:
821 return -((-1)**other._sign)
822 if not other:
823 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000824
Facundo Batista59c58842007-04-10 12:58:45 +0000825 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000826 if other._sign < self._sign:
827 return -1
828 if self._sign < other._sign:
829 return 1
830
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000831 self_adjusted = self.adjusted()
832 other_adjusted = other.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +0000833 if self_adjusted == other_adjusted:
Facundo Batista72bc54f2007-11-23 17:59:00 +0000834 self_padded = self._int + '0'*(self._exp - other._exp)
835 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone52c3142009-01-25 10:39:15 +0000836 if self_padded == other_padded:
837 return 0
838 elif self_padded < other_padded:
839 return -(-1)**self._sign
840 else:
841 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000842 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000843 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000844 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000845 return -((-1)**self._sign)
846
Mark Dickinson2fc92632008-02-06 22:10:50 +0000847 # Note: The Decimal standard doesn't cover rich comparisons for
848 # Decimals. In particular, the specification is silent on the
849 # subject of what should happen for a comparison involving a NaN.
850 # We take the following approach:
851 #
Mark Dickinsone096e822010-04-02 10:17:07 +0000852 # == comparisons involving a quiet NaN always return False
853 # != comparisons involving a quiet NaN always return True
854 # == or != comparisons involving a signaling NaN signal
855 # InvalidOperation, and return False or True as above if the
856 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000857 # <, >, <= and >= comparisons involving a (quiet or signaling)
858 # NaN signal InvalidOperation, and return False if the
Mark Dickinson3a94ee02008-02-10 15:19:58 +0000859 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000860 #
861 # This behavior is designed to conform as closely as possible to
862 # that specified by IEEE 754.
863
Mark Dickinsone096e822010-04-02 10:17:07 +0000864 def __eq__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000865 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000866 if other is NotImplemented:
867 return other
Mark Dickinsone096e822010-04-02 10:17:07 +0000868 if self._check_nans(other, context):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000869 return False
870 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000871
Mark Dickinsone096e822010-04-02 10:17:07 +0000872 def __ne__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000873 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000874 if other is NotImplemented:
875 return other
Mark Dickinsone096e822010-04-02 10:17:07 +0000876 if self._check_nans(other, context):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000877 return True
878 return self._cmp(other) != 0
879
880 def __lt__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000881 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000882 if other is NotImplemented:
883 return other
884 ans = self._compare_check_nans(other, context)
885 if ans:
886 return False
887 return self._cmp(other) < 0
888
889 def __le__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000890 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000891 if other is NotImplemented:
892 return other
893 ans = self._compare_check_nans(other, context)
894 if ans:
895 return False
896 return self._cmp(other) <= 0
897
898 def __gt__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000899 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000900 if other is NotImplemented:
901 return other
902 ans = self._compare_check_nans(other, context)
903 if ans:
904 return False
905 return self._cmp(other) > 0
906
907 def __ge__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000908 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000909 if other is NotImplemented:
910 return other
911 ans = self._compare_check_nans(other, context)
912 if ans:
913 return False
914 return self._cmp(other) >= 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000915
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000916 def compare(self, other, context=None):
917 """Compares one to another.
918
919 -1 => a < b
920 0 => a = b
921 1 => a > b
922 NaN => one is NaN
923 Like __cmp__, but returns Decimal instances.
924 """
Facundo Batista353750c2007-09-13 18:13:15 +0000925 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000926
Facundo Batista59c58842007-04-10 12:58:45 +0000927 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000928 if (self._is_special or other and other._is_special):
929 ans = self._check_nans(other, context)
930 if ans:
931 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000932
Mark Dickinson2fc92632008-02-06 22:10:50 +0000933 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000934
935 def __hash__(self):
936 """x.__hash__() <==> hash(x)"""
937 # Decimal integers must hash the same as the ints
Facundo Batista52b25792008-01-08 12:25:20 +0000938 #
939 # The hash of a nonspecial noninteger Decimal must depend only
940 # on the value of that Decimal, and not on its representation.
Raymond Hettingerabe32372008-02-14 02:41:22 +0000941 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Mark Dickinsonf3eeca12010-04-02 10:35:12 +0000942
943 # Equality comparisons involving signaling nans can raise an
944 # exception; since equality checks are implicitly and
945 # unpredictably used when checking set and dict membership, we
946 # prevent signaling nans from being used as set elements or
947 # dict keys by making __hash__ raise an exception.
948 if self._is_special:
949 if self.is_snan():
950 raise TypeError('Cannot hash a signaling NaN value.')
951 elif self.is_nan():
952 # 0 to match hash(float('nan'))
953 return 0
954 else:
955 # values chosen to match hash(float('inf')) and
956 # hash(float('-inf')).
957 if self._sign:
958 return -271828
959 else:
960 return 314159
Mark Dickinson99d80962010-04-02 08:53:22 +0000961
962 # In Python 2.7, we're allowing comparisons (but not
963 # arithmetic operations) between floats and Decimals; so if
964 # a Decimal instance is exactly representable as a float then
Mark Dickinsonf3eeca12010-04-02 10:35:12 +0000965 # its hash should match that of the float.
Mark Dickinson99d80962010-04-02 08:53:22 +0000966 self_as_float = float(self)
967 if Decimal.from_float(self_as_float) == self:
968 return hash(self_as_float)
969
Facundo Batista8c202442007-09-19 17:53:25 +0000970 if self._isinteger():
971 op = _WorkRep(self.to_integral_value())
972 # to make computation feasible for Decimals with large
973 # exponent, we use the fact that hash(n) == hash(m) for
974 # any two nonzero integers n and m such that (i) n and m
975 # have the same sign, and (ii) n is congruent to m modulo
976 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
977 # hash((-1)**s*c*pow(10, e, 2**64-1).
978 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Facundo Batista52b25792008-01-08 12:25:20 +0000979 # The value of a nonzero nonspecial Decimal instance is
980 # faithfully represented by the triple consisting of its sign,
981 # its adjusted exponent, and its coefficient with trailing
982 # zeros removed.
983 return hash((self._sign,
984 self._exp+len(self._int),
985 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000986
987 def as_tuple(self):
988 """Represents the number as a triple tuple.
989
990 To show the internals exactly as they are.
991 """
Raymond Hettinger097a1902008-01-11 02:24:13 +0000992 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000993
994 def __repr__(self):
995 """Represents the number as an instance of Decimal."""
996 # Invariant: eval(repr(d)) == d
Raymond Hettingerabe32372008-02-14 02:41:22 +0000997 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000998
Facundo Batista353750c2007-09-13 18:13:15 +0000999 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000 """Return string representation of the number in scientific notation.
1001
1002 Captures all of the information in the underlying representation.
1003 """
1004
Facundo Batista62edb712007-12-03 16:29:52 +00001005 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +00001006 if self._is_special:
Facundo Batista62edb712007-12-03 16:29:52 +00001007 if self._exp == 'F':
1008 return sign + 'Infinity'
1009 elif self._exp == 'n':
1010 return sign + 'NaN' + self._int
1011 else: # self._exp == 'N'
1012 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001013
Facundo Batista62edb712007-12-03 16:29:52 +00001014 # number of digits of self._int to left of decimal point
1015 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001016
Facundo Batista62edb712007-12-03 16:29:52 +00001017 # dotplace is number of digits of self._int to the left of the
1018 # decimal point in the mantissa of the output string (that is,
1019 # after adjusting the exponent)
1020 if self._exp <= 0 and leftdigits > -6:
1021 # no exponent required
1022 dotplace = leftdigits
1023 elif not eng:
1024 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001025 dotplace = 1
Facundo Batista62edb712007-12-03 16:29:52 +00001026 elif self._int == '0':
1027 # engineering notation, zero
1028 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001029 else:
Facundo Batista62edb712007-12-03 16:29:52 +00001030 # engineering notation, nonzero
1031 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001032
Facundo Batista62edb712007-12-03 16:29:52 +00001033 if dotplace <= 0:
1034 intpart = '0'
1035 fracpart = '.' + '0'*(-dotplace) + self._int
1036 elif dotplace >= len(self._int):
1037 intpart = self._int+'0'*(dotplace-len(self._int))
1038 fracpart = ''
1039 else:
1040 intpart = self._int[:dotplace]
1041 fracpart = '.' + self._int[dotplace:]
1042 if leftdigits == dotplace:
1043 exp = ''
1044 else:
1045 if context is None:
1046 context = getcontext()
1047 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1048
1049 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001050
1051 def to_eng_string(self, context=None):
1052 """Convert to engineering-type string.
1053
1054 Engineering notation has an exponent which is a multiple of 3, so there
1055 are up to 3 digits left of the decimal place.
1056
1057 Same rules for when in exponential and when as a value as in __str__.
1058 """
Facundo Batista353750c2007-09-13 18:13:15 +00001059 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001060
1061 def __neg__(self, context=None):
1062 """Returns a copy with the sign switched.
1063
1064 Rounds, if it has reason.
1065 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001066 if self._is_special:
1067 ans = self._check_nans(context=context)
1068 if ans:
1069 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001070
Mark Dickinson2c8c62e2011-03-12 11:05:32 +00001071 if context is None:
1072 context = getcontext()
1073
1074 if not self and context.rounding != ROUND_FLOOR:
1075 # -Decimal('0') is Decimal('0'), not Decimal('-0'), except
1076 # in ROUND_FLOOR rounding mode.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001077 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001078 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001079 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001080
Facundo Batistae64acfa2007-12-17 14:18:42 +00001081 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001082
1083 def __pos__(self, context=None):
1084 """Returns a copy, unless it is a sNaN.
1085
1086 Rounds the number (if more then precision digits)
1087 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001088 if self._is_special:
1089 ans = self._check_nans(context=context)
1090 if ans:
1091 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001092
Mark Dickinson2c8c62e2011-03-12 11:05:32 +00001093 if context is None:
1094 context = getcontext()
1095
1096 if not self and context.rounding != ROUND_FLOOR:
1097 # + (-0) = 0, except in ROUND_FLOOR rounding mode.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001098 ans = self.copy_abs()
Facundo Batista353750c2007-09-13 18:13:15 +00001099 else:
1100 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001101
Facundo Batistae64acfa2007-12-17 14:18:42 +00001102 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001103
Facundo Batistae64acfa2007-12-17 14:18:42 +00001104 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001105 """Returns the absolute value of self.
1106
Facundo Batistae64acfa2007-12-17 14:18:42 +00001107 If the keyword argument 'round' is false, do not round. The
1108 expression self.__abs__(round=False) is equivalent to
1109 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001110 """
Facundo Batistae64acfa2007-12-17 14:18:42 +00001111 if not round:
1112 return self.copy_abs()
1113
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001114 if self._is_special:
1115 ans = self._check_nans(context=context)
1116 if ans:
1117 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001118
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001119 if self._sign:
1120 ans = self.__neg__(context=context)
1121 else:
1122 ans = self.__pos__(context=context)
1123
1124 return ans
1125
1126 def __add__(self, other, context=None):
1127 """Returns self + other.
1128
1129 -INF + INF (or the reverse) cause InvalidOperation errors.
1130 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001131 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001132 if other is NotImplemented:
1133 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001134
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001135 if context is None:
1136 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001137
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001138 if self._is_special or other._is_special:
1139 ans = self._check_nans(other, context)
1140 if ans:
1141 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001142
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001143 if self._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001144 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001145 if self._sign != other._sign and other._isinfinity():
1146 return context._raise_error(InvalidOperation, '-INF + INF')
1147 return Decimal(self)
1148 if other._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001149 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001150
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001151 exp = min(self._exp, other._exp)
1152 negativezero = 0
1153 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Facundo Batista59c58842007-04-10 12:58:45 +00001154 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001155 negativezero = 1
1156
1157 if not self and not other:
1158 sign = min(self._sign, other._sign)
1159 if negativezero:
1160 sign = 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00001161 ans = _dec_from_triple(sign, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001162 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001163 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001164 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001165 exp = max(exp, other._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001166 ans = other._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001167 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001168 return ans
1169 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001170 exp = max(exp, self._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001171 ans = self._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001172 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001173 return ans
1174
1175 op1 = _WorkRep(self)
1176 op2 = _WorkRep(other)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001177 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178
1179 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001180 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001181 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001182 if op1.int == op2.int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001183 ans = _dec_from_triple(negativezero, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001184 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001185 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001186 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001187 op1, op2 = op2, op1
Facundo Batista59c58842007-04-10 12:58:45 +00001188 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001189 if op1.sign == 1:
1190 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001191 op1.sign, op2.sign = op2.sign, op1.sign
1192 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001193 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001194 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001195 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001196 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001197 op1.sign, op2.sign = (0, 0)
1198 else:
1199 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001200 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001201
Raymond Hettinger17931de2004-10-27 06:21:46 +00001202 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001203 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001205 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001206
1207 result.exp = op1.exp
1208 ans = Decimal(result)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001209 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001210 return ans
1211
1212 __radd__ = __add__
1213
1214 def __sub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001215 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001216 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001217 if other is NotImplemented:
1218 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001219
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001220 if self._is_special or other._is_special:
1221 ans = self._check_nans(other, context=context)
1222 if ans:
1223 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001224
Facundo Batista353750c2007-09-13 18:13:15 +00001225 # self - other is computed as self + other.copy_negate()
1226 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001227
1228 def __rsub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001229 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001230 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001231 if other is NotImplemented:
1232 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233
Facundo Batista353750c2007-09-13 18:13:15 +00001234 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001236 def __mul__(self, other, context=None):
1237 """Return self * other.
1238
1239 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1240 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001241 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001242 if other is NotImplemented:
1243 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001244
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001245 if context is None:
1246 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001247
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001248 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001249
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001250 if self._is_special or other._is_special:
1251 ans = self._check_nans(other, context)
1252 if ans:
1253 return ans
1254
1255 if self._isinfinity():
1256 if not other:
1257 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001258 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001259
1260 if other._isinfinity():
1261 if not self:
1262 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001263 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001264
1265 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001266
1267 # Special case for multiplying by zero
1268 if not self or not other:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001269 ans = _dec_from_triple(resultsign, '0', resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001270 # Fixing in case the exponent is out of bounds
1271 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001272 return ans
1273
1274 # Special case for multiplying by power of 10
Facundo Batista72bc54f2007-11-23 17:59:00 +00001275 if self._int == '1':
1276 ans = _dec_from_triple(resultsign, other._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001277 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001278 return ans
Facundo Batista72bc54f2007-11-23 17:59:00 +00001279 if other._int == '1':
1280 ans = _dec_from_triple(resultsign, self._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001281 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001282 return ans
1283
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001284 op1 = _WorkRep(self)
1285 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001286
Facundo Batista72bc54f2007-11-23 17:59:00 +00001287 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001288 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001289
1290 return ans
1291 __rmul__ = __mul__
1292
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001293 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001294 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001295 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001296 if other is NotImplemented:
Facundo Batistacce8df22007-09-18 16:53:18 +00001297 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001298
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001299 if context is None:
1300 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001301
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001302 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001303
1304 if self._is_special or other._is_special:
1305 ans = self._check_nans(other, context)
1306 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001307 return ans
1308
1309 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001310 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001311
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001312 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001313 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001314
1315 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001316 context._raise_error(Clamped, 'Division by infinity')
Facundo Batista72bc54f2007-11-23 17:59:00 +00001317 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001318
1319 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001320 if not other:
Facundo Batistacce8df22007-09-18 16:53:18 +00001321 if not self:
1322 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001323 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001324
Facundo Batistacce8df22007-09-18 16:53:18 +00001325 if not self:
1326 exp = self._exp - other._exp
1327 coeff = 0
1328 else:
1329 # OK, so neither = 0, INF or NaN
1330 shift = len(other._int) - len(self._int) + context.prec + 1
1331 exp = self._exp - other._exp - shift
1332 op1 = _WorkRep(self)
1333 op2 = _WorkRep(other)
1334 if shift >= 0:
1335 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1336 else:
1337 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1338 if remainder:
1339 # result is not exact; adjust to ensure correct rounding
1340 if coeff % 5 == 0:
1341 coeff += 1
1342 else:
1343 # result is exact; get as close to ideal exponent as possible
1344 ideal_exp = self._exp - other._exp
1345 while exp < ideal_exp and coeff % 10 == 0:
1346 coeff //= 10
1347 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001348
Facundo Batista72bc54f2007-11-23 17:59:00 +00001349 ans = _dec_from_triple(sign, str(coeff), exp)
Facundo Batistacce8df22007-09-18 16:53:18 +00001350 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001351
Facundo Batistacce8df22007-09-18 16:53:18 +00001352 def _divide(self, other, context):
1353 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001354
Facundo Batistacce8df22007-09-18 16:53:18 +00001355 Assumes that neither self nor other is a NaN, that self is not
1356 infinite and that other is nonzero.
1357 """
1358 sign = self._sign ^ other._sign
1359 if other._isinfinity():
1360 ideal_exp = self._exp
1361 else:
1362 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001363
Facundo Batistacce8df22007-09-18 16:53:18 +00001364 expdiff = self.adjusted() - other.adjusted()
1365 if not self or other._isinfinity() or expdiff <= -2:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001366 return (_dec_from_triple(sign, '0', 0),
Facundo Batistacce8df22007-09-18 16:53:18 +00001367 self._rescale(ideal_exp, context.rounding))
1368 if expdiff <= context.prec:
1369 op1 = _WorkRep(self)
1370 op2 = _WorkRep(other)
1371 if op1.exp >= op2.exp:
1372 op1.int *= 10**(op1.exp - op2.exp)
1373 else:
1374 op2.int *= 10**(op2.exp - op1.exp)
1375 q, r = divmod(op1.int, op2.int)
1376 if q < 10**context.prec:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001377 return (_dec_from_triple(sign, str(q), 0),
1378 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001379
Facundo Batistacce8df22007-09-18 16:53:18 +00001380 # Here the quotient is too large to be representable
1381 ans = context._raise_error(DivisionImpossible,
1382 'quotient too large in //, % or divmod')
1383 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001384
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001385 def __rtruediv__(self, other, context=None):
1386 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001387 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001388 if other is NotImplemented:
1389 return other
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001390 return other.__truediv__(self, context=context)
1391
1392 __div__ = __truediv__
1393 __rdiv__ = __rtruediv__
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001394
1395 def __divmod__(self, other, context=None):
1396 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001397 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001398 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001399 other = _convert_other(other)
1400 if other is NotImplemented:
1401 return other
1402
1403 if context is None:
1404 context = getcontext()
1405
1406 ans = self._check_nans(other, context)
1407 if ans:
1408 return (ans, ans)
1409
1410 sign = self._sign ^ other._sign
1411 if self._isinfinity():
1412 if other._isinfinity():
1413 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1414 return ans, ans
1415 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001416 return (_SignedInfinity[sign],
Facundo Batistacce8df22007-09-18 16:53:18 +00001417 context._raise_error(InvalidOperation, 'INF % x'))
1418
1419 if not other:
1420 if not self:
1421 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1422 return ans, ans
1423 else:
1424 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1425 context._raise_error(InvalidOperation, 'x % 0'))
1426
1427 quotient, remainder = self._divide(other, context)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001428 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001429 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001430
1431 def __rdivmod__(self, other, context=None):
1432 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001433 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001434 if other is NotImplemented:
1435 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001436 return other.__divmod__(self, context=context)
1437
1438 def __mod__(self, other, context=None):
1439 """
1440 self % other
1441 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001442 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001443 if other is NotImplemented:
1444 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001445
Facundo Batistacce8df22007-09-18 16:53:18 +00001446 if context is None:
1447 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001448
Facundo Batistacce8df22007-09-18 16:53:18 +00001449 ans = self._check_nans(other, context)
1450 if ans:
1451 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001452
Facundo Batistacce8df22007-09-18 16:53:18 +00001453 if self._isinfinity():
1454 return context._raise_error(InvalidOperation, 'INF % x')
1455 elif not other:
1456 if self:
1457 return context._raise_error(InvalidOperation, 'x % 0')
1458 else:
1459 return context._raise_error(DivisionUndefined, '0 % 0')
1460
1461 remainder = self._divide(other, context)[1]
Facundo Batistae64acfa2007-12-17 14:18:42 +00001462 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001463 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001464
1465 def __rmod__(self, other, context=None):
1466 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001467 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001468 if other is NotImplemented:
1469 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001470 return other.__mod__(self, context=context)
1471
1472 def remainder_near(self, other, context=None):
1473 """
1474 Remainder nearest to 0- abs(remainder-near) <= other/2
1475 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001476 if context is None:
1477 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001478
Facundo Batista353750c2007-09-13 18:13:15 +00001479 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001480
Facundo Batista353750c2007-09-13 18:13:15 +00001481 ans = self._check_nans(other, context)
1482 if ans:
1483 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001484
Facundo Batista353750c2007-09-13 18:13:15 +00001485 # self == +/-infinity -> InvalidOperation
1486 if self._isinfinity():
1487 return context._raise_error(InvalidOperation,
1488 'remainder_near(infinity, x)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001489
Facundo Batista353750c2007-09-13 18:13:15 +00001490 # other == 0 -> either InvalidOperation or DivisionUndefined
1491 if not other:
1492 if self:
1493 return context._raise_error(InvalidOperation,
1494 'remainder_near(x, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001495 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001496 return context._raise_error(DivisionUndefined,
1497 'remainder_near(0, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001498
Facundo Batista353750c2007-09-13 18:13:15 +00001499 # other = +/-infinity -> remainder = self
1500 if other._isinfinity():
1501 ans = Decimal(self)
1502 return ans._fix(context)
1503
1504 # self = 0 -> remainder = self, with ideal exponent
1505 ideal_exponent = min(self._exp, other._exp)
1506 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001507 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001508 return ans._fix(context)
1509
1510 # catch most cases of large or small quotient
1511 expdiff = self.adjusted() - other.adjusted()
1512 if expdiff >= context.prec + 1:
1513 # expdiff >= prec+1 => abs(self/other) > 10**prec
Facundo Batistacce8df22007-09-18 16:53:18 +00001514 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001515 if expdiff <= -2:
1516 # expdiff <= -2 => abs(self/other) < 0.1
1517 ans = self._rescale(ideal_exponent, context.rounding)
1518 return ans._fix(context)
1519
1520 # adjust both arguments to have the same exponent, then divide
1521 op1 = _WorkRep(self)
1522 op2 = _WorkRep(other)
1523 if op1.exp >= op2.exp:
1524 op1.int *= 10**(op1.exp - op2.exp)
1525 else:
1526 op2.int *= 10**(op2.exp - op1.exp)
1527 q, r = divmod(op1.int, op2.int)
1528 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1529 # 10**ideal_exponent. Apply correction to ensure that
1530 # abs(remainder) <= abs(other)/2
1531 if 2*r + (q&1) > op2.int:
1532 r -= op2.int
1533 q += 1
1534
1535 if q >= 10**context.prec:
Facundo Batistacce8df22007-09-18 16:53:18 +00001536 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001537
1538 # result has same sign as self unless r is negative
1539 sign = self._sign
1540 if r < 0:
1541 sign = 1-sign
1542 r = -r
1543
Facundo Batista72bc54f2007-11-23 17:59:00 +00001544 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001545 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001546
1547 def __floordiv__(self, other, context=None):
1548 """self // other"""
Facundo Batistacce8df22007-09-18 16:53:18 +00001549 other = _convert_other(other)
1550 if other is NotImplemented:
1551 return other
1552
1553 if context is None:
1554 context = getcontext()
1555
1556 ans = self._check_nans(other, context)
1557 if ans:
1558 return ans
1559
1560 if self._isinfinity():
1561 if other._isinfinity():
1562 return context._raise_error(InvalidOperation, 'INF // INF')
1563 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001564 return _SignedInfinity[self._sign ^ other._sign]
Facundo Batistacce8df22007-09-18 16:53:18 +00001565
1566 if not other:
1567 if self:
1568 return context._raise_error(DivisionByZero, 'x // 0',
1569 self._sign ^ other._sign)
1570 else:
1571 return context._raise_error(DivisionUndefined, '0 // 0')
1572
1573 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001574
1575 def __rfloordiv__(self, other, context=None):
1576 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001577 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001578 if other is NotImplemented:
1579 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001580 return other.__floordiv__(self, context=context)
1581
1582 def __float__(self):
1583 """Float representation."""
1584 return float(str(self))
1585
1586 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001587 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001588 if self._is_special:
1589 if self._isnan():
Mark Dickinson968f1692009-09-07 18:04:58 +00001590 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001591 elif self._isinfinity():
Mark Dickinson968f1692009-09-07 18:04:58 +00001592 raise OverflowError("Cannot convert infinity to integer")
Facundo Batista353750c2007-09-13 18:13:15 +00001593 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001594 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001595 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001596 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001597 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001598
Raymond Hettinger5a053642008-01-24 19:05:29 +00001599 __trunc__ = __int__
1600
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001601 def real(self):
1602 return self
Mark Dickinson65808ff2009-01-04 21:22:02 +00001603 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001604
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001605 def imag(self):
1606 return Decimal(0)
Mark Dickinson65808ff2009-01-04 21:22:02 +00001607 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001608
1609 def conjugate(self):
1610 return self
1611
1612 def __complex__(self):
1613 return complex(float(self))
1614
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001615 def __long__(self):
1616 """Converts to a long.
1617
1618 Equivalent to long(int(self))
1619 """
1620 return long(self.__int__())
1621
Facundo Batista353750c2007-09-13 18:13:15 +00001622 def _fix_nan(self, context):
1623 """Decapitate the payload of a NaN to fit the context"""
1624 payload = self._int
1625
1626 # maximum length of payload is precision if _clamp=0,
1627 # precision-1 if _clamp=1.
1628 max_payload_len = context.prec - context._clamp
1629 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001630 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1631 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001632 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001633
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001634 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001635 """Round if it is necessary to keep self within prec precision.
1636
1637 Rounds and fixes the exponent. Does not raise on a sNaN.
1638
1639 Arguments:
1640 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001641 context - context used.
1642 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001643
Facundo Batista353750c2007-09-13 18:13:15 +00001644 if self._is_special:
1645 if self._isnan():
1646 # decapitate payload if necessary
1647 return self._fix_nan(context)
1648 else:
1649 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001650 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001651
Facundo Batista353750c2007-09-13 18:13:15 +00001652 # if self is zero then exponent should be between Etiny and
1653 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1654 Etiny = context.Etiny()
1655 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001656 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001657 exp_max = [context.Emax, Etop][context._clamp]
1658 new_exp = min(max(self._exp, Etiny), exp_max)
1659 if new_exp != self._exp:
1660 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001661 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001662 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001663 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001664
1665 # exp_min is the smallest allowable exponent of the result,
1666 # equal to max(self.adjusted()-context.prec+1, Etiny)
1667 exp_min = len(self._int) + self._exp - context.prec
1668 if exp_min > Etop:
1669 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001670 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00001671 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001672 context._raise_error(Rounded)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001673 return ans
1674
Facundo Batista353750c2007-09-13 18:13:15 +00001675 self_is_subnormal = exp_min < Etiny
1676 if self_is_subnormal:
Facundo Batista353750c2007-09-13 18:13:15 +00001677 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001678
Facundo Batista353750c2007-09-13 18:13:15 +00001679 # round if self has too many digits
1680 if self._exp < exp_min:
Facundo Batista2ec74152007-12-03 17:55:00 +00001681 digits = len(self._int) + self._exp - exp_min
1682 if digits < 0:
1683 self = _dec_from_triple(self._sign, '1', exp_min-1)
1684 digits = 0
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001685 rounding_method = self._pick_rounding_function[context.rounding]
1686 changed = getattr(self, rounding_method)(digits)
Facundo Batista2ec74152007-12-03 17:55:00 +00001687 coeff = self._int[:digits] or '0'
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001688 if changed > 0:
Facundo Batista2ec74152007-12-03 17:55:00 +00001689 coeff = str(int(coeff)+1)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001690 if len(coeff) > context.prec:
1691 coeff = coeff[:-1]
1692 exp_min += 1
Facundo Batista2ec74152007-12-03 17:55:00 +00001693
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001694 # check whether the rounding pushed the exponent out of range
1695 if exp_min > Etop:
1696 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1697 else:
1698 ans = _dec_from_triple(self._sign, coeff, exp_min)
1699
1700 # raise the appropriate signals, taking care to respect
1701 # the precedence described in the specification
1702 if changed and self_is_subnormal:
1703 context._raise_error(Underflow)
1704 if self_is_subnormal:
1705 context._raise_error(Subnormal)
Facundo Batista2ec74152007-12-03 17:55:00 +00001706 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001707 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001708 context._raise_error(Rounded)
1709 if not ans:
1710 # raise Clamped on underflow to 0
1711 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001712 return ans
1713
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001714 if self_is_subnormal:
1715 context._raise_error(Subnormal)
1716
Facundo Batista353750c2007-09-13 18:13:15 +00001717 # fold down if _clamp == 1 and self has too few digits
1718 if context._clamp == 1 and self._exp > Etop:
1719 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001720 self_padded = self._int + '0'*(self._exp - Etop)
1721 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001722
Facundo Batista353750c2007-09-13 18:13:15 +00001723 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001724 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001725
1726 _pick_rounding_function = {}
1727
Facundo Batista353750c2007-09-13 18:13:15 +00001728 # for each of the rounding functions below:
1729 # self is a finite, nonzero Decimal
1730 # prec is an integer satisfying 0 <= prec < len(self._int)
Facundo Batista2ec74152007-12-03 17:55:00 +00001731 #
1732 # each function returns either -1, 0, or 1, as follows:
1733 # 1 indicates that self should be rounded up (away from zero)
1734 # 0 indicates that self should be truncated, and that all the
1735 # digits to be truncated are zeros (so the value is unchanged)
1736 # -1 indicates that there are nonzero digits to be truncated
Facundo Batista353750c2007-09-13 18:13:15 +00001737
1738 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001739 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001740 if _all_zeros(self._int, prec):
1741 return 0
1742 else:
1743 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001744
Facundo Batista353750c2007-09-13 18:13:15 +00001745 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001746 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001747 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001748
Facundo Batista353750c2007-09-13 18:13:15 +00001749 def _round_half_up(self, prec):
1750 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001751 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001752 return 1
1753 elif _all_zeros(self._int, prec):
1754 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001755 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001756 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001757
1758 def _round_half_down(self, prec):
1759 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001760 if _exact_half(self._int, prec):
1761 return -1
1762 else:
1763 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001764
1765 def _round_half_even(self, prec):
1766 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001767 if _exact_half(self._int, prec) and \
1768 (prec == 0 or self._int[prec-1] in '02468'):
1769 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001770 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001771 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001772
1773 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001774 """Rounds up (not away from 0 if negative.)"""
1775 if self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001776 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001777 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001778 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001779
Facundo Batista353750c2007-09-13 18:13:15 +00001780 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001781 """Rounds down (not towards 0 if negative)"""
1782 if not self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001783 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001784 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001785 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001786
Facundo Batista353750c2007-09-13 18:13:15 +00001787 def _round_05up(self, prec):
1788 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001789 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001790 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001791 else:
1792 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001793
Facundo Batista353750c2007-09-13 18:13:15 +00001794 def fma(self, other, third, context=None):
1795 """Fused multiply-add.
1796
1797 Returns self*other+third with no rounding of the intermediate
1798 product self*other.
1799
1800 self and other are multiplied together, with no rounding of
1801 the result. The third operand is then added to the result,
1802 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001803 """
Facundo Batista353750c2007-09-13 18:13:15 +00001804
1805 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001806
1807 # compute product; raise InvalidOperation if either operand is
1808 # a signaling NaN or if the product is zero times infinity.
1809 if self._is_special or other._is_special:
1810 if context is None:
1811 context = getcontext()
1812 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001813 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001814 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001815 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001816 if self._exp == 'n':
1817 product = self
1818 elif other._exp == 'n':
1819 product = other
1820 elif self._exp == 'F':
1821 if not other:
1822 return context._raise_error(InvalidOperation,
1823 'INF * 0 in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001824 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001825 elif other._exp == 'F':
1826 if not self:
1827 return context._raise_error(InvalidOperation,
1828 '0 * INF in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001829 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001830 else:
1831 product = _dec_from_triple(self._sign ^ other._sign,
1832 str(int(self._int) * int(other._int)),
1833 self._exp + other._exp)
1834
Facundo Batista353750c2007-09-13 18:13:15 +00001835 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001836 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001837
Facundo Batista353750c2007-09-13 18:13:15 +00001838 def _power_modulo(self, other, modulo, context=None):
1839 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001840
Facundo Batista353750c2007-09-13 18:13:15 +00001841 # if can't convert other and modulo to Decimal, raise
1842 # TypeError; there's no point returning NotImplemented (no
1843 # equivalent of __rpow__ for three argument pow)
1844 other = _convert_other(other, raiseit=True)
1845 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001846
Facundo Batista353750c2007-09-13 18:13:15 +00001847 if context is None:
1848 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001849
Facundo Batista353750c2007-09-13 18:13:15 +00001850 # deal with NaNs: if there are any sNaNs then first one wins,
1851 # (i.e. behaviour for NaNs is identical to that of fma)
1852 self_is_nan = self._isnan()
1853 other_is_nan = other._isnan()
1854 modulo_is_nan = modulo._isnan()
1855 if self_is_nan or other_is_nan or modulo_is_nan:
1856 if self_is_nan == 2:
1857 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001858 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001859 if other_is_nan == 2:
1860 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001861 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001862 if modulo_is_nan == 2:
1863 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001864 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001865 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001866 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001867 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001868 return other._fix_nan(context)
1869 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001870
Facundo Batista353750c2007-09-13 18:13:15 +00001871 # check inputs: we apply same restrictions as Python's pow()
1872 if not (self._isinteger() and
1873 other._isinteger() and
1874 modulo._isinteger()):
1875 return context._raise_error(InvalidOperation,
1876 'pow() 3rd argument not allowed '
1877 'unless all arguments are integers')
1878 if other < 0:
1879 return context._raise_error(InvalidOperation,
1880 'pow() 2nd argument cannot be '
1881 'negative when 3rd argument specified')
1882 if not modulo:
1883 return context._raise_error(InvalidOperation,
1884 'pow() 3rd argument cannot be 0')
1885
1886 # additional restriction for decimal: the modulus must be less
1887 # than 10**prec in absolute value
1888 if modulo.adjusted() >= context.prec:
1889 return context._raise_error(InvalidOperation,
1890 'insufficient precision: pow() 3rd '
1891 'argument must not have more than '
1892 'precision digits')
1893
1894 # define 0**0 == NaN, for consistency with two-argument pow
1895 # (even though it hurts!)
1896 if not other and not self:
1897 return context._raise_error(InvalidOperation,
1898 'at least one of pow() 1st argument '
1899 'and 2nd argument must be nonzero ;'
1900 '0**0 is not defined')
1901
1902 # compute sign of result
1903 if other._iseven():
1904 sign = 0
1905 else:
1906 sign = self._sign
1907
1908 # convert modulo to a Python integer, and self and other to
1909 # Decimal integers (i.e. force their exponents to be >= 0)
1910 modulo = abs(int(modulo))
1911 base = _WorkRep(self.to_integral_value())
1912 exponent = _WorkRep(other.to_integral_value())
1913
1914 # compute result using integer pow()
1915 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1916 for i in xrange(exponent.exp):
1917 base = pow(base, 10, modulo)
1918 base = pow(base, exponent.int, modulo)
1919
Facundo Batista72bc54f2007-11-23 17:59:00 +00001920 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001921
1922 def _power_exact(self, other, p):
1923 """Attempt to compute self**other exactly.
1924
1925 Given Decimals self and other and an integer p, attempt to
1926 compute an exact result for the power self**other, with p
1927 digits of precision. Return None if self**other is not
1928 exactly representable in p digits.
1929
1930 Assumes that elimination of special cases has already been
1931 performed: self and other must both be nonspecial; self must
1932 be positive and not numerically equal to 1; other must be
1933 nonzero. For efficiency, other._exp should not be too large,
1934 so that 10**abs(other._exp) is a feasible calculation."""
1935
1936 # In the comments below, we write x for the value of self and
1937 # y for the value of other. Write x = xc*10**xe and y =
1938 # yc*10**ye.
1939
1940 # The main purpose of this method is to identify the *failure*
1941 # of x**y to be exactly representable with as little effort as
1942 # possible. So we look for cheap and easy tests that
1943 # eliminate the possibility of x**y being exact. Only if all
1944 # these tests are passed do we go on to actually compute x**y.
1945
1946 # Here's the main idea. First normalize both x and y. We
1947 # express y as a rational m/n, with m and n relatively prime
1948 # and n>0. Then for x**y to be exactly representable (at
1949 # *any* precision), xc must be the nth power of a positive
1950 # integer and xe must be divisible by n. If m is negative
1951 # then additionally xc must be a power of either 2 or 5, hence
1952 # a power of 2**n or 5**n.
1953 #
1954 # There's a limit to how small |y| can be: if y=m/n as above
1955 # then:
1956 #
1957 # (1) if xc != 1 then for the result to be representable we
1958 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1959 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1960 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1961 # representable.
1962 #
1963 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1964 # |y| < 1/|xe| then the result is not representable.
1965 #
1966 # Note that since x is not equal to 1, at least one of (1) and
1967 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1968 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1969 #
1970 # There's also a limit to how large y can be, at least if it's
1971 # positive: the normalized result will have coefficient xc**y,
1972 # so if it's representable then xc**y < 10**p, and y <
1973 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1974 # not exactly representable.
1975
1976 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1977 # so |y| < 1/xe and the result is not representable.
1978 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1979 # < 1/nbits(xc).
1980
1981 x = _WorkRep(self)
1982 xc, xe = x.int, x.exp
1983 while xc % 10 == 0:
1984 xc //= 10
1985 xe += 1
1986
1987 y = _WorkRep(other)
1988 yc, ye = y.int, y.exp
1989 while yc % 10 == 0:
1990 yc //= 10
1991 ye += 1
1992
1993 # case where xc == 1: result is 10**(xe*y), with xe*y
1994 # required to be an integer
1995 if xc == 1:
Mark Dickinsone85aa732010-07-08 19:24:40 +00001996 xe *= yc
1997 # result is now 10**(xe * 10**ye); xe * 10**ye must be integral
1998 while xe % 10 == 0:
1999 xe //= 10
2000 ye += 1
2001 if ye < 0:
2002 return None
2003 exponent = xe * 10**ye
Facundo Batista353750c2007-09-13 18:13:15 +00002004 if y.sign == 1:
2005 exponent = -exponent
2006 # if other is a nonnegative integer, use ideal exponent
2007 if other._isinteger() and other._sign == 0:
2008 ideal_exponent = self._exp*int(other)
2009 zeros = min(exponent-ideal_exponent, p-1)
2010 else:
2011 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002012 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002013
2014 # case where y is negative: xc must be either a power
2015 # of 2 or a power of 5.
2016 if y.sign == 1:
2017 last_digit = xc % 10
2018 if last_digit in (2,4,6,8):
2019 # quick test for power of 2
2020 if xc & -xc != xc:
2021 return None
2022 # now xc is a power of 2; e is its exponent
2023 e = _nbits(xc)-1
2024 # find e*y and xe*y; both must be integers
2025 if ye >= 0:
2026 y_as_int = yc*10**ye
2027 e = e*y_as_int
2028 xe = xe*y_as_int
2029 else:
2030 ten_pow = 10**-ye
2031 e, remainder = divmod(e*yc, ten_pow)
2032 if remainder:
2033 return None
2034 xe, remainder = divmod(xe*yc, ten_pow)
2035 if remainder:
2036 return None
2037
2038 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2039 return None
2040 xc = 5**e
2041
2042 elif last_digit == 5:
2043 # e >= log_5(xc) if xc is a power of 5; we have
2044 # equality all the way up to xc=5**2658
2045 e = _nbits(xc)*28//65
2046 xc, remainder = divmod(5**e, xc)
2047 if remainder:
2048 return None
2049 while xc % 5 == 0:
2050 xc //= 5
2051 e -= 1
2052 if ye >= 0:
2053 y_as_integer = yc*10**ye
2054 e = e*y_as_integer
2055 xe = xe*y_as_integer
2056 else:
2057 ten_pow = 10**-ye
2058 e, remainder = divmod(e*yc, ten_pow)
2059 if remainder:
2060 return None
2061 xe, remainder = divmod(xe*yc, ten_pow)
2062 if remainder:
2063 return None
2064 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2065 return None
2066 xc = 2**e
2067 else:
2068 return None
2069
2070 if xc >= 10**p:
2071 return None
2072 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00002073 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00002074
2075 # now y is positive; find m and n such that y = m/n
2076 if ye >= 0:
2077 m, n = yc*10**ye, 1
2078 else:
2079 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2080 return None
2081 xc_bits = _nbits(xc)
2082 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2083 return None
2084 m, n = yc, 10**(-ye)
2085 while m % 2 == n % 2 == 0:
2086 m //= 2
2087 n //= 2
2088 while m % 5 == n % 5 == 0:
2089 m //= 5
2090 n //= 5
2091
2092 # compute nth root of xc*10**xe
2093 if n > 1:
2094 # if 1 < xc < 2**n then xc isn't an nth power
2095 if xc != 1 and xc_bits <= n:
2096 return None
2097
2098 xe, rem = divmod(xe, n)
2099 if rem != 0:
2100 return None
2101
2102 # compute nth root of xc using Newton's method
2103 a = 1L << -(-_nbits(xc)//n) # initial estimate
2104 while True:
2105 q, r = divmod(xc, a**(n-1))
2106 if a <= q:
2107 break
2108 else:
2109 a = (a*(n-1) + q)//n
2110 if not (a == q and r == 0):
2111 return None
2112 xc = a
2113
2114 # now xc*10**xe is the nth root of the original xc*10**xe
2115 # compute mth power of xc*10**xe
2116
2117 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2118 # 10**p and the result is not representable.
2119 if xc > 1 and m > p*100//_log10_lb(xc):
2120 return None
2121 xc = xc**m
2122 xe *= m
2123 if xc > 10**p:
2124 return None
2125
2126 # by this point the result *is* exactly representable
2127 # adjust the exponent to get as close as possible to the ideal
2128 # exponent, if necessary
2129 str_xc = str(xc)
2130 if other._isinteger() and other._sign == 0:
2131 ideal_exponent = self._exp*int(other)
2132 zeros = min(xe-ideal_exponent, p-len(str_xc))
2133 else:
2134 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002135 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002136
2137 def __pow__(self, other, modulo=None, context=None):
2138 """Return self ** other [ % modulo].
2139
2140 With two arguments, compute self**other.
2141
2142 With three arguments, compute (self**other) % modulo. For the
2143 three argument form, the following restrictions on the
2144 arguments hold:
2145
2146 - all three arguments must be integral
2147 - other must be nonnegative
2148 - either self or other (or both) must be nonzero
2149 - modulo must be nonzero and must have at most p digits,
2150 where p is the context precision.
2151
2152 If any of these restrictions is violated the InvalidOperation
2153 flag is raised.
2154
2155 The result of pow(self, other, modulo) is identical to the
2156 result that would be obtained by computing (self**other) %
2157 modulo with unbounded precision, but is computed more
2158 efficiently. It is always exact.
2159 """
2160
2161 if modulo is not None:
2162 return self._power_modulo(other, modulo, context)
2163
2164 other = _convert_other(other)
2165 if other is NotImplemented:
2166 return other
2167
2168 if context is None:
2169 context = getcontext()
2170
2171 # either argument is a NaN => result is NaN
2172 ans = self._check_nans(other, context)
2173 if ans:
2174 return ans
2175
2176 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2177 if not other:
2178 if not self:
2179 return context._raise_error(InvalidOperation, '0 ** 0')
2180 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002181 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002182
2183 # result has sign 1 iff self._sign is 1 and other is an odd integer
2184 result_sign = 0
2185 if self._sign == 1:
2186 if other._isinteger():
2187 if not other._iseven():
2188 result_sign = 1
2189 else:
2190 # -ve**noninteger = NaN
2191 # (-0)**noninteger = 0**noninteger
2192 if self:
2193 return context._raise_error(InvalidOperation,
2194 'x ** y with x negative and y not an integer')
2195 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002196 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002197
2198 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2199 if not self:
2200 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002201 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002202 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002203 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002204
2205 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002206 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002207 if other._sign == 0:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002208 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002209 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002210 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002211
Facundo Batista353750c2007-09-13 18:13:15 +00002212 # 1**other = 1, but the choice of exponent and the flags
2213 # depend on the exponent of self, and on whether other is a
2214 # positive integer, a negative integer, or neither
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002215 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002216 if other._isinteger():
2217 # exp = max(self._exp*max(int(other), 0),
2218 # 1-context.prec) but evaluating int(other) directly
2219 # is dangerous until we know other is small (other
2220 # could be 1e999999999)
2221 if other._sign == 1:
2222 multiplier = 0
2223 elif other > context.prec:
2224 multiplier = context.prec
2225 else:
2226 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002227
Facundo Batista353750c2007-09-13 18:13:15 +00002228 exp = self._exp * multiplier
2229 if exp < 1-context.prec:
2230 exp = 1-context.prec
2231 context._raise_error(Rounded)
2232 else:
2233 context._raise_error(Inexact)
2234 context._raise_error(Rounded)
2235 exp = 1-context.prec
2236
Facundo Batista72bc54f2007-11-23 17:59:00 +00002237 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002238
2239 # compute adjusted exponent of self
2240 self_adj = self.adjusted()
2241
2242 # self ** infinity is infinity if self > 1, 0 if self < 1
2243 # self ** -infinity is infinity if self < 1, 0 if self > 1
2244 if other._isinfinity():
2245 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002246 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002247 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002248 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002249
2250 # from here on, the result always goes through the call
2251 # to _fix at the end of this function.
2252 ans = None
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002253 exact = False
Facundo Batista353750c2007-09-13 18:13:15 +00002254
2255 # crude test to catch cases of extreme overflow/underflow. If
2256 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2257 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2258 # self**other >= 10**(Emax+1), so overflow occurs. The test
2259 # for underflow is similar.
2260 bound = self._log10_exp_bound() + other.adjusted()
2261 if (self_adj >= 0) == (other._sign == 0):
2262 # self > 1 and other +ve, or self < 1 and other -ve
2263 # possibility of overflow
2264 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002265 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002266 else:
2267 # self > 1 and other -ve, or self < 1 and other +ve
2268 # possibility of underflow to 0
2269 Etiny = context.Etiny()
2270 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002271 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002272
2273 # try for an exact result with precision +1
2274 if ans is None:
2275 ans = self._power_exact(other, context.prec + 1)
Mark Dickinsone85aa732010-07-08 19:24:40 +00002276 if ans is not None:
2277 if result_sign == 1:
2278 ans = _dec_from_triple(1, ans._int, ans._exp)
2279 exact = True
Facundo Batista353750c2007-09-13 18:13:15 +00002280
2281 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2282 if ans is None:
2283 p = context.prec
2284 x = _WorkRep(self)
2285 xc, xe = x.int, x.exp
2286 y = _WorkRep(other)
2287 yc, ye = y.int, y.exp
2288 if y.sign == 1:
2289 yc = -yc
2290
2291 # compute correctly rounded result: start with precision +3,
2292 # then increase precision until result is unambiguously roundable
2293 extra = 3
2294 while True:
2295 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2296 if coeff % (5*10**(len(str(coeff))-p-1)):
2297 break
2298 extra += 3
2299
Facundo Batista72bc54f2007-11-23 17:59:00 +00002300 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002301
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002302 # unlike exp, ln and log10, the power function respects the
2303 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2304
2305 # There's a difficulty here when 'other' is not an integer and
2306 # the result is exact. In this case, the specification
2307 # requires that the Inexact flag be raised (in spite of
2308 # exactness), but since the result is exact _fix won't do this
2309 # for us. (Correspondingly, the Underflow signal should also
2310 # be raised for subnormal results.) We can't directly raise
2311 # these signals either before or after calling _fix, since
2312 # that would violate the precedence for signals. So we wrap
2313 # the ._fix call in a temporary context, and reraise
2314 # afterwards.
2315 if exact and not other._isinteger():
2316 # pad with zeros up to length context.prec+1 if necessary; this
2317 # ensures that the Rounded signal will be raised.
Facundo Batista353750c2007-09-13 18:13:15 +00002318 if len(ans._int) <= context.prec:
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002319 expdiff = context.prec + 1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002320 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2321 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002322
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002323 # create a copy of the current context, with cleared flags/traps
2324 newcontext = context.copy()
2325 newcontext.clear_flags()
2326 for exception in _signals:
2327 newcontext.traps[exception] = 0
2328
2329 # round in the new context
2330 ans = ans._fix(newcontext)
2331
2332 # raise Inexact, and if necessary, Underflow
2333 newcontext._raise_error(Inexact)
2334 if newcontext.flags[Subnormal]:
2335 newcontext._raise_error(Underflow)
2336
2337 # propagate signals to the original context; _fix could
2338 # have raised any of Overflow, Underflow, Subnormal,
2339 # Inexact, Rounded, Clamped. Overflow needs the correct
2340 # arguments. Note that the order of the exceptions is
2341 # important here.
2342 if newcontext.flags[Overflow]:
2343 context._raise_error(Overflow, 'above Emax', ans._sign)
2344 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2345 if newcontext.flags[exception]:
2346 context._raise_error(exception)
2347
2348 else:
2349 ans = ans._fix(context)
2350
Facundo Batista353750c2007-09-13 18:13:15 +00002351 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002352
2353 def __rpow__(self, other, context=None):
2354 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002355 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002356 if other is NotImplemented:
2357 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002358 return other.__pow__(self, context=context)
2359
2360 def normalize(self, context=None):
2361 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002362
Facundo Batista353750c2007-09-13 18:13:15 +00002363 if context is None:
2364 context = getcontext()
2365
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002366 if self._is_special:
2367 ans = self._check_nans(context=context)
2368 if ans:
2369 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002370
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002371 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002372 if dup._isinfinity():
2373 return dup
2374
2375 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002376 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002377 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002378 end = len(dup._int)
2379 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002380 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002381 exp += 1
2382 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002383 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002384
Facundo Batistabd2fe832007-09-13 18:42:09 +00002385 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002386 """Quantize self so its exponent is the same as that of exp.
2387
2388 Similar to self._rescale(exp._exp) but with error checking.
2389 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002390 exp = _convert_other(exp, raiseit=True)
2391
Facundo Batista353750c2007-09-13 18:13:15 +00002392 if context is None:
2393 context = getcontext()
2394 if rounding is None:
2395 rounding = context.rounding
2396
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002397 if self._is_special or exp._is_special:
2398 ans = self._check_nans(exp, context)
2399 if ans:
2400 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002401
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002402 if exp._isinfinity() or self._isinfinity():
2403 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002404 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002405 return context._raise_error(InvalidOperation,
2406 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002407
Facundo Batistabd2fe832007-09-13 18:42:09 +00002408 # if we're not watching exponents, do a simple rescale
2409 if not watchexp:
2410 ans = self._rescale(exp._exp, rounding)
2411 # raise Inexact and Rounded where appropriate
2412 if ans._exp > self._exp:
2413 context._raise_error(Rounded)
2414 if ans != self:
2415 context._raise_error(Inexact)
2416 return ans
2417
Facundo Batista353750c2007-09-13 18:13:15 +00002418 # exp._exp should be between Etiny and Emax
2419 if not (context.Etiny() <= exp._exp <= context.Emax):
2420 return context._raise_error(InvalidOperation,
2421 'target exponent out of bounds in quantize')
2422
2423 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002424 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002425 return ans._fix(context)
2426
2427 self_adjusted = self.adjusted()
2428 if self_adjusted > context.Emax:
2429 return context._raise_error(InvalidOperation,
2430 'exponent of quantize result too large for current context')
2431 if self_adjusted - exp._exp + 1 > context.prec:
2432 return context._raise_error(InvalidOperation,
2433 'quantize result has too many digits for current context')
2434
2435 ans = self._rescale(exp._exp, rounding)
2436 if ans.adjusted() > context.Emax:
2437 return context._raise_error(InvalidOperation,
2438 'exponent of quantize result too large for current context')
2439 if len(ans._int) > context.prec:
2440 return context._raise_error(InvalidOperation,
2441 'quantize result has too many digits for current context')
2442
2443 # raise appropriate flags
Facundo Batista353750c2007-09-13 18:13:15 +00002444 if ans and ans.adjusted() < context.Emin:
2445 context._raise_error(Subnormal)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002446 if ans._exp > self._exp:
2447 if ans != self:
2448 context._raise_error(Inexact)
2449 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00002450
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002451 # call to fix takes care of any necessary folddown, and
2452 # signals Clamped if necessary
Facundo Batista353750c2007-09-13 18:13:15 +00002453 ans = ans._fix(context)
2454 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002455
2456 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002457 """Return True if self and other have the same exponent; otherwise
2458 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002459
Facundo Batista1a191df2007-10-02 17:01:24 +00002460 If either operand is a special value, the following rules are used:
2461 * return True if both operands are infinities
2462 * return True if both operands are NaNs
2463 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002464 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002465 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002466 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002467 return (self.is_nan() and other.is_nan() or
2468 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002469 return self._exp == other._exp
2470
Facundo Batista353750c2007-09-13 18:13:15 +00002471 def _rescale(self, exp, rounding):
2472 """Rescale self so that the exponent is exp, either by padding with zeros
2473 or by truncating digits, using the given rounding mode.
2474
2475 Specials are returned without change. This operation is
2476 quiet: it raises no flags, and uses no information from the
2477 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002478
2479 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002480 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002481 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002482 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002483 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002484 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002485 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002486
Facundo Batista353750c2007-09-13 18:13:15 +00002487 if self._exp >= exp:
2488 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002489 return _dec_from_triple(self._sign,
2490 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002491
Facundo Batista353750c2007-09-13 18:13:15 +00002492 # too many digits; round and lose data. If self.adjusted() <
2493 # exp-1, replace self by 10**(exp-1) before rounding
2494 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002495 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002496 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002497 digits = 0
2498 this_function = getattr(self, self._pick_rounding_function[rounding])
Facundo Batista2ec74152007-12-03 17:55:00 +00002499 changed = this_function(digits)
2500 coeff = self._int[:digits] or '0'
2501 if changed == 1:
2502 coeff = str(int(coeff)+1)
2503 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002504
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002505 def _round(self, places, rounding):
2506 """Round a nonzero, nonspecial Decimal to a fixed number of
2507 significant figures, using the given rounding mode.
2508
2509 Infinities, NaNs and zeros are returned unaltered.
2510
2511 This operation is quiet: it raises no flags, and uses no
2512 information from the context.
2513
2514 """
2515 if places <= 0:
2516 raise ValueError("argument should be at least 1 in _round")
2517 if self._is_special or not self:
2518 return Decimal(self)
2519 ans = self._rescale(self.adjusted()+1-places, rounding)
2520 # it can happen that the rescale alters the adjusted exponent;
2521 # for example when rounding 99.97 to 3 significant figures.
2522 # When this happens we end up with an extra 0 at the end of
2523 # the number; a second rescale fixes this.
2524 if ans.adjusted() != self.adjusted():
2525 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2526 return ans
2527
Facundo Batista353750c2007-09-13 18:13:15 +00002528 def to_integral_exact(self, rounding=None, context=None):
2529 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002530
Facundo Batista353750c2007-09-13 18:13:15 +00002531 If no rounding mode is specified, take the rounding mode from
2532 the context. This method raises the Rounded and Inexact flags
2533 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002534
Facundo Batista353750c2007-09-13 18:13:15 +00002535 See also: to_integral_value, which does exactly the same as
2536 this method except that it doesn't raise Inexact or Rounded.
2537 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002538 if self._is_special:
2539 ans = self._check_nans(context=context)
2540 if ans:
2541 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002542 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002543 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002544 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002545 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002546 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002547 if context is None:
2548 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002549 if rounding is None:
2550 rounding = context.rounding
Facundo Batista353750c2007-09-13 18:13:15 +00002551 ans = self._rescale(0, rounding)
2552 if ans != self:
2553 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002554 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002555 return ans
2556
Facundo Batista353750c2007-09-13 18:13:15 +00002557 def to_integral_value(self, rounding=None, context=None):
2558 """Rounds to the nearest integer, without raising inexact, rounded."""
2559 if context is None:
2560 context = getcontext()
2561 if rounding is None:
2562 rounding = context.rounding
2563 if self._is_special:
2564 ans = self._check_nans(context=context)
2565 if ans:
2566 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002567 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002568 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002569 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002570 else:
2571 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002572
Facundo Batista353750c2007-09-13 18:13:15 +00002573 # the method name changed, but we provide also the old one, for compatibility
2574 to_integral = to_integral_value
2575
2576 def sqrt(self, context=None):
2577 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002578 if context is None:
2579 context = getcontext()
2580
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002581 if self._is_special:
2582 ans = self._check_nans(context=context)
2583 if ans:
2584 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002585
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002586 if self._isinfinity() and self._sign == 0:
2587 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002588
2589 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002590 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002591 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002592 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002593
2594 if self._sign == 1:
2595 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2596
Facundo Batista353750c2007-09-13 18:13:15 +00002597 # At this point self represents a positive number. Let p be
2598 # the desired precision and express self in the form c*100**e
2599 # with c a positive real number and e an integer, c and e
2600 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2601 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2602 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2603 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2604 # the closest integer to sqrt(c) with the even integer chosen
2605 # in the case of a tie.
2606 #
2607 # To ensure correct rounding in all cases, we use the
2608 # following trick: we compute the square root to an extra
2609 # place (precision p+1 instead of precision p), rounding down.
2610 # Then, if the result is inexact and its last digit is 0 or 5,
2611 # we increase the last digit to 1 or 6 respectively; if it's
2612 # exact we leave the last digit alone. Now the final round to
2613 # p places (or fewer in the case of underflow) will round
2614 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002615
Facundo Batista353750c2007-09-13 18:13:15 +00002616 # use an extra digit of precision
2617 prec = context.prec+1
2618
2619 # write argument in the form c*100**e where e = self._exp//2
2620 # is the 'ideal' exponent, to be used if the square root is
2621 # exactly representable. l is the number of 'digits' of c in
2622 # base 100, so that 100**(l-1) <= c < 100**l.
2623 op = _WorkRep(self)
2624 e = op.exp >> 1
2625 if op.exp & 1:
2626 c = op.int * 10
2627 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002628 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002629 c = op.int
2630 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002631
Facundo Batista353750c2007-09-13 18:13:15 +00002632 # rescale so that c has exactly prec base 100 'digits'
2633 shift = prec-l
2634 if shift >= 0:
2635 c *= 100**shift
2636 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002637 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002638 c, remainder = divmod(c, 100**-shift)
2639 exact = not remainder
2640 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002641
Facundo Batista353750c2007-09-13 18:13:15 +00002642 # find n = floor(sqrt(c)) using Newton's method
2643 n = 10**prec
2644 while True:
2645 q = c//n
2646 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002647 break
Facundo Batista353750c2007-09-13 18:13:15 +00002648 else:
2649 n = n + q >> 1
2650 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002651
Facundo Batista353750c2007-09-13 18:13:15 +00002652 if exact:
2653 # result is exact; rescale to use ideal exponent e
2654 if shift >= 0:
2655 # assert n % 10**shift == 0
2656 n //= 10**shift
2657 else:
2658 n *= 10**-shift
2659 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002660 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002661 # result is not exact; fix last digit as described above
2662 if n % 5 == 0:
2663 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002664
Facundo Batista72bc54f2007-11-23 17:59:00 +00002665 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002666
Facundo Batista353750c2007-09-13 18:13:15 +00002667 # round, and fit to current context
2668 context = context._shallow_copy()
2669 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002670 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002671 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002672
Facundo Batista353750c2007-09-13 18:13:15 +00002673 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002674
2675 def max(self, other, context=None):
2676 """Returns the larger value.
2677
Facundo Batista353750c2007-09-13 18:13:15 +00002678 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002679 NaN (and signals if one is sNaN). Also rounds.
2680 """
Facundo Batista353750c2007-09-13 18:13:15 +00002681 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002682
Facundo Batista6c398da2007-09-17 17:30:13 +00002683 if context is None:
2684 context = getcontext()
2685
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002686 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002687 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002688 # number is always returned
2689 sn = self._isnan()
2690 on = other._isnan()
2691 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002692 if on == 1 and sn == 0:
2693 return self._fix(context)
2694 if sn == 1 and on == 0:
2695 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002696 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002697
Mark Dickinson2fc92632008-02-06 22:10:50 +00002698 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002699 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002700 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002701 # then an ordering is applied:
2702 #
Facundo Batista59c58842007-04-10 12:58:45 +00002703 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002704 # positive sign and min returns the operand with the negative sign
2705 #
Facundo Batista59c58842007-04-10 12:58:45 +00002706 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002707 # the result. This is exactly the ordering used in compare_total.
2708 c = self.compare_total(other)
2709
2710 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002711 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002712 else:
2713 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002714
Facundo Batistae64acfa2007-12-17 14:18:42 +00002715 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002716
2717 def min(self, other, context=None):
2718 """Returns the smaller value.
2719
Facundo Batista59c58842007-04-10 12:58:45 +00002720 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002721 NaN (and signals if one is sNaN). Also rounds.
2722 """
Facundo Batista353750c2007-09-13 18:13:15 +00002723 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002724
Facundo Batista6c398da2007-09-17 17:30:13 +00002725 if context is None:
2726 context = getcontext()
2727
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002728 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002729 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002730 # number is always returned
2731 sn = self._isnan()
2732 on = other._isnan()
2733 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002734 if on == 1 and sn == 0:
2735 return self._fix(context)
2736 if sn == 1 and on == 0:
2737 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002738 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002739
Mark Dickinson2fc92632008-02-06 22:10:50 +00002740 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002741 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002742 c = self.compare_total(other)
2743
2744 if c == -1:
2745 ans = self
2746 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002747 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002748
Facundo Batistae64acfa2007-12-17 14:18:42 +00002749 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002750
2751 def _isinteger(self):
2752 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002753 if self._is_special:
2754 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002755 if self._exp >= 0:
2756 return True
2757 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002758 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002759
2760 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002761 """Returns True if self is even. Assumes self is an integer."""
2762 if not self or self._exp > 0:
2763 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002764 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002765
2766 def adjusted(self):
2767 """Return the adjusted exponent of self"""
2768 try:
2769 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002770 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002771 except TypeError:
2772 return 0
2773
Facundo Batista353750c2007-09-13 18:13:15 +00002774 def canonical(self, context=None):
2775 """Returns the same Decimal object.
2776
2777 As we do not have different encodings for the same number, the
2778 received object already is in its canonical form.
2779 """
2780 return self
2781
2782 def compare_signal(self, other, context=None):
2783 """Compares self to the other operand numerically.
2784
2785 It's pretty much like compare(), but all NaNs signal, with signaling
2786 NaNs taking precedence over quiet NaNs.
2787 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002788 other = _convert_other(other, raiseit = True)
2789 ans = self._compare_check_nans(other, context)
2790 if ans:
2791 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002792 return self.compare(other, context=context)
2793
2794 def compare_total(self, other):
2795 """Compares self to other using the abstract representations.
2796
2797 This is not like the standard compare, which use their numerical
2798 value. Note that a total ordering is defined for all possible abstract
2799 representations.
2800 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002801 other = _convert_other(other, raiseit=True)
2802
Facundo Batista353750c2007-09-13 18:13:15 +00002803 # if one is negative and the other is positive, it's easy
2804 if self._sign and not other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002805 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002806 if not self._sign and other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002807 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002808 sign = self._sign
2809
2810 # let's handle both NaN types
2811 self_nan = self._isnan()
2812 other_nan = other._isnan()
2813 if self_nan or other_nan:
2814 if self_nan == other_nan:
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002815 # compare payloads as though they're integers
2816 self_key = len(self._int), self._int
2817 other_key = len(other._int), other._int
2818 if self_key < other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002819 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002820 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002821 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002822 return _NegativeOne
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002823 if self_key > other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002824 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002825 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002826 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002827 return _One
2828 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002829
2830 if sign:
2831 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002832 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002833 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002834 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002835 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002836 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002837 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002838 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002839 else:
2840 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002841 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002842 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002843 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002844 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002845 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002846 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002847 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002848
2849 if self < other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002850 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002851 if self > other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002852 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002853
2854 if self._exp < other._exp:
2855 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002856 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002857 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002858 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002859 if self._exp > other._exp:
2860 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002861 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002862 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002863 return _One
2864 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002865
2866
2867 def compare_total_mag(self, other):
2868 """Compares self to other using abstract repr., ignoring sign.
2869
2870 Like compare_total, but with operand's sign ignored and assumed to be 0.
2871 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002872 other = _convert_other(other, raiseit=True)
2873
Facundo Batista353750c2007-09-13 18:13:15 +00002874 s = self.copy_abs()
2875 o = other.copy_abs()
2876 return s.compare_total(o)
2877
2878 def copy_abs(self):
2879 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002880 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002881
2882 def copy_negate(self):
2883 """Returns a copy with the sign inverted."""
2884 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002885 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002886 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002887 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002888
2889 def copy_sign(self, other):
2890 """Returns self with the sign of other."""
Mark Dickinson6d8effb2010-02-18 14:27:02 +00002891 other = _convert_other(other, raiseit=True)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002892 return _dec_from_triple(other._sign, self._int,
2893 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002894
2895 def exp(self, context=None):
2896 """Returns e ** self."""
2897
2898 if context is None:
2899 context = getcontext()
2900
2901 # exp(NaN) = NaN
2902 ans = self._check_nans(context=context)
2903 if ans:
2904 return ans
2905
2906 # exp(-Infinity) = 0
2907 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002908 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002909
2910 # exp(0) = 1
2911 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002912 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002913
2914 # exp(Infinity) = Infinity
2915 if self._isinfinity() == 1:
2916 return Decimal(self)
2917
2918 # the result is now guaranteed to be inexact (the true
2919 # mathematical result is transcendental). There's no need to
2920 # raise Rounded and Inexact here---they'll always be raised as
2921 # a result of the call to _fix.
2922 p = context.prec
2923 adj = self.adjusted()
2924
2925 # we only need to do any computation for quite a small range
2926 # of adjusted exponents---for example, -29 <= adj <= 10 for
2927 # the default context. For smaller exponent the result is
2928 # indistinguishable from 1 at the given precision, while for
2929 # larger exponent the result either overflows or underflows.
2930 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2931 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002932 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002933 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2934 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002935 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002936 elif self._sign == 0 and adj < -p:
2937 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002938 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002939 elif self._sign == 1 and adj < -p-1:
2940 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002941 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002942 # general case
2943 else:
2944 op = _WorkRep(self)
2945 c, e = op.int, op.exp
2946 if op.sign == 1:
2947 c = -c
2948
2949 # compute correctly rounded result: increase precision by
2950 # 3 digits at a time until we get an unambiguously
2951 # roundable result
2952 extra = 3
2953 while True:
2954 coeff, exp = _dexp(c, e, p+extra)
2955 if coeff % (5*10**(len(str(coeff))-p-1)):
2956 break
2957 extra += 3
2958
Facundo Batista72bc54f2007-11-23 17:59:00 +00002959 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002960
2961 # at this stage, ans should round correctly with *any*
2962 # rounding mode, not just with ROUND_HALF_EVEN
2963 context = context._shallow_copy()
2964 rounding = context._set_rounding(ROUND_HALF_EVEN)
2965 ans = ans._fix(context)
2966 context.rounding = rounding
2967
2968 return ans
2969
2970 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002971 """Return True if self is canonical; otherwise return False.
2972
2973 Currently, the encoding of a Decimal instance is always
2974 canonical, so this method returns True for any Decimal.
2975 """
2976 return True
Facundo Batista353750c2007-09-13 18:13:15 +00002977
2978 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002979 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00002980
Facundo Batista1a191df2007-10-02 17:01:24 +00002981 A Decimal instance is considered finite if it is neither
2982 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00002983 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002984 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00002985
2986 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002987 """Return True if self is infinite; otherwise return False."""
2988 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00002989
2990 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002991 """Return True if self is a qNaN or sNaN; otherwise return False."""
2992 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00002993
2994 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002995 """Return True if self is a normal number; otherwise return False."""
2996 if self._is_special or not self:
2997 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002998 if context is None:
2999 context = getcontext()
Mark Dickinsona7a52ab2009-10-20 13:33:03 +00003000 return context.Emin <= self.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +00003001
3002 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003003 """Return True if self is a quiet NaN; otherwise return False."""
3004 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00003005
3006 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003007 """Return True if self is negative; otherwise return False."""
3008 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00003009
3010 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003011 """Return True if self is a signaling NaN; otherwise return False."""
3012 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00003013
3014 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00003015 """Return True if self is subnormal; otherwise return False."""
3016 if self._is_special or not self:
3017 return False
Facundo Batista353750c2007-09-13 18:13:15 +00003018 if context is None:
3019 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00003020 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00003021
3022 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003023 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00003024 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00003025
3026 def _ln_exp_bound(self):
3027 """Compute a lower bound for the adjusted exponent of self.ln().
3028 In other words, compute r such that self.ln() >= 10**r. Assumes
3029 that self is finite and positive and that self != 1.
3030 """
3031
3032 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3033 adj = self._exp + len(self._int) - 1
3034 if adj >= 1:
3035 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3036 return len(str(adj*23//10)) - 1
3037 if adj <= -2:
3038 # argument <= 0.1
3039 return len(str((-1-adj)*23//10)) - 1
3040 op = _WorkRep(self)
3041 c, e = op.int, op.exp
3042 if adj == 0:
3043 # 1 < self < 10
3044 num = str(c-10**-e)
3045 den = str(c)
3046 return len(num) - len(den) - (num < den)
3047 # adj == -1, 0.1 <= self < 1
3048 return e + len(str(10**-e - c)) - 1
3049
3050
3051 def ln(self, context=None):
3052 """Returns the natural (base e) logarithm of self."""
3053
3054 if context is None:
3055 context = getcontext()
3056
3057 # ln(NaN) = NaN
3058 ans = self._check_nans(context=context)
3059 if ans:
3060 return ans
3061
3062 # ln(0.0) == -Infinity
3063 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003064 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003065
3066 # ln(Infinity) = Infinity
3067 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003068 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003069
3070 # ln(1.0) == 0.0
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003071 if self == _One:
3072 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00003073
3074 # ln(negative) raises InvalidOperation
3075 if self._sign == 1:
3076 return context._raise_error(InvalidOperation,
3077 'ln of a negative value')
3078
3079 # result is irrational, so necessarily inexact
3080 op = _WorkRep(self)
3081 c, e = op.int, op.exp
3082 p = context.prec
3083
3084 # correctly rounded result: repeatedly increase precision by 3
3085 # until we get an unambiguously roundable result
3086 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3087 while True:
3088 coeff = _dlog(c, e, places)
3089 # assert len(str(abs(coeff)))-p >= 1
3090 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3091 break
3092 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003093 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003094
3095 context = context._shallow_copy()
3096 rounding = context._set_rounding(ROUND_HALF_EVEN)
3097 ans = ans._fix(context)
3098 context.rounding = rounding
3099 return ans
3100
3101 def _log10_exp_bound(self):
3102 """Compute a lower bound for the adjusted exponent of self.log10().
3103 In other words, find r such that self.log10() >= 10**r.
3104 Assumes that self is finite and positive and that self != 1.
3105 """
3106
3107 # For x >= 10 or x < 0.1 we only need a bound on the integer
3108 # part of log10(self), and this comes directly from the
3109 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3110 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3111 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3112
3113 adj = self._exp + len(self._int) - 1
3114 if adj >= 1:
3115 # self >= 10
3116 return len(str(adj))-1
3117 if adj <= -2:
3118 # self < 0.1
3119 return len(str(-1-adj))-1
3120 op = _WorkRep(self)
3121 c, e = op.int, op.exp
3122 if adj == 0:
3123 # 1 < self < 10
3124 num = str(c-10**-e)
3125 den = str(231*c)
3126 return len(num) - len(den) - (num < den) + 2
3127 # adj == -1, 0.1 <= self < 1
3128 num = str(10**-e-c)
3129 return len(num) + e - (num < "231") - 1
3130
3131 def log10(self, context=None):
3132 """Returns the base 10 logarithm of self."""
3133
3134 if context is None:
3135 context = getcontext()
3136
3137 # log10(NaN) = NaN
3138 ans = self._check_nans(context=context)
3139 if ans:
3140 return ans
3141
3142 # log10(0.0) == -Infinity
3143 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003144 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003145
3146 # log10(Infinity) = Infinity
3147 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003148 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003149
3150 # log10(negative or -Infinity) raises InvalidOperation
3151 if self._sign == 1:
3152 return context._raise_error(InvalidOperation,
3153 'log10 of a negative value')
3154
3155 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003156 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003157 # answer may need rounding
3158 ans = Decimal(self._exp + len(self._int) - 1)
3159 else:
3160 # result is irrational, so necessarily inexact
3161 op = _WorkRep(self)
3162 c, e = op.int, op.exp
3163 p = context.prec
3164
3165 # correctly rounded result: repeatedly increase precision
3166 # until result is unambiguously roundable
3167 places = p-self._log10_exp_bound()+2
3168 while True:
3169 coeff = _dlog10(c, e, places)
3170 # assert len(str(abs(coeff)))-p >= 1
3171 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3172 break
3173 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003174 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003175
3176 context = context._shallow_copy()
3177 rounding = context._set_rounding(ROUND_HALF_EVEN)
3178 ans = ans._fix(context)
3179 context.rounding = rounding
3180 return ans
3181
3182 def logb(self, context=None):
3183 """ Returns the exponent of the magnitude of self's MSD.
3184
3185 The result is the integer which is the exponent of the magnitude
3186 of the most significant digit of self (as though it were truncated
3187 to a single digit while maintaining the value of that digit and
3188 without limiting the resulting exponent).
3189 """
3190 # logb(NaN) = NaN
3191 ans = self._check_nans(context=context)
3192 if ans:
3193 return ans
3194
3195 if context is None:
3196 context = getcontext()
3197
3198 # logb(+/-Inf) = +Inf
3199 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003200 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003201
3202 # logb(0) = -Inf, DivisionByZero
3203 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003204 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003205
3206 # otherwise, simply return the adjusted exponent of self, as a
3207 # Decimal. Note that no attempt is made to fit the result
3208 # into the current context.
Mark Dickinson15ae41c2009-10-07 19:22:05 +00003209 ans = Decimal(self.adjusted())
3210 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003211
3212 def _islogical(self):
3213 """Return True if self is a logical operand.
3214
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003215 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003216 an exponent of 0, and a coefficient whose digits must all be
3217 either 0 or 1.
3218 """
3219 if self._sign != 0 or self._exp != 0:
3220 return False
3221 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003222 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003223 return False
3224 return True
3225
3226 def _fill_logical(self, context, opa, opb):
3227 dif = context.prec - len(opa)
3228 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003229 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003230 elif dif < 0:
3231 opa = opa[-context.prec:]
3232 dif = context.prec - len(opb)
3233 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003234 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003235 elif dif < 0:
3236 opb = opb[-context.prec:]
3237 return opa, opb
3238
3239 def logical_and(self, other, context=None):
3240 """Applies an 'and' operation between self and other's digits."""
3241 if context is None:
3242 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003243
3244 other = _convert_other(other, raiseit=True)
3245
Facundo Batista353750c2007-09-13 18:13:15 +00003246 if not self._islogical() or not other._islogical():
3247 return context._raise_error(InvalidOperation)
3248
3249 # fill to context.prec
3250 (opa, opb) = self._fill_logical(context, self._int, other._int)
3251
3252 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003253 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3254 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003255
3256 def logical_invert(self, context=None):
3257 """Invert all its digits."""
3258 if context is None:
3259 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003260 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3261 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003262
3263 def logical_or(self, other, context=None):
3264 """Applies an 'or' operation between self and other's digits."""
3265 if context is None:
3266 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003267
3268 other = _convert_other(other, raiseit=True)
3269
Facundo Batista353750c2007-09-13 18:13:15 +00003270 if not self._islogical() or not other._islogical():
3271 return context._raise_error(InvalidOperation)
3272
3273 # fill to context.prec
3274 (opa, opb) = self._fill_logical(context, self._int, other._int)
3275
3276 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003277 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003278 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003279
3280 def logical_xor(self, other, context=None):
3281 """Applies an 'xor' operation between self and other's digits."""
3282 if context is None:
3283 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003284
3285 other = _convert_other(other, raiseit=True)
3286
Facundo Batista353750c2007-09-13 18:13:15 +00003287 if not self._islogical() or not other._islogical():
3288 return context._raise_error(InvalidOperation)
3289
3290 # fill to context.prec
3291 (opa, opb) = self._fill_logical(context, self._int, other._int)
3292
3293 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003294 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003295 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003296
3297 def max_mag(self, other, context=None):
3298 """Compares the values numerically with their sign ignored."""
3299 other = _convert_other(other, raiseit=True)
3300
Facundo Batista6c398da2007-09-17 17:30:13 +00003301 if context is None:
3302 context = getcontext()
3303
Facundo Batista353750c2007-09-13 18:13:15 +00003304 if self._is_special or other._is_special:
3305 # If one operand is a quiet NaN and the other is number, then the
3306 # number is always returned
3307 sn = self._isnan()
3308 on = other._isnan()
3309 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003310 if on == 1 and sn == 0:
3311 return self._fix(context)
3312 if sn == 1 and on == 0:
3313 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003314 return self._check_nans(other, context)
3315
Mark Dickinson2fc92632008-02-06 22:10:50 +00003316 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003317 if c == 0:
3318 c = self.compare_total(other)
3319
3320 if c == -1:
3321 ans = other
3322 else:
3323 ans = self
3324
Facundo Batistae64acfa2007-12-17 14:18:42 +00003325 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003326
3327 def min_mag(self, other, context=None):
3328 """Compares the values numerically with their sign ignored."""
3329 other = _convert_other(other, raiseit=True)
3330
Facundo Batista6c398da2007-09-17 17:30:13 +00003331 if context is None:
3332 context = getcontext()
3333
Facundo Batista353750c2007-09-13 18:13:15 +00003334 if self._is_special or other._is_special:
3335 # If one operand is a quiet NaN and the other is number, then the
3336 # number is always returned
3337 sn = self._isnan()
3338 on = other._isnan()
3339 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003340 if on == 1 and sn == 0:
3341 return self._fix(context)
3342 if sn == 1 and on == 0:
3343 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003344 return self._check_nans(other, context)
3345
Mark Dickinson2fc92632008-02-06 22:10:50 +00003346 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003347 if c == 0:
3348 c = self.compare_total(other)
3349
3350 if c == -1:
3351 ans = self
3352 else:
3353 ans = other
3354
Facundo Batistae64acfa2007-12-17 14:18:42 +00003355 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003356
3357 def next_minus(self, context=None):
3358 """Returns the largest representable number smaller than itself."""
3359 if context is None:
3360 context = getcontext()
3361
3362 ans = self._check_nans(context=context)
3363 if ans:
3364 return ans
3365
3366 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003367 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003368 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003369 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003370
3371 context = context.copy()
3372 context._set_rounding(ROUND_FLOOR)
3373 context._ignore_all_flags()
3374 new_self = self._fix(context)
3375 if new_self != self:
3376 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003377 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3378 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003379
3380 def next_plus(self, context=None):
3381 """Returns the smallest representable number larger than itself."""
3382 if context is None:
3383 context = getcontext()
3384
3385 ans = self._check_nans(context=context)
3386 if ans:
3387 return ans
3388
3389 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003390 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003391 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003392 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003393
3394 context = context.copy()
3395 context._set_rounding(ROUND_CEILING)
3396 context._ignore_all_flags()
3397 new_self = self._fix(context)
3398 if new_self != self:
3399 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003400 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3401 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003402
3403 def next_toward(self, other, context=None):
3404 """Returns the number closest to self, in the direction towards other.
3405
3406 The result is the closest representable number to self
3407 (excluding self) that is in the direction towards other,
3408 unless both have the same value. If the two operands are
3409 numerically equal, then the result is a copy of self with the
3410 sign set to be the same as the sign of other.
3411 """
3412 other = _convert_other(other, raiseit=True)
3413
3414 if context is None:
3415 context = getcontext()
3416
3417 ans = self._check_nans(other, context)
3418 if ans:
3419 return ans
3420
Mark Dickinson2fc92632008-02-06 22:10:50 +00003421 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003422 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003423 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003424
3425 if comparison == -1:
3426 ans = self.next_plus(context)
3427 else: # comparison == 1
3428 ans = self.next_minus(context)
3429
3430 # decide which flags to raise using value of ans
3431 if ans._isinfinity():
3432 context._raise_error(Overflow,
3433 'Infinite result from next_toward',
3434 ans._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00003435 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00003436 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003437 elif ans.adjusted() < context.Emin:
3438 context._raise_error(Underflow)
3439 context._raise_error(Subnormal)
Facundo Batista353750c2007-09-13 18:13:15 +00003440 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00003441 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003442 # if precision == 1 then we don't raise Clamped for a
3443 # result 0E-Etiny.
3444 if not ans:
3445 context._raise_error(Clamped)
3446
3447 return ans
3448
3449 def number_class(self, context=None):
3450 """Returns an indication of the class of self.
3451
3452 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003453 sNaN
3454 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003455 -Infinity
3456 -Normal
3457 -Subnormal
3458 -Zero
3459 +Zero
3460 +Subnormal
3461 +Normal
3462 +Infinity
3463 """
3464 if self.is_snan():
3465 return "sNaN"
3466 if self.is_qnan():
3467 return "NaN"
3468 inf = self._isinfinity()
3469 if inf == 1:
3470 return "+Infinity"
3471 if inf == -1:
3472 return "-Infinity"
3473 if self.is_zero():
3474 if self._sign:
3475 return "-Zero"
3476 else:
3477 return "+Zero"
3478 if context is None:
3479 context = getcontext()
3480 if self.is_subnormal(context=context):
3481 if self._sign:
3482 return "-Subnormal"
3483 else:
3484 return "+Subnormal"
3485 # just a normal, regular, boring number, :)
3486 if self._sign:
3487 return "-Normal"
3488 else:
3489 return "+Normal"
3490
3491 def radix(self):
3492 """Just returns 10, as this is Decimal, :)"""
3493 return Decimal(10)
3494
3495 def rotate(self, other, context=None):
3496 """Returns a rotated copy of self, value-of-other times."""
3497 if context is None:
3498 context = getcontext()
3499
Mark Dickinson0c673122009-10-29 12:04:00 +00003500 other = _convert_other(other, raiseit=True)
3501
Facundo Batista353750c2007-09-13 18:13:15 +00003502 ans = self._check_nans(other, context)
3503 if ans:
3504 return ans
3505
3506 if other._exp != 0:
3507 return context._raise_error(InvalidOperation)
3508 if not (-context.prec <= int(other) <= context.prec):
3509 return context._raise_error(InvalidOperation)
3510
3511 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003512 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003513
3514 # get values, pad if necessary
3515 torot = int(other)
3516 rotdig = self._int
3517 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003518 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003519 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003520 elif topad < 0:
3521 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003522
3523 # let's rotate!
3524 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003525 return _dec_from_triple(self._sign,
3526 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003527
Mark Dickinson0c673122009-10-29 12:04:00 +00003528 def scaleb(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00003529 """Returns self operand after adding the second value to its exp."""
3530 if context is None:
3531 context = getcontext()
3532
Mark Dickinson0c673122009-10-29 12:04:00 +00003533 other = _convert_other(other, raiseit=True)
3534
Facundo Batista353750c2007-09-13 18:13:15 +00003535 ans = self._check_nans(other, context)
3536 if ans:
3537 return ans
3538
3539 if other._exp != 0:
3540 return context._raise_error(InvalidOperation)
3541 liminf = -2 * (context.Emax + context.prec)
3542 limsup = 2 * (context.Emax + context.prec)
3543 if not (liminf <= int(other) <= limsup):
3544 return context._raise_error(InvalidOperation)
3545
3546 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003547 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003548
Facundo Batista72bc54f2007-11-23 17:59:00 +00003549 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003550 d = d._fix(context)
3551 return d
3552
3553 def shift(self, other, context=None):
3554 """Returns a shifted copy of self, value-of-other times."""
3555 if context is None:
3556 context = getcontext()
3557
Mark Dickinson0c673122009-10-29 12:04:00 +00003558 other = _convert_other(other, raiseit=True)
3559
Facundo Batista353750c2007-09-13 18:13:15 +00003560 ans = self._check_nans(other, context)
3561 if ans:
3562 return ans
3563
3564 if other._exp != 0:
3565 return context._raise_error(InvalidOperation)
3566 if not (-context.prec <= int(other) <= context.prec):
3567 return context._raise_error(InvalidOperation)
3568
3569 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003570 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003571
3572 # get values, pad if necessary
3573 torot = int(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003574 rotdig = self._int
3575 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003576 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003577 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003578 elif topad < 0:
3579 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003580
3581 # let's shift!
3582 if torot < 0:
Mark Dickinson6f390012009-10-29 12:11:18 +00003583 shifted = rotdig[:torot]
Facundo Batista353750c2007-09-13 18:13:15 +00003584 else:
Mark Dickinson6f390012009-10-29 12:11:18 +00003585 shifted = rotdig + '0'*torot
3586 shifted = shifted[-context.prec:]
Facundo Batista353750c2007-09-13 18:13:15 +00003587
Facundo Batista72bc54f2007-11-23 17:59:00 +00003588 return _dec_from_triple(self._sign,
Mark Dickinson6f390012009-10-29 12:11:18 +00003589 shifted.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003590
Facundo Batista59c58842007-04-10 12:58:45 +00003591 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003592 def __reduce__(self):
3593 return (self.__class__, (str(self),))
3594
3595 def __copy__(self):
Benjamin Peterson28e369a2010-01-25 03:58:21 +00003596 if type(self) is Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003597 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003598 return self.__class__(str(self))
3599
3600 def __deepcopy__(self, memo):
Benjamin Peterson28e369a2010-01-25 03:58:21 +00003601 if type(self) is Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003602 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003603 return self.__class__(str(self))
3604
Mark Dickinson277859d2009-03-17 23:03:46 +00003605 # PEP 3101 support. the _localeconv keyword argument should be
3606 # considered private: it's provided for ease of testing only.
3607 def __format__(self, specifier, context=None, _localeconv=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003608 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003609
3610 The specifier should be a standard format specifier, with the
3611 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson277859d2009-03-17 23:03:46 +00003612 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3613 type is omitted it defaults to 'g' or 'G', depending on the
3614 value of context.capitals.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003615 """
3616
3617 # Note: PEP 3101 says that if the type is not present then
3618 # there should be at least one digit after the decimal point.
3619 # We take the liberty of ignoring this requirement for
3620 # Decimal---it's presumably there to make sure that
3621 # format(float, '') behaves similarly to str(float).
3622 if context is None:
3623 context = getcontext()
3624
Mark Dickinson277859d2009-03-17 23:03:46 +00003625 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003626
Mark Dickinson277859d2009-03-17 23:03:46 +00003627 # special values don't care about the type or precision
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003628 if self._is_special:
Mark Dickinson277859d2009-03-17 23:03:46 +00003629 sign = _format_sign(self._sign, spec)
3630 body = str(self.copy_abs())
3631 return _format_align(sign, body, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003632
3633 # a type of None defaults to 'g' or 'G', depending on context
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003634 if spec['type'] is None:
3635 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson277859d2009-03-17 23:03:46 +00003636
3637 # if type is '%', adjust exponent of self accordingly
3638 if spec['type'] == '%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003639 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3640
3641 # round if necessary, taking rounding mode from the context
3642 rounding = context.rounding
3643 precision = spec['precision']
3644 if precision is not None:
3645 if spec['type'] in 'eE':
3646 self = self._round(precision+1, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003647 elif spec['type'] in 'fF%':
3648 self = self._rescale(-precision, rounding)
Mark Dickinson277859d2009-03-17 23:03:46 +00003649 elif spec['type'] in 'gG' and len(self._int) > precision:
3650 self = self._round(precision, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003651 # special case: zeros with a positive exponent can't be
3652 # represented in fixed point; rescale them to 0e0.
Mark Dickinson277859d2009-03-17 23:03:46 +00003653 if not self and self._exp > 0 and spec['type'] in 'fF%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003654 self = self._rescale(0, rounding)
3655
3656 # figure out placement of the decimal point
3657 leftdigits = self._exp + len(self._int)
Mark Dickinson277859d2009-03-17 23:03:46 +00003658 if spec['type'] in 'eE':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003659 if not self and precision is not None:
3660 dotplace = 1 - precision
3661 else:
3662 dotplace = 1
Mark Dickinson277859d2009-03-17 23:03:46 +00003663 elif spec['type'] in 'fF%':
3664 dotplace = leftdigits
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003665 elif spec['type'] in 'gG':
3666 if self._exp <= 0 and leftdigits > -6:
3667 dotplace = leftdigits
3668 else:
3669 dotplace = 1
3670
Mark Dickinson277859d2009-03-17 23:03:46 +00003671 # find digits before and after decimal point, and get exponent
3672 if dotplace < 0:
3673 intpart = '0'
3674 fracpart = '0'*(-dotplace) + self._int
3675 elif dotplace > len(self._int):
3676 intpart = self._int + '0'*(dotplace-len(self._int))
3677 fracpart = ''
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003678 else:
Mark Dickinson277859d2009-03-17 23:03:46 +00003679 intpart = self._int[:dotplace] or '0'
3680 fracpart = self._int[dotplace:]
3681 exp = leftdigits-dotplace
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003682
Mark Dickinson277859d2009-03-17 23:03:46 +00003683 # done with the decimal-specific stuff; hand over the rest
3684 # of the formatting to the _format_number function
3685 return _format_number(self._sign, intpart, fracpart, exp, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003686
Facundo Batista72bc54f2007-11-23 17:59:00 +00003687def _dec_from_triple(sign, coefficient, exponent, special=False):
3688 """Create a decimal instance directly, without any validation,
3689 normalization (e.g. removal of leading zeros) or argument
3690 conversion.
3691
3692 This function is for *internal use only*.
3693 """
3694
3695 self = object.__new__(Decimal)
3696 self._sign = sign
3697 self._int = coefficient
3698 self._exp = exponent
3699 self._is_special = special
3700
3701 return self
3702
Raymond Hettinger2c8585b2009-02-03 03:37:03 +00003703# Register Decimal as a kind of Number (an abstract base class).
3704# However, do not register it as Real (because Decimals are not
3705# interoperable with floats).
3706_numbers.Number.register(Decimal)
3707
3708
Facundo Batista59c58842007-04-10 12:58:45 +00003709##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003710
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003711
3712# get rounding method function:
Facundo Batista59c58842007-04-10 12:58:45 +00003713rounding_functions = [name for name in Decimal.__dict__.keys()
3714 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003715for name in rounding_functions:
Facundo Batista59c58842007-04-10 12:58:45 +00003716 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003717 globalname = name[1:].upper()
3718 val = globals()[globalname]
3719 Decimal._pick_rounding_function[val] = name
3720
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003721del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003722
Nick Coghlanced12182006-09-02 03:54:17 +00003723class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003724 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003725
Nick Coghlanced12182006-09-02 03:54:17 +00003726 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003727 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003728 """
3729 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003730 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003731 def __enter__(self):
3732 self.saved_context = getcontext()
3733 setcontext(self.new_context)
3734 return self.new_context
3735 def __exit__(self, t, v, tb):
3736 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003737
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003738class Context(object):
3739 """Contains the context for a Decimal instance.
3740
3741 Contains:
3742 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003743 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003744 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003745 raised when it is caused. Otherwise, a value is
3746 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003747 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003748 (Whether or not the trap_enabler is set)
3749 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003750 Emin - Minimum exponent
3751 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003752 capitals - If 1, 1*10^1 is printed as 1E+1.
3753 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003754 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003755 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003756
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003757 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003758 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003759 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003760 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003761 _ignored_flags=None):
Mark Dickinson9b9e1252010-07-08 21:22:54 +00003762 # Set defaults; for everything except flags and _ignored_flags,
3763 # inherit from DefaultContext.
3764 try:
3765 dc = DefaultContext
3766 except NameError:
3767 pass
3768
3769 self.prec = prec if prec is not None else dc.prec
3770 self.rounding = rounding if rounding is not None else dc.rounding
3771 self.Emin = Emin if Emin is not None else dc.Emin
3772 self.Emax = Emax if Emax is not None else dc.Emax
3773 self.capitals = capitals if capitals is not None else dc.capitals
3774 self._clamp = _clamp if _clamp is not None else dc._clamp
3775
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003776 if _ignored_flags is None:
Mark Dickinson9b9e1252010-07-08 21:22:54 +00003777 self._ignored_flags = []
3778 else:
3779 self._ignored_flags = _ignored_flags
3780
3781 if traps is None:
3782 self.traps = dc.traps.copy()
3783 elif not isinstance(traps, dict):
3784 self.traps = dict((s, int(s in traps)) for s in _signals)
3785 else:
3786 self.traps = traps
3787
3788 if flags is None:
3789 self.flags = dict.fromkeys(_signals, 0)
3790 elif not isinstance(flags, dict):
3791 self.flags = dict((s, int(s in flags)) for s in _signals)
3792 else:
3793 self.flags = flags
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003794
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003795 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003796 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003797 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003798 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3799 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3800 % vars(self))
3801 names = [f.__name__ for f, v in self.flags.items() if v]
3802 s.append('flags=[' + ', '.join(names) + ']')
3803 names = [t.__name__ for t, v in self.traps.items() if v]
3804 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003805 return ', '.join(s) + ')'
3806
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003807 def clear_flags(self):
3808 """Reset all flags to zero"""
3809 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003810 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003811
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003812 def _shallow_copy(self):
3813 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003814 nc = Context(self.prec, self.rounding, self.traps,
3815 self.flags, self.Emin, self.Emax,
3816 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003817 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003818
3819 def copy(self):
3820 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003821 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003822 self.flags.copy(), self.Emin, self.Emax,
3823 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003824 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003825 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003826
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003827 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003828 """Handles an error
3829
3830 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003831 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah8a6f3fe2010-05-19 15:46:39 +00003832 trap_enabler is set, it reraises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003833 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003834 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003835 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003836 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003837 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003838 return error().handle(self, *args)
3839
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003840 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003841 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003842 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003843 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003844
3845 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003846 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003847 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003848
3849 def _ignore_all_flags(self):
3850 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003851 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003852
3853 def _ignore_flags(self, *flags):
3854 """Ignore the flags, if they are raised"""
3855 # Do not mutate-- This way, copies of a context leave the original
3856 # alone.
3857 self._ignored_flags = (self._ignored_flags + list(flags))
3858 return list(flags)
3859
3860 def _regard_flags(self, *flags):
3861 """Stop ignoring the flags, if they are raised"""
3862 if flags and isinstance(flags[0], (tuple,list)):
3863 flags = flags[0]
3864 for flag in flags:
3865 self._ignored_flags.remove(flag)
3866
Nick Coghlan53663a62008-07-15 14:27:37 +00003867 # We inherit object.__hash__, so we must deny this explicitly
3868 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003869
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003870 def Etiny(self):
3871 """Returns Etiny (= Emin - prec + 1)"""
3872 return int(self.Emin - self.prec + 1)
3873
3874 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003875 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003876 return int(self.Emax - self.prec + 1)
3877
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003878 def _set_rounding(self, type):
3879 """Sets the rounding type.
3880
3881 Sets the rounding type, and returns the current (previous)
3882 rounding type. Often used like:
3883
3884 context = context.copy()
3885 # so you don't change the calling context
3886 # if an error occurs in the middle.
3887 rounding = context._set_rounding(ROUND_UP)
3888 val = self.__sub__(other, context=context)
3889 context._set_rounding(rounding)
3890
3891 This will make it round up for that operation.
3892 """
3893 rounding = self.rounding
3894 self.rounding= type
3895 return rounding
3896
Raymond Hettingerfed52962004-07-14 15:41:57 +00003897 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003898 """Creates a new Decimal instance but using self as context.
3899
3900 This method implements the to-number operation of the
3901 IBM Decimal specification."""
3902
3903 if isinstance(num, basestring) and num != num.strip():
3904 return self._raise_error(ConversionSyntax,
3905 "no trailing or leading whitespace is "
3906 "permitted.")
3907
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003908 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003909 if d._isnan() and len(d._int) > self.prec - self._clamp:
3910 return self._raise_error(ConversionSyntax,
3911 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003912 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003913
Raymond Hettingerf4d85972009-01-03 19:02:23 +00003914 def create_decimal_from_float(self, f):
3915 """Creates a new Decimal instance from a float but rounding using self
3916 as the context.
3917
3918 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3919 >>> context.create_decimal_from_float(3.1415926535897932)
3920 Decimal('3.1415')
3921 >>> context = Context(prec=5, traps=[Inexact])
3922 >>> context.create_decimal_from_float(3.1415926535897932)
3923 Traceback (most recent call last):
3924 ...
3925 Inexact: None
3926
3927 """
3928 d = Decimal.from_float(f) # An exact conversion
3929 return d._fix(self) # Apply the context rounding
3930
Facundo Batista59c58842007-04-10 12:58:45 +00003931 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003932 def abs(self, a):
3933 """Returns the absolute value of the operand.
3934
3935 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003936 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003937 the plus operation on the operand.
3938
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003939 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003940 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003941 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003942 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003943 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003944 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003945 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003946 Decimal('101.5')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003947 >>> ExtendedContext.abs(-1)
3948 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003949 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003950 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003951 return a.__abs__(context=self)
3952
3953 def add(self, a, b):
3954 """Return the sum of the two operands.
3955
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003956 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003957 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003958 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003959 Decimal('1.02E+4')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003960 >>> ExtendedContext.add(1, Decimal(2))
3961 Decimal('3')
3962 >>> ExtendedContext.add(Decimal(8), 5)
3963 Decimal('13')
3964 >>> ExtendedContext.add(5, 5)
3965 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003966 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003967 a = _convert_other(a, raiseit=True)
3968 r = a.__add__(b, context=self)
3969 if r is NotImplemented:
3970 raise TypeError("Unable to convert %s to Decimal" % b)
3971 else:
3972 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003973
3974 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003975 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003976
Facundo Batista353750c2007-09-13 18:13:15 +00003977 def canonical(self, a):
3978 """Returns the same Decimal object.
3979
3980 As we do not have different encodings for the same number, the
3981 received object already is in its canonical form.
3982
3983 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003984 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003985 """
3986 return a.canonical(context=self)
3987
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003988 def compare(self, a, b):
3989 """Compares values numerically.
3990
3991 If the signs of the operands differ, a value representing each operand
3992 ('-1' if the operand is less than zero, '0' if the operand is zero or
3993 negative zero, or '1' if the operand is greater than zero) is used in
3994 place of that operand for the comparison instead of the actual
3995 operand.
3996
3997 The comparison is then effected by subtracting the second operand from
3998 the first and then returning a value according to the result of the
3999 subtraction: '-1' if the result is less than zero, '0' if the result is
4000 zero or negative zero, or '1' if the result is greater than zero.
4001
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004002 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004003 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004004 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004005 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004006 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004007 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004008 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004009 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004010 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004011 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004012 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004013 Decimal('-1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004014 >>> ExtendedContext.compare(1, 2)
4015 Decimal('-1')
4016 >>> ExtendedContext.compare(Decimal(1), 2)
4017 Decimal('-1')
4018 >>> ExtendedContext.compare(1, Decimal(2))
4019 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004020 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004021 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004022 return a.compare(b, context=self)
4023
Facundo Batista353750c2007-09-13 18:13:15 +00004024 def compare_signal(self, a, b):
4025 """Compares the values of the two operands numerically.
4026
4027 It's pretty much like compare(), but all NaNs signal, with signaling
4028 NaNs taking precedence over quiet NaNs.
4029
4030 >>> c = ExtendedContext
4031 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004032 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004033 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004034 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004035 >>> c.flags[InvalidOperation] = 0
4036 >>> print c.flags[InvalidOperation]
4037 0
4038 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004039 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004040 >>> print c.flags[InvalidOperation]
4041 1
4042 >>> c.flags[InvalidOperation] = 0
4043 >>> print c.flags[InvalidOperation]
4044 0
4045 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004046 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004047 >>> print c.flags[InvalidOperation]
4048 1
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004049 >>> c.compare_signal(-1, 2)
4050 Decimal('-1')
4051 >>> c.compare_signal(Decimal(-1), 2)
4052 Decimal('-1')
4053 >>> c.compare_signal(-1, Decimal(2))
4054 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004055 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004056 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004057 return a.compare_signal(b, context=self)
4058
4059 def compare_total(self, a, b):
4060 """Compares two operands using their abstract representation.
4061
4062 This is not like the standard compare, which use their numerical
4063 value. Note that a total ordering is defined for all possible abstract
4064 representations.
4065
4066 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004067 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004068 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004069 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004070 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004071 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004072 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004073 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004074 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004075 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004076 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004077 Decimal('-1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004078 >>> ExtendedContext.compare_total(1, 2)
4079 Decimal('-1')
4080 >>> ExtendedContext.compare_total(Decimal(1), 2)
4081 Decimal('-1')
4082 >>> ExtendedContext.compare_total(1, Decimal(2))
4083 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004084 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004085 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004086 return a.compare_total(b)
4087
4088 def compare_total_mag(self, a, b):
4089 """Compares two operands using their abstract representation ignoring sign.
4090
4091 Like compare_total, but with operand's sign ignored and assumed to be 0.
4092 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004093 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004094 return a.compare_total_mag(b)
4095
4096 def copy_abs(self, a):
4097 """Returns a copy of the operand with the sign set to 0.
4098
4099 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004100 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00004101 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004102 Decimal('100')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004103 >>> ExtendedContext.copy_abs(-1)
4104 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004105 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004106 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004107 return a.copy_abs()
4108
4109 def copy_decimal(self, a):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004110 """Returns a copy of the decimal object.
Facundo Batista353750c2007-09-13 18:13:15 +00004111
4112 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004113 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00004114 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004115 Decimal('-1.00')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004116 >>> ExtendedContext.copy_decimal(1)
4117 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004118 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004119 a = _convert_other(a, raiseit=True)
Facundo Batista6c398da2007-09-17 17:30:13 +00004120 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00004121
4122 def copy_negate(self, a):
4123 """Returns a copy of the operand with the sign inverted.
4124
4125 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004126 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00004127 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004128 Decimal('101.5')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004129 >>> ExtendedContext.copy_negate(1)
4130 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004131 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004132 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004133 return a.copy_negate()
4134
4135 def copy_sign(self, a, b):
4136 """Copies the second operand's sign to the first one.
4137
4138 In detail, it returns a copy of the first operand with the sign
4139 equal to the sign of the second operand.
4140
4141 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004142 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004143 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004144 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004145 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004146 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004147 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004148 Decimal('-1.50')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004149 >>> ExtendedContext.copy_sign(1, -2)
4150 Decimal('-1')
4151 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4152 Decimal('-1')
4153 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4154 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004155 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004156 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004157 return a.copy_sign(b)
4158
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004159 def divide(self, a, b):
4160 """Decimal division in a specified context.
4161
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004162 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004163 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004164 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004165 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004166 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004167 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004168 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004169 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004170 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004171 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004172 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004173 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004174 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004175 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004176 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004177 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004178 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004179 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004180 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004181 Decimal('1.20E+6')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004182 >>> ExtendedContext.divide(5, 5)
4183 Decimal('1')
4184 >>> ExtendedContext.divide(Decimal(5), 5)
4185 Decimal('1')
4186 >>> ExtendedContext.divide(5, Decimal(5))
4187 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004188 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004189 a = _convert_other(a, raiseit=True)
4190 r = a.__div__(b, context=self)
4191 if r is NotImplemented:
4192 raise TypeError("Unable to convert %s to Decimal" % b)
4193 else:
4194 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004195
4196 def divide_int(self, a, b):
4197 """Divides two numbers and returns the integer part of the result.
4198
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004199 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004200 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004201 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004202 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004203 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004204 Decimal('3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004205 >>> ExtendedContext.divide_int(10, 3)
4206 Decimal('3')
4207 >>> ExtendedContext.divide_int(Decimal(10), 3)
4208 Decimal('3')
4209 >>> ExtendedContext.divide_int(10, Decimal(3))
4210 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004211 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004212 a = _convert_other(a, raiseit=True)
4213 r = a.__floordiv__(b, context=self)
4214 if r is NotImplemented:
4215 raise TypeError("Unable to convert %s to Decimal" % b)
4216 else:
4217 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004218
4219 def divmod(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004220 """Return (a // b, a % b).
Mark Dickinson202eb902010-01-06 16:20:22 +00004221
4222 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4223 (Decimal('2'), Decimal('2'))
4224 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4225 (Decimal('2'), Decimal('0'))
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004226 >>> ExtendedContext.divmod(8, 4)
4227 (Decimal('2'), Decimal('0'))
4228 >>> ExtendedContext.divmod(Decimal(8), 4)
4229 (Decimal('2'), Decimal('0'))
4230 >>> ExtendedContext.divmod(8, Decimal(4))
4231 (Decimal('2'), Decimal('0'))
Mark Dickinson202eb902010-01-06 16:20:22 +00004232 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004233 a = _convert_other(a, raiseit=True)
4234 r = a.__divmod__(b, context=self)
4235 if r is NotImplemented:
4236 raise TypeError("Unable to convert %s to Decimal" % b)
4237 else:
4238 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004239
Facundo Batista353750c2007-09-13 18:13:15 +00004240 def exp(self, a):
4241 """Returns e ** a.
4242
4243 >>> c = ExtendedContext.copy()
4244 >>> c.Emin = -999
4245 >>> c.Emax = 999
4246 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004247 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004248 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004249 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00004250 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004251 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004252 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004253 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00004254 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004255 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004256 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004257 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004258 >>> c.exp(10)
4259 Decimal('22026.4658')
Facundo Batista353750c2007-09-13 18:13:15 +00004260 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004261 a =_convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004262 return a.exp(context=self)
4263
4264 def fma(self, a, b, c):
4265 """Returns a multiplied by b, plus c.
4266
4267 The first two operands are multiplied together, using multiply,
4268 the third operand is then added to the result of that
4269 multiplication, using add, all with only one final rounding.
4270
4271 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004272 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004273 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004274 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004275 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004276 Decimal('1.38435736E+12')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004277 >>> ExtendedContext.fma(1, 3, 4)
4278 Decimal('7')
4279 >>> ExtendedContext.fma(1, Decimal(3), 4)
4280 Decimal('7')
4281 >>> ExtendedContext.fma(1, 3, Decimal(4))
4282 Decimal('7')
Facundo Batista353750c2007-09-13 18:13:15 +00004283 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004284 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004285 return a.fma(b, c, context=self)
4286
4287 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004288 """Return True if the operand is canonical; otherwise return False.
4289
4290 Currently, the encoding of a Decimal instance is always
4291 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004292
4293 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004294 True
Facundo Batista353750c2007-09-13 18:13:15 +00004295 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004296 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004297
4298 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004299 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004300
Facundo Batista1a191df2007-10-02 17:01:24 +00004301 A Decimal instance is considered finite if it is neither
4302 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004303
4304 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004305 True
Facundo Batista353750c2007-09-13 18:13:15 +00004306 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004307 True
Facundo Batista353750c2007-09-13 18:13:15 +00004308 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004309 True
Facundo Batista353750c2007-09-13 18:13:15 +00004310 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004311 False
Facundo Batista353750c2007-09-13 18:13:15 +00004312 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004313 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004314 >>> ExtendedContext.is_finite(1)
4315 True
Facundo Batista353750c2007-09-13 18:13:15 +00004316 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004317 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004318 return a.is_finite()
4319
4320 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004321 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004322
4323 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004324 False
Facundo Batista353750c2007-09-13 18:13:15 +00004325 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004326 True
Facundo Batista353750c2007-09-13 18:13:15 +00004327 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004328 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004329 >>> ExtendedContext.is_infinite(1)
4330 False
Facundo Batista353750c2007-09-13 18:13:15 +00004331 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004332 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004333 return a.is_infinite()
4334
4335 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004336 """Return True if the operand is a qNaN or sNaN;
4337 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004338
4339 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004340 False
Facundo Batista353750c2007-09-13 18:13:15 +00004341 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004342 True
Facundo Batista353750c2007-09-13 18:13:15 +00004343 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004344 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004345 >>> ExtendedContext.is_nan(1)
4346 False
Facundo Batista353750c2007-09-13 18:13:15 +00004347 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004348 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004349 return a.is_nan()
4350
4351 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004352 """Return True if the operand is a normal number;
4353 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004354
4355 >>> c = ExtendedContext.copy()
4356 >>> c.Emin = -999
4357 >>> c.Emax = 999
4358 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004359 True
Facundo Batista353750c2007-09-13 18:13:15 +00004360 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004361 False
Facundo Batista353750c2007-09-13 18:13:15 +00004362 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004363 False
Facundo Batista353750c2007-09-13 18:13:15 +00004364 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004365 False
Facundo Batista353750c2007-09-13 18:13:15 +00004366 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004367 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004368 >>> c.is_normal(1)
4369 True
Facundo Batista353750c2007-09-13 18:13:15 +00004370 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004371 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004372 return a.is_normal(context=self)
4373
4374 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004375 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004376
4377 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004378 False
Facundo Batista353750c2007-09-13 18:13:15 +00004379 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004380 True
Facundo Batista353750c2007-09-13 18:13:15 +00004381 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004382 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004383 >>> ExtendedContext.is_qnan(1)
4384 False
Facundo Batista353750c2007-09-13 18:13:15 +00004385 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004386 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004387 return a.is_qnan()
4388
4389 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004390 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004391
4392 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004393 False
Facundo Batista353750c2007-09-13 18:13:15 +00004394 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004395 True
Facundo Batista353750c2007-09-13 18:13:15 +00004396 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004397 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004398 >>> ExtendedContext.is_signed(8)
4399 False
4400 >>> ExtendedContext.is_signed(-8)
4401 True
Facundo Batista353750c2007-09-13 18:13:15 +00004402 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004403 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004404 return a.is_signed()
4405
4406 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004407 """Return True if the operand is a signaling NaN;
4408 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004409
4410 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004411 False
Facundo Batista353750c2007-09-13 18:13:15 +00004412 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004413 False
Facundo Batista353750c2007-09-13 18:13:15 +00004414 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004415 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004416 >>> ExtendedContext.is_snan(1)
4417 False
Facundo Batista353750c2007-09-13 18:13:15 +00004418 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004419 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004420 return a.is_snan()
4421
4422 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004423 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004424
4425 >>> c = ExtendedContext.copy()
4426 >>> c.Emin = -999
4427 >>> c.Emax = 999
4428 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004429 False
Facundo Batista353750c2007-09-13 18:13:15 +00004430 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004431 True
Facundo Batista353750c2007-09-13 18:13:15 +00004432 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004433 False
Facundo Batista353750c2007-09-13 18:13:15 +00004434 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004435 False
Facundo Batista353750c2007-09-13 18:13:15 +00004436 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004437 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004438 >>> c.is_subnormal(1)
4439 False
Facundo Batista353750c2007-09-13 18:13:15 +00004440 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004441 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004442 return a.is_subnormal(context=self)
4443
4444 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004445 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004446
4447 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004448 True
Facundo Batista353750c2007-09-13 18:13:15 +00004449 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004450 False
Facundo Batista353750c2007-09-13 18:13:15 +00004451 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004452 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004453 >>> ExtendedContext.is_zero(1)
4454 False
4455 >>> ExtendedContext.is_zero(0)
4456 True
Facundo Batista353750c2007-09-13 18:13:15 +00004457 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004458 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004459 return a.is_zero()
4460
4461 def ln(self, a):
4462 """Returns the natural (base e) logarithm of the operand.
4463
4464 >>> c = ExtendedContext.copy()
4465 >>> c.Emin = -999
4466 >>> c.Emax = 999
4467 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004468 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004469 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004470 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004471 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004472 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004473 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004474 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004475 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004476 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004477 >>> c.ln(1)
4478 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004479 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004480 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004481 return a.ln(context=self)
4482
4483 def log10(self, a):
4484 """Returns the base 10 logarithm of the operand.
4485
4486 >>> c = ExtendedContext.copy()
4487 >>> c.Emin = -999
4488 >>> c.Emax = 999
4489 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004490 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004491 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004492 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004493 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004494 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004495 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004496 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004497 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004498 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004499 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004500 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004501 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004502 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004503 >>> c.log10(0)
4504 Decimal('-Infinity')
4505 >>> c.log10(1)
4506 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004507 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004508 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004509 return a.log10(context=self)
4510
4511 def logb(self, a):
4512 """ Returns the exponent of the magnitude of the operand's MSD.
4513
4514 The result is the integer which is the exponent of the magnitude
4515 of the most significant digit of the operand (as though the
4516 operand were truncated to a single digit while maintaining the
4517 value of that digit and without limiting the resulting exponent).
4518
4519 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004520 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004521 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004522 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004523 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004524 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004525 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004526 Decimal('-Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004527 >>> ExtendedContext.logb(1)
4528 Decimal('0')
4529 >>> ExtendedContext.logb(10)
4530 Decimal('1')
4531 >>> ExtendedContext.logb(100)
4532 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004533 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004534 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004535 return a.logb(context=self)
4536
4537 def logical_and(self, a, b):
4538 """Applies the logical operation 'and' between each operand's digits.
4539
4540 The operands must be both logical numbers.
4541
4542 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004543 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004544 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004545 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004546 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004547 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004548 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004549 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004550 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004551 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004552 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004553 Decimal('10')
Mark Dickinson456e1652010-02-18 14:45:33 +00004554 >>> ExtendedContext.logical_and(110, 1101)
4555 Decimal('100')
4556 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4557 Decimal('100')
4558 >>> ExtendedContext.logical_and(110, Decimal(1101))
4559 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004560 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004561 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004562 return a.logical_and(b, context=self)
4563
4564 def logical_invert(self, a):
4565 """Invert all the digits in the operand.
4566
4567 The operand must be a logical number.
4568
4569 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004570 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004571 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004572 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004573 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004574 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004575 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004576 Decimal('10101010')
Mark Dickinson456e1652010-02-18 14:45:33 +00004577 >>> ExtendedContext.logical_invert(1101)
4578 Decimal('111110010')
Facundo Batista353750c2007-09-13 18:13:15 +00004579 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004580 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004581 return a.logical_invert(context=self)
4582
4583 def logical_or(self, a, b):
4584 """Applies the logical operation 'or' between each operand's digits.
4585
4586 The operands must be both logical numbers.
4587
4588 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004589 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004590 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004591 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004592 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004593 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004594 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004595 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004596 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004597 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004598 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004599 Decimal('1110')
Mark Dickinson456e1652010-02-18 14:45:33 +00004600 >>> ExtendedContext.logical_or(110, 1101)
4601 Decimal('1111')
4602 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4603 Decimal('1111')
4604 >>> ExtendedContext.logical_or(110, Decimal(1101))
4605 Decimal('1111')
Facundo Batista353750c2007-09-13 18:13:15 +00004606 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004607 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004608 return a.logical_or(b, context=self)
4609
4610 def logical_xor(self, a, b):
4611 """Applies the logical operation 'xor' between each operand's digits.
4612
4613 The operands must be both logical numbers.
4614
4615 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004616 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004617 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004618 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004619 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004620 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004621 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004622 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004623 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004624 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004625 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004626 Decimal('1101')
Mark Dickinson456e1652010-02-18 14:45:33 +00004627 >>> ExtendedContext.logical_xor(110, 1101)
4628 Decimal('1011')
4629 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4630 Decimal('1011')
4631 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4632 Decimal('1011')
Facundo Batista353750c2007-09-13 18:13:15 +00004633 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004634 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004635 return a.logical_xor(b, context=self)
4636
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004637 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004638 """max compares two values numerically and returns the maximum.
4639
4640 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004641 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004642 operation. If they are numerically equal then the left-hand operand
4643 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004644 infinity) of the two operands is chosen as the result.
4645
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004646 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004647 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004648 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004649 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004650 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004651 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004652 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004653 Decimal('7')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004654 >>> ExtendedContext.max(1, 2)
4655 Decimal('2')
4656 >>> ExtendedContext.max(Decimal(1), 2)
4657 Decimal('2')
4658 >>> ExtendedContext.max(1, Decimal(2))
4659 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004660 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004661 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004662 return a.max(b, context=self)
4663
Facundo Batista353750c2007-09-13 18:13:15 +00004664 def max_mag(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004665 """Compares the values numerically with their sign ignored.
4666
4667 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4668 Decimal('7')
4669 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4670 Decimal('-10')
4671 >>> ExtendedContext.max_mag(1, -2)
4672 Decimal('-2')
4673 >>> ExtendedContext.max_mag(Decimal(1), -2)
4674 Decimal('-2')
4675 >>> ExtendedContext.max_mag(1, Decimal(-2))
4676 Decimal('-2')
4677 """
4678 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004679 return a.max_mag(b, context=self)
4680
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004681 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004682 """min compares two values numerically and returns the minimum.
4683
4684 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004685 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004686 operation. If they are numerically equal then the left-hand operand
4687 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004688 infinity) of the two operands is chosen as the result.
4689
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004690 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004691 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004692 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004693 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004694 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004695 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004696 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004697 Decimal('7')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004698 >>> ExtendedContext.min(1, 2)
4699 Decimal('1')
4700 >>> ExtendedContext.min(Decimal(1), 2)
4701 Decimal('1')
4702 >>> ExtendedContext.min(1, Decimal(29))
4703 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004704 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004705 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004706 return a.min(b, context=self)
4707
Facundo Batista353750c2007-09-13 18:13:15 +00004708 def min_mag(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004709 """Compares the values numerically with their sign ignored.
4710
4711 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4712 Decimal('-2')
4713 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4714 Decimal('-3')
4715 >>> ExtendedContext.min_mag(1, -2)
4716 Decimal('1')
4717 >>> ExtendedContext.min_mag(Decimal(1), -2)
4718 Decimal('1')
4719 >>> ExtendedContext.min_mag(1, Decimal(-2))
4720 Decimal('1')
4721 """
4722 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004723 return a.min_mag(b, context=self)
4724
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004725 def minus(self, a):
4726 """Minus corresponds to unary prefix minus in Python.
4727
4728 The operation is evaluated using the same rules as subtract; the
4729 operation minus(a) is calculated as subtract('0', a) where the '0'
4730 has the same exponent as the operand.
4731
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004732 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004733 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004734 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004735 Decimal('1.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004736 >>> ExtendedContext.minus(1)
4737 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004738 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004739 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004740 return a.__neg__(context=self)
4741
4742 def multiply(self, a, b):
4743 """multiply multiplies two operands.
4744
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004745 If either operand is a special value then the general rules apply.
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004746 Otherwise, the operands are multiplied together
4747 ('long multiplication'), resulting in a number which may be as long as
4748 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004749
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004750 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004751 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004752 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004753 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004754 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004755 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004756 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004757 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004758 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004759 Decimal('4.28135971E+11')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004760 >>> ExtendedContext.multiply(7, 7)
4761 Decimal('49')
4762 >>> ExtendedContext.multiply(Decimal(7), 7)
4763 Decimal('49')
4764 >>> ExtendedContext.multiply(7, Decimal(7))
4765 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004766 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004767 a = _convert_other(a, raiseit=True)
4768 r = a.__mul__(b, context=self)
4769 if r is NotImplemented:
4770 raise TypeError("Unable to convert %s to Decimal" % b)
4771 else:
4772 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004773
Facundo Batista353750c2007-09-13 18:13:15 +00004774 def next_minus(self, a):
4775 """Returns the largest representable number smaller than a.
4776
4777 >>> c = ExtendedContext.copy()
4778 >>> c.Emin = -999
4779 >>> c.Emax = 999
4780 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004781 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004782 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004783 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004784 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004785 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004786 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004787 Decimal('9.99999999E+999')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004788 >>> c.next_minus(1)
4789 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004790 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004791 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004792 return a.next_minus(context=self)
4793
4794 def next_plus(self, a):
4795 """Returns the smallest representable number larger than a.
4796
4797 >>> c = ExtendedContext.copy()
4798 >>> c.Emin = -999
4799 >>> c.Emax = 999
4800 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004801 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004802 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004803 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004804 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004805 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004806 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004807 Decimal('-9.99999999E+999')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004808 >>> c.next_plus(1)
4809 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004810 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004811 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004812 return a.next_plus(context=self)
4813
4814 def next_toward(self, a, b):
4815 """Returns the number closest to a, in direction towards b.
4816
4817 The result is the closest representable number from the first
4818 operand (but not the first operand) that is in the direction
4819 towards the second operand, unless the operands have the same
4820 value.
4821
4822 >>> c = ExtendedContext.copy()
4823 >>> c.Emin = -999
4824 >>> c.Emax = 999
4825 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004826 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004827 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004828 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004829 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004830 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004831 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004832 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004833 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004834 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004835 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004836 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004837 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004838 Decimal('-0.00')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004839 >>> c.next_toward(0, 1)
4840 Decimal('1E-1007')
4841 >>> c.next_toward(Decimal(0), 1)
4842 Decimal('1E-1007')
4843 >>> c.next_toward(0, Decimal(1))
4844 Decimal('1E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004845 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004846 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004847 return a.next_toward(b, context=self)
4848
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004849 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004850 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004851
4852 Essentially a plus operation with all trailing zeros removed from the
4853 result.
4854
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004855 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004856 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004857 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004858 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004859 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004860 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004861 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004862 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004863 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004864 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004865 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004866 Decimal('0')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004867 >>> ExtendedContext.normalize(6)
4868 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004869 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004870 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004871 return a.normalize(context=self)
4872
Facundo Batista353750c2007-09-13 18:13:15 +00004873 def number_class(self, a):
4874 """Returns an indication of the class of the operand.
4875
4876 The class is one of the following strings:
4877 -sNaN
4878 -NaN
4879 -Infinity
4880 -Normal
4881 -Subnormal
4882 -Zero
4883 +Zero
4884 +Subnormal
4885 +Normal
4886 +Infinity
4887
4888 >>> c = Context(ExtendedContext)
4889 >>> c.Emin = -999
4890 >>> c.Emax = 999
4891 >>> c.number_class(Decimal('Infinity'))
4892 '+Infinity'
4893 >>> c.number_class(Decimal('1E-10'))
4894 '+Normal'
4895 >>> c.number_class(Decimal('2.50'))
4896 '+Normal'
4897 >>> c.number_class(Decimal('0.1E-999'))
4898 '+Subnormal'
4899 >>> c.number_class(Decimal('0'))
4900 '+Zero'
4901 >>> c.number_class(Decimal('-0'))
4902 '-Zero'
4903 >>> c.number_class(Decimal('-0.1E-999'))
4904 '-Subnormal'
4905 >>> c.number_class(Decimal('-1E-10'))
4906 '-Normal'
4907 >>> c.number_class(Decimal('-2.50'))
4908 '-Normal'
4909 >>> c.number_class(Decimal('-Infinity'))
4910 '-Infinity'
4911 >>> c.number_class(Decimal('NaN'))
4912 'NaN'
4913 >>> c.number_class(Decimal('-NaN'))
4914 'NaN'
4915 >>> c.number_class(Decimal('sNaN'))
4916 'sNaN'
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004917 >>> c.number_class(123)
4918 '+Normal'
Facundo Batista353750c2007-09-13 18:13:15 +00004919 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004920 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004921 return a.number_class(context=self)
4922
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004923 def plus(self, a):
4924 """Plus corresponds to unary prefix plus in Python.
4925
4926 The operation is evaluated using the same rules as add; the
4927 operation plus(a) is calculated as add('0', a) where the '0'
4928 has the same exponent as the operand.
4929
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004930 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004931 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004932 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004933 Decimal('-1.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004934 >>> ExtendedContext.plus(-1)
4935 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004936 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004937 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004938 return a.__pos__(context=self)
4939
4940 def power(self, a, b, modulo=None):
4941 """Raises a to the power of b, to modulo if given.
4942
Facundo Batista353750c2007-09-13 18:13:15 +00004943 With two arguments, compute a**b. If a is negative then b
4944 must be integral. The result will be inexact unless b is
4945 integral and the result is finite and can be expressed exactly
4946 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004947
Facundo Batista353750c2007-09-13 18:13:15 +00004948 With three arguments, compute (a**b) % modulo. For the
4949 three argument form, the following restrictions on the
4950 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004951
Facundo Batista353750c2007-09-13 18:13:15 +00004952 - all three arguments must be integral
4953 - b must be nonnegative
4954 - at least one of a or b must be nonzero
4955 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004956
Facundo Batista353750c2007-09-13 18:13:15 +00004957 The result of pow(a, b, modulo) is identical to the result
4958 that would be obtained by computing (a**b) % modulo with
4959 unbounded precision, but is computed more efficiently. It is
4960 always exact.
4961
4962 >>> c = ExtendedContext.copy()
4963 >>> c.Emin = -999
4964 >>> c.Emax = 999
4965 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004966 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004967 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004968 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004969 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004970 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004971 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004972 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004973 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004974 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004975 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004976 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004977 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004978 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004979 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004980 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004981 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004982 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004983 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004984 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004985 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004986 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004987 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004988 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004989 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004990 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004991
4992 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004993 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004994 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004995 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00004996 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004997 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004998 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004999 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00005000 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005001 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00005002 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005003 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00005004 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005005 Decimal('1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005006 >>> ExtendedContext.power(7, 7)
5007 Decimal('823543')
5008 >>> ExtendedContext.power(Decimal(7), 7)
5009 Decimal('823543')
5010 >>> ExtendedContext.power(7, Decimal(7), 2)
5011 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005012 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005013 a = _convert_other(a, raiseit=True)
5014 r = a.__pow__(b, modulo, context=self)
5015 if r is NotImplemented:
5016 raise TypeError("Unable to convert %s to Decimal" % b)
5017 else:
5018 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005019
5020 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00005021 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005022
5023 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00005024 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005025 exponent is being increased), multiplied by a positive power of ten (if
5026 the exponent is being decreased), or is unchanged (if the exponent is
5027 already equal to that of the right-hand operand).
5028
5029 Unlike other operations, if the length of the coefficient after the
5030 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00005031 operation condition is raised. This guarantees that, unless there is
5032 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005033 equal to that of the right-hand operand.
5034
5035 Also unlike other operations, quantize will never raise Underflow, even
5036 if the result is subnormal and inexact.
5037
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005038 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005039 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005040 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005041 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005042 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005043 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005044 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005045 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005046 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005047 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005048 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005049 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005050 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005051 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005052 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005053 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005054 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005055 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005056 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005057 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005058 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005059 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005060 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005061 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005062 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005063 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005064 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005065 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005066 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005067 Decimal('2E+2')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005068 >>> ExtendedContext.quantize(1, 2)
5069 Decimal('1')
5070 >>> ExtendedContext.quantize(Decimal(1), 2)
5071 Decimal('1')
5072 >>> ExtendedContext.quantize(1, Decimal(2))
5073 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005074 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005075 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005076 return a.quantize(b, context=self)
5077
Facundo Batista353750c2007-09-13 18:13:15 +00005078 def radix(self):
5079 """Just returns 10, as this is Decimal, :)
5080
5081 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00005082 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00005083 """
5084 return Decimal(10)
5085
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005086 def remainder(self, a, b):
5087 """Returns the remainder from integer division.
5088
5089 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00005090 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00005091 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00005092 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005093
5094 This operation will fail under the same conditions as integer division
5095 (that is, if integer division on the same two operands would fail, the
5096 remainder cannot be calculated).
5097
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005098 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005099 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005100 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005101 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005102 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005103 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005104 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005105 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005106 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005107 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005108 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005109 Decimal('1.0')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005110 >>> ExtendedContext.remainder(22, 6)
5111 Decimal('4')
5112 >>> ExtendedContext.remainder(Decimal(22), 6)
5113 Decimal('4')
5114 >>> ExtendedContext.remainder(22, Decimal(6))
5115 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005116 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005117 a = _convert_other(a, raiseit=True)
5118 r = a.__mod__(b, context=self)
5119 if r is NotImplemented:
5120 raise TypeError("Unable to convert %s to Decimal" % b)
5121 else:
5122 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005123
5124 def remainder_near(self, a, b):
5125 """Returns to be "a - b * n", where n is the integer nearest the exact
5126 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00005127 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005128 sign of a.
5129
5130 This operation will fail under the same conditions as integer division
5131 (that is, if integer division on the same two operands would fail, the
5132 remainder cannot be calculated).
5133
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005134 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005135 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005136 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005137 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005138 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005139 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005140 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005141 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005142 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005143 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005144 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005145 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005146 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005147 Decimal('-0.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005148 >>> ExtendedContext.remainder_near(3, 11)
5149 Decimal('3')
5150 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5151 Decimal('3')
5152 >>> ExtendedContext.remainder_near(3, Decimal(11))
5153 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005154 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005155 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005156 return a.remainder_near(b, context=self)
5157
Facundo Batista353750c2007-09-13 18:13:15 +00005158 def rotate(self, a, b):
5159 """Returns a rotated copy of a, b times.
5160
5161 The coefficient of the result is a rotated copy of the digits in
5162 the coefficient of the first operand. The number of places of
5163 rotation is taken from the absolute value of the second operand,
5164 with the rotation being to the left if the second operand is
5165 positive or to the right otherwise.
5166
5167 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005168 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00005169 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005170 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00005171 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005172 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00005173 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005174 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00005175 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005176 Decimal('345678912')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005177 >>> ExtendedContext.rotate(1333333, 1)
5178 Decimal('13333330')
5179 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5180 Decimal('13333330')
5181 >>> ExtendedContext.rotate(1333333, Decimal(1))
5182 Decimal('13333330')
Facundo Batista353750c2007-09-13 18:13:15 +00005183 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005184 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005185 return a.rotate(b, context=self)
5186
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005187 def same_quantum(self, a, b):
5188 """Returns True if the two operands have the same exponent.
5189
5190 The result is never affected by either the sign or the coefficient of
5191 either operand.
5192
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005193 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005194 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005195 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005196 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005197 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005198 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005199 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005200 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005201 >>> ExtendedContext.same_quantum(10000, -1)
5202 True
5203 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5204 True
5205 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5206 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005207 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005208 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005209 return a.same_quantum(b)
5210
Facundo Batista353750c2007-09-13 18:13:15 +00005211 def scaleb (self, a, b):
5212 """Returns the first operand after adding the second value its exp.
5213
5214 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005215 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00005216 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005217 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00005218 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005219 Decimal('7.50E+3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005220 >>> ExtendedContext.scaleb(1, 4)
5221 Decimal('1E+4')
5222 >>> ExtendedContext.scaleb(Decimal(1), 4)
5223 Decimal('1E+4')
5224 >>> ExtendedContext.scaleb(1, Decimal(4))
5225 Decimal('1E+4')
Facundo Batista353750c2007-09-13 18:13:15 +00005226 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005227 a = _convert_other(a, raiseit=True)
5228 return a.scaleb(b, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00005229
5230 def shift(self, a, b):
5231 """Returns a shifted copy of a, b times.
5232
5233 The coefficient of the result is a shifted copy of the digits
5234 in the coefficient of the first operand. The number of places
5235 to shift is taken from the absolute value of the second operand,
5236 with the shift being to the left if the second operand is
5237 positive or to the right otherwise. Digits shifted into the
5238 coefficient are zeros.
5239
5240 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005241 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00005242 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005243 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00005244 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005245 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00005246 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005247 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00005248 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005249 Decimal('345678900')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005250 >>> ExtendedContext.shift(88888888, 2)
5251 Decimal('888888800')
5252 >>> ExtendedContext.shift(Decimal(88888888), 2)
5253 Decimal('888888800')
5254 >>> ExtendedContext.shift(88888888, Decimal(2))
5255 Decimal('888888800')
Facundo Batista353750c2007-09-13 18:13:15 +00005256 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005257 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005258 return a.shift(b, context=self)
5259
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005260 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00005261 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005262
5263 If the result must be inexact, it is rounded using the round-half-even
5264 algorithm.
5265
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005266 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005267 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005268 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005269 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005270 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005271 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005272 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005273 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005274 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005275 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005276 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005277 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005278 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005279 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005280 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005281 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005282 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005283 Decimal('3.16227766')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005284 >>> ExtendedContext.sqrt(2)
5285 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005286 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005287 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005288 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005289 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005290 return a.sqrt(context=self)
5291
5292 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005293 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005294
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005295 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005296 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005297 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005298 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005299 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005300 Decimal('-0.77')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005301 >>> ExtendedContext.subtract(8, 5)
5302 Decimal('3')
5303 >>> ExtendedContext.subtract(Decimal(8), 5)
5304 Decimal('3')
5305 >>> ExtendedContext.subtract(8, Decimal(5))
5306 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005307 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005308 a = _convert_other(a, raiseit=True)
5309 r = a.__sub__(b, context=self)
5310 if r is NotImplemented:
5311 raise TypeError("Unable to convert %s to Decimal" % b)
5312 else:
5313 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005314
5315 def to_eng_string(self, a):
5316 """Converts a number to a string, using scientific notation.
5317
5318 The operation is not affected by the context.
5319 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005320 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005321 return a.to_eng_string(context=self)
5322
5323 def to_sci_string(self, a):
5324 """Converts a number to a string, using scientific notation.
5325
5326 The operation is not affected by the context.
5327 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005328 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005329 return a.__str__(context=self)
5330
Facundo Batista353750c2007-09-13 18:13:15 +00005331 def to_integral_exact(self, a):
5332 """Rounds to an integer.
5333
5334 When the operand has a negative exponent, the result is the same
5335 as using the quantize() operation using the given operand as the
5336 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5337 of the operand as the precision setting; Inexact and Rounded flags
5338 are allowed in this operation. The rounding mode is taken from the
5339 context.
5340
5341 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005342 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00005343 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005344 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005345 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005346 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005347 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005348 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00005349 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005350 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00005351 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005352 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00005353 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005354 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00005355 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005356 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005357 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005358 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005359 return a.to_integral_exact(context=self)
5360
5361 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005362 """Rounds to an integer.
5363
5364 When the operand has a negative exponent, the result is the same
5365 as using the quantize() operation using the given operand as the
5366 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5367 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00005368 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005369
Facundo Batista353750c2007-09-13 18:13:15 +00005370 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005371 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00005372 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005373 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005374 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005375 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005376 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005377 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00005378 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005379 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00005380 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005381 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00005382 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005383 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00005384 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005385 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005386 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005387 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005388 return a.to_integral_value(context=self)
5389
5390 # the method name changed, but we provide also the old one, for compatibility
5391 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005392
5393class _WorkRep(object):
5394 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005395 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005396 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005397 # exp: None, int, or string
5398
5399 def __init__(self, value=None):
5400 if value is None:
5401 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005402 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005403 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005404 elif isinstance(value, Decimal):
5405 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00005406 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005407 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005408 else:
5409 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005410 self.sign = value[0]
5411 self.int = value[1]
5412 self.exp = value[2]
5413
5414 def __repr__(self):
5415 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5416
5417 __str__ = __repr__
5418
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005419
5420
Facundo Batistae64acfa2007-12-17 14:18:42 +00005421def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005422 """Normalizes op1, op2 to have the same exp and length of coefficient.
5423
5424 Done during addition.
5425 """
Facundo Batista353750c2007-09-13 18:13:15 +00005426 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005427 tmp = op2
5428 other = op1
5429 else:
5430 tmp = op1
5431 other = op2
5432
Facundo Batista353750c2007-09-13 18:13:15 +00005433 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5434 # Then adding 10**exp to tmp has the same effect (after rounding)
5435 # as adding any positive quantity smaller than 10**exp; similarly
5436 # for subtraction. So if other is smaller than 10**exp we replace
5437 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00005438 tmp_len = len(str(tmp.int))
5439 other_len = len(str(other.int))
5440 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5441 if other_len + other.exp - 1 < exp:
5442 other.int = 1
5443 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005444
Facundo Batista353750c2007-09-13 18:13:15 +00005445 tmp.int *= 10 ** (tmp.exp - other.exp)
5446 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005447 return op1, op2
5448
Facundo Batista353750c2007-09-13 18:13:15 +00005449##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
5450
5451# This function from Tim Peters was taken from here:
5452# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5453# The correction being in the function definition is for speed, and
5454# the whole function is not resolved with math.log because of avoiding
5455# the use of floats.
5456def _nbits(n, correction = {
5457 '0': 4, '1': 3, '2': 2, '3': 2,
5458 '4': 1, '5': 1, '6': 1, '7': 1,
5459 '8': 0, '9': 0, 'a': 0, 'b': 0,
5460 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5461 """Number of bits in binary representation of the positive integer n,
5462 or 0 if n == 0.
5463 """
5464 if n < 0:
5465 raise ValueError("The argument to _nbits should be nonnegative.")
5466 hex_n = "%x" % n
5467 return 4*len(hex_n) - correction[hex_n[0]]
5468
5469def _sqrt_nearest(n, a):
5470 """Closest integer to the square root of the positive integer n. a is
5471 an initial approximation to the square root. Any positive integer
5472 will do for a, but the closer a is to the square root of n the
5473 faster convergence will be.
5474
5475 """
5476 if n <= 0 or a <= 0:
5477 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5478
5479 b=0
5480 while a != b:
5481 b, a = a, a--n//a>>1
5482 return a
5483
5484def _rshift_nearest(x, shift):
5485 """Given an integer x and a nonnegative integer shift, return closest
5486 integer to x / 2**shift; use round-to-even in case of a tie.
5487
5488 """
5489 b, q = 1L << shift, x >> shift
5490 return q + (2*(x & (b-1)) + (q&1) > b)
5491
5492def _div_nearest(a, b):
5493 """Closest integer to a/b, a and b positive integers; rounds to even
5494 in the case of a tie.
5495
5496 """
5497 q, r = divmod(a, b)
5498 return q + (2*r + (q&1) > b)
5499
5500def _ilog(x, M, L = 8):
5501 """Integer approximation to M*log(x/M), with absolute error boundable
5502 in terms only of x/M.
5503
5504 Given positive integers x and M, return an integer approximation to
5505 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5506 between the approximation and the exact result is at most 22. For
5507 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5508 both cases these are upper bounds on the error; it will usually be
5509 much smaller."""
5510
5511 # The basic algorithm is the following: let log1p be the function
5512 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5513 # the reduction
5514 #
5515 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5516 #
5517 # repeatedly until the argument to log1p is small (< 2**-L in
5518 # absolute value). For small y we can use the Taylor series
5519 # expansion
5520 #
5521 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5522 #
5523 # truncating at T such that y**T is small enough. The whole
5524 # computation is carried out in a form of fixed-point arithmetic,
5525 # with a real number z being represented by an integer
5526 # approximation to z*M. To avoid loss of precision, the y below
5527 # is actually an integer approximation to 2**R*y*M, where R is the
5528 # number of reductions performed so far.
5529
5530 y = x-M
5531 # argument reduction; R = number of reductions performed
5532 R = 0
5533 while (R <= L and long(abs(y)) << L-R >= M or
5534 R > L and abs(y) >> R-L >= M):
5535 y = _div_nearest(long(M*y) << 1,
5536 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5537 R += 1
5538
5539 # Taylor series with T terms
5540 T = -int(-10*len(str(M))//(3*L))
5541 yshift = _rshift_nearest(y, R)
5542 w = _div_nearest(M, T)
5543 for k in xrange(T-1, 0, -1):
5544 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5545
5546 return _div_nearest(w*y, M)
5547
5548def _dlog10(c, e, p):
5549 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5550 approximation to 10**p * log10(c*10**e), with an absolute error of
5551 at most 1. Assumes that c*10**e is not exactly 1."""
5552
5553 # increase precision by 2; compensate for this by dividing
5554 # final result by 100
5555 p += 2
5556
5557 # write c*10**e as d*10**f with either:
5558 # f >= 0 and 1 <= d <= 10, or
5559 # f <= 0 and 0.1 <= d <= 1.
5560 # Thus for c*10**e close to 1, f = 0
5561 l = len(str(c))
5562 f = e+l - (e+l >= 1)
5563
5564 if p > 0:
5565 M = 10**p
5566 k = e+p-f
5567 if k >= 0:
5568 c *= 10**k
5569 else:
5570 c = _div_nearest(c, 10**-k)
5571
5572 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005573 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005574 log_d = _div_nearest(log_d*M, log_10)
5575 log_tenpower = f*M # exact
5576 else:
5577 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005578 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005579
5580 return _div_nearest(log_tenpower+log_d, 100)
5581
5582def _dlog(c, e, p):
5583 """Given integers c, e and p with c > 0, compute an integer
5584 approximation to 10**p * log(c*10**e), with an absolute error of
5585 at most 1. Assumes that c*10**e is not exactly 1."""
5586
5587 # Increase precision by 2. The precision increase is compensated
5588 # for at the end with a division by 100.
5589 p += 2
5590
5591 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5592 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5593 # as 10**p * log(d) + 10**p*f * log(10).
5594 l = len(str(c))
5595 f = e+l - (e+l >= 1)
5596
5597 # compute approximation to 10**p*log(d), with error < 27
5598 if p > 0:
5599 k = e+p-f
5600 if k >= 0:
5601 c *= 10**k
5602 else:
5603 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5604
5605 # _ilog magnifies existing error in c by a factor of at most 10
5606 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5607 else:
5608 # p <= 0: just approximate the whole thing by 0; error < 2.31
5609 log_d = 0
5610
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005611 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005612 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005613 extra = len(str(abs(f)))-1
5614 if p + extra >= 0:
5615 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5616 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5617 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005618 else:
5619 f_log_ten = 0
5620 else:
5621 f_log_ten = 0
5622
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005623 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005624 return _div_nearest(f_log_ten + log_d, 100)
5625
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005626class _Log10Memoize(object):
5627 """Class to compute, store, and allow retrieval of, digits of the
5628 constant log(10) = 2.302585.... This constant is needed by
5629 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5630 def __init__(self):
5631 self.digits = "23025850929940456840179914546843642076011014886"
5632
5633 def getdigits(self, p):
5634 """Given an integer p >= 0, return floor(10**p)*log(10).
5635
5636 For example, self.getdigits(3) returns 2302.
5637 """
5638 # digits are stored as a string, for quick conversion to
5639 # integer in the case that we've already computed enough
5640 # digits; the stored digits should always be correct
5641 # (truncated, not rounded to nearest).
5642 if p < 0:
5643 raise ValueError("p should be nonnegative")
5644
5645 if p >= len(self.digits):
5646 # compute p+3, p+6, p+9, ... digits; continue until at
5647 # least one of the extra digits is nonzero
5648 extra = 3
5649 while True:
5650 # compute p+extra digits, correct to within 1ulp
5651 M = 10**(p+extra+2)
5652 digits = str(_div_nearest(_ilog(10*M, M), 100))
5653 if digits[-extra:] != '0'*extra:
5654 break
5655 extra += 3
5656 # keep all reliable digits so far; remove trailing zeros
5657 # and next nonzero digit
5658 self.digits = digits.rstrip('0')[:-1]
5659 return int(self.digits[:p+1])
5660
5661_log10_digits = _Log10Memoize().getdigits
5662
Facundo Batista353750c2007-09-13 18:13:15 +00005663def _iexp(x, M, L=8):
5664 """Given integers x and M, M > 0, such that x/M is small in absolute
5665 value, compute an integer approximation to M*exp(x/M). For 0 <=
5666 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5667 is usually much smaller)."""
5668
5669 # Algorithm: to compute exp(z) for a real number z, first divide z
5670 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5671 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5672 # series
5673 #
5674 # expm1(x) = x + x**2/2! + x**3/3! + ...
5675 #
5676 # Now use the identity
5677 #
5678 # expm1(2x) = expm1(x)*(expm1(x)+2)
5679 #
5680 # R times to compute the sequence expm1(z/2**R),
5681 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5682
5683 # Find R such that x/2**R/M <= 2**-L
5684 R = _nbits((long(x)<<L)//M)
5685
5686 # Taylor series. (2**L)**T > M
5687 T = -int(-10*len(str(M))//(3*L))
5688 y = _div_nearest(x, T)
5689 Mshift = long(M)<<R
5690 for i in xrange(T-1, 0, -1):
5691 y = _div_nearest(x*(Mshift + y), Mshift * i)
5692
5693 # Expansion
5694 for k in xrange(R-1, -1, -1):
5695 Mshift = long(M)<<(k+2)
5696 y = _div_nearest(y*(y+Mshift), Mshift)
5697
5698 return M+y
5699
5700def _dexp(c, e, p):
5701 """Compute an approximation to exp(c*10**e), with p decimal places of
5702 precision.
5703
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005704 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005705
5706 10**(p-1) <= d <= 10**p, and
5707 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5708
5709 In other words, d*10**f is an approximation to exp(c*10**e) with p
5710 digits of precision, and with an error in d of at most 1. This is
5711 almost, but not quite, the same as the error being < 1ulp: when d
5712 = 10**(p-1) the error could be up to 10 ulp."""
5713
5714 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5715 p += 2
5716
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005717 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005718 extra = max(0, e + len(str(c)) - 1)
5719 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005720
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005721 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005722 # rounding down
5723 shift = e+q
5724 if shift >= 0:
5725 cshift = c*10**shift
5726 else:
5727 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005728 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005729
5730 # reduce remainder back to original precision
5731 rem = _div_nearest(rem, 10**extra)
5732
5733 # error in result of _iexp < 120; error after division < 0.62
5734 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5735
5736def _dpower(xc, xe, yc, ye, p):
5737 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5738 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5739
5740 10**(p-1) <= c <= 10**p, and
5741 (c-1)*10**e < x**y < (c+1)*10**e
5742
5743 in other words, c*10**e is an approximation to x**y with p digits
5744 of precision, and with an error in c of at most 1. (This is
5745 almost, but not quite, the same as the error being < 1ulp: when c
5746 == 10**(p-1) we can only guarantee error < 10ulp.)
5747
5748 We assume that: x is positive and not equal to 1, and y is nonzero.
5749 """
5750
5751 # Find b such that 10**(b-1) <= |y| <= 10**b
5752 b = len(str(abs(yc))) + ye
5753
5754 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5755 lxc = _dlog(xc, xe, p+b+1)
5756
5757 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5758 shift = ye-b
5759 if shift >= 0:
5760 pc = lxc*yc*10**shift
5761 else:
5762 pc = _div_nearest(lxc*yc, 10**-shift)
5763
5764 if pc == 0:
5765 # we prefer a result that isn't exactly 1; this makes it
5766 # easier to compute a correctly rounded result in __pow__
5767 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5768 coeff, exp = 10**(p-1)+1, 1-p
5769 else:
5770 coeff, exp = 10**p-1, -p
5771 else:
5772 coeff, exp = _dexp(pc, -(p+1), p+1)
5773 coeff = _div_nearest(coeff, 10)
5774 exp += 1
5775
5776 return coeff, exp
5777
5778def _log10_lb(c, correction = {
5779 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5780 '6': 23, '7': 16, '8': 10, '9': 5}):
5781 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5782 if c <= 0:
5783 raise ValueError("The argument to _log10_lb should be nonnegative.")
5784 str_c = str(c)
5785 return 100*len(str_c) - correction[str_c[0]]
5786
Facundo Batista59c58842007-04-10 12:58:45 +00005787##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005788
Mark Dickinson99d80962010-04-02 08:53:22 +00005789def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005790 """Convert other to Decimal.
5791
5792 Verifies that it's ok to use in an implicit construction.
Mark Dickinson99d80962010-04-02 08:53:22 +00005793 If allow_float is true, allow conversion from float; this
5794 is used in the comparison methods (__eq__ and friends).
5795
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005796 """
5797 if isinstance(other, Decimal):
5798 return other
5799 if isinstance(other, (int, long)):
5800 return Decimal(other)
Mark Dickinson99d80962010-04-02 08:53:22 +00005801 if allow_float and isinstance(other, float):
5802 return Decimal.from_float(other)
5803
Facundo Batista353750c2007-09-13 18:13:15 +00005804 if raiseit:
5805 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005806 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005807
Facundo Batista59c58842007-04-10 12:58:45 +00005808##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005809
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005810# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005811# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005812
5813DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005814 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005815 traps=[DivisionByZero, Overflow, InvalidOperation],
5816 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005817 Emax=999999999,
5818 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005819 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005820)
5821
5822# Pre-made alternate contexts offered by the specification
5823# Don't change these; the user should be able to select these
5824# contexts and be able to reproduce results from other implementations
5825# of the spec.
5826
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005827BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005828 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005829 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5830 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005831)
5832
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005833ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005834 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005835 traps=[],
5836 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005837)
5838
5839
Facundo Batista72bc54f2007-11-23 17:59:00 +00005840##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005841#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005842# Regular expression used for parsing numeric strings. Additional
5843# comments:
5844#
5845# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5846# whitespace. But note that the specification disallows whitespace in
5847# a numeric string.
5848#
5849# 2. For finite numbers (not infinities and NaNs) the body of the
5850# number between the optional sign and the optional exponent must have
5851# at least one decimal digit, possibly after the decimal point. The
5852# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005853
5854import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005855_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005856# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005857 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005858 (
Mark Dickinson4326ad82009-08-02 10:59:36 +00005859 (?=\d|\.\d) # ...a number (with at least one digit)
5860 (?P<int>\d*) # having a (possibly empty) integer part
5861 (\.(?P<frac>\d*))? # followed by an optional fractional part
5862 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005863 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005864 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005865 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005866 (?P<signal>s)? # ...an (optionally signaling)
5867 NaN # NaN
Mark Dickinson4326ad82009-08-02 10:59:36 +00005868 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005869 )
5870# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005871 \Z
Mark Dickinson4326ad82009-08-02 10:59:36 +00005872""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005873
Facundo Batista2ec74152007-12-03 17:55:00 +00005874_all_zeros = re.compile('0*$').match
5875_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005876
5877##### PEP3101 support functions ##############################################
Mark Dickinson277859d2009-03-17 23:03:46 +00005878# The functions in this section have little to do with the Decimal
5879# class, and could potentially be reused or adapted for other pure
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005880# Python numeric classes that want to implement __format__
5881#
5882# A format specifier for Decimal looks like:
5883#
Mark Dickinson277859d2009-03-17 23:03:46 +00005884# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005885
5886_parse_format_specifier_regex = re.compile(r"""\A
5887(?:
5888 (?P<fill>.)?
5889 (?P<align>[<>=^])
5890)?
5891(?P<sign>[-+ ])?
5892(?P<zeropad>0)?
5893(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson277859d2009-03-17 23:03:46 +00005894(?P<thousands_sep>,)?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005895(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson277859d2009-03-17 23:03:46 +00005896(?P<type>[eEfFgGn%])?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005897\Z
5898""", re.VERBOSE)
5899
Facundo Batista72bc54f2007-11-23 17:59:00 +00005900del re
5901
Mark Dickinson277859d2009-03-17 23:03:46 +00005902# The locale module is only needed for the 'n' format specifier. The
5903# rest of the PEP 3101 code functions quite happily without it, so we
5904# don't care too much if locale isn't present.
5905try:
5906 import locale as _locale
5907except ImportError:
5908 pass
5909
5910def _parse_format_specifier(format_spec, _localeconv=None):
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005911 """Parse and validate a format specifier.
5912
5913 Turns a standard numeric format specifier into a dict, with the
5914 following entries:
5915
5916 fill: fill character to pad field to minimum width
5917 align: alignment type, either '<', '>', '=' or '^'
5918 sign: either '+', '-' or ' '
5919 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson277859d2009-03-17 23:03:46 +00005920 zeropad: boolean, indicating whether to pad with zeros
5921 thousands_sep: string to use as thousands separator, or ''
5922 grouping: grouping for thousands separators, in format
5923 used by localeconv
5924 decimal_point: string to use for decimal point
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005925 precision: nonnegative integer giving precision, or None
5926 type: one of the characters 'eEfFgG%', or None
Mark Dickinson277859d2009-03-17 23:03:46 +00005927 unicode: boolean (always True for Python 3.x)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005928
5929 """
5930 m = _parse_format_specifier_regex.match(format_spec)
5931 if m is None:
5932 raise ValueError("Invalid format specifier: " + format_spec)
5933
5934 # get the dictionary
5935 format_dict = m.groupdict()
5936
Mark Dickinson277859d2009-03-17 23:03:46 +00005937 # zeropad; defaults for fill and alignment. If zero padding
5938 # is requested, the fill and align fields should be absent.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005939 fill = format_dict['fill']
5940 align = format_dict['align']
Mark Dickinson277859d2009-03-17 23:03:46 +00005941 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5942 if format_dict['zeropad']:
5943 if fill is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005944 raise ValueError("Fill character conflicts with '0'"
5945 " in format specifier: " + format_spec)
Mark Dickinson277859d2009-03-17 23:03:46 +00005946 if align is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005947 raise ValueError("Alignment conflicts with '0' in "
5948 "format specifier: " + format_spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005949 format_dict['fill'] = fill or ' '
Mark Dickinson5cfa8042009-09-08 20:20:19 +00005950 # PEP 3101 originally specified that the default alignment should
5951 # be left; it was later agreed that right-aligned makes more sense
5952 # for numeric types. See http://bugs.python.org/issue6857.
5953 format_dict['align'] = align or '>'
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005954
Mark Dickinson277859d2009-03-17 23:03:46 +00005955 # default sign handling: '-' for negative, '' for positive
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005956 if format_dict['sign'] is None:
5957 format_dict['sign'] = '-'
5958
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005959 # minimumwidth defaults to 0; precision remains None if not given
5960 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5961 if format_dict['precision'] is not None:
5962 format_dict['precision'] = int(format_dict['precision'])
5963
5964 # if format type is 'g' or 'G' then a precision of 0 makes little
5965 # sense; convert it to 1. Same if format type is unspecified.
5966 if format_dict['precision'] == 0:
Mark Dickinson491ea552009-09-07 16:17:41 +00005967 if format_dict['type'] is None or format_dict['type'] in 'gG':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005968 format_dict['precision'] = 1
5969
Mark Dickinson277859d2009-03-17 23:03:46 +00005970 # determine thousands separator, grouping, and decimal separator, and
5971 # add appropriate entries to format_dict
5972 if format_dict['type'] == 'n':
5973 # apart from separators, 'n' behaves just like 'g'
5974 format_dict['type'] = 'g'
5975 if _localeconv is None:
5976 _localeconv = _locale.localeconv()
5977 if format_dict['thousands_sep'] is not None:
5978 raise ValueError("Explicit thousands separator conflicts with "
5979 "'n' type in format specifier: " + format_spec)
5980 format_dict['thousands_sep'] = _localeconv['thousands_sep']
5981 format_dict['grouping'] = _localeconv['grouping']
5982 format_dict['decimal_point'] = _localeconv['decimal_point']
5983 else:
5984 if format_dict['thousands_sep'] is None:
5985 format_dict['thousands_sep'] = ''
5986 format_dict['grouping'] = [3, 0]
5987 format_dict['decimal_point'] = '.'
5988
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005989 # record whether return type should be str or unicode
5990 format_dict['unicode'] = isinstance(format_spec, unicode)
5991
5992 return format_dict
5993
Mark Dickinson277859d2009-03-17 23:03:46 +00005994def _format_align(sign, body, spec):
5995 """Given an unpadded, non-aligned numeric string 'body' and sign
Ezio Melotti24b07bc2011-03-15 18:55:01 +02005996 string 'sign', add padding and alignment conforming to the given
Mark Dickinson277859d2009-03-17 23:03:46 +00005997 format specifier dictionary 'spec' (as produced by
5998 parse_format_specifier).
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005999
Mark Dickinson277859d2009-03-17 23:03:46 +00006000 Also converts result to unicode if necessary.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006001
6002 """
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006003 # how much extra space do we have to play with?
Mark Dickinson277859d2009-03-17 23:03:46 +00006004 minimumwidth = spec['minimumwidth']
6005 fill = spec['fill']
6006 padding = fill*(minimumwidth - len(sign) - len(body))
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006007
Mark Dickinson277859d2009-03-17 23:03:46 +00006008 align = spec['align']
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006009 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006010 result = sign + body + padding
Mark Dickinsonb065e522009-03-17 18:01:03 +00006011 elif align == '>':
6012 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006013 elif align == '=':
6014 result = sign + padding + body
Mark Dickinson277859d2009-03-17 23:03:46 +00006015 elif align == '^':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006016 half = len(padding)//2
6017 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson277859d2009-03-17 23:03:46 +00006018 else:
6019 raise ValueError('Unrecognised alignment field')
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006020
6021 # make sure that result is unicode if necessary
Mark Dickinson277859d2009-03-17 23:03:46 +00006022 if spec['unicode']:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006023 result = unicode(result)
6024
6025 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00006026
Mark Dickinson277859d2009-03-17 23:03:46 +00006027def _group_lengths(grouping):
6028 """Convert a localeconv-style grouping into a (possibly infinite)
6029 iterable of integers representing group lengths.
6030
6031 """
6032 # The result from localeconv()['grouping'], and the input to this
6033 # function, should be a list of integers in one of the
6034 # following three forms:
6035 #
6036 # (1) an empty list, or
6037 # (2) nonempty list of positive integers + [0]
6038 # (3) list of positive integers + [locale.CHAR_MAX], or
6039
6040 from itertools import chain, repeat
6041 if not grouping:
6042 return []
6043 elif grouping[-1] == 0 and len(grouping) >= 2:
6044 return chain(grouping[:-1], repeat(grouping[-2]))
6045 elif grouping[-1] == _locale.CHAR_MAX:
6046 return grouping[:-1]
6047 else:
6048 raise ValueError('unrecognised format for grouping')
6049
6050def _insert_thousands_sep(digits, spec, min_width=1):
6051 """Insert thousands separators into a digit string.
6052
6053 spec is a dictionary whose keys should include 'thousands_sep' and
6054 'grouping'; typically it's the result of parsing the format
6055 specifier using _parse_format_specifier.
6056
6057 The min_width keyword argument gives the minimum length of the
6058 result, which will be padded on the left with zeros if necessary.
6059
6060 If necessary, the zero padding adds an extra '0' on the left to
6061 avoid a leading thousands separator. For example, inserting
6062 commas every three digits in '123456', with min_width=8, gives
6063 '0,123,456', even though that has length 9.
6064
6065 """
6066
6067 sep = spec['thousands_sep']
6068 grouping = spec['grouping']
6069
6070 groups = []
6071 for l in _group_lengths(grouping):
Mark Dickinson277859d2009-03-17 23:03:46 +00006072 if l <= 0:
6073 raise ValueError("group length should be positive")
6074 # max(..., 1) forces at least 1 digit to the left of a separator
6075 l = min(max(len(digits), min_width, 1), l)
6076 groups.append('0'*(l - len(digits)) + digits[-l:])
6077 digits = digits[:-l]
6078 min_width -= l
6079 if not digits and min_width <= 0:
6080 break
Mark Dickinsonb14514a2009-03-18 08:22:51 +00006081 min_width -= len(sep)
Mark Dickinson277859d2009-03-17 23:03:46 +00006082 else:
6083 l = max(len(digits), min_width, 1)
6084 groups.append('0'*(l - len(digits)) + digits[-l:])
6085 return sep.join(reversed(groups))
6086
6087def _format_sign(is_negative, spec):
6088 """Determine sign character."""
6089
6090 if is_negative:
6091 return '-'
6092 elif spec['sign'] in ' +':
6093 return spec['sign']
6094 else:
6095 return ''
6096
6097def _format_number(is_negative, intpart, fracpart, exp, spec):
6098 """Format a number, given the following data:
6099
6100 is_negative: true if the number is negative, else false
6101 intpart: string of digits that must appear before the decimal point
6102 fracpart: string of digits that must come after the point
6103 exp: exponent, as an integer
6104 spec: dictionary resulting from parsing the format specifier
6105
6106 This function uses the information in spec to:
6107 insert separators (decimal separator and thousands separators)
6108 format the sign
6109 format the exponent
6110 add trailing '%' for the '%' type
6111 zero-pad if necessary
6112 fill and align if necessary
6113 """
6114
6115 sign = _format_sign(is_negative, spec)
6116
6117 if fracpart:
6118 fracpart = spec['decimal_point'] + fracpart
6119
6120 if exp != 0 or spec['type'] in 'eE':
6121 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6122 fracpart += "{0}{1:+}".format(echar, exp)
6123 if spec['type'] == '%':
6124 fracpart += '%'
6125
6126 if spec['zeropad']:
6127 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6128 else:
6129 min_width = 0
6130 intpart = _insert_thousands_sep(intpart, spec, min_width)
6131
6132 return _format_align(sign, intpart+fracpart, spec)
6133
6134
Facundo Batista59c58842007-04-10 12:58:45 +00006135##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006136
Facundo Batista59c58842007-04-10 12:58:45 +00006137# Reusable defaults
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006138_Infinity = Decimal('Inf')
6139_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonc5de0962009-01-02 23:07:08 +00006140_NaN = Decimal('NaN')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006141_Zero = Decimal(0)
6142_One = Decimal(1)
6143_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006144
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006145# _SignedInfinity[sign] is infinity w/ that sign
6146_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006147
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006148
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006149
6150if __name__ == '__main__':
6151 import doctest, sys
6152 doctest.testmod(sys.modules[__name__])