blob: 80ef20d1fff08b81b56f438f42538b2c9fc3e1dd [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
171 trap_enabler is set. First argument is self, second is the
172 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
1071 if not self:
1072 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001073 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001074 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001075 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001076
1077 if context is None:
1078 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001079 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001080
1081 def __pos__(self, context=None):
1082 """Returns a copy, unless it is a sNaN.
1083
1084 Rounds the number (if more then precision digits)
1085 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001086 if self._is_special:
1087 ans = self._check_nans(context=context)
1088 if ans:
1089 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001090
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001091 if not self:
1092 # + (-0) = 0
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001093 ans = self.copy_abs()
Facundo Batista353750c2007-09-13 18:13:15 +00001094 else:
1095 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001096
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001097 if context is None:
1098 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001099 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001100
Facundo Batistae64acfa2007-12-17 14:18:42 +00001101 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001102 """Returns the absolute value of self.
1103
Facundo Batistae64acfa2007-12-17 14:18:42 +00001104 If the keyword argument 'round' is false, do not round. The
1105 expression self.__abs__(round=False) is equivalent to
1106 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001107 """
Facundo Batistae64acfa2007-12-17 14:18:42 +00001108 if not round:
1109 return self.copy_abs()
1110
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001111 if self._is_special:
1112 ans = self._check_nans(context=context)
1113 if ans:
1114 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001115
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001116 if self._sign:
1117 ans = self.__neg__(context=context)
1118 else:
1119 ans = self.__pos__(context=context)
1120
1121 return ans
1122
1123 def __add__(self, other, context=None):
1124 """Returns self + other.
1125
1126 -INF + INF (or the reverse) cause InvalidOperation errors.
1127 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001128 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001129 if other is NotImplemented:
1130 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001131
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001132 if context is None:
1133 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001134
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001135 if self._is_special or other._is_special:
1136 ans = self._check_nans(other, context)
1137 if ans:
1138 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001139
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001140 if self._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001141 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001142 if self._sign != other._sign and other._isinfinity():
1143 return context._raise_error(InvalidOperation, '-INF + INF')
1144 return Decimal(self)
1145 if other._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001146 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001147
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001148 exp = min(self._exp, other._exp)
1149 negativezero = 0
1150 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Facundo Batista59c58842007-04-10 12:58:45 +00001151 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001152 negativezero = 1
1153
1154 if not self and not other:
1155 sign = min(self._sign, other._sign)
1156 if negativezero:
1157 sign = 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00001158 ans = _dec_from_triple(sign, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001159 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001160 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001161 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001162 exp = max(exp, other._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001163 ans = other._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001164 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001165 return ans
1166 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001167 exp = max(exp, self._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001168 ans = self._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001169 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001170 return ans
1171
1172 op1 = _WorkRep(self)
1173 op2 = _WorkRep(other)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001174 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001175
1176 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001177 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001179 if op1.int == op2.int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001180 ans = _dec_from_triple(negativezero, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001181 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001182 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001183 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001184 op1, op2 = op2, op1
Facundo Batista59c58842007-04-10 12:58:45 +00001185 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001186 if op1.sign == 1:
1187 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001188 op1.sign, op2.sign = op2.sign, op1.sign
1189 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001190 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001191 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001192 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001193 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001194 op1.sign, op2.sign = (0, 0)
1195 else:
1196 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001197 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001198
Raymond Hettinger17931de2004-10-27 06:21:46 +00001199 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001200 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001201 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001202 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001203
1204 result.exp = op1.exp
1205 ans = Decimal(result)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001206 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001207 return ans
1208
1209 __radd__ = __add__
1210
1211 def __sub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001212 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001213 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001214 if other is NotImplemented:
1215 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001216
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001217 if self._is_special or other._is_special:
1218 ans = self._check_nans(other, context=context)
1219 if ans:
1220 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001221
Facundo Batista353750c2007-09-13 18:13:15 +00001222 # self - other is computed as self + other.copy_negate()
1223 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001224
1225 def __rsub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001226 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001227 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001228 if other is NotImplemented:
1229 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001230
Facundo Batista353750c2007-09-13 18:13:15 +00001231 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001232
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233 def __mul__(self, other, context=None):
1234 """Return self * other.
1235
1236 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1237 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001238 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001239 if other is NotImplemented:
1240 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001241
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001242 if context is None:
1243 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001244
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001245 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001246
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001247 if self._is_special or other._is_special:
1248 ans = self._check_nans(other, context)
1249 if ans:
1250 return ans
1251
1252 if self._isinfinity():
1253 if not other:
1254 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001255 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001256
1257 if other._isinfinity():
1258 if not self:
1259 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001260 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001261
1262 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001263
1264 # Special case for multiplying by zero
1265 if not self or not other:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001266 ans = _dec_from_triple(resultsign, '0', resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001267 # Fixing in case the exponent is out of bounds
1268 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001269 return ans
1270
1271 # Special case for multiplying by power of 10
Facundo Batista72bc54f2007-11-23 17:59:00 +00001272 if self._int == '1':
1273 ans = _dec_from_triple(resultsign, other._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001274 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001275 return ans
Facundo Batista72bc54f2007-11-23 17:59:00 +00001276 if other._int == '1':
1277 ans = _dec_from_triple(resultsign, self._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001278 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001279 return ans
1280
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001281 op1 = _WorkRep(self)
1282 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001283
Facundo Batista72bc54f2007-11-23 17:59:00 +00001284 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001285 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001286
1287 return ans
1288 __rmul__ = __mul__
1289
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001290 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001291 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001292 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001293 if other is NotImplemented:
Facundo Batistacce8df22007-09-18 16:53:18 +00001294 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001295
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001296 if context is None:
1297 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001298
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001299 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001300
1301 if self._is_special or other._is_special:
1302 ans = self._check_nans(other, context)
1303 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001304 return ans
1305
1306 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001307 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001308
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001309 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001310 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001311
1312 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001313 context._raise_error(Clamped, 'Division by infinity')
Facundo Batista72bc54f2007-11-23 17:59:00 +00001314 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001315
1316 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001317 if not other:
Facundo Batistacce8df22007-09-18 16:53:18 +00001318 if not self:
1319 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001320 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001321
Facundo Batistacce8df22007-09-18 16:53:18 +00001322 if not self:
1323 exp = self._exp - other._exp
1324 coeff = 0
1325 else:
1326 # OK, so neither = 0, INF or NaN
1327 shift = len(other._int) - len(self._int) + context.prec + 1
1328 exp = self._exp - other._exp - shift
1329 op1 = _WorkRep(self)
1330 op2 = _WorkRep(other)
1331 if shift >= 0:
1332 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1333 else:
1334 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1335 if remainder:
1336 # result is not exact; adjust to ensure correct rounding
1337 if coeff % 5 == 0:
1338 coeff += 1
1339 else:
1340 # result is exact; get as close to ideal exponent as possible
1341 ideal_exp = self._exp - other._exp
1342 while exp < ideal_exp and coeff % 10 == 0:
1343 coeff //= 10
1344 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001345
Facundo Batista72bc54f2007-11-23 17:59:00 +00001346 ans = _dec_from_triple(sign, str(coeff), exp)
Facundo Batistacce8df22007-09-18 16:53:18 +00001347 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001348
Facundo Batistacce8df22007-09-18 16:53:18 +00001349 def _divide(self, other, context):
1350 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001351
Facundo Batistacce8df22007-09-18 16:53:18 +00001352 Assumes that neither self nor other is a NaN, that self is not
1353 infinite and that other is nonzero.
1354 """
1355 sign = self._sign ^ other._sign
1356 if other._isinfinity():
1357 ideal_exp = self._exp
1358 else:
1359 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001360
Facundo Batistacce8df22007-09-18 16:53:18 +00001361 expdiff = self.adjusted() - other.adjusted()
1362 if not self or other._isinfinity() or expdiff <= -2:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001363 return (_dec_from_triple(sign, '0', 0),
Facundo Batistacce8df22007-09-18 16:53:18 +00001364 self._rescale(ideal_exp, context.rounding))
1365 if expdiff <= context.prec:
1366 op1 = _WorkRep(self)
1367 op2 = _WorkRep(other)
1368 if op1.exp >= op2.exp:
1369 op1.int *= 10**(op1.exp - op2.exp)
1370 else:
1371 op2.int *= 10**(op2.exp - op1.exp)
1372 q, r = divmod(op1.int, op2.int)
1373 if q < 10**context.prec:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001374 return (_dec_from_triple(sign, str(q), 0),
1375 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001376
Facundo Batistacce8df22007-09-18 16:53:18 +00001377 # Here the quotient is too large to be representable
1378 ans = context._raise_error(DivisionImpossible,
1379 'quotient too large in //, % or divmod')
1380 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001381
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001382 def __rtruediv__(self, other, context=None):
1383 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001384 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001385 if other is NotImplemented:
1386 return other
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001387 return other.__truediv__(self, context=context)
1388
1389 __div__ = __truediv__
1390 __rdiv__ = __rtruediv__
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001391
1392 def __divmod__(self, other, context=None):
1393 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001394 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001395 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001396 other = _convert_other(other)
1397 if other is NotImplemented:
1398 return other
1399
1400 if context is None:
1401 context = getcontext()
1402
1403 ans = self._check_nans(other, context)
1404 if ans:
1405 return (ans, ans)
1406
1407 sign = self._sign ^ other._sign
1408 if self._isinfinity():
1409 if other._isinfinity():
1410 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1411 return ans, ans
1412 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001413 return (_SignedInfinity[sign],
Facundo Batistacce8df22007-09-18 16:53:18 +00001414 context._raise_error(InvalidOperation, 'INF % x'))
1415
1416 if not other:
1417 if not self:
1418 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1419 return ans, ans
1420 else:
1421 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1422 context._raise_error(InvalidOperation, 'x % 0'))
1423
1424 quotient, remainder = self._divide(other, context)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001425 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001426 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001427
1428 def __rdivmod__(self, other, context=None):
1429 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001430 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001431 if other is NotImplemented:
1432 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001433 return other.__divmod__(self, context=context)
1434
1435 def __mod__(self, other, context=None):
1436 """
1437 self % other
1438 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001439 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001440 if other is NotImplemented:
1441 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001442
Facundo Batistacce8df22007-09-18 16:53:18 +00001443 if context is None:
1444 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001445
Facundo Batistacce8df22007-09-18 16:53:18 +00001446 ans = self._check_nans(other, context)
1447 if ans:
1448 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001449
Facundo Batistacce8df22007-09-18 16:53:18 +00001450 if self._isinfinity():
1451 return context._raise_error(InvalidOperation, 'INF % x')
1452 elif not other:
1453 if self:
1454 return context._raise_error(InvalidOperation, 'x % 0')
1455 else:
1456 return context._raise_error(DivisionUndefined, '0 % 0')
1457
1458 remainder = self._divide(other, context)[1]
Facundo Batistae64acfa2007-12-17 14:18:42 +00001459 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001460 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001461
1462 def __rmod__(self, other, context=None):
1463 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001464 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001465 if other is NotImplemented:
1466 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001467 return other.__mod__(self, context=context)
1468
1469 def remainder_near(self, other, context=None):
1470 """
1471 Remainder nearest to 0- abs(remainder-near) <= other/2
1472 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001473 if context is None:
1474 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001475
Facundo Batista353750c2007-09-13 18:13:15 +00001476 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001477
Facundo Batista353750c2007-09-13 18:13:15 +00001478 ans = self._check_nans(other, context)
1479 if ans:
1480 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001481
Facundo Batista353750c2007-09-13 18:13:15 +00001482 # self == +/-infinity -> InvalidOperation
1483 if self._isinfinity():
1484 return context._raise_error(InvalidOperation,
1485 'remainder_near(infinity, x)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001486
Facundo Batista353750c2007-09-13 18:13:15 +00001487 # other == 0 -> either InvalidOperation or DivisionUndefined
1488 if not other:
1489 if self:
1490 return context._raise_error(InvalidOperation,
1491 'remainder_near(x, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001492 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001493 return context._raise_error(DivisionUndefined,
1494 'remainder_near(0, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001495
Facundo Batista353750c2007-09-13 18:13:15 +00001496 # other = +/-infinity -> remainder = self
1497 if other._isinfinity():
1498 ans = Decimal(self)
1499 return ans._fix(context)
1500
1501 # self = 0 -> remainder = self, with ideal exponent
1502 ideal_exponent = min(self._exp, other._exp)
1503 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001504 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001505 return ans._fix(context)
1506
1507 # catch most cases of large or small quotient
1508 expdiff = self.adjusted() - other.adjusted()
1509 if expdiff >= context.prec + 1:
1510 # expdiff >= prec+1 => abs(self/other) > 10**prec
Facundo Batistacce8df22007-09-18 16:53:18 +00001511 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001512 if expdiff <= -2:
1513 # expdiff <= -2 => abs(self/other) < 0.1
1514 ans = self._rescale(ideal_exponent, context.rounding)
1515 return ans._fix(context)
1516
1517 # adjust both arguments to have the same exponent, then divide
1518 op1 = _WorkRep(self)
1519 op2 = _WorkRep(other)
1520 if op1.exp >= op2.exp:
1521 op1.int *= 10**(op1.exp - op2.exp)
1522 else:
1523 op2.int *= 10**(op2.exp - op1.exp)
1524 q, r = divmod(op1.int, op2.int)
1525 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1526 # 10**ideal_exponent. Apply correction to ensure that
1527 # abs(remainder) <= abs(other)/2
1528 if 2*r + (q&1) > op2.int:
1529 r -= op2.int
1530 q += 1
1531
1532 if q >= 10**context.prec:
Facundo Batistacce8df22007-09-18 16:53:18 +00001533 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001534
1535 # result has same sign as self unless r is negative
1536 sign = self._sign
1537 if r < 0:
1538 sign = 1-sign
1539 r = -r
1540
Facundo Batista72bc54f2007-11-23 17:59:00 +00001541 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001542 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001543
1544 def __floordiv__(self, other, context=None):
1545 """self // other"""
Facundo Batistacce8df22007-09-18 16:53:18 +00001546 other = _convert_other(other)
1547 if other is NotImplemented:
1548 return other
1549
1550 if context is None:
1551 context = getcontext()
1552
1553 ans = self._check_nans(other, context)
1554 if ans:
1555 return ans
1556
1557 if self._isinfinity():
1558 if other._isinfinity():
1559 return context._raise_error(InvalidOperation, 'INF // INF')
1560 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001561 return _SignedInfinity[self._sign ^ other._sign]
Facundo Batistacce8df22007-09-18 16:53:18 +00001562
1563 if not other:
1564 if self:
1565 return context._raise_error(DivisionByZero, 'x // 0',
1566 self._sign ^ other._sign)
1567 else:
1568 return context._raise_error(DivisionUndefined, '0 // 0')
1569
1570 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001571
1572 def __rfloordiv__(self, other, context=None):
1573 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001574 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001575 if other is NotImplemented:
1576 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001577 return other.__floordiv__(self, context=context)
1578
1579 def __float__(self):
1580 """Float representation."""
1581 return float(str(self))
1582
1583 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001584 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001585 if self._is_special:
1586 if self._isnan():
Mark Dickinson968f1692009-09-07 18:04:58 +00001587 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001588 elif self._isinfinity():
Mark Dickinson968f1692009-09-07 18:04:58 +00001589 raise OverflowError("Cannot convert infinity to integer")
Facundo Batista353750c2007-09-13 18:13:15 +00001590 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001591 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001592 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001593 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001594 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001595
Raymond Hettinger5a053642008-01-24 19:05:29 +00001596 __trunc__ = __int__
1597
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001598 def real(self):
1599 return self
Mark Dickinson65808ff2009-01-04 21:22:02 +00001600 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001601
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001602 def imag(self):
1603 return Decimal(0)
Mark Dickinson65808ff2009-01-04 21:22:02 +00001604 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001605
1606 def conjugate(self):
1607 return self
1608
1609 def __complex__(self):
1610 return complex(float(self))
1611
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001612 def __long__(self):
1613 """Converts to a long.
1614
1615 Equivalent to long(int(self))
1616 """
1617 return long(self.__int__())
1618
Facundo Batista353750c2007-09-13 18:13:15 +00001619 def _fix_nan(self, context):
1620 """Decapitate the payload of a NaN to fit the context"""
1621 payload = self._int
1622
1623 # maximum length of payload is precision if _clamp=0,
1624 # precision-1 if _clamp=1.
1625 max_payload_len = context.prec - context._clamp
1626 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001627 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1628 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001629 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001630
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001631 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001632 """Round if it is necessary to keep self within prec precision.
1633
1634 Rounds and fixes the exponent. Does not raise on a sNaN.
1635
1636 Arguments:
1637 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001638 context - context used.
1639 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001640
Facundo Batista353750c2007-09-13 18:13:15 +00001641 if self._is_special:
1642 if self._isnan():
1643 # decapitate payload if necessary
1644 return self._fix_nan(context)
1645 else:
1646 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001647 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001648
Facundo Batista353750c2007-09-13 18:13:15 +00001649 # if self is zero then exponent should be between Etiny and
1650 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1651 Etiny = context.Etiny()
1652 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001653 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001654 exp_max = [context.Emax, Etop][context._clamp]
1655 new_exp = min(max(self._exp, Etiny), exp_max)
1656 if new_exp != self._exp:
1657 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001658 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001659 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001660 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001661
1662 # exp_min is the smallest allowable exponent of the result,
1663 # equal to max(self.adjusted()-context.prec+1, Etiny)
1664 exp_min = len(self._int) + self._exp - context.prec
1665 if exp_min > Etop:
1666 # overflow: exp_min > Etop iff self.adjusted() > Emax
1667 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001668 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00001669 return context._raise_error(Overflow, 'above Emax', self._sign)
1670 self_is_subnormal = exp_min < Etiny
1671 if self_is_subnormal:
1672 context._raise_error(Subnormal)
1673 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001674
Facundo Batista353750c2007-09-13 18:13:15 +00001675 # round if self has too many digits
1676 if self._exp < exp_min:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001677 context._raise_error(Rounded)
Facundo Batista2ec74152007-12-03 17:55:00 +00001678 digits = len(self._int) + self._exp - exp_min
1679 if digits < 0:
1680 self = _dec_from_triple(self._sign, '1', exp_min-1)
1681 digits = 0
1682 this_function = getattr(self, self._pick_rounding_function[context.rounding])
1683 changed = this_function(digits)
1684 coeff = self._int[:digits] or '0'
1685 if changed == 1:
1686 coeff = str(int(coeff)+1)
1687 ans = _dec_from_triple(self._sign, coeff, exp_min)
1688
1689 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001690 context._raise_error(Inexact)
1691 if self_is_subnormal:
1692 context._raise_error(Underflow)
1693 if not ans:
1694 # raise Clamped on underflow to 0
1695 context._raise_error(Clamped)
1696 elif len(ans._int) == context.prec+1:
1697 # we get here only if rescaling rounds the
1698 # cofficient up to exactly 10**context.prec
1699 if ans._exp < Etop:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001700 ans = _dec_from_triple(ans._sign,
1701 ans._int[:-1], ans._exp+1)
Facundo Batista353750c2007-09-13 18:13:15 +00001702 else:
1703 # Inexact and Rounded have already been raised
1704 ans = context._raise_error(Overflow, 'above Emax',
1705 self._sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001706 return ans
1707
Facundo Batista353750c2007-09-13 18:13:15 +00001708 # fold down if _clamp == 1 and self has too few digits
1709 if context._clamp == 1 and self._exp > Etop:
1710 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001711 self_padded = self._int + '0'*(self._exp - Etop)
1712 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001713
Facundo Batista353750c2007-09-13 18:13:15 +00001714 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001715 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001716
1717 _pick_rounding_function = {}
1718
Facundo Batista353750c2007-09-13 18:13:15 +00001719 # for each of the rounding functions below:
1720 # self is a finite, nonzero Decimal
1721 # prec is an integer satisfying 0 <= prec < len(self._int)
Facundo Batista2ec74152007-12-03 17:55:00 +00001722 #
1723 # each function returns either -1, 0, or 1, as follows:
1724 # 1 indicates that self should be rounded up (away from zero)
1725 # 0 indicates that self should be truncated, and that all the
1726 # digits to be truncated are zeros (so the value is unchanged)
1727 # -1 indicates that there are nonzero digits to be truncated
Facundo Batista353750c2007-09-13 18:13:15 +00001728
1729 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001730 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001731 if _all_zeros(self._int, prec):
1732 return 0
1733 else:
1734 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001735
Facundo Batista353750c2007-09-13 18:13:15 +00001736 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001737 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001738 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001739
Facundo Batista353750c2007-09-13 18:13:15 +00001740 def _round_half_up(self, prec):
1741 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001742 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001743 return 1
1744 elif _all_zeros(self._int, prec):
1745 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001746 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001747 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001748
1749 def _round_half_down(self, prec):
1750 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001751 if _exact_half(self._int, prec):
1752 return -1
1753 else:
1754 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001755
1756 def _round_half_even(self, prec):
1757 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001758 if _exact_half(self._int, prec) and \
1759 (prec == 0 or self._int[prec-1] in '02468'):
1760 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001761 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001762 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001763
1764 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001765 """Rounds up (not away from 0 if negative.)"""
1766 if self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001767 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001768 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001769 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001770
Facundo Batista353750c2007-09-13 18:13:15 +00001771 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001772 """Rounds down (not towards 0 if negative)"""
1773 if not self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001774 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001775 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001776 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001777
Facundo Batista353750c2007-09-13 18:13:15 +00001778 def _round_05up(self, prec):
1779 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001780 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001781 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001782 else:
1783 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001784
Facundo Batista353750c2007-09-13 18:13:15 +00001785 def fma(self, other, third, context=None):
1786 """Fused multiply-add.
1787
1788 Returns self*other+third with no rounding of the intermediate
1789 product self*other.
1790
1791 self and other are multiplied together, with no rounding of
1792 the result. The third operand is then added to the result,
1793 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001794 """
Facundo Batista353750c2007-09-13 18:13:15 +00001795
1796 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001797
1798 # compute product; raise InvalidOperation if either operand is
1799 # a signaling NaN or if the product is zero times infinity.
1800 if self._is_special or other._is_special:
1801 if context is None:
1802 context = getcontext()
1803 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001804 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001805 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001806 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001807 if self._exp == 'n':
1808 product = self
1809 elif other._exp == 'n':
1810 product = other
1811 elif self._exp == 'F':
1812 if not other:
1813 return context._raise_error(InvalidOperation,
1814 'INF * 0 in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001815 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001816 elif other._exp == 'F':
1817 if not self:
1818 return context._raise_error(InvalidOperation,
1819 '0 * INF in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001820 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001821 else:
1822 product = _dec_from_triple(self._sign ^ other._sign,
1823 str(int(self._int) * int(other._int)),
1824 self._exp + other._exp)
1825
Facundo Batista353750c2007-09-13 18:13:15 +00001826 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001827 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001828
Facundo Batista353750c2007-09-13 18:13:15 +00001829 def _power_modulo(self, other, modulo, context=None):
1830 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001831
Facundo Batista353750c2007-09-13 18:13:15 +00001832 # if can't convert other and modulo to Decimal, raise
1833 # TypeError; there's no point returning NotImplemented (no
1834 # equivalent of __rpow__ for three argument pow)
1835 other = _convert_other(other, raiseit=True)
1836 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001837
Facundo Batista353750c2007-09-13 18:13:15 +00001838 if context is None:
1839 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001840
Facundo Batista353750c2007-09-13 18:13:15 +00001841 # deal with NaNs: if there are any sNaNs then first one wins,
1842 # (i.e. behaviour for NaNs is identical to that of fma)
1843 self_is_nan = self._isnan()
1844 other_is_nan = other._isnan()
1845 modulo_is_nan = modulo._isnan()
1846 if self_is_nan or other_is_nan or modulo_is_nan:
1847 if self_is_nan == 2:
1848 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001849 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001850 if other_is_nan == 2:
1851 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001852 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001853 if modulo_is_nan == 2:
1854 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001855 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001856 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001857 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001858 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001859 return other._fix_nan(context)
1860 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001861
Facundo Batista353750c2007-09-13 18:13:15 +00001862 # check inputs: we apply same restrictions as Python's pow()
1863 if not (self._isinteger() and
1864 other._isinteger() and
1865 modulo._isinteger()):
1866 return context._raise_error(InvalidOperation,
1867 'pow() 3rd argument not allowed '
1868 'unless all arguments are integers')
1869 if other < 0:
1870 return context._raise_error(InvalidOperation,
1871 'pow() 2nd argument cannot be '
1872 'negative when 3rd argument specified')
1873 if not modulo:
1874 return context._raise_error(InvalidOperation,
1875 'pow() 3rd argument cannot be 0')
1876
1877 # additional restriction for decimal: the modulus must be less
1878 # than 10**prec in absolute value
1879 if modulo.adjusted() >= context.prec:
1880 return context._raise_error(InvalidOperation,
1881 'insufficient precision: pow() 3rd '
1882 'argument must not have more than '
1883 'precision digits')
1884
1885 # define 0**0 == NaN, for consistency with two-argument pow
1886 # (even though it hurts!)
1887 if not other and not self:
1888 return context._raise_error(InvalidOperation,
1889 'at least one of pow() 1st argument '
1890 'and 2nd argument must be nonzero ;'
1891 '0**0 is not defined')
1892
1893 # compute sign of result
1894 if other._iseven():
1895 sign = 0
1896 else:
1897 sign = self._sign
1898
1899 # convert modulo to a Python integer, and self and other to
1900 # Decimal integers (i.e. force their exponents to be >= 0)
1901 modulo = abs(int(modulo))
1902 base = _WorkRep(self.to_integral_value())
1903 exponent = _WorkRep(other.to_integral_value())
1904
1905 # compute result using integer pow()
1906 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1907 for i in xrange(exponent.exp):
1908 base = pow(base, 10, modulo)
1909 base = pow(base, exponent.int, modulo)
1910
Facundo Batista72bc54f2007-11-23 17:59:00 +00001911 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001912
1913 def _power_exact(self, other, p):
1914 """Attempt to compute self**other exactly.
1915
1916 Given Decimals self and other and an integer p, attempt to
1917 compute an exact result for the power self**other, with p
1918 digits of precision. Return None if self**other is not
1919 exactly representable in p digits.
1920
1921 Assumes that elimination of special cases has already been
1922 performed: self and other must both be nonspecial; self must
1923 be positive and not numerically equal to 1; other must be
1924 nonzero. For efficiency, other._exp should not be too large,
1925 so that 10**abs(other._exp) is a feasible calculation."""
1926
1927 # In the comments below, we write x for the value of self and
1928 # y for the value of other. Write x = xc*10**xe and y =
1929 # yc*10**ye.
1930
1931 # The main purpose of this method is to identify the *failure*
1932 # of x**y to be exactly representable with as little effort as
1933 # possible. So we look for cheap and easy tests that
1934 # eliminate the possibility of x**y being exact. Only if all
1935 # these tests are passed do we go on to actually compute x**y.
1936
1937 # Here's the main idea. First normalize both x and y. We
1938 # express y as a rational m/n, with m and n relatively prime
1939 # and n>0. Then for x**y to be exactly representable (at
1940 # *any* precision), xc must be the nth power of a positive
1941 # integer and xe must be divisible by n. If m is negative
1942 # then additionally xc must be a power of either 2 or 5, hence
1943 # a power of 2**n or 5**n.
1944 #
1945 # There's a limit to how small |y| can be: if y=m/n as above
1946 # then:
1947 #
1948 # (1) if xc != 1 then for the result to be representable we
1949 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1950 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1951 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1952 # representable.
1953 #
1954 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1955 # |y| < 1/|xe| then the result is not representable.
1956 #
1957 # Note that since x is not equal to 1, at least one of (1) and
1958 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1959 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1960 #
1961 # There's also a limit to how large y can be, at least if it's
1962 # positive: the normalized result will have coefficient xc**y,
1963 # so if it's representable then xc**y < 10**p, and y <
1964 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1965 # not exactly representable.
1966
1967 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1968 # so |y| < 1/xe and the result is not representable.
1969 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1970 # < 1/nbits(xc).
1971
1972 x = _WorkRep(self)
1973 xc, xe = x.int, x.exp
1974 while xc % 10 == 0:
1975 xc //= 10
1976 xe += 1
1977
1978 y = _WorkRep(other)
1979 yc, ye = y.int, y.exp
1980 while yc % 10 == 0:
1981 yc //= 10
1982 ye += 1
1983
1984 # case where xc == 1: result is 10**(xe*y), with xe*y
1985 # required to be an integer
1986 if xc == 1:
1987 if ye >= 0:
1988 exponent = xe*yc*10**ye
1989 else:
1990 exponent, remainder = divmod(xe*yc, 10**-ye)
1991 if remainder:
1992 return None
1993 if y.sign == 1:
1994 exponent = -exponent
1995 # if other is a nonnegative integer, use ideal exponent
1996 if other._isinteger() and other._sign == 0:
1997 ideal_exponent = self._exp*int(other)
1998 zeros = min(exponent-ideal_exponent, p-1)
1999 else:
2000 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002001 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002002
2003 # case where y is negative: xc must be either a power
2004 # of 2 or a power of 5.
2005 if y.sign == 1:
2006 last_digit = xc % 10
2007 if last_digit in (2,4,6,8):
2008 # quick test for power of 2
2009 if xc & -xc != xc:
2010 return None
2011 # now xc is a power of 2; e is its exponent
2012 e = _nbits(xc)-1
2013 # find e*y and xe*y; both must be integers
2014 if ye >= 0:
2015 y_as_int = yc*10**ye
2016 e = e*y_as_int
2017 xe = xe*y_as_int
2018 else:
2019 ten_pow = 10**-ye
2020 e, remainder = divmod(e*yc, ten_pow)
2021 if remainder:
2022 return None
2023 xe, remainder = divmod(xe*yc, ten_pow)
2024 if remainder:
2025 return None
2026
2027 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2028 return None
2029 xc = 5**e
2030
2031 elif last_digit == 5:
2032 # e >= log_5(xc) if xc is a power of 5; we have
2033 # equality all the way up to xc=5**2658
2034 e = _nbits(xc)*28//65
2035 xc, remainder = divmod(5**e, xc)
2036 if remainder:
2037 return None
2038 while xc % 5 == 0:
2039 xc //= 5
2040 e -= 1
2041 if ye >= 0:
2042 y_as_integer = yc*10**ye
2043 e = e*y_as_integer
2044 xe = xe*y_as_integer
2045 else:
2046 ten_pow = 10**-ye
2047 e, remainder = divmod(e*yc, ten_pow)
2048 if remainder:
2049 return None
2050 xe, remainder = divmod(xe*yc, ten_pow)
2051 if remainder:
2052 return None
2053 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2054 return None
2055 xc = 2**e
2056 else:
2057 return None
2058
2059 if xc >= 10**p:
2060 return None
2061 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00002062 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00002063
2064 # now y is positive; find m and n such that y = m/n
2065 if ye >= 0:
2066 m, n = yc*10**ye, 1
2067 else:
2068 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2069 return None
2070 xc_bits = _nbits(xc)
2071 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2072 return None
2073 m, n = yc, 10**(-ye)
2074 while m % 2 == n % 2 == 0:
2075 m //= 2
2076 n //= 2
2077 while m % 5 == n % 5 == 0:
2078 m //= 5
2079 n //= 5
2080
2081 # compute nth root of xc*10**xe
2082 if n > 1:
2083 # if 1 < xc < 2**n then xc isn't an nth power
2084 if xc != 1 and xc_bits <= n:
2085 return None
2086
2087 xe, rem = divmod(xe, n)
2088 if rem != 0:
2089 return None
2090
2091 # compute nth root of xc using Newton's method
2092 a = 1L << -(-_nbits(xc)//n) # initial estimate
2093 while True:
2094 q, r = divmod(xc, a**(n-1))
2095 if a <= q:
2096 break
2097 else:
2098 a = (a*(n-1) + q)//n
2099 if not (a == q and r == 0):
2100 return None
2101 xc = a
2102
2103 # now xc*10**xe is the nth root of the original xc*10**xe
2104 # compute mth power of xc*10**xe
2105
2106 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2107 # 10**p and the result is not representable.
2108 if xc > 1 and m > p*100//_log10_lb(xc):
2109 return None
2110 xc = xc**m
2111 xe *= m
2112 if xc > 10**p:
2113 return None
2114
2115 # by this point the result *is* exactly representable
2116 # adjust the exponent to get as close as possible to the ideal
2117 # exponent, if necessary
2118 str_xc = str(xc)
2119 if other._isinteger() and other._sign == 0:
2120 ideal_exponent = self._exp*int(other)
2121 zeros = min(xe-ideal_exponent, p-len(str_xc))
2122 else:
2123 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002124 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002125
2126 def __pow__(self, other, modulo=None, context=None):
2127 """Return self ** other [ % modulo].
2128
2129 With two arguments, compute self**other.
2130
2131 With three arguments, compute (self**other) % modulo. For the
2132 three argument form, the following restrictions on the
2133 arguments hold:
2134
2135 - all three arguments must be integral
2136 - other must be nonnegative
2137 - either self or other (or both) must be nonzero
2138 - modulo must be nonzero and must have at most p digits,
2139 where p is the context precision.
2140
2141 If any of these restrictions is violated the InvalidOperation
2142 flag is raised.
2143
2144 The result of pow(self, other, modulo) is identical to the
2145 result that would be obtained by computing (self**other) %
2146 modulo with unbounded precision, but is computed more
2147 efficiently. It is always exact.
2148 """
2149
2150 if modulo is not None:
2151 return self._power_modulo(other, modulo, context)
2152
2153 other = _convert_other(other)
2154 if other is NotImplemented:
2155 return other
2156
2157 if context is None:
2158 context = getcontext()
2159
2160 # either argument is a NaN => result is NaN
2161 ans = self._check_nans(other, context)
2162 if ans:
2163 return ans
2164
2165 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2166 if not other:
2167 if not self:
2168 return context._raise_error(InvalidOperation, '0 ** 0')
2169 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002170 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002171
2172 # result has sign 1 iff self._sign is 1 and other is an odd integer
2173 result_sign = 0
2174 if self._sign == 1:
2175 if other._isinteger():
2176 if not other._iseven():
2177 result_sign = 1
2178 else:
2179 # -ve**noninteger = NaN
2180 # (-0)**noninteger = 0**noninteger
2181 if self:
2182 return context._raise_error(InvalidOperation,
2183 'x ** y with x negative and y not an integer')
2184 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002185 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002186
2187 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2188 if not self:
2189 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002190 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002191 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002192 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002193
2194 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002195 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002196 if other._sign == 0:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002197 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002198 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002199 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002200
Facundo Batista353750c2007-09-13 18:13:15 +00002201 # 1**other = 1, but the choice of exponent and the flags
2202 # depend on the exponent of self, and on whether other is a
2203 # positive integer, a negative integer, or neither
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002204 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002205 if other._isinteger():
2206 # exp = max(self._exp*max(int(other), 0),
2207 # 1-context.prec) but evaluating int(other) directly
2208 # is dangerous until we know other is small (other
2209 # could be 1e999999999)
2210 if other._sign == 1:
2211 multiplier = 0
2212 elif other > context.prec:
2213 multiplier = context.prec
2214 else:
2215 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002216
Facundo Batista353750c2007-09-13 18:13:15 +00002217 exp = self._exp * multiplier
2218 if exp < 1-context.prec:
2219 exp = 1-context.prec
2220 context._raise_error(Rounded)
2221 else:
2222 context._raise_error(Inexact)
2223 context._raise_error(Rounded)
2224 exp = 1-context.prec
2225
Facundo Batista72bc54f2007-11-23 17:59:00 +00002226 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002227
2228 # compute adjusted exponent of self
2229 self_adj = self.adjusted()
2230
2231 # self ** infinity is infinity if self > 1, 0 if self < 1
2232 # self ** -infinity is infinity if self < 1, 0 if self > 1
2233 if other._isinfinity():
2234 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002235 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002236 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002237 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002238
2239 # from here on, the result always goes through the call
2240 # to _fix at the end of this function.
2241 ans = None
2242
2243 # crude test to catch cases of extreme overflow/underflow. If
2244 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2245 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2246 # self**other >= 10**(Emax+1), so overflow occurs. The test
2247 # for underflow is similar.
2248 bound = self._log10_exp_bound() + other.adjusted()
2249 if (self_adj >= 0) == (other._sign == 0):
2250 # self > 1 and other +ve, or self < 1 and other -ve
2251 # possibility of overflow
2252 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002253 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002254 else:
2255 # self > 1 and other -ve, or self < 1 and other +ve
2256 # possibility of underflow to 0
2257 Etiny = context.Etiny()
2258 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002259 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002260
2261 # try for an exact result with precision +1
2262 if ans is None:
2263 ans = self._power_exact(other, context.prec + 1)
2264 if ans is not None and result_sign == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002265 ans = _dec_from_triple(1, ans._int, ans._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002266
2267 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2268 if ans is None:
2269 p = context.prec
2270 x = _WorkRep(self)
2271 xc, xe = x.int, x.exp
2272 y = _WorkRep(other)
2273 yc, ye = y.int, y.exp
2274 if y.sign == 1:
2275 yc = -yc
2276
2277 # compute correctly rounded result: start with precision +3,
2278 # then increase precision until result is unambiguously roundable
2279 extra = 3
2280 while True:
2281 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2282 if coeff % (5*10**(len(str(coeff))-p-1)):
2283 break
2284 extra += 3
2285
Facundo Batista72bc54f2007-11-23 17:59:00 +00002286 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002287
2288 # the specification says that for non-integer other we need to
2289 # raise Inexact, even when the result is actually exact. In
2290 # the same way, we need to raise Underflow here if the result
2291 # is subnormal. (The call to _fix will take care of raising
2292 # Rounded and Subnormal, as usual.)
2293 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002294 context._raise_error(Inexact)
Facundo Batista353750c2007-09-13 18:13:15 +00002295 # pad with zeros up to length context.prec+1 if necessary
2296 if len(ans._int) <= context.prec:
2297 expdiff = context.prec+1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002298 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2299 ans._exp-expdiff)
Facundo Batista353750c2007-09-13 18:13:15 +00002300 if ans.adjusted() < context.Emin:
2301 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002302
Facundo Batista353750c2007-09-13 18:13:15 +00002303 # unlike exp, ln and log10, the power function respects the
2304 # rounding mode; no need to use ROUND_HALF_EVEN here
2305 ans = ans._fix(context)
2306 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002307
2308 def __rpow__(self, other, context=None):
2309 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002310 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002311 if other is NotImplemented:
2312 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002313 return other.__pow__(self, context=context)
2314
2315 def normalize(self, context=None):
2316 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002317
Facundo Batista353750c2007-09-13 18:13:15 +00002318 if context is None:
2319 context = getcontext()
2320
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002321 if self._is_special:
2322 ans = self._check_nans(context=context)
2323 if ans:
2324 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002325
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002326 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002327 if dup._isinfinity():
2328 return dup
2329
2330 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002331 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002332 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002333 end = len(dup._int)
2334 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002335 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002336 exp += 1
2337 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002338 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002339
Facundo Batistabd2fe832007-09-13 18:42:09 +00002340 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002341 """Quantize self so its exponent is the same as that of exp.
2342
2343 Similar to self._rescale(exp._exp) but with error checking.
2344 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002345 exp = _convert_other(exp, raiseit=True)
2346
Facundo Batista353750c2007-09-13 18:13:15 +00002347 if context is None:
2348 context = getcontext()
2349 if rounding is None:
2350 rounding = context.rounding
2351
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002352 if self._is_special or exp._is_special:
2353 ans = self._check_nans(exp, context)
2354 if ans:
2355 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002356
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002357 if exp._isinfinity() or self._isinfinity():
2358 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002359 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002360 return context._raise_error(InvalidOperation,
2361 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002362
Facundo Batistabd2fe832007-09-13 18:42:09 +00002363 # if we're not watching exponents, do a simple rescale
2364 if not watchexp:
2365 ans = self._rescale(exp._exp, rounding)
2366 # raise Inexact and Rounded where appropriate
2367 if ans._exp > self._exp:
2368 context._raise_error(Rounded)
2369 if ans != self:
2370 context._raise_error(Inexact)
2371 return ans
2372
Facundo Batista353750c2007-09-13 18:13:15 +00002373 # exp._exp should be between Etiny and Emax
2374 if not (context.Etiny() <= exp._exp <= context.Emax):
2375 return context._raise_error(InvalidOperation,
2376 'target exponent out of bounds in quantize')
2377
2378 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002379 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002380 return ans._fix(context)
2381
2382 self_adjusted = self.adjusted()
2383 if self_adjusted > context.Emax:
2384 return context._raise_error(InvalidOperation,
2385 'exponent of quantize result too large for current context')
2386 if self_adjusted - exp._exp + 1 > context.prec:
2387 return context._raise_error(InvalidOperation,
2388 'quantize result has too many digits for current context')
2389
2390 ans = self._rescale(exp._exp, rounding)
2391 if ans.adjusted() > context.Emax:
2392 return context._raise_error(InvalidOperation,
2393 'exponent of quantize result too large for current context')
2394 if len(ans._int) > context.prec:
2395 return context._raise_error(InvalidOperation,
2396 'quantize result has too many digits for current context')
2397
2398 # raise appropriate flags
2399 if ans._exp > self._exp:
2400 context._raise_error(Rounded)
2401 if ans != self:
2402 context._raise_error(Inexact)
2403 if ans and ans.adjusted() < context.Emin:
2404 context._raise_error(Subnormal)
2405
2406 # call to fix takes care of any necessary folddown
2407 ans = ans._fix(context)
2408 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002409
2410 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002411 """Return True if self and other have the same exponent; otherwise
2412 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002413
Facundo Batista1a191df2007-10-02 17:01:24 +00002414 If either operand is a special value, the following rules are used:
2415 * return True if both operands are infinities
2416 * return True if both operands are NaNs
2417 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002418 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002419 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002420 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002421 return (self.is_nan() and other.is_nan() or
2422 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002423 return self._exp == other._exp
2424
Facundo Batista353750c2007-09-13 18:13:15 +00002425 def _rescale(self, exp, rounding):
2426 """Rescale self so that the exponent is exp, either by padding with zeros
2427 or by truncating digits, using the given rounding mode.
2428
2429 Specials are returned without change. This operation is
2430 quiet: it raises no flags, and uses no information from the
2431 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002432
2433 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002434 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002435 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002436 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002437 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002438 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002439 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002440
Facundo Batista353750c2007-09-13 18:13:15 +00002441 if self._exp >= exp:
2442 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002443 return _dec_from_triple(self._sign,
2444 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002445
Facundo Batista353750c2007-09-13 18:13:15 +00002446 # too many digits; round and lose data. If self.adjusted() <
2447 # exp-1, replace self by 10**(exp-1) before rounding
2448 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002449 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002450 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002451 digits = 0
2452 this_function = getattr(self, self._pick_rounding_function[rounding])
Facundo Batista2ec74152007-12-03 17:55:00 +00002453 changed = this_function(digits)
2454 coeff = self._int[:digits] or '0'
2455 if changed == 1:
2456 coeff = str(int(coeff)+1)
2457 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002458
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002459 def _round(self, places, rounding):
2460 """Round a nonzero, nonspecial Decimal to a fixed number of
2461 significant figures, using the given rounding mode.
2462
2463 Infinities, NaNs and zeros are returned unaltered.
2464
2465 This operation is quiet: it raises no flags, and uses no
2466 information from the context.
2467
2468 """
2469 if places <= 0:
2470 raise ValueError("argument should be at least 1 in _round")
2471 if self._is_special or not self:
2472 return Decimal(self)
2473 ans = self._rescale(self.adjusted()+1-places, rounding)
2474 # it can happen that the rescale alters the adjusted exponent;
2475 # for example when rounding 99.97 to 3 significant figures.
2476 # When this happens we end up with an extra 0 at the end of
2477 # the number; a second rescale fixes this.
2478 if ans.adjusted() != self.adjusted():
2479 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2480 return ans
2481
Facundo Batista353750c2007-09-13 18:13:15 +00002482 def to_integral_exact(self, rounding=None, context=None):
2483 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002484
Facundo Batista353750c2007-09-13 18:13:15 +00002485 If no rounding mode is specified, take the rounding mode from
2486 the context. This method raises the Rounded and Inexact flags
2487 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002488
Facundo Batista353750c2007-09-13 18:13:15 +00002489 See also: to_integral_value, which does exactly the same as
2490 this method except that it doesn't raise Inexact or Rounded.
2491 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002492 if self._is_special:
2493 ans = self._check_nans(context=context)
2494 if ans:
2495 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002496 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002497 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002498 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002499 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002500 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002501 if context is None:
2502 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002503 if rounding is None:
2504 rounding = context.rounding
2505 context._raise_error(Rounded)
2506 ans = self._rescale(0, rounding)
2507 if ans != self:
2508 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002509 return ans
2510
Facundo Batista353750c2007-09-13 18:13:15 +00002511 def to_integral_value(self, rounding=None, context=None):
2512 """Rounds to the nearest integer, without raising inexact, rounded."""
2513 if context is None:
2514 context = getcontext()
2515 if rounding is None:
2516 rounding = context.rounding
2517 if self._is_special:
2518 ans = self._check_nans(context=context)
2519 if ans:
2520 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002521 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002522 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002523 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002524 else:
2525 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002526
Facundo Batista353750c2007-09-13 18:13:15 +00002527 # the method name changed, but we provide also the old one, for compatibility
2528 to_integral = to_integral_value
2529
2530 def sqrt(self, context=None):
2531 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002532 if context is None:
2533 context = getcontext()
2534
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002535 if self._is_special:
2536 ans = self._check_nans(context=context)
2537 if ans:
2538 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002539
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002540 if self._isinfinity() and self._sign == 0:
2541 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002542
2543 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002544 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002545 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002546 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002547
2548 if self._sign == 1:
2549 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2550
Facundo Batista353750c2007-09-13 18:13:15 +00002551 # At this point self represents a positive number. Let p be
2552 # the desired precision and express self in the form c*100**e
2553 # with c a positive real number and e an integer, c and e
2554 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2555 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2556 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2557 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2558 # the closest integer to sqrt(c) with the even integer chosen
2559 # in the case of a tie.
2560 #
2561 # To ensure correct rounding in all cases, we use the
2562 # following trick: we compute the square root to an extra
2563 # place (precision p+1 instead of precision p), rounding down.
2564 # Then, if the result is inexact and its last digit is 0 or 5,
2565 # we increase the last digit to 1 or 6 respectively; if it's
2566 # exact we leave the last digit alone. Now the final round to
2567 # p places (or fewer in the case of underflow) will round
2568 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002569
Facundo Batista353750c2007-09-13 18:13:15 +00002570 # use an extra digit of precision
2571 prec = context.prec+1
2572
2573 # write argument in the form c*100**e where e = self._exp//2
2574 # is the 'ideal' exponent, to be used if the square root is
2575 # exactly representable. l is the number of 'digits' of c in
2576 # base 100, so that 100**(l-1) <= c < 100**l.
2577 op = _WorkRep(self)
2578 e = op.exp >> 1
2579 if op.exp & 1:
2580 c = op.int * 10
2581 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002582 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002583 c = op.int
2584 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002585
Facundo Batista353750c2007-09-13 18:13:15 +00002586 # rescale so that c has exactly prec base 100 'digits'
2587 shift = prec-l
2588 if shift >= 0:
2589 c *= 100**shift
2590 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002591 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002592 c, remainder = divmod(c, 100**-shift)
2593 exact = not remainder
2594 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002595
Facundo Batista353750c2007-09-13 18:13:15 +00002596 # find n = floor(sqrt(c)) using Newton's method
2597 n = 10**prec
2598 while True:
2599 q = c//n
2600 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002601 break
Facundo Batista353750c2007-09-13 18:13:15 +00002602 else:
2603 n = n + q >> 1
2604 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002605
Facundo Batista353750c2007-09-13 18:13:15 +00002606 if exact:
2607 # result is exact; rescale to use ideal exponent e
2608 if shift >= 0:
2609 # assert n % 10**shift == 0
2610 n //= 10**shift
2611 else:
2612 n *= 10**-shift
2613 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002614 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002615 # result is not exact; fix last digit as described above
2616 if n % 5 == 0:
2617 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002618
Facundo Batista72bc54f2007-11-23 17:59:00 +00002619 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002620
Facundo Batista353750c2007-09-13 18:13:15 +00002621 # round, and fit to current context
2622 context = context._shallow_copy()
2623 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002624 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002625 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002626
Facundo Batista353750c2007-09-13 18:13:15 +00002627 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002628
2629 def max(self, other, context=None):
2630 """Returns the larger value.
2631
Facundo Batista353750c2007-09-13 18:13:15 +00002632 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002633 NaN (and signals if one is sNaN). Also rounds.
2634 """
Facundo Batista353750c2007-09-13 18:13:15 +00002635 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002636
Facundo Batista6c398da2007-09-17 17:30:13 +00002637 if context is None:
2638 context = getcontext()
2639
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002640 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002641 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002642 # number is always returned
2643 sn = self._isnan()
2644 on = other._isnan()
2645 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002646 if on == 1 and sn == 0:
2647 return self._fix(context)
2648 if sn == 1 and on == 0:
2649 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002650 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002651
Mark Dickinson2fc92632008-02-06 22:10:50 +00002652 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002653 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002654 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002655 # then an ordering is applied:
2656 #
Facundo Batista59c58842007-04-10 12:58:45 +00002657 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002658 # positive sign and min returns the operand with the negative sign
2659 #
Facundo Batista59c58842007-04-10 12:58:45 +00002660 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002661 # the result. This is exactly the ordering used in compare_total.
2662 c = self.compare_total(other)
2663
2664 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002665 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002666 else:
2667 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002668
Facundo Batistae64acfa2007-12-17 14:18:42 +00002669 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002670
2671 def min(self, other, context=None):
2672 """Returns the smaller value.
2673
Facundo Batista59c58842007-04-10 12:58:45 +00002674 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002675 NaN (and signals if one is sNaN). Also rounds.
2676 """
Facundo Batista353750c2007-09-13 18:13:15 +00002677 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002678
Facundo Batista6c398da2007-09-17 17:30:13 +00002679 if context is None:
2680 context = getcontext()
2681
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002682 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002683 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002684 # number is always returned
2685 sn = self._isnan()
2686 on = other._isnan()
2687 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002688 if on == 1 and sn == 0:
2689 return self._fix(context)
2690 if sn == 1 and on == 0:
2691 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002692 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002693
Mark Dickinson2fc92632008-02-06 22:10:50 +00002694 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002695 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002696 c = self.compare_total(other)
2697
2698 if c == -1:
2699 ans = self
2700 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002701 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002702
Facundo Batistae64acfa2007-12-17 14:18:42 +00002703 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002704
2705 def _isinteger(self):
2706 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002707 if self._is_special:
2708 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002709 if self._exp >= 0:
2710 return True
2711 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002712 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002713
2714 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002715 """Returns True if self is even. Assumes self is an integer."""
2716 if not self or self._exp > 0:
2717 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002718 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002719
2720 def adjusted(self):
2721 """Return the adjusted exponent of self"""
2722 try:
2723 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002724 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002725 except TypeError:
2726 return 0
2727
Facundo Batista353750c2007-09-13 18:13:15 +00002728 def canonical(self, context=None):
2729 """Returns the same Decimal object.
2730
2731 As we do not have different encodings for the same number, the
2732 received object already is in its canonical form.
2733 """
2734 return self
2735
2736 def compare_signal(self, other, context=None):
2737 """Compares self to the other operand numerically.
2738
2739 It's pretty much like compare(), but all NaNs signal, with signaling
2740 NaNs taking precedence over quiet NaNs.
2741 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002742 other = _convert_other(other, raiseit = True)
2743 ans = self._compare_check_nans(other, context)
2744 if ans:
2745 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002746 return self.compare(other, context=context)
2747
2748 def compare_total(self, other):
2749 """Compares self to other using the abstract representations.
2750
2751 This is not like the standard compare, which use their numerical
2752 value. Note that a total ordering is defined for all possible abstract
2753 representations.
2754 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002755 other = _convert_other(other, raiseit=True)
2756
Facundo Batista353750c2007-09-13 18:13:15 +00002757 # if one is negative and the other is positive, it's easy
2758 if self._sign and not other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002759 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002760 if not self._sign and other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002761 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002762 sign = self._sign
2763
2764 # let's handle both NaN types
2765 self_nan = self._isnan()
2766 other_nan = other._isnan()
2767 if self_nan or other_nan:
2768 if self_nan == other_nan:
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002769 # compare payloads as though they're integers
2770 self_key = len(self._int), self._int
2771 other_key = len(other._int), other._int
2772 if self_key < other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002773 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002774 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002775 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002776 return _NegativeOne
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002777 if self_key > other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002778 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002779 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002780 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002781 return _One
2782 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002783
2784 if sign:
2785 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002786 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002787 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002788 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002789 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002790 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002791 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002792 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002793 else:
2794 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002795 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002796 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002797 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002798 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002799 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002800 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002801 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002802
2803 if self < other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002804 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002805 if self > other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002806 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002807
2808 if self._exp < other._exp:
2809 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002810 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002811 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002812 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002813 if self._exp > other._exp:
2814 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002815 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002816 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002817 return _One
2818 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002819
2820
2821 def compare_total_mag(self, other):
2822 """Compares self to other using abstract repr., ignoring sign.
2823
2824 Like compare_total, but with operand's sign ignored and assumed to be 0.
2825 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002826 other = _convert_other(other, raiseit=True)
2827
Facundo Batista353750c2007-09-13 18:13:15 +00002828 s = self.copy_abs()
2829 o = other.copy_abs()
2830 return s.compare_total(o)
2831
2832 def copy_abs(self):
2833 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002834 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002835
2836 def copy_negate(self):
2837 """Returns a copy with the sign inverted."""
2838 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002839 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002840 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002841 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002842
2843 def copy_sign(self, other):
2844 """Returns self with the sign of other."""
Mark Dickinson6d8effb2010-02-18 14:27:02 +00002845 other = _convert_other(other, raiseit=True)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002846 return _dec_from_triple(other._sign, self._int,
2847 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002848
2849 def exp(self, context=None):
2850 """Returns e ** self."""
2851
2852 if context is None:
2853 context = getcontext()
2854
2855 # exp(NaN) = NaN
2856 ans = self._check_nans(context=context)
2857 if ans:
2858 return ans
2859
2860 # exp(-Infinity) = 0
2861 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002862 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002863
2864 # exp(0) = 1
2865 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002866 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002867
2868 # exp(Infinity) = Infinity
2869 if self._isinfinity() == 1:
2870 return Decimal(self)
2871
2872 # the result is now guaranteed to be inexact (the true
2873 # mathematical result is transcendental). There's no need to
2874 # raise Rounded and Inexact here---they'll always be raised as
2875 # a result of the call to _fix.
2876 p = context.prec
2877 adj = self.adjusted()
2878
2879 # we only need to do any computation for quite a small range
2880 # of adjusted exponents---for example, -29 <= adj <= 10 for
2881 # the default context. For smaller exponent the result is
2882 # indistinguishable from 1 at the given precision, while for
2883 # larger exponent the result either overflows or underflows.
2884 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2885 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002886 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002887 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2888 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002889 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002890 elif self._sign == 0 and adj < -p:
2891 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002892 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002893 elif self._sign == 1 and adj < -p-1:
2894 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002895 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002896 # general case
2897 else:
2898 op = _WorkRep(self)
2899 c, e = op.int, op.exp
2900 if op.sign == 1:
2901 c = -c
2902
2903 # compute correctly rounded result: increase precision by
2904 # 3 digits at a time until we get an unambiguously
2905 # roundable result
2906 extra = 3
2907 while True:
2908 coeff, exp = _dexp(c, e, p+extra)
2909 if coeff % (5*10**(len(str(coeff))-p-1)):
2910 break
2911 extra += 3
2912
Facundo Batista72bc54f2007-11-23 17:59:00 +00002913 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002914
2915 # at this stage, ans should round correctly with *any*
2916 # rounding mode, not just with ROUND_HALF_EVEN
2917 context = context._shallow_copy()
2918 rounding = context._set_rounding(ROUND_HALF_EVEN)
2919 ans = ans._fix(context)
2920 context.rounding = rounding
2921
2922 return ans
2923
2924 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002925 """Return True if self is canonical; otherwise return False.
2926
2927 Currently, the encoding of a Decimal instance is always
2928 canonical, so this method returns True for any Decimal.
2929 """
2930 return True
Facundo Batista353750c2007-09-13 18:13:15 +00002931
2932 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002933 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00002934
Facundo Batista1a191df2007-10-02 17:01:24 +00002935 A Decimal instance is considered finite if it is neither
2936 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00002937 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002938 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00002939
2940 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002941 """Return True if self is infinite; otherwise return False."""
2942 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00002943
2944 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002945 """Return True if self is a qNaN or sNaN; otherwise return False."""
2946 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00002947
2948 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002949 """Return True if self is a normal number; otherwise return False."""
2950 if self._is_special or not self:
2951 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002952 if context is None:
2953 context = getcontext()
Mark Dickinsona7a52ab2009-10-20 13:33:03 +00002954 return context.Emin <= self.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +00002955
2956 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002957 """Return True if self is a quiet NaN; otherwise return False."""
2958 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00002959
2960 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002961 """Return True if self is negative; otherwise return False."""
2962 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00002963
2964 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002965 """Return True if self is a signaling NaN; otherwise return False."""
2966 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00002967
2968 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002969 """Return True if self is subnormal; otherwise return False."""
2970 if self._is_special or not self:
2971 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002972 if context is None:
2973 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00002974 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00002975
2976 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002977 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00002978 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00002979
2980 def _ln_exp_bound(self):
2981 """Compute a lower bound for the adjusted exponent of self.ln().
2982 In other words, compute r such that self.ln() >= 10**r. Assumes
2983 that self is finite and positive and that self != 1.
2984 """
2985
2986 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
2987 adj = self._exp + len(self._int) - 1
2988 if adj >= 1:
2989 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
2990 return len(str(adj*23//10)) - 1
2991 if adj <= -2:
2992 # argument <= 0.1
2993 return len(str((-1-adj)*23//10)) - 1
2994 op = _WorkRep(self)
2995 c, e = op.int, op.exp
2996 if adj == 0:
2997 # 1 < self < 10
2998 num = str(c-10**-e)
2999 den = str(c)
3000 return len(num) - len(den) - (num < den)
3001 # adj == -1, 0.1 <= self < 1
3002 return e + len(str(10**-e - c)) - 1
3003
3004
3005 def ln(self, context=None):
3006 """Returns the natural (base e) logarithm of self."""
3007
3008 if context is None:
3009 context = getcontext()
3010
3011 # ln(NaN) = NaN
3012 ans = self._check_nans(context=context)
3013 if ans:
3014 return ans
3015
3016 # ln(0.0) == -Infinity
3017 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003018 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003019
3020 # ln(Infinity) = Infinity
3021 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003022 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003023
3024 # ln(1.0) == 0.0
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003025 if self == _One:
3026 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00003027
3028 # ln(negative) raises InvalidOperation
3029 if self._sign == 1:
3030 return context._raise_error(InvalidOperation,
3031 'ln of a negative value')
3032
3033 # result is irrational, so necessarily inexact
3034 op = _WorkRep(self)
3035 c, e = op.int, op.exp
3036 p = context.prec
3037
3038 # correctly rounded result: repeatedly increase precision by 3
3039 # until we get an unambiguously roundable result
3040 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3041 while True:
3042 coeff = _dlog(c, e, places)
3043 # assert len(str(abs(coeff)))-p >= 1
3044 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3045 break
3046 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003047 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003048
3049 context = context._shallow_copy()
3050 rounding = context._set_rounding(ROUND_HALF_EVEN)
3051 ans = ans._fix(context)
3052 context.rounding = rounding
3053 return ans
3054
3055 def _log10_exp_bound(self):
3056 """Compute a lower bound for the adjusted exponent of self.log10().
3057 In other words, find r such that self.log10() >= 10**r.
3058 Assumes that self is finite and positive and that self != 1.
3059 """
3060
3061 # For x >= 10 or x < 0.1 we only need a bound on the integer
3062 # part of log10(self), and this comes directly from the
3063 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3064 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3065 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3066
3067 adj = self._exp + len(self._int) - 1
3068 if adj >= 1:
3069 # self >= 10
3070 return len(str(adj))-1
3071 if adj <= -2:
3072 # self < 0.1
3073 return len(str(-1-adj))-1
3074 op = _WorkRep(self)
3075 c, e = op.int, op.exp
3076 if adj == 0:
3077 # 1 < self < 10
3078 num = str(c-10**-e)
3079 den = str(231*c)
3080 return len(num) - len(den) - (num < den) + 2
3081 # adj == -1, 0.1 <= self < 1
3082 num = str(10**-e-c)
3083 return len(num) + e - (num < "231") - 1
3084
3085 def log10(self, context=None):
3086 """Returns the base 10 logarithm of self."""
3087
3088 if context is None:
3089 context = getcontext()
3090
3091 # log10(NaN) = NaN
3092 ans = self._check_nans(context=context)
3093 if ans:
3094 return ans
3095
3096 # log10(0.0) == -Infinity
3097 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003098 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003099
3100 # log10(Infinity) = Infinity
3101 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003102 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003103
3104 # log10(negative or -Infinity) raises InvalidOperation
3105 if self._sign == 1:
3106 return context._raise_error(InvalidOperation,
3107 'log10 of a negative value')
3108
3109 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003110 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003111 # answer may need rounding
3112 ans = Decimal(self._exp + len(self._int) - 1)
3113 else:
3114 # result is irrational, so necessarily inexact
3115 op = _WorkRep(self)
3116 c, e = op.int, op.exp
3117 p = context.prec
3118
3119 # correctly rounded result: repeatedly increase precision
3120 # until result is unambiguously roundable
3121 places = p-self._log10_exp_bound()+2
3122 while True:
3123 coeff = _dlog10(c, e, places)
3124 # assert len(str(abs(coeff)))-p >= 1
3125 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3126 break
3127 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003128 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003129
3130 context = context._shallow_copy()
3131 rounding = context._set_rounding(ROUND_HALF_EVEN)
3132 ans = ans._fix(context)
3133 context.rounding = rounding
3134 return ans
3135
3136 def logb(self, context=None):
3137 """ Returns the exponent of the magnitude of self's MSD.
3138
3139 The result is the integer which is the exponent of the magnitude
3140 of the most significant digit of self (as though it were truncated
3141 to a single digit while maintaining the value of that digit and
3142 without limiting the resulting exponent).
3143 """
3144 # logb(NaN) = NaN
3145 ans = self._check_nans(context=context)
3146 if ans:
3147 return ans
3148
3149 if context is None:
3150 context = getcontext()
3151
3152 # logb(+/-Inf) = +Inf
3153 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003154 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003155
3156 # logb(0) = -Inf, DivisionByZero
3157 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003158 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003159
3160 # otherwise, simply return the adjusted exponent of self, as a
3161 # Decimal. Note that no attempt is made to fit the result
3162 # into the current context.
Mark Dickinson15ae41c2009-10-07 19:22:05 +00003163 ans = Decimal(self.adjusted())
3164 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003165
3166 def _islogical(self):
3167 """Return True if self is a logical operand.
3168
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003169 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003170 an exponent of 0, and a coefficient whose digits must all be
3171 either 0 or 1.
3172 """
3173 if self._sign != 0 or self._exp != 0:
3174 return False
3175 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003176 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003177 return False
3178 return True
3179
3180 def _fill_logical(self, context, opa, opb):
3181 dif = context.prec - len(opa)
3182 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003183 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003184 elif dif < 0:
3185 opa = opa[-context.prec:]
3186 dif = context.prec - len(opb)
3187 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003188 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003189 elif dif < 0:
3190 opb = opb[-context.prec:]
3191 return opa, opb
3192
3193 def logical_and(self, other, context=None):
3194 """Applies an 'and' operation between self and other's digits."""
3195 if context is None:
3196 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003197
3198 other = _convert_other(other, raiseit=True)
3199
Facundo Batista353750c2007-09-13 18:13:15 +00003200 if not self._islogical() or not other._islogical():
3201 return context._raise_error(InvalidOperation)
3202
3203 # fill to context.prec
3204 (opa, opb) = self._fill_logical(context, self._int, other._int)
3205
3206 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003207 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3208 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003209
3210 def logical_invert(self, context=None):
3211 """Invert all its digits."""
3212 if context is None:
3213 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003214 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3215 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003216
3217 def logical_or(self, other, context=None):
3218 """Applies an 'or' operation between self and other's digits."""
3219 if context is None:
3220 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003221
3222 other = _convert_other(other, raiseit=True)
3223
Facundo Batista353750c2007-09-13 18:13:15 +00003224 if not self._islogical() or not other._islogical():
3225 return context._raise_error(InvalidOperation)
3226
3227 # fill to context.prec
3228 (opa, opb) = self._fill_logical(context, self._int, other._int)
3229
3230 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003231 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003232 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003233
3234 def logical_xor(self, other, context=None):
3235 """Applies an 'xor' operation between self and other's digits."""
3236 if context is None:
3237 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003238
3239 other = _convert_other(other, raiseit=True)
3240
Facundo Batista353750c2007-09-13 18:13:15 +00003241 if not self._islogical() or not other._islogical():
3242 return context._raise_error(InvalidOperation)
3243
3244 # fill to context.prec
3245 (opa, opb) = self._fill_logical(context, self._int, other._int)
3246
3247 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003248 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003249 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003250
3251 def max_mag(self, other, context=None):
3252 """Compares the values numerically with their sign ignored."""
3253 other = _convert_other(other, raiseit=True)
3254
Facundo Batista6c398da2007-09-17 17:30:13 +00003255 if context is None:
3256 context = getcontext()
3257
Facundo Batista353750c2007-09-13 18:13:15 +00003258 if self._is_special or other._is_special:
3259 # If one operand is a quiet NaN and the other is number, then the
3260 # number is always returned
3261 sn = self._isnan()
3262 on = other._isnan()
3263 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003264 if on == 1 and sn == 0:
3265 return self._fix(context)
3266 if sn == 1 and on == 0:
3267 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003268 return self._check_nans(other, context)
3269
Mark Dickinson2fc92632008-02-06 22:10:50 +00003270 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003271 if c == 0:
3272 c = self.compare_total(other)
3273
3274 if c == -1:
3275 ans = other
3276 else:
3277 ans = self
3278
Facundo Batistae64acfa2007-12-17 14:18:42 +00003279 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003280
3281 def min_mag(self, other, context=None):
3282 """Compares the values numerically with their sign ignored."""
3283 other = _convert_other(other, raiseit=True)
3284
Facundo Batista6c398da2007-09-17 17:30:13 +00003285 if context is None:
3286 context = getcontext()
3287
Facundo Batista353750c2007-09-13 18:13:15 +00003288 if self._is_special or other._is_special:
3289 # If one operand is a quiet NaN and the other is number, then the
3290 # number is always returned
3291 sn = self._isnan()
3292 on = other._isnan()
3293 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003294 if on == 1 and sn == 0:
3295 return self._fix(context)
3296 if sn == 1 and on == 0:
3297 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003298 return self._check_nans(other, context)
3299
Mark Dickinson2fc92632008-02-06 22:10:50 +00003300 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003301 if c == 0:
3302 c = self.compare_total(other)
3303
3304 if c == -1:
3305 ans = self
3306 else:
3307 ans = other
3308
Facundo Batistae64acfa2007-12-17 14:18:42 +00003309 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003310
3311 def next_minus(self, context=None):
3312 """Returns the largest representable number smaller than itself."""
3313 if context is None:
3314 context = getcontext()
3315
3316 ans = self._check_nans(context=context)
3317 if ans:
3318 return ans
3319
3320 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003321 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003322 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003323 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003324
3325 context = context.copy()
3326 context._set_rounding(ROUND_FLOOR)
3327 context._ignore_all_flags()
3328 new_self = self._fix(context)
3329 if new_self != self:
3330 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003331 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3332 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003333
3334 def next_plus(self, context=None):
3335 """Returns the smallest representable number larger than itself."""
3336 if context is None:
3337 context = getcontext()
3338
3339 ans = self._check_nans(context=context)
3340 if ans:
3341 return ans
3342
3343 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003344 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003345 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003346 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003347
3348 context = context.copy()
3349 context._set_rounding(ROUND_CEILING)
3350 context._ignore_all_flags()
3351 new_self = self._fix(context)
3352 if new_self != self:
3353 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003354 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3355 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003356
3357 def next_toward(self, other, context=None):
3358 """Returns the number closest to self, in the direction towards other.
3359
3360 The result is the closest representable number to self
3361 (excluding self) that is in the direction towards other,
3362 unless both have the same value. If the two operands are
3363 numerically equal, then the result is a copy of self with the
3364 sign set to be the same as the sign of other.
3365 """
3366 other = _convert_other(other, raiseit=True)
3367
3368 if context is None:
3369 context = getcontext()
3370
3371 ans = self._check_nans(other, context)
3372 if ans:
3373 return ans
3374
Mark Dickinson2fc92632008-02-06 22:10:50 +00003375 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003376 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003377 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003378
3379 if comparison == -1:
3380 ans = self.next_plus(context)
3381 else: # comparison == 1
3382 ans = self.next_minus(context)
3383
3384 # decide which flags to raise using value of ans
3385 if ans._isinfinity():
3386 context._raise_error(Overflow,
3387 'Infinite result from next_toward',
3388 ans._sign)
3389 context._raise_error(Rounded)
3390 context._raise_error(Inexact)
3391 elif ans.adjusted() < context.Emin:
3392 context._raise_error(Underflow)
3393 context._raise_error(Subnormal)
3394 context._raise_error(Rounded)
3395 context._raise_error(Inexact)
3396 # if precision == 1 then we don't raise Clamped for a
3397 # result 0E-Etiny.
3398 if not ans:
3399 context._raise_error(Clamped)
3400
3401 return ans
3402
3403 def number_class(self, context=None):
3404 """Returns an indication of the class of self.
3405
3406 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003407 sNaN
3408 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003409 -Infinity
3410 -Normal
3411 -Subnormal
3412 -Zero
3413 +Zero
3414 +Subnormal
3415 +Normal
3416 +Infinity
3417 """
3418 if self.is_snan():
3419 return "sNaN"
3420 if self.is_qnan():
3421 return "NaN"
3422 inf = self._isinfinity()
3423 if inf == 1:
3424 return "+Infinity"
3425 if inf == -1:
3426 return "-Infinity"
3427 if self.is_zero():
3428 if self._sign:
3429 return "-Zero"
3430 else:
3431 return "+Zero"
3432 if context is None:
3433 context = getcontext()
3434 if self.is_subnormal(context=context):
3435 if self._sign:
3436 return "-Subnormal"
3437 else:
3438 return "+Subnormal"
3439 # just a normal, regular, boring number, :)
3440 if self._sign:
3441 return "-Normal"
3442 else:
3443 return "+Normal"
3444
3445 def radix(self):
3446 """Just returns 10, as this is Decimal, :)"""
3447 return Decimal(10)
3448
3449 def rotate(self, other, context=None):
3450 """Returns a rotated copy of self, value-of-other times."""
3451 if context is None:
3452 context = getcontext()
3453
Mark Dickinson0c673122009-10-29 12:04:00 +00003454 other = _convert_other(other, raiseit=True)
3455
Facundo Batista353750c2007-09-13 18:13:15 +00003456 ans = self._check_nans(other, context)
3457 if ans:
3458 return ans
3459
3460 if other._exp != 0:
3461 return context._raise_error(InvalidOperation)
3462 if not (-context.prec <= int(other) <= context.prec):
3463 return context._raise_error(InvalidOperation)
3464
3465 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003466 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003467
3468 # get values, pad if necessary
3469 torot = int(other)
3470 rotdig = self._int
3471 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003472 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003473 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003474 elif topad < 0:
3475 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003476
3477 # let's rotate!
3478 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003479 return _dec_from_triple(self._sign,
3480 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003481
Mark Dickinson0c673122009-10-29 12:04:00 +00003482 def scaleb(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00003483 """Returns self operand after adding the second value to its exp."""
3484 if context is None:
3485 context = getcontext()
3486
Mark Dickinson0c673122009-10-29 12:04:00 +00003487 other = _convert_other(other, raiseit=True)
3488
Facundo Batista353750c2007-09-13 18:13:15 +00003489 ans = self._check_nans(other, context)
3490 if ans:
3491 return ans
3492
3493 if other._exp != 0:
3494 return context._raise_error(InvalidOperation)
3495 liminf = -2 * (context.Emax + context.prec)
3496 limsup = 2 * (context.Emax + context.prec)
3497 if not (liminf <= int(other) <= limsup):
3498 return context._raise_error(InvalidOperation)
3499
3500 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003501 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003502
Facundo Batista72bc54f2007-11-23 17:59:00 +00003503 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003504 d = d._fix(context)
3505 return d
3506
3507 def shift(self, other, context=None):
3508 """Returns a shifted copy of self, value-of-other times."""
3509 if context is None:
3510 context = getcontext()
3511
Mark Dickinson0c673122009-10-29 12:04:00 +00003512 other = _convert_other(other, raiseit=True)
3513
Facundo Batista353750c2007-09-13 18:13:15 +00003514 ans = self._check_nans(other, context)
3515 if ans:
3516 return ans
3517
3518 if other._exp != 0:
3519 return context._raise_error(InvalidOperation)
3520 if not (-context.prec <= int(other) <= context.prec):
3521 return context._raise_error(InvalidOperation)
3522
3523 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003524 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003525
3526 # get values, pad if necessary
3527 torot = int(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003528 rotdig = self._int
3529 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003530 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003531 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003532 elif topad < 0:
3533 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003534
3535 # let's shift!
3536 if torot < 0:
Mark Dickinson6f390012009-10-29 12:11:18 +00003537 shifted = rotdig[:torot]
Facundo Batista353750c2007-09-13 18:13:15 +00003538 else:
Mark Dickinson6f390012009-10-29 12:11:18 +00003539 shifted = rotdig + '0'*torot
3540 shifted = shifted[-context.prec:]
Facundo Batista353750c2007-09-13 18:13:15 +00003541
Facundo Batista72bc54f2007-11-23 17:59:00 +00003542 return _dec_from_triple(self._sign,
Mark Dickinson6f390012009-10-29 12:11:18 +00003543 shifted.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003544
Facundo Batista59c58842007-04-10 12:58:45 +00003545 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003546 def __reduce__(self):
3547 return (self.__class__, (str(self),))
3548
3549 def __copy__(self):
Benjamin Peterson28e369a2010-01-25 03:58:21 +00003550 if type(self) is Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003551 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003552 return self.__class__(str(self))
3553
3554 def __deepcopy__(self, memo):
Benjamin Peterson28e369a2010-01-25 03:58:21 +00003555 if type(self) is Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003556 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003557 return self.__class__(str(self))
3558
Mark Dickinson277859d2009-03-17 23:03:46 +00003559 # PEP 3101 support. the _localeconv keyword argument should be
3560 # considered private: it's provided for ease of testing only.
3561 def __format__(self, specifier, context=None, _localeconv=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003562 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003563
3564 The specifier should be a standard format specifier, with the
3565 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson277859d2009-03-17 23:03:46 +00003566 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3567 type is omitted it defaults to 'g' or 'G', depending on the
3568 value of context.capitals.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003569 """
3570
3571 # Note: PEP 3101 says that if the type is not present then
3572 # there should be at least one digit after the decimal point.
3573 # We take the liberty of ignoring this requirement for
3574 # Decimal---it's presumably there to make sure that
3575 # format(float, '') behaves similarly to str(float).
3576 if context is None:
3577 context = getcontext()
3578
Mark Dickinson277859d2009-03-17 23:03:46 +00003579 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003580
Mark Dickinson277859d2009-03-17 23:03:46 +00003581 # special values don't care about the type or precision
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003582 if self._is_special:
Mark Dickinson277859d2009-03-17 23:03:46 +00003583 sign = _format_sign(self._sign, spec)
3584 body = str(self.copy_abs())
3585 return _format_align(sign, body, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003586
3587 # a type of None defaults to 'g' or 'G', depending on context
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003588 if spec['type'] is None:
3589 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson277859d2009-03-17 23:03:46 +00003590
3591 # if type is '%', adjust exponent of self accordingly
3592 if spec['type'] == '%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003593 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3594
3595 # round if necessary, taking rounding mode from the context
3596 rounding = context.rounding
3597 precision = spec['precision']
3598 if precision is not None:
3599 if spec['type'] in 'eE':
3600 self = self._round(precision+1, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003601 elif spec['type'] in 'fF%':
3602 self = self._rescale(-precision, rounding)
Mark Dickinson277859d2009-03-17 23:03:46 +00003603 elif spec['type'] in 'gG' and len(self._int) > precision:
3604 self = self._round(precision, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003605 # special case: zeros with a positive exponent can't be
3606 # represented in fixed point; rescale them to 0e0.
Mark Dickinson277859d2009-03-17 23:03:46 +00003607 if not self and self._exp > 0 and spec['type'] in 'fF%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003608 self = self._rescale(0, rounding)
3609
3610 # figure out placement of the decimal point
3611 leftdigits = self._exp + len(self._int)
Mark Dickinson277859d2009-03-17 23:03:46 +00003612 if spec['type'] in 'eE':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003613 if not self and precision is not None:
3614 dotplace = 1 - precision
3615 else:
3616 dotplace = 1
Mark Dickinson277859d2009-03-17 23:03:46 +00003617 elif spec['type'] in 'fF%':
3618 dotplace = leftdigits
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003619 elif spec['type'] in 'gG':
3620 if self._exp <= 0 and leftdigits > -6:
3621 dotplace = leftdigits
3622 else:
3623 dotplace = 1
3624
Mark Dickinson277859d2009-03-17 23:03:46 +00003625 # find digits before and after decimal point, and get exponent
3626 if dotplace < 0:
3627 intpart = '0'
3628 fracpart = '0'*(-dotplace) + self._int
3629 elif dotplace > len(self._int):
3630 intpart = self._int + '0'*(dotplace-len(self._int))
3631 fracpart = ''
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003632 else:
Mark Dickinson277859d2009-03-17 23:03:46 +00003633 intpart = self._int[:dotplace] or '0'
3634 fracpart = self._int[dotplace:]
3635 exp = leftdigits-dotplace
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003636
Mark Dickinson277859d2009-03-17 23:03:46 +00003637 # done with the decimal-specific stuff; hand over the rest
3638 # of the formatting to the _format_number function
3639 return _format_number(self._sign, intpart, fracpart, exp, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003640
Facundo Batista72bc54f2007-11-23 17:59:00 +00003641def _dec_from_triple(sign, coefficient, exponent, special=False):
3642 """Create a decimal instance directly, without any validation,
3643 normalization (e.g. removal of leading zeros) or argument
3644 conversion.
3645
3646 This function is for *internal use only*.
3647 """
3648
3649 self = object.__new__(Decimal)
3650 self._sign = sign
3651 self._int = coefficient
3652 self._exp = exponent
3653 self._is_special = special
3654
3655 return self
3656
Raymond Hettinger2c8585b2009-02-03 03:37:03 +00003657# Register Decimal as a kind of Number (an abstract base class).
3658# However, do not register it as Real (because Decimals are not
3659# interoperable with floats).
3660_numbers.Number.register(Decimal)
3661
3662
Facundo Batista59c58842007-04-10 12:58:45 +00003663##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003664
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003665
3666# get rounding method function:
Facundo Batista59c58842007-04-10 12:58:45 +00003667rounding_functions = [name for name in Decimal.__dict__.keys()
3668 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003669for name in rounding_functions:
Facundo Batista59c58842007-04-10 12:58:45 +00003670 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003671 globalname = name[1:].upper()
3672 val = globals()[globalname]
3673 Decimal._pick_rounding_function[val] = name
3674
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003675del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003676
Nick Coghlanced12182006-09-02 03:54:17 +00003677class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003678 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003679
Nick Coghlanced12182006-09-02 03:54:17 +00003680 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003681 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003682 """
3683 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003684 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003685 def __enter__(self):
3686 self.saved_context = getcontext()
3687 setcontext(self.new_context)
3688 return self.new_context
3689 def __exit__(self, t, v, tb):
3690 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003691
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003692class Context(object):
3693 """Contains the context for a Decimal instance.
3694
3695 Contains:
3696 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003697 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003698 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003699 raised when it is caused. Otherwise, a value is
3700 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003701 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003702 (Whether or not the trap_enabler is set)
3703 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003704 Emin - Minimum exponent
3705 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003706 capitals - If 1, 1*10^1 is printed as 1E+1.
3707 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003708 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003709 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003710
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003711 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003712 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003713 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003714 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003715 _ignored_flags=None):
3716 if flags is None:
3717 flags = []
3718 if _ignored_flags is None:
3719 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003720 if not isinstance(flags, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003721 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003722 del s
Raymond Hettingerbf440692004-07-10 14:14:37 +00003723 if traps is not None and not isinstance(traps, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003724 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003725 del s
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003726 for name, val in locals().items():
3727 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003728 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003729 else:
3730 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003731 del self.self
3732
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003733 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003734 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003735 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003736 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3737 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3738 % vars(self))
3739 names = [f.__name__ for f, v in self.flags.items() if v]
3740 s.append('flags=[' + ', '.join(names) + ']')
3741 names = [t.__name__ for t, v in self.traps.items() if v]
3742 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003743 return ', '.join(s) + ')'
3744
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003745 def clear_flags(self):
3746 """Reset all flags to zero"""
3747 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003748 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003749
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003750 def _shallow_copy(self):
3751 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003752 nc = Context(self.prec, self.rounding, self.traps,
3753 self.flags, self.Emin, self.Emax,
3754 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003755 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003756
3757 def copy(self):
3758 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003759 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003760 self.flags.copy(), self.Emin, self.Emax,
3761 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003762 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003763 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003764
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003765 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003766 """Handles an error
3767
3768 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003769 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003770 trap_enabler is set, it reaises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003771 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003772 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003773 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003774 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003775 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003776 return error().handle(self, *args)
3777
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003778 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003779 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003780 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003781 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003782
3783 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003784 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003785 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003786
3787 def _ignore_all_flags(self):
3788 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003789 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003790
3791 def _ignore_flags(self, *flags):
3792 """Ignore the flags, if they are raised"""
3793 # Do not mutate-- This way, copies of a context leave the original
3794 # alone.
3795 self._ignored_flags = (self._ignored_flags + list(flags))
3796 return list(flags)
3797
3798 def _regard_flags(self, *flags):
3799 """Stop ignoring the flags, if they are raised"""
3800 if flags and isinstance(flags[0], (tuple,list)):
3801 flags = flags[0]
3802 for flag in flags:
3803 self._ignored_flags.remove(flag)
3804
Nick Coghlan53663a62008-07-15 14:27:37 +00003805 # We inherit object.__hash__, so we must deny this explicitly
3806 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003807
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003808 def Etiny(self):
3809 """Returns Etiny (= Emin - prec + 1)"""
3810 return int(self.Emin - self.prec + 1)
3811
3812 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003813 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003814 return int(self.Emax - self.prec + 1)
3815
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003816 def _set_rounding(self, type):
3817 """Sets the rounding type.
3818
3819 Sets the rounding type, and returns the current (previous)
3820 rounding type. Often used like:
3821
3822 context = context.copy()
3823 # so you don't change the calling context
3824 # if an error occurs in the middle.
3825 rounding = context._set_rounding(ROUND_UP)
3826 val = self.__sub__(other, context=context)
3827 context._set_rounding(rounding)
3828
3829 This will make it round up for that operation.
3830 """
3831 rounding = self.rounding
3832 self.rounding= type
3833 return rounding
3834
Raymond Hettingerfed52962004-07-14 15:41:57 +00003835 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003836 """Creates a new Decimal instance but using self as context.
3837
3838 This method implements the to-number operation of the
3839 IBM Decimal specification."""
3840
3841 if isinstance(num, basestring) and num != num.strip():
3842 return self._raise_error(ConversionSyntax,
3843 "no trailing or leading whitespace is "
3844 "permitted.")
3845
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003846 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003847 if d._isnan() and len(d._int) > self.prec - self._clamp:
3848 return self._raise_error(ConversionSyntax,
3849 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003850 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003851
Raymond Hettingerf4d85972009-01-03 19:02:23 +00003852 def create_decimal_from_float(self, f):
3853 """Creates a new Decimal instance from a float but rounding using self
3854 as the context.
3855
3856 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3857 >>> context.create_decimal_from_float(3.1415926535897932)
3858 Decimal('3.1415')
3859 >>> context = Context(prec=5, traps=[Inexact])
3860 >>> context.create_decimal_from_float(3.1415926535897932)
3861 Traceback (most recent call last):
3862 ...
3863 Inexact: None
3864
3865 """
3866 d = Decimal.from_float(f) # An exact conversion
3867 return d._fix(self) # Apply the context rounding
3868
Facundo Batista59c58842007-04-10 12:58:45 +00003869 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003870 def abs(self, a):
3871 """Returns the absolute value of the operand.
3872
3873 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003874 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003875 the plus operation on the operand.
3876
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003877 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003878 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003879 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003880 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003881 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003882 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003883 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003884 Decimal('101.5')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003885 >>> ExtendedContext.abs(-1)
3886 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003887 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003888 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003889 return a.__abs__(context=self)
3890
3891 def add(self, a, b):
3892 """Return the sum of the two operands.
3893
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003894 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003895 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003896 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003897 Decimal('1.02E+4')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003898 >>> ExtendedContext.add(1, Decimal(2))
3899 Decimal('3')
3900 >>> ExtendedContext.add(Decimal(8), 5)
3901 Decimal('13')
3902 >>> ExtendedContext.add(5, 5)
3903 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003904 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003905 a = _convert_other(a, raiseit=True)
3906 r = a.__add__(b, context=self)
3907 if r is NotImplemented:
3908 raise TypeError("Unable to convert %s to Decimal" % b)
3909 else:
3910 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003911
3912 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003913 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003914
Facundo Batista353750c2007-09-13 18:13:15 +00003915 def canonical(self, a):
3916 """Returns the same Decimal object.
3917
3918 As we do not have different encodings for the same number, the
3919 received object already is in its canonical form.
3920
3921 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003922 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003923 """
3924 return a.canonical(context=self)
3925
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003926 def compare(self, a, b):
3927 """Compares values numerically.
3928
3929 If the signs of the operands differ, a value representing each operand
3930 ('-1' if the operand is less than zero, '0' if the operand is zero or
3931 negative zero, or '1' if the operand is greater than zero) is used in
3932 place of that operand for the comparison instead of the actual
3933 operand.
3934
3935 The comparison is then effected by subtracting the second operand from
3936 the first and then returning a value according to the result of the
3937 subtraction: '-1' if the result is less than zero, '0' if the result is
3938 zero or negative zero, or '1' if the result is greater than zero.
3939
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003940 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003941 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003942 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003943 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003944 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003945 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003946 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003947 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003948 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003949 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003950 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003951 Decimal('-1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003952 >>> ExtendedContext.compare(1, 2)
3953 Decimal('-1')
3954 >>> ExtendedContext.compare(Decimal(1), 2)
3955 Decimal('-1')
3956 >>> ExtendedContext.compare(1, Decimal(2))
3957 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003958 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003959 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003960 return a.compare(b, context=self)
3961
Facundo Batista353750c2007-09-13 18:13:15 +00003962 def compare_signal(self, a, b):
3963 """Compares the values of the two operands numerically.
3964
3965 It's pretty much like compare(), but all NaNs signal, with signaling
3966 NaNs taking precedence over quiet NaNs.
3967
3968 >>> c = ExtendedContext
3969 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003970 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003971 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003972 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00003973 >>> c.flags[InvalidOperation] = 0
3974 >>> print c.flags[InvalidOperation]
3975 0
3976 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003977 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003978 >>> print c.flags[InvalidOperation]
3979 1
3980 >>> c.flags[InvalidOperation] = 0
3981 >>> print c.flags[InvalidOperation]
3982 0
3983 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003984 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00003985 >>> print c.flags[InvalidOperation]
3986 1
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003987 >>> c.compare_signal(-1, 2)
3988 Decimal('-1')
3989 >>> c.compare_signal(Decimal(-1), 2)
3990 Decimal('-1')
3991 >>> c.compare_signal(-1, Decimal(2))
3992 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00003993 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003994 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00003995 return a.compare_signal(b, context=self)
3996
3997 def compare_total(self, a, b):
3998 """Compares two operands using their abstract representation.
3999
4000 This is not like the standard compare, which use their numerical
4001 value. Note that a total ordering is defined for all possible abstract
4002 representations.
4003
4004 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004005 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004006 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004007 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004008 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004009 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004010 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004011 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004012 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004013 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004014 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004015 Decimal('-1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004016 >>> ExtendedContext.compare_total(1, 2)
4017 Decimal('-1')
4018 >>> ExtendedContext.compare_total(Decimal(1), 2)
4019 Decimal('-1')
4020 >>> ExtendedContext.compare_total(1, Decimal(2))
4021 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004022 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004023 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004024 return a.compare_total(b)
4025
4026 def compare_total_mag(self, a, b):
4027 """Compares two operands using their abstract representation ignoring sign.
4028
4029 Like compare_total, but with operand's sign ignored and assumed to be 0.
4030 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004031 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004032 return a.compare_total_mag(b)
4033
4034 def copy_abs(self, a):
4035 """Returns a copy of the operand with the sign set to 0.
4036
4037 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004038 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00004039 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004040 Decimal('100')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004041 >>> ExtendedContext.copy_abs(-1)
4042 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004043 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004044 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004045 return a.copy_abs()
4046
4047 def copy_decimal(self, a):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004048 """Returns a copy of the decimal object.
Facundo Batista353750c2007-09-13 18:13:15 +00004049
4050 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004051 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00004052 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004053 Decimal('-1.00')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004054 >>> ExtendedContext.copy_decimal(1)
4055 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004056 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004057 a = _convert_other(a, raiseit=True)
Facundo Batista6c398da2007-09-17 17:30:13 +00004058 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00004059
4060 def copy_negate(self, a):
4061 """Returns a copy of the operand with the sign inverted.
4062
4063 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004064 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00004065 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004066 Decimal('101.5')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004067 >>> ExtendedContext.copy_negate(1)
4068 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004069 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004070 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004071 return a.copy_negate()
4072
4073 def copy_sign(self, a, b):
4074 """Copies the second operand's sign to the first one.
4075
4076 In detail, it returns a copy of the first operand with the sign
4077 equal to the sign of the second operand.
4078
4079 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004080 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004081 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004082 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004083 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004084 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004085 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004086 Decimal('-1.50')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004087 >>> ExtendedContext.copy_sign(1, -2)
4088 Decimal('-1')
4089 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4090 Decimal('-1')
4091 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4092 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004093 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004094 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004095 return a.copy_sign(b)
4096
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004097 def divide(self, a, b):
4098 """Decimal division in a specified context.
4099
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004100 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004101 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004102 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004103 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004104 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004105 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004106 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004107 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004108 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004109 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004110 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004111 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004112 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004113 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004114 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004115 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004116 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004117 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004118 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004119 Decimal('1.20E+6')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004120 >>> ExtendedContext.divide(5, 5)
4121 Decimal('1')
4122 >>> ExtendedContext.divide(Decimal(5), 5)
4123 Decimal('1')
4124 >>> ExtendedContext.divide(5, Decimal(5))
4125 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004126 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004127 a = _convert_other(a, raiseit=True)
4128 r = a.__div__(b, context=self)
4129 if r is NotImplemented:
4130 raise TypeError("Unable to convert %s to Decimal" % b)
4131 else:
4132 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004133
4134 def divide_int(self, a, b):
4135 """Divides two numbers and returns the integer part of the result.
4136
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004137 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004138 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004139 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004140 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004141 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004142 Decimal('3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004143 >>> ExtendedContext.divide_int(10, 3)
4144 Decimal('3')
4145 >>> ExtendedContext.divide_int(Decimal(10), 3)
4146 Decimal('3')
4147 >>> ExtendedContext.divide_int(10, Decimal(3))
4148 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004149 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004150 a = _convert_other(a, raiseit=True)
4151 r = a.__floordiv__(b, context=self)
4152 if r is NotImplemented:
4153 raise TypeError("Unable to convert %s to Decimal" % b)
4154 else:
4155 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004156
4157 def divmod(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004158 """Return (a // b, a % b).
Mark Dickinson202eb902010-01-06 16:20:22 +00004159
4160 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4161 (Decimal('2'), Decimal('2'))
4162 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4163 (Decimal('2'), Decimal('0'))
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004164 >>> ExtendedContext.divmod(8, 4)
4165 (Decimal('2'), Decimal('0'))
4166 >>> ExtendedContext.divmod(Decimal(8), 4)
4167 (Decimal('2'), Decimal('0'))
4168 >>> ExtendedContext.divmod(8, Decimal(4))
4169 (Decimal('2'), Decimal('0'))
Mark Dickinson202eb902010-01-06 16:20:22 +00004170 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004171 a = _convert_other(a, raiseit=True)
4172 r = a.__divmod__(b, context=self)
4173 if r is NotImplemented:
4174 raise TypeError("Unable to convert %s to Decimal" % b)
4175 else:
4176 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004177
Facundo Batista353750c2007-09-13 18:13:15 +00004178 def exp(self, a):
4179 """Returns e ** a.
4180
4181 >>> c = ExtendedContext.copy()
4182 >>> c.Emin = -999
4183 >>> c.Emax = 999
4184 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004185 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004186 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004187 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00004188 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004189 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004190 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004191 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00004192 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004193 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004194 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004195 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004196 >>> c.exp(10)
4197 Decimal('22026.4658')
Facundo Batista353750c2007-09-13 18:13:15 +00004198 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004199 a =_convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004200 return a.exp(context=self)
4201
4202 def fma(self, a, b, c):
4203 """Returns a multiplied by b, plus c.
4204
4205 The first two operands are multiplied together, using multiply,
4206 the third operand is then added to the result of that
4207 multiplication, using add, all with only one final rounding.
4208
4209 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004210 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004211 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004212 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004213 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004214 Decimal('1.38435736E+12')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004215 >>> ExtendedContext.fma(1, 3, 4)
4216 Decimal('7')
4217 >>> ExtendedContext.fma(1, Decimal(3), 4)
4218 Decimal('7')
4219 >>> ExtendedContext.fma(1, 3, Decimal(4))
4220 Decimal('7')
Facundo Batista353750c2007-09-13 18:13:15 +00004221 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004222 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004223 return a.fma(b, c, context=self)
4224
4225 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004226 """Return True if the operand is canonical; otherwise return False.
4227
4228 Currently, the encoding of a Decimal instance is always
4229 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004230
4231 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004232 True
Facundo Batista353750c2007-09-13 18:13:15 +00004233 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004234 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004235
4236 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004237 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004238
Facundo Batista1a191df2007-10-02 17:01:24 +00004239 A Decimal instance is considered finite if it is neither
4240 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004241
4242 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004243 True
Facundo Batista353750c2007-09-13 18:13:15 +00004244 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004245 True
Facundo Batista353750c2007-09-13 18:13:15 +00004246 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004247 True
Facundo Batista353750c2007-09-13 18:13:15 +00004248 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004249 False
Facundo Batista353750c2007-09-13 18:13:15 +00004250 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004251 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004252 >>> ExtendedContext.is_finite(1)
4253 True
Facundo Batista353750c2007-09-13 18:13:15 +00004254 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004255 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004256 return a.is_finite()
4257
4258 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004259 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004260
4261 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004262 False
Facundo Batista353750c2007-09-13 18:13:15 +00004263 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004264 True
Facundo Batista353750c2007-09-13 18:13:15 +00004265 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004266 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004267 >>> ExtendedContext.is_infinite(1)
4268 False
Facundo Batista353750c2007-09-13 18:13:15 +00004269 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004270 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004271 return a.is_infinite()
4272
4273 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004274 """Return True if the operand is a qNaN or sNaN;
4275 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004276
4277 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004278 False
Facundo Batista353750c2007-09-13 18:13:15 +00004279 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004280 True
Facundo Batista353750c2007-09-13 18:13:15 +00004281 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004282 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004283 >>> ExtendedContext.is_nan(1)
4284 False
Facundo Batista353750c2007-09-13 18:13:15 +00004285 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004286 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004287 return a.is_nan()
4288
4289 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004290 """Return True if the operand is a normal number;
4291 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004292
4293 >>> c = ExtendedContext.copy()
4294 >>> c.Emin = -999
4295 >>> c.Emax = 999
4296 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004297 True
Facundo Batista353750c2007-09-13 18:13:15 +00004298 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004299 False
Facundo Batista353750c2007-09-13 18:13:15 +00004300 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004301 False
Facundo Batista353750c2007-09-13 18:13:15 +00004302 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004303 False
Facundo Batista353750c2007-09-13 18:13:15 +00004304 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004305 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004306 >>> c.is_normal(1)
4307 True
Facundo Batista353750c2007-09-13 18:13:15 +00004308 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004309 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004310 return a.is_normal(context=self)
4311
4312 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004313 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004314
4315 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004316 False
Facundo Batista353750c2007-09-13 18:13:15 +00004317 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004318 True
Facundo Batista353750c2007-09-13 18:13:15 +00004319 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004320 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004321 >>> ExtendedContext.is_qnan(1)
4322 False
Facundo Batista353750c2007-09-13 18:13:15 +00004323 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004324 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004325 return a.is_qnan()
4326
4327 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004328 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004329
4330 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004331 False
Facundo Batista353750c2007-09-13 18:13:15 +00004332 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004333 True
Facundo Batista353750c2007-09-13 18:13:15 +00004334 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004335 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004336 >>> ExtendedContext.is_signed(8)
4337 False
4338 >>> ExtendedContext.is_signed(-8)
4339 True
Facundo Batista353750c2007-09-13 18:13:15 +00004340 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004341 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004342 return a.is_signed()
4343
4344 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004345 """Return True if the operand is a signaling NaN;
4346 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004347
4348 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004349 False
Facundo Batista353750c2007-09-13 18:13:15 +00004350 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004351 False
Facundo Batista353750c2007-09-13 18:13:15 +00004352 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004353 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004354 >>> ExtendedContext.is_snan(1)
4355 False
Facundo Batista353750c2007-09-13 18:13:15 +00004356 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004357 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004358 return a.is_snan()
4359
4360 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004361 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004362
4363 >>> c = ExtendedContext.copy()
4364 >>> c.Emin = -999
4365 >>> c.Emax = 999
4366 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004367 False
Facundo Batista353750c2007-09-13 18:13:15 +00004368 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004369 True
Facundo Batista353750c2007-09-13 18:13:15 +00004370 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004371 False
Facundo Batista353750c2007-09-13 18:13:15 +00004372 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004373 False
Facundo Batista353750c2007-09-13 18:13:15 +00004374 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004375 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004376 >>> c.is_subnormal(1)
4377 False
Facundo Batista353750c2007-09-13 18:13:15 +00004378 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004379 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004380 return a.is_subnormal(context=self)
4381
4382 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004383 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004384
4385 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004386 True
Facundo Batista353750c2007-09-13 18:13:15 +00004387 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004388 False
Facundo Batista353750c2007-09-13 18:13:15 +00004389 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004390 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004391 >>> ExtendedContext.is_zero(1)
4392 False
4393 >>> ExtendedContext.is_zero(0)
4394 True
Facundo Batista353750c2007-09-13 18:13:15 +00004395 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004396 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004397 return a.is_zero()
4398
4399 def ln(self, a):
4400 """Returns the natural (base e) logarithm of the operand.
4401
4402 >>> c = ExtendedContext.copy()
4403 >>> c.Emin = -999
4404 >>> c.Emax = 999
4405 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004406 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004407 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004408 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004409 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004410 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004411 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004412 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004413 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004414 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004415 >>> c.ln(1)
4416 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004417 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004418 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004419 return a.ln(context=self)
4420
4421 def log10(self, a):
4422 """Returns the base 10 logarithm of the operand.
4423
4424 >>> c = ExtendedContext.copy()
4425 >>> c.Emin = -999
4426 >>> c.Emax = 999
4427 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004428 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004429 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004430 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004431 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004432 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004433 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004434 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004435 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004436 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004437 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004438 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004439 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004440 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004441 >>> c.log10(0)
4442 Decimal('-Infinity')
4443 >>> c.log10(1)
4444 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004445 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004446 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004447 return a.log10(context=self)
4448
4449 def logb(self, a):
4450 """ Returns the exponent of the magnitude of the operand's MSD.
4451
4452 The result is the integer which is the exponent of the magnitude
4453 of the most significant digit of the operand (as though the
4454 operand were truncated to a single digit while maintaining the
4455 value of that digit and without limiting the resulting exponent).
4456
4457 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004458 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004459 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004460 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004461 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004462 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004463 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004464 Decimal('-Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004465 >>> ExtendedContext.logb(1)
4466 Decimal('0')
4467 >>> ExtendedContext.logb(10)
4468 Decimal('1')
4469 >>> ExtendedContext.logb(100)
4470 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004471 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004472 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004473 return a.logb(context=self)
4474
4475 def logical_and(self, a, b):
4476 """Applies the logical operation 'and' between each operand's digits.
4477
4478 The operands must be both logical numbers.
4479
4480 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004481 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004482 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004483 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004484 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004485 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004486 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004487 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004488 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004489 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004490 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004491 Decimal('10')
Mark Dickinson456e1652010-02-18 14:45:33 +00004492 >>> ExtendedContext.logical_and(110, 1101)
4493 Decimal('100')
4494 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4495 Decimal('100')
4496 >>> ExtendedContext.logical_and(110, Decimal(1101))
4497 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004498 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004499 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004500 return a.logical_and(b, context=self)
4501
4502 def logical_invert(self, a):
4503 """Invert all the digits in the operand.
4504
4505 The operand must be a logical number.
4506
4507 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004508 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004509 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004510 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004511 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004512 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004513 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004514 Decimal('10101010')
Mark Dickinson456e1652010-02-18 14:45:33 +00004515 >>> ExtendedContext.logical_invert(1101)
4516 Decimal('111110010')
Facundo Batista353750c2007-09-13 18:13:15 +00004517 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004518 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004519 return a.logical_invert(context=self)
4520
4521 def logical_or(self, a, b):
4522 """Applies the logical operation 'or' between each operand's digits.
4523
4524 The operands must be both logical numbers.
4525
4526 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004527 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004528 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004529 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004530 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004531 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004532 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004533 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004534 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004535 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004536 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004537 Decimal('1110')
Mark Dickinson456e1652010-02-18 14:45:33 +00004538 >>> ExtendedContext.logical_or(110, 1101)
4539 Decimal('1111')
4540 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4541 Decimal('1111')
4542 >>> ExtendedContext.logical_or(110, Decimal(1101))
4543 Decimal('1111')
Facundo Batista353750c2007-09-13 18:13:15 +00004544 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004545 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004546 return a.logical_or(b, context=self)
4547
4548 def logical_xor(self, a, b):
4549 """Applies the logical operation 'xor' between each operand's digits.
4550
4551 The operands must be both logical numbers.
4552
4553 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004554 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004555 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004556 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004557 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004558 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004559 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004560 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004561 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004562 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004563 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004564 Decimal('1101')
Mark Dickinson456e1652010-02-18 14:45:33 +00004565 >>> ExtendedContext.logical_xor(110, 1101)
4566 Decimal('1011')
4567 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4568 Decimal('1011')
4569 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4570 Decimal('1011')
Facundo Batista353750c2007-09-13 18:13:15 +00004571 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004572 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004573 return a.logical_xor(b, context=self)
4574
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004575 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004576 """max compares two values numerically and returns the maximum.
4577
4578 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004579 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004580 operation. If they are numerically equal then the left-hand operand
4581 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004582 infinity) of the two operands is chosen as the result.
4583
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004584 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004585 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004586 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004587 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004588 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004589 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004590 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004591 Decimal('7')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004592 >>> ExtendedContext.max(1, 2)
4593 Decimal('2')
4594 >>> ExtendedContext.max(Decimal(1), 2)
4595 Decimal('2')
4596 >>> ExtendedContext.max(1, Decimal(2))
4597 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004598 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004599 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004600 return a.max(b, context=self)
4601
Facundo Batista353750c2007-09-13 18:13:15 +00004602 def max_mag(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004603 """Compares the values numerically with their sign ignored.
4604
4605 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4606 Decimal('7')
4607 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4608 Decimal('-10')
4609 >>> ExtendedContext.max_mag(1, -2)
4610 Decimal('-2')
4611 >>> ExtendedContext.max_mag(Decimal(1), -2)
4612 Decimal('-2')
4613 >>> ExtendedContext.max_mag(1, Decimal(-2))
4614 Decimal('-2')
4615 """
4616 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004617 return a.max_mag(b, context=self)
4618
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004619 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004620 """min compares two values numerically and returns the minimum.
4621
4622 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004623 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004624 operation. If they are numerically equal then the left-hand operand
4625 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004626 infinity) of the two operands is chosen as the result.
4627
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004628 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004629 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004630 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004631 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004632 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004633 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004634 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004635 Decimal('7')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004636 >>> ExtendedContext.min(1, 2)
4637 Decimal('1')
4638 >>> ExtendedContext.min(Decimal(1), 2)
4639 Decimal('1')
4640 >>> ExtendedContext.min(1, Decimal(29))
4641 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004642 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004643 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004644 return a.min(b, context=self)
4645
Facundo Batista353750c2007-09-13 18:13:15 +00004646 def min_mag(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004647 """Compares the values numerically with their sign ignored.
4648
4649 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4650 Decimal('-2')
4651 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4652 Decimal('-3')
4653 >>> ExtendedContext.min_mag(1, -2)
4654 Decimal('1')
4655 >>> ExtendedContext.min_mag(Decimal(1), -2)
4656 Decimal('1')
4657 >>> ExtendedContext.min_mag(1, Decimal(-2))
4658 Decimal('1')
4659 """
4660 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004661 return a.min_mag(b, context=self)
4662
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004663 def minus(self, a):
4664 """Minus corresponds to unary prefix minus in Python.
4665
4666 The operation is evaluated using the same rules as subtract; the
4667 operation minus(a) is calculated as subtract('0', a) where the '0'
4668 has the same exponent as the operand.
4669
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004670 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004671 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004672 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004673 Decimal('1.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004674 >>> ExtendedContext.minus(1)
4675 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004676 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004677 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004678 return a.__neg__(context=self)
4679
4680 def multiply(self, a, b):
4681 """multiply multiplies two operands.
4682
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004683 If either operand is a special value then the general rules apply.
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004684 Otherwise, the operands are multiplied together
4685 ('long multiplication'), resulting in a number which may be as long as
4686 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004687
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004688 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004689 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004690 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004691 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004692 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004693 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004694 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004695 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004696 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004697 Decimal('4.28135971E+11')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004698 >>> ExtendedContext.multiply(7, 7)
4699 Decimal('49')
4700 >>> ExtendedContext.multiply(Decimal(7), 7)
4701 Decimal('49')
4702 >>> ExtendedContext.multiply(7, Decimal(7))
4703 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004704 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004705 a = _convert_other(a, raiseit=True)
4706 r = a.__mul__(b, context=self)
4707 if r is NotImplemented:
4708 raise TypeError("Unable to convert %s to Decimal" % b)
4709 else:
4710 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004711
Facundo Batista353750c2007-09-13 18:13:15 +00004712 def next_minus(self, a):
4713 """Returns the largest representable number smaller than a.
4714
4715 >>> c = ExtendedContext.copy()
4716 >>> c.Emin = -999
4717 >>> c.Emax = 999
4718 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004719 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004720 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004721 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004722 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004723 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004724 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004725 Decimal('9.99999999E+999')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004726 >>> c.next_minus(1)
4727 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004728 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004729 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004730 return a.next_minus(context=self)
4731
4732 def next_plus(self, a):
4733 """Returns the smallest representable number larger than a.
4734
4735 >>> c = ExtendedContext.copy()
4736 >>> c.Emin = -999
4737 >>> c.Emax = 999
4738 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004739 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004740 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004741 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004742 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004743 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004744 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004745 Decimal('-9.99999999E+999')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004746 >>> c.next_plus(1)
4747 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004748 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004749 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004750 return a.next_plus(context=self)
4751
4752 def next_toward(self, a, b):
4753 """Returns the number closest to a, in direction towards b.
4754
4755 The result is the closest representable number from the first
4756 operand (but not the first operand) that is in the direction
4757 towards the second operand, unless the operands have the same
4758 value.
4759
4760 >>> c = ExtendedContext.copy()
4761 >>> c.Emin = -999
4762 >>> c.Emax = 999
4763 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004764 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004765 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004766 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004767 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004768 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004769 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004770 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004771 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004772 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004773 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004774 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004775 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004776 Decimal('-0.00')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004777 >>> c.next_toward(0, 1)
4778 Decimal('1E-1007')
4779 >>> c.next_toward(Decimal(0), 1)
4780 Decimal('1E-1007')
4781 >>> c.next_toward(0, Decimal(1))
4782 Decimal('1E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004783 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004784 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004785 return a.next_toward(b, context=self)
4786
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004787 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004788 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004789
4790 Essentially a plus operation with all trailing zeros removed from the
4791 result.
4792
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004793 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004794 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004795 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004796 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004797 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004798 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004799 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004800 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004801 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004802 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004803 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004804 Decimal('0')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004805 >>> ExtendedContext.normalize(6)
4806 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004807 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004808 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004809 return a.normalize(context=self)
4810
Facundo Batista353750c2007-09-13 18:13:15 +00004811 def number_class(self, a):
4812 """Returns an indication of the class of the operand.
4813
4814 The class is one of the following strings:
4815 -sNaN
4816 -NaN
4817 -Infinity
4818 -Normal
4819 -Subnormal
4820 -Zero
4821 +Zero
4822 +Subnormal
4823 +Normal
4824 +Infinity
4825
4826 >>> c = Context(ExtendedContext)
4827 >>> c.Emin = -999
4828 >>> c.Emax = 999
4829 >>> c.number_class(Decimal('Infinity'))
4830 '+Infinity'
4831 >>> c.number_class(Decimal('1E-10'))
4832 '+Normal'
4833 >>> c.number_class(Decimal('2.50'))
4834 '+Normal'
4835 >>> c.number_class(Decimal('0.1E-999'))
4836 '+Subnormal'
4837 >>> c.number_class(Decimal('0'))
4838 '+Zero'
4839 >>> c.number_class(Decimal('-0'))
4840 '-Zero'
4841 >>> c.number_class(Decimal('-0.1E-999'))
4842 '-Subnormal'
4843 >>> c.number_class(Decimal('-1E-10'))
4844 '-Normal'
4845 >>> c.number_class(Decimal('-2.50'))
4846 '-Normal'
4847 >>> c.number_class(Decimal('-Infinity'))
4848 '-Infinity'
4849 >>> c.number_class(Decimal('NaN'))
4850 'NaN'
4851 >>> c.number_class(Decimal('-NaN'))
4852 'NaN'
4853 >>> c.number_class(Decimal('sNaN'))
4854 'sNaN'
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004855 >>> c.number_class(123)
4856 '+Normal'
Facundo Batista353750c2007-09-13 18:13:15 +00004857 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004858 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004859 return a.number_class(context=self)
4860
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004861 def plus(self, a):
4862 """Plus corresponds to unary prefix plus in Python.
4863
4864 The operation is evaluated using the same rules as add; the
4865 operation plus(a) is calculated as add('0', a) where the '0'
4866 has the same exponent as the operand.
4867
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004868 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004869 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004870 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004871 Decimal('-1.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004872 >>> ExtendedContext.plus(-1)
4873 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004874 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004875 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004876 return a.__pos__(context=self)
4877
4878 def power(self, a, b, modulo=None):
4879 """Raises a to the power of b, to modulo if given.
4880
Facundo Batista353750c2007-09-13 18:13:15 +00004881 With two arguments, compute a**b. If a is negative then b
4882 must be integral. The result will be inexact unless b is
4883 integral and the result is finite and can be expressed exactly
4884 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004885
Facundo Batista353750c2007-09-13 18:13:15 +00004886 With three arguments, compute (a**b) % modulo. For the
4887 three argument form, the following restrictions on the
4888 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004889
Facundo Batista353750c2007-09-13 18:13:15 +00004890 - all three arguments must be integral
4891 - b must be nonnegative
4892 - at least one of a or b must be nonzero
4893 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004894
Facundo Batista353750c2007-09-13 18:13:15 +00004895 The result of pow(a, b, modulo) is identical to the result
4896 that would be obtained by computing (a**b) % modulo with
4897 unbounded precision, but is computed more efficiently. It is
4898 always exact.
4899
4900 >>> c = ExtendedContext.copy()
4901 >>> c.Emin = -999
4902 >>> c.Emax = 999
4903 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004904 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004905 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004906 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004907 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004908 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004909 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004910 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004911 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004912 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004913 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004914 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004915 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004916 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004917 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004918 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004919 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004920 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004921 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004922 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004923 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004924 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004925 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004926 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004927 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004928 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004929
4930 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004931 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004932 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004933 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00004934 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004935 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004936 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004937 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004938 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004939 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00004940 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004941 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004942 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004943 Decimal('1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004944 >>> ExtendedContext.power(7, 7)
4945 Decimal('823543')
4946 >>> ExtendedContext.power(Decimal(7), 7)
4947 Decimal('823543')
4948 >>> ExtendedContext.power(7, Decimal(7), 2)
4949 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004950 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004951 a = _convert_other(a, raiseit=True)
4952 r = a.__pow__(b, modulo, context=self)
4953 if r is NotImplemented:
4954 raise TypeError("Unable to convert %s to Decimal" % b)
4955 else:
4956 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004957
4958 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00004959 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004960
4961 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00004962 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004963 exponent is being increased), multiplied by a positive power of ten (if
4964 the exponent is being decreased), or is unchanged (if the exponent is
4965 already equal to that of the right-hand operand).
4966
4967 Unlike other operations, if the length of the coefficient after the
4968 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00004969 operation condition is raised. This guarantees that, unless there is
4970 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004971 equal to that of the right-hand operand.
4972
4973 Also unlike other operations, quantize will never raise Underflow, even
4974 if the result is subnormal and inexact.
4975
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004976 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004977 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004978 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004979 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004980 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004981 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004982 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004983 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004984 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004985 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004986 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004987 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004988 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004989 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004990 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004991 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004992 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004993 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004994 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004995 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004996 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004997 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004998 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004999 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005000 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005001 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005002 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005003 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005004 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005005 Decimal('2E+2')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005006 >>> ExtendedContext.quantize(1, 2)
5007 Decimal('1')
5008 >>> ExtendedContext.quantize(Decimal(1), 2)
5009 Decimal('1')
5010 >>> ExtendedContext.quantize(1, Decimal(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)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005014 return a.quantize(b, context=self)
5015
Facundo Batista353750c2007-09-13 18:13:15 +00005016 def radix(self):
5017 """Just returns 10, as this is Decimal, :)
5018
5019 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00005020 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00005021 """
5022 return Decimal(10)
5023
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005024 def remainder(self, a, b):
5025 """Returns the remainder from integer division.
5026
5027 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00005028 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00005029 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00005030 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005031
5032 This operation will fail under the same conditions as integer division
5033 (that is, if integer division on the same two operands would fail, the
5034 remainder cannot be calculated).
5035
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005036 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005037 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005038 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005039 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005040 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005041 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005042 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005043 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005044 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005045 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005046 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005047 Decimal('1.0')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005048 >>> ExtendedContext.remainder(22, 6)
5049 Decimal('4')
5050 >>> ExtendedContext.remainder(Decimal(22), 6)
5051 Decimal('4')
5052 >>> ExtendedContext.remainder(22, Decimal(6))
5053 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005054 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005055 a = _convert_other(a, raiseit=True)
5056 r = a.__mod__(b, context=self)
5057 if r is NotImplemented:
5058 raise TypeError("Unable to convert %s to Decimal" % b)
5059 else:
5060 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005061
5062 def remainder_near(self, a, b):
5063 """Returns to be "a - b * n", where n is the integer nearest the exact
5064 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00005065 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005066 sign of a.
5067
5068 This operation will fail under the same conditions as integer division
5069 (that is, if integer division on the same two operands would fail, the
5070 remainder cannot be calculated).
5071
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005072 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005073 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005074 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005075 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005076 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005077 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005078 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005079 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005080 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005081 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005082 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005083 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005084 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005085 Decimal('-0.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005086 >>> ExtendedContext.remainder_near(3, 11)
5087 Decimal('3')
5088 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5089 Decimal('3')
5090 >>> ExtendedContext.remainder_near(3, Decimal(11))
5091 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005092 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005093 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005094 return a.remainder_near(b, context=self)
5095
Facundo Batista353750c2007-09-13 18:13:15 +00005096 def rotate(self, a, b):
5097 """Returns a rotated copy of a, b times.
5098
5099 The coefficient of the result is a rotated copy of the digits in
5100 the coefficient of the first operand. The number of places of
5101 rotation is taken from the absolute value of the second operand,
5102 with the rotation being to the left if the second operand is
5103 positive or to the right otherwise.
5104
5105 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005106 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00005107 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005108 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00005109 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005110 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00005111 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005112 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00005113 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005114 Decimal('345678912')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005115 >>> ExtendedContext.rotate(1333333, 1)
5116 Decimal('13333330')
5117 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5118 Decimal('13333330')
5119 >>> ExtendedContext.rotate(1333333, Decimal(1))
5120 Decimal('13333330')
Facundo Batista353750c2007-09-13 18:13:15 +00005121 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005122 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005123 return a.rotate(b, context=self)
5124
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005125 def same_quantum(self, a, b):
5126 """Returns True if the two operands have the same exponent.
5127
5128 The result is never affected by either the sign or the coefficient of
5129 either operand.
5130
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005131 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005132 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005133 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005134 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005135 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005136 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005137 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005138 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005139 >>> ExtendedContext.same_quantum(10000, -1)
5140 True
5141 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5142 True
5143 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5144 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005145 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005146 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005147 return a.same_quantum(b)
5148
Facundo Batista353750c2007-09-13 18:13:15 +00005149 def scaleb (self, a, b):
5150 """Returns the first operand after adding the second value its exp.
5151
5152 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005153 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00005154 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005155 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00005156 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005157 Decimal('7.50E+3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005158 >>> ExtendedContext.scaleb(1, 4)
5159 Decimal('1E+4')
5160 >>> ExtendedContext.scaleb(Decimal(1), 4)
5161 Decimal('1E+4')
5162 >>> ExtendedContext.scaleb(1, Decimal(4))
5163 Decimal('1E+4')
Facundo Batista353750c2007-09-13 18:13:15 +00005164 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005165 a = _convert_other(a, raiseit=True)
5166 return a.scaleb(b, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00005167
5168 def shift(self, a, b):
5169 """Returns a shifted copy of a, b times.
5170
5171 The coefficient of the result is a shifted copy of the digits
5172 in the coefficient of the first operand. The number of places
5173 to shift is taken from the absolute value of the second operand,
5174 with the shift being to the left if the second operand is
5175 positive or to the right otherwise. Digits shifted into the
5176 coefficient are zeros.
5177
5178 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005179 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00005180 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005181 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00005182 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005183 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00005184 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005185 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00005186 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005187 Decimal('345678900')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005188 >>> ExtendedContext.shift(88888888, 2)
5189 Decimal('888888800')
5190 >>> ExtendedContext.shift(Decimal(88888888), 2)
5191 Decimal('888888800')
5192 >>> ExtendedContext.shift(88888888, Decimal(2))
5193 Decimal('888888800')
Facundo Batista353750c2007-09-13 18:13:15 +00005194 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005195 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005196 return a.shift(b, context=self)
5197
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005198 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00005199 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005200
5201 If the result must be inexact, it is rounded using the round-half-even
5202 algorithm.
5203
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005204 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005205 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005206 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005207 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005208 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005209 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005210 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005211 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005212 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005213 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005214 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005215 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005216 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005217 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005218 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005219 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005220 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005221 Decimal('3.16227766')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005222 >>> ExtendedContext.sqrt(2)
5223 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005224 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005225 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005226 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005227 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005228 return a.sqrt(context=self)
5229
5230 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005231 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005232
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005233 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005234 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005235 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005236 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005237 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005238 Decimal('-0.77')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005239 >>> ExtendedContext.subtract(8, 5)
5240 Decimal('3')
5241 >>> ExtendedContext.subtract(Decimal(8), 5)
5242 Decimal('3')
5243 >>> ExtendedContext.subtract(8, Decimal(5))
5244 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005245 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005246 a = _convert_other(a, raiseit=True)
5247 r = a.__sub__(b, context=self)
5248 if r is NotImplemented:
5249 raise TypeError("Unable to convert %s to Decimal" % b)
5250 else:
5251 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005252
5253 def to_eng_string(self, a):
5254 """Converts a number to a string, using scientific notation.
5255
5256 The operation is not affected by the context.
5257 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005258 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005259 return a.to_eng_string(context=self)
5260
5261 def to_sci_string(self, a):
5262 """Converts a number to a string, using scientific notation.
5263
5264 The operation is not affected by the context.
5265 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005266 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005267 return a.__str__(context=self)
5268
Facundo Batista353750c2007-09-13 18:13:15 +00005269 def to_integral_exact(self, a):
5270 """Rounds to an integer.
5271
5272 When the operand has a negative exponent, the result is the same
5273 as using the quantize() operation using the given operand as the
5274 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5275 of the operand as the precision setting; Inexact and Rounded flags
5276 are allowed in this operation. The rounding mode is taken from the
5277 context.
5278
5279 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005280 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00005281 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005282 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005283 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005284 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005285 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005286 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00005287 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005288 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00005289 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005290 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00005291 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005292 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00005293 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005294 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005295 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005296 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005297 return a.to_integral_exact(context=self)
5298
5299 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005300 """Rounds to an integer.
5301
5302 When the operand has a negative exponent, the result is the same
5303 as using the quantize() operation using the given operand as the
5304 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5305 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00005306 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005307
Facundo Batista353750c2007-09-13 18:13:15 +00005308 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005309 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00005310 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005311 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005312 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005313 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005314 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005315 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00005316 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005317 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00005318 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005319 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00005320 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005321 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00005322 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005323 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005324 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005325 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005326 return a.to_integral_value(context=self)
5327
5328 # the method name changed, but we provide also the old one, for compatibility
5329 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005330
5331class _WorkRep(object):
5332 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005333 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005334 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005335 # exp: None, int, or string
5336
5337 def __init__(self, value=None):
5338 if value is None:
5339 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005340 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005341 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005342 elif isinstance(value, Decimal):
5343 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00005344 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005345 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005346 else:
5347 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005348 self.sign = value[0]
5349 self.int = value[1]
5350 self.exp = value[2]
5351
5352 def __repr__(self):
5353 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5354
5355 __str__ = __repr__
5356
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005357
5358
Facundo Batistae64acfa2007-12-17 14:18:42 +00005359def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005360 """Normalizes op1, op2 to have the same exp and length of coefficient.
5361
5362 Done during addition.
5363 """
Facundo Batista353750c2007-09-13 18:13:15 +00005364 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005365 tmp = op2
5366 other = op1
5367 else:
5368 tmp = op1
5369 other = op2
5370
Facundo Batista353750c2007-09-13 18:13:15 +00005371 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5372 # Then adding 10**exp to tmp has the same effect (after rounding)
5373 # as adding any positive quantity smaller than 10**exp; similarly
5374 # for subtraction. So if other is smaller than 10**exp we replace
5375 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00005376 tmp_len = len(str(tmp.int))
5377 other_len = len(str(other.int))
5378 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5379 if other_len + other.exp - 1 < exp:
5380 other.int = 1
5381 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005382
Facundo Batista353750c2007-09-13 18:13:15 +00005383 tmp.int *= 10 ** (tmp.exp - other.exp)
5384 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005385 return op1, op2
5386
Facundo Batista353750c2007-09-13 18:13:15 +00005387##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
5388
5389# This function from Tim Peters was taken from here:
5390# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5391# The correction being in the function definition is for speed, and
5392# the whole function is not resolved with math.log because of avoiding
5393# the use of floats.
5394def _nbits(n, correction = {
5395 '0': 4, '1': 3, '2': 2, '3': 2,
5396 '4': 1, '5': 1, '6': 1, '7': 1,
5397 '8': 0, '9': 0, 'a': 0, 'b': 0,
5398 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5399 """Number of bits in binary representation of the positive integer n,
5400 or 0 if n == 0.
5401 """
5402 if n < 0:
5403 raise ValueError("The argument to _nbits should be nonnegative.")
5404 hex_n = "%x" % n
5405 return 4*len(hex_n) - correction[hex_n[0]]
5406
5407def _sqrt_nearest(n, a):
5408 """Closest integer to the square root of the positive integer n. a is
5409 an initial approximation to the square root. Any positive integer
5410 will do for a, but the closer a is to the square root of n the
5411 faster convergence will be.
5412
5413 """
5414 if n <= 0 or a <= 0:
5415 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5416
5417 b=0
5418 while a != b:
5419 b, a = a, a--n//a>>1
5420 return a
5421
5422def _rshift_nearest(x, shift):
5423 """Given an integer x and a nonnegative integer shift, return closest
5424 integer to x / 2**shift; use round-to-even in case of a tie.
5425
5426 """
5427 b, q = 1L << shift, x >> shift
5428 return q + (2*(x & (b-1)) + (q&1) > b)
5429
5430def _div_nearest(a, b):
5431 """Closest integer to a/b, a and b positive integers; rounds to even
5432 in the case of a tie.
5433
5434 """
5435 q, r = divmod(a, b)
5436 return q + (2*r + (q&1) > b)
5437
5438def _ilog(x, M, L = 8):
5439 """Integer approximation to M*log(x/M), with absolute error boundable
5440 in terms only of x/M.
5441
5442 Given positive integers x and M, return an integer approximation to
5443 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5444 between the approximation and the exact result is at most 22. For
5445 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5446 both cases these are upper bounds on the error; it will usually be
5447 much smaller."""
5448
5449 # The basic algorithm is the following: let log1p be the function
5450 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5451 # the reduction
5452 #
5453 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5454 #
5455 # repeatedly until the argument to log1p is small (< 2**-L in
5456 # absolute value). For small y we can use the Taylor series
5457 # expansion
5458 #
5459 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5460 #
5461 # truncating at T such that y**T is small enough. The whole
5462 # computation is carried out in a form of fixed-point arithmetic,
5463 # with a real number z being represented by an integer
5464 # approximation to z*M. To avoid loss of precision, the y below
5465 # is actually an integer approximation to 2**R*y*M, where R is the
5466 # number of reductions performed so far.
5467
5468 y = x-M
5469 # argument reduction; R = number of reductions performed
5470 R = 0
5471 while (R <= L and long(abs(y)) << L-R >= M or
5472 R > L and abs(y) >> R-L >= M):
5473 y = _div_nearest(long(M*y) << 1,
5474 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5475 R += 1
5476
5477 # Taylor series with T terms
5478 T = -int(-10*len(str(M))//(3*L))
5479 yshift = _rshift_nearest(y, R)
5480 w = _div_nearest(M, T)
5481 for k in xrange(T-1, 0, -1):
5482 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5483
5484 return _div_nearest(w*y, M)
5485
5486def _dlog10(c, e, p):
5487 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5488 approximation to 10**p * log10(c*10**e), with an absolute error of
5489 at most 1. Assumes that c*10**e is not exactly 1."""
5490
5491 # increase precision by 2; compensate for this by dividing
5492 # final result by 100
5493 p += 2
5494
5495 # write c*10**e as d*10**f with either:
5496 # f >= 0 and 1 <= d <= 10, or
5497 # f <= 0 and 0.1 <= d <= 1.
5498 # Thus for c*10**e close to 1, f = 0
5499 l = len(str(c))
5500 f = e+l - (e+l >= 1)
5501
5502 if p > 0:
5503 M = 10**p
5504 k = e+p-f
5505 if k >= 0:
5506 c *= 10**k
5507 else:
5508 c = _div_nearest(c, 10**-k)
5509
5510 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005511 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005512 log_d = _div_nearest(log_d*M, log_10)
5513 log_tenpower = f*M # exact
5514 else:
5515 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005516 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005517
5518 return _div_nearest(log_tenpower+log_d, 100)
5519
5520def _dlog(c, e, p):
5521 """Given integers c, e and p with c > 0, compute an integer
5522 approximation to 10**p * log(c*10**e), with an absolute error of
5523 at most 1. Assumes that c*10**e is not exactly 1."""
5524
5525 # Increase precision by 2. The precision increase is compensated
5526 # for at the end with a division by 100.
5527 p += 2
5528
5529 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5530 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5531 # as 10**p * log(d) + 10**p*f * log(10).
5532 l = len(str(c))
5533 f = e+l - (e+l >= 1)
5534
5535 # compute approximation to 10**p*log(d), with error < 27
5536 if p > 0:
5537 k = e+p-f
5538 if k >= 0:
5539 c *= 10**k
5540 else:
5541 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5542
5543 # _ilog magnifies existing error in c by a factor of at most 10
5544 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5545 else:
5546 # p <= 0: just approximate the whole thing by 0; error < 2.31
5547 log_d = 0
5548
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005549 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005550 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005551 extra = len(str(abs(f)))-1
5552 if p + extra >= 0:
5553 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5554 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5555 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005556 else:
5557 f_log_ten = 0
5558 else:
5559 f_log_ten = 0
5560
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005561 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005562 return _div_nearest(f_log_ten + log_d, 100)
5563
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005564class _Log10Memoize(object):
5565 """Class to compute, store, and allow retrieval of, digits of the
5566 constant log(10) = 2.302585.... This constant is needed by
5567 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5568 def __init__(self):
5569 self.digits = "23025850929940456840179914546843642076011014886"
5570
5571 def getdigits(self, p):
5572 """Given an integer p >= 0, return floor(10**p)*log(10).
5573
5574 For example, self.getdigits(3) returns 2302.
5575 """
5576 # digits are stored as a string, for quick conversion to
5577 # integer in the case that we've already computed enough
5578 # digits; the stored digits should always be correct
5579 # (truncated, not rounded to nearest).
5580 if p < 0:
5581 raise ValueError("p should be nonnegative")
5582
5583 if p >= len(self.digits):
5584 # compute p+3, p+6, p+9, ... digits; continue until at
5585 # least one of the extra digits is nonzero
5586 extra = 3
5587 while True:
5588 # compute p+extra digits, correct to within 1ulp
5589 M = 10**(p+extra+2)
5590 digits = str(_div_nearest(_ilog(10*M, M), 100))
5591 if digits[-extra:] != '0'*extra:
5592 break
5593 extra += 3
5594 # keep all reliable digits so far; remove trailing zeros
5595 # and next nonzero digit
5596 self.digits = digits.rstrip('0')[:-1]
5597 return int(self.digits[:p+1])
5598
5599_log10_digits = _Log10Memoize().getdigits
5600
Facundo Batista353750c2007-09-13 18:13:15 +00005601def _iexp(x, M, L=8):
5602 """Given integers x and M, M > 0, such that x/M is small in absolute
5603 value, compute an integer approximation to M*exp(x/M). For 0 <=
5604 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5605 is usually much smaller)."""
5606
5607 # Algorithm: to compute exp(z) for a real number z, first divide z
5608 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5609 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5610 # series
5611 #
5612 # expm1(x) = x + x**2/2! + x**3/3! + ...
5613 #
5614 # Now use the identity
5615 #
5616 # expm1(2x) = expm1(x)*(expm1(x)+2)
5617 #
5618 # R times to compute the sequence expm1(z/2**R),
5619 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5620
5621 # Find R such that x/2**R/M <= 2**-L
5622 R = _nbits((long(x)<<L)//M)
5623
5624 # Taylor series. (2**L)**T > M
5625 T = -int(-10*len(str(M))//(3*L))
5626 y = _div_nearest(x, T)
5627 Mshift = long(M)<<R
5628 for i in xrange(T-1, 0, -1):
5629 y = _div_nearest(x*(Mshift + y), Mshift * i)
5630
5631 # Expansion
5632 for k in xrange(R-1, -1, -1):
5633 Mshift = long(M)<<(k+2)
5634 y = _div_nearest(y*(y+Mshift), Mshift)
5635
5636 return M+y
5637
5638def _dexp(c, e, p):
5639 """Compute an approximation to exp(c*10**e), with p decimal places of
5640 precision.
5641
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005642 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005643
5644 10**(p-1) <= d <= 10**p, and
5645 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5646
5647 In other words, d*10**f is an approximation to exp(c*10**e) with p
5648 digits of precision, and with an error in d of at most 1. This is
5649 almost, but not quite, the same as the error being < 1ulp: when d
5650 = 10**(p-1) the error could be up to 10 ulp."""
5651
5652 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5653 p += 2
5654
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005655 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005656 extra = max(0, e + len(str(c)) - 1)
5657 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005658
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005659 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005660 # rounding down
5661 shift = e+q
5662 if shift >= 0:
5663 cshift = c*10**shift
5664 else:
5665 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005666 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005667
5668 # reduce remainder back to original precision
5669 rem = _div_nearest(rem, 10**extra)
5670
5671 # error in result of _iexp < 120; error after division < 0.62
5672 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5673
5674def _dpower(xc, xe, yc, ye, p):
5675 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5676 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5677
5678 10**(p-1) <= c <= 10**p, and
5679 (c-1)*10**e < x**y < (c+1)*10**e
5680
5681 in other words, c*10**e is an approximation to x**y with p digits
5682 of precision, and with an error in c of at most 1. (This is
5683 almost, but not quite, the same as the error being < 1ulp: when c
5684 == 10**(p-1) we can only guarantee error < 10ulp.)
5685
5686 We assume that: x is positive and not equal to 1, and y is nonzero.
5687 """
5688
5689 # Find b such that 10**(b-1) <= |y| <= 10**b
5690 b = len(str(abs(yc))) + ye
5691
5692 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5693 lxc = _dlog(xc, xe, p+b+1)
5694
5695 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5696 shift = ye-b
5697 if shift >= 0:
5698 pc = lxc*yc*10**shift
5699 else:
5700 pc = _div_nearest(lxc*yc, 10**-shift)
5701
5702 if pc == 0:
5703 # we prefer a result that isn't exactly 1; this makes it
5704 # easier to compute a correctly rounded result in __pow__
5705 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5706 coeff, exp = 10**(p-1)+1, 1-p
5707 else:
5708 coeff, exp = 10**p-1, -p
5709 else:
5710 coeff, exp = _dexp(pc, -(p+1), p+1)
5711 coeff = _div_nearest(coeff, 10)
5712 exp += 1
5713
5714 return coeff, exp
5715
5716def _log10_lb(c, correction = {
5717 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5718 '6': 23, '7': 16, '8': 10, '9': 5}):
5719 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5720 if c <= 0:
5721 raise ValueError("The argument to _log10_lb should be nonnegative.")
5722 str_c = str(c)
5723 return 100*len(str_c) - correction[str_c[0]]
5724
Facundo Batista59c58842007-04-10 12:58:45 +00005725##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005726
Mark Dickinson99d80962010-04-02 08:53:22 +00005727def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005728 """Convert other to Decimal.
5729
5730 Verifies that it's ok to use in an implicit construction.
Mark Dickinson99d80962010-04-02 08:53:22 +00005731 If allow_float is true, allow conversion from float; this
5732 is used in the comparison methods (__eq__ and friends).
5733
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005734 """
5735 if isinstance(other, Decimal):
5736 return other
5737 if isinstance(other, (int, long)):
5738 return Decimal(other)
Mark Dickinson99d80962010-04-02 08:53:22 +00005739 if allow_float and isinstance(other, float):
5740 return Decimal.from_float(other)
5741
Facundo Batista353750c2007-09-13 18:13:15 +00005742 if raiseit:
5743 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005744 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005745
Facundo Batista59c58842007-04-10 12:58:45 +00005746##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005747
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005748# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005749# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005750
5751DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005752 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005753 traps=[DivisionByZero, Overflow, InvalidOperation],
5754 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005755 Emax=999999999,
5756 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005757 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005758)
5759
5760# Pre-made alternate contexts offered by the specification
5761# Don't change these; the user should be able to select these
5762# contexts and be able to reproduce results from other implementations
5763# of the spec.
5764
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005765BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005766 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005767 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5768 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005769)
5770
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005771ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005772 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005773 traps=[],
5774 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005775)
5776
5777
Facundo Batista72bc54f2007-11-23 17:59:00 +00005778##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005779#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005780# Regular expression used for parsing numeric strings. Additional
5781# comments:
5782#
5783# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5784# whitespace. But note that the specification disallows whitespace in
5785# a numeric string.
5786#
5787# 2. For finite numbers (not infinities and NaNs) the body of the
5788# number between the optional sign and the optional exponent must have
5789# at least one decimal digit, possibly after the decimal point. The
5790# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005791
5792import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005793_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005794# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005795 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005796 (
Mark Dickinson4326ad82009-08-02 10:59:36 +00005797 (?=\d|\.\d) # ...a number (with at least one digit)
5798 (?P<int>\d*) # having a (possibly empty) integer part
5799 (\.(?P<frac>\d*))? # followed by an optional fractional part
5800 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005801 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005802 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005803 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005804 (?P<signal>s)? # ...an (optionally signaling)
5805 NaN # NaN
Mark Dickinson4326ad82009-08-02 10:59:36 +00005806 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005807 )
5808# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005809 \Z
Mark Dickinson4326ad82009-08-02 10:59:36 +00005810""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005811
Facundo Batista2ec74152007-12-03 17:55:00 +00005812_all_zeros = re.compile('0*$').match
5813_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005814
5815##### PEP3101 support functions ##############################################
Mark Dickinson277859d2009-03-17 23:03:46 +00005816# The functions in this section have little to do with the Decimal
5817# class, and could potentially be reused or adapted for other pure
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005818# Python numeric classes that want to implement __format__
5819#
5820# A format specifier for Decimal looks like:
5821#
Mark Dickinson277859d2009-03-17 23:03:46 +00005822# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005823
5824_parse_format_specifier_regex = re.compile(r"""\A
5825(?:
5826 (?P<fill>.)?
5827 (?P<align>[<>=^])
5828)?
5829(?P<sign>[-+ ])?
5830(?P<zeropad>0)?
5831(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson277859d2009-03-17 23:03:46 +00005832(?P<thousands_sep>,)?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005833(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson277859d2009-03-17 23:03:46 +00005834(?P<type>[eEfFgGn%])?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005835\Z
5836""", re.VERBOSE)
5837
Facundo Batista72bc54f2007-11-23 17:59:00 +00005838del re
5839
Mark Dickinson277859d2009-03-17 23:03:46 +00005840# The locale module is only needed for the 'n' format specifier. The
5841# rest of the PEP 3101 code functions quite happily without it, so we
5842# don't care too much if locale isn't present.
5843try:
5844 import locale as _locale
5845except ImportError:
5846 pass
5847
5848def _parse_format_specifier(format_spec, _localeconv=None):
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005849 """Parse and validate a format specifier.
5850
5851 Turns a standard numeric format specifier into a dict, with the
5852 following entries:
5853
5854 fill: fill character to pad field to minimum width
5855 align: alignment type, either '<', '>', '=' or '^'
5856 sign: either '+', '-' or ' '
5857 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson277859d2009-03-17 23:03:46 +00005858 zeropad: boolean, indicating whether to pad with zeros
5859 thousands_sep: string to use as thousands separator, or ''
5860 grouping: grouping for thousands separators, in format
5861 used by localeconv
5862 decimal_point: string to use for decimal point
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005863 precision: nonnegative integer giving precision, or None
5864 type: one of the characters 'eEfFgG%', or None
Mark Dickinson277859d2009-03-17 23:03:46 +00005865 unicode: boolean (always True for Python 3.x)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005866
5867 """
5868 m = _parse_format_specifier_regex.match(format_spec)
5869 if m is None:
5870 raise ValueError("Invalid format specifier: " + format_spec)
5871
5872 # get the dictionary
5873 format_dict = m.groupdict()
5874
Mark Dickinson277859d2009-03-17 23:03:46 +00005875 # zeropad; defaults for fill and alignment. If zero padding
5876 # is requested, the fill and align fields should be absent.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005877 fill = format_dict['fill']
5878 align = format_dict['align']
Mark Dickinson277859d2009-03-17 23:03:46 +00005879 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5880 if format_dict['zeropad']:
5881 if fill is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005882 raise ValueError("Fill character conflicts with '0'"
5883 " in format specifier: " + format_spec)
Mark Dickinson277859d2009-03-17 23:03:46 +00005884 if align is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005885 raise ValueError("Alignment conflicts with '0' in "
5886 "format specifier: " + format_spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005887 format_dict['fill'] = fill or ' '
Mark Dickinson5cfa8042009-09-08 20:20:19 +00005888 # PEP 3101 originally specified that the default alignment should
5889 # be left; it was later agreed that right-aligned makes more sense
5890 # for numeric types. See http://bugs.python.org/issue6857.
5891 format_dict['align'] = align or '>'
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005892
Mark Dickinson277859d2009-03-17 23:03:46 +00005893 # default sign handling: '-' for negative, '' for positive
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005894 if format_dict['sign'] is None:
5895 format_dict['sign'] = '-'
5896
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005897 # minimumwidth defaults to 0; precision remains None if not given
5898 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5899 if format_dict['precision'] is not None:
5900 format_dict['precision'] = int(format_dict['precision'])
5901
5902 # if format type is 'g' or 'G' then a precision of 0 makes little
5903 # sense; convert it to 1. Same if format type is unspecified.
5904 if format_dict['precision'] == 0:
Mark Dickinson491ea552009-09-07 16:17:41 +00005905 if format_dict['type'] is None or format_dict['type'] in 'gG':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005906 format_dict['precision'] = 1
5907
Mark Dickinson277859d2009-03-17 23:03:46 +00005908 # determine thousands separator, grouping, and decimal separator, and
5909 # add appropriate entries to format_dict
5910 if format_dict['type'] == 'n':
5911 # apart from separators, 'n' behaves just like 'g'
5912 format_dict['type'] = 'g'
5913 if _localeconv is None:
5914 _localeconv = _locale.localeconv()
5915 if format_dict['thousands_sep'] is not None:
5916 raise ValueError("Explicit thousands separator conflicts with "
5917 "'n' type in format specifier: " + format_spec)
5918 format_dict['thousands_sep'] = _localeconv['thousands_sep']
5919 format_dict['grouping'] = _localeconv['grouping']
5920 format_dict['decimal_point'] = _localeconv['decimal_point']
5921 else:
5922 if format_dict['thousands_sep'] is None:
5923 format_dict['thousands_sep'] = ''
5924 format_dict['grouping'] = [3, 0]
5925 format_dict['decimal_point'] = '.'
5926
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005927 # record whether return type should be str or unicode
5928 format_dict['unicode'] = isinstance(format_spec, unicode)
5929
5930 return format_dict
5931
Mark Dickinson277859d2009-03-17 23:03:46 +00005932def _format_align(sign, body, spec):
5933 """Given an unpadded, non-aligned numeric string 'body' and sign
5934 string 'sign', add padding and aligment conforming to the given
5935 format specifier dictionary 'spec' (as produced by
5936 parse_format_specifier).
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005937
Mark Dickinson277859d2009-03-17 23:03:46 +00005938 Also converts result to unicode if necessary.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005939
5940 """
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005941 # how much extra space do we have to play with?
Mark Dickinson277859d2009-03-17 23:03:46 +00005942 minimumwidth = spec['minimumwidth']
5943 fill = spec['fill']
5944 padding = fill*(minimumwidth - len(sign) - len(body))
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005945
Mark Dickinson277859d2009-03-17 23:03:46 +00005946 align = spec['align']
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005947 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005948 result = sign + body + padding
Mark Dickinsonb065e522009-03-17 18:01:03 +00005949 elif align == '>':
5950 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005951 elif align == '=':
5952 result = sign + padding + body
Mark Dickinson277859d2009-03-17 23:03:46 +00005953 elif align == '^':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005954 half = len(padding)//2
5955 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson277859d2009-03-17 23:03:46 +00005956 else:
5957 raise ValueError('Unrecognised alignment field')
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005958
5959 # make sure that result is unicode if necessary
Mark Dickinson277859d2009-03-17 23:03:46 +00005960 if spec['unicode']:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005961 result = unicode(result)
5962
5963 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00005964
Mark Dickinson277859d2009-03-17 23:03:46 +00005965def _group_lengths(grouping):
5966 """Convert a localeconv-style grouping into a (possibly infinite)
5967 iterable of integers representing group lengths.
5968
5969 """
5970 # The result from localeconv()['grouping'], and the input to this
5971 # function, should be a list of integers in one of the
5972 # following three forms:
5973 #
5974 # (1) an empty list, or
5975 # (2) nonempty list of positive integers + [0]
5976 # (3) list of positive integers + [locale.CHAR_MAX], or
5977
5978 from itertools import chain, repeat
5979 if not grouping:
5980 return []
5981 elif grouping[-1] == 0 and len(grouping) >= 2:
5982 return chain(grouping[:-1], repeat(grouping[-2]))
5983 elif grouping[-1] == _locale.CHAR_MAX:
5984 return grouping[:-1]
5985 else:
5986 raise ValueError('unrecognised format for grouping')
5987
5988def _insert_thousands_sep(digits, spec, min_width=1):
5989 """Insert thousands separators into a digit string.
5990
5991 spec is a dictionary whose keys should include 'thousands_sep' and
5992 'grouping'; typically it's the result of parsing the format
5993 specifier using _parse_format_specifier.
5994
5995 The min_width keyword argument gives the minimum length of the
5996 result, which will be padded on the left with zeros if necessary.
5997
5998 If necessary, the zero padding adds an extra '0' on the left to
5999 avoid a leading thousands separator. For example, inserting
6000 commas every three digits in '123456', with min_width=8, gives
6001 '0,123,456', even though that has length 9.
6002
6003 """
6004
6005 sep = spec['thousands_sep']
6006 grouping = spec['grouping']
6007
6008 groups = []
6009 for l in _group_lengths(grouping):
Mark Dickinson277859d2009-03-17 23:03:46 +00006010 if l <= 0:
6011 raise ValueError("group length should be positive")
6012 # max(..., 1) forces at least 1 digit to the left of a separator
6013 l = min(max(len(digits), min_width, 1), l)
6014 groups.append('0'*(l - len(digits)) + digits[-l:])
6015 digits = digits[:-l]
6016 min_width -= l
6017 if not digits and min_width <= 0:
6018 break
Mark Dickinsonb14514a2009-03-18 08:22:51 +00006019 min_width -= len(sep)
Mark Dickinson277859d2009-03-17 23:03:46 +00006020 else:
6021 l = max(len(digits), min_width, 1)
6022 groups.append('0'*(l - len(digits)) + digits[-l:])
6023 return sep.join(reversed(groups))
6024
6025def _format_sign(is_negative, spec):
6026 """Determine sign character."""
6027
6028 if is_negative:
6029 return '-'
6030 elif spec['sign'] in ' +':
6031 return spec['sign']
6032 else:
6033 return ''
6034
6035def _format_number(is_negative, intpart, fracpart, exp, spec):
6036 """Format a number, given the following data:
6037
6038 is_negative: true if the number is negative, else false
6039 intpart: string of digits that must appear before the decimal point
6040 fracpart: string of digits that must come after the point
6041 exp: exponent, as an integer
6042 spec: dictionary resulting from parsing the format specifier
6043
6044 This function uses the information in spec to:
6045 insert separators (decimal separator and thousands separators)
6046 format the sign
6047 format the exponent
6048 add trailing '%' for the '%' type
6049 zero-pad if necessary
6050 fill and align if necessary
6051 """
6052
6053 sign = _format_sign(is_negative, spec)
6054
6055 if fracpart:
6056 fracpart = spec['decimal_point'] + fracpart
6057
6058 if exp != 0 or spec['type'] in 'eE':
6059 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6060 fracpart += "{0}{1:+}".format(echar, exp)
6061 if spec['type'] == '%':
6062 fracpart += '%'
6063
6064 if spec['zeropad']:
6065 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6066 else:
6067 min_width = 0
6068 intpart = _insert_thousands_sep(intpart, spec, min_width)
6069
6070 return _format_align(sign, intpart+fracpart, spec)
6071
6072
Facundo Batista59c58842007-04-10 12:58:45 +00006073##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006074
Facundo Batista59c58842007-04-10 12:58:45 +00006075# Reusable defaults
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006076_Infinity = Decimal('Inf')
6077_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonc5de0962009-01-02 23:07:08 +00006078_NaN = Decimal('NaN')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006079_Zero = Decimal(0)
6080_One = Decimal(1)
6081_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006082
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006083# _SignedInfinity[sign] is infinity w/ that sign
6084_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006085
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006086
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006087
6088if __name__ == '__main__':
6089 import doctest, sys
6090 doctest.testmod(sys.modules[__name__])