blob: 19cc50f9dbb07994e0203b1523ceea40ecace8d3 [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
Raymond Hettinger8a9369b2011-08-24 19:13:17 -070024 http://speleotrove.com/decimal/decarith.html
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000025
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000026and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000027
Senthil Kumaran023c3e72013-09-07 23:18:53 -070028 http://en.wikipedia.org/wiki/IEEE_854-1987
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000029
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030Decimal floating point has finite precision with arbitrarily large bounds.
31
Facundo Batista59c58842007-04-10 12:58:45 +000032The purpose of this module is to support arithmetic using familiar
33"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000034issues associated with binary floating point. The package is especially
35useful for financial applications or for contexts where users have
36expectations that are at odds with binary floating point (for instance,
37in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Raymond Hettingerabe32372008-02-14 02:41:22 +000038of the expected Decimal('0.00') returned by decimal floating point).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000039
40Here are some examples of using the decimal module:
41
42>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000043>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000044>>> Decimal(0)
Raymond Hettingerabe32372008-02-14 02:41:22 +000045Decimal('0')
46>>> Decimal('1')
47Decimal('1')
48>>> Decimal('-.0123')
49Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000050>>> Decimal(123456)
Raymond Hettingerabe32372008-02-14 02:41:22 +000051Decimal('123456')
52>>> Decimal('123.45e12345678901234567890')
53Decimal('1.2345E+12345678901234567892')
54>>> Decimal('1.33') + Decimal('1.27')
55Decimal('2.60')
56>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
57Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000058>>> dig = Decimal(1)
59>>> print dig / Decimal(3)
600.333333333
61>>> getcontext().prec = 18
62>>> print dig / Decimal(3)
630.333333333333333333
64>>> print dig.sqrt()
651
66>>> print Decimal(3).sqrt()
671.73205080756887729
68>>> print Decimal(3) ** 123
694.85192780976896427E+58
70>>> inf = Decimal(1) / Decimal(0)
71>>> print inf
72Infinity
73>>> neginf = Decimal(-1) / Decimal(0)
74>>> print neginf
75-Infinity
76>>> print neginf + inf
77NaN
78>>> print neginf * inf
79-Infinity
80>>> print dig / 0
81Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000082>>> getcontext().traps[DivisionByZero] = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000083>>> print dig / 0
84Traceback (most recent call last):
85 ...
86 ...
87 ...
88DivisionByZero: x / 0
89>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000090>>> c.traps[InvalidOperation] = 0
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000091>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
93>>> c.divide(Decimal(0), Decimal(0))
Raymond Hettingerabe32372008-02-14 02:41:22 +000094Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000095>>> c.traps[InvalidOperation] = 1
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000096>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000971
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000098>>> c.flags[InvalidOperation] = 0
99>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000
101>>> print c.divide(Decimal(0), Decimal(0))
102Traceback (most recent call last):
103 ...
104 ...
105 ...
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000106InvalidOperation: 0 / 0
107>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001081
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000109>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000110>>> c.traps[InvalidOperation] = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000111>>> print c.divide(Decimal(0), Decimal(0))
112NaN
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000113>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001141
115>>>
116"""
117
118__all__ = [
119 # Two major classes
120 'Decimal', 'Context',
121
122 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000123 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000124
125 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000126 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
127 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000128
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000129 # Constants for use in setting up contexts
130 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Facundo Batista353750c2007-09-13 18:13:15 +0000131 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000132
133 # Functions for manipulating contexts
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000134 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000135]
136
Raymond Hettingera016deb2009-04-27 21:12:27 +0000137__version__ = '1.70' # Highest version of the spec this complies with
Raymond Hettingerdaeceb22009-03-10 04:49:21 +0000138
Raymond Hettingereb260842005-06-07 18:52:34 +0000139import copy as _copy
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000140import math as _math
Raymond Hettinger2c8585b2009-02-03 03:37:03 +0000141import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000142
Raymond Hettinger097a1902008-01-11 02:24:13 +0000143try:
144 from collections import namedtuple as _namedtuple
145 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
146except ImportError:
147 DecimalTuple = lambda *args: args
148
Facundo Batista59c58842007-04-10 12:58:45 +0000149# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000150ROUND_DOWN = 'ROUND_DOWN'
151ROUND_HALF_UP = 'ROUND_HALF_UP'
152ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
153ROUND_CEILING = 'ROUND_CEILING'
154ROUND_FLOOR = 'ROUND_FLOOR'
155ROUND_UP = 'ROUND_UP'
156ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Facundo Batista353750c2007-09-13 18:13:15 +0000157ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000158
Facundo Batista59c58842007-04-10 12:58:45 +0000159# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000160
161class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000162 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000163
164 Used exceptions derive from this.
165 If an exception derives from another exception besides this (such as
166 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
167 called if the others are present. This isn't actually used for
168 anything, though.
169
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000170 handle -- Called when context._raise_error is called and the
Stefan Krah8a6f3fe2010-05-19 15:46:39 +0000171 trap_enabler is not set. First argument is self, second is the
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000172 context. More arguments can be given, those being after
173 the explanation in _raise_error (For example,
174 context._raise_error(NewError, '(-x)!', self._sign) would
175 call NewError().handle(context, self._sign).)
176
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000177 To define a new exception, it should be sufficient to have it derive
178 from DecimalException.
179 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000180 def handle(self, context, *args):
181 pass
182
183
184class Clamped(DecimalException):
185 """Exponent of a 0 changed to fit bounds.
186
187 This occurs and signals clamped if the exponent of a result has been
188 altered in order to fit the constraints of a specific concrete
Facundo Batista59c58842007-04-10 12:58:45 +0000189 representation. This may occur when the exponent of a zero result would
190 be outside the bounds of a representation, or when a large normal
191 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000192 this latter case, the exponent is reduced to fit and the corresponding
193 number of zero digits are appended to the coefficient ("fold-down").
194 """
195
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000196class InvalidOperation(DecimalException):
197 """An invalid operation was performed.
198
199 Various bad things cause this:
200
201 Something creates a signaling NaN
202 -INF + INF
Facundo Batista59c58842007-04-10 12:58:45 +0000203 0 * (+-)INF
204 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000205 x % 0
206 (+-)INF % x
207 x._rescale( non-integer )
208 sqrt(-x) , x > 0
209 0 ** 0
210 x ** (non-integer)
211 x ** (+-)INF
212 An operand is invalid
Facundo Batista353750c2007-09-13 18:13:15 +0000213
214 The result of the operation after these is a quiet positive NaN,
215 except when the cause is a signaling NaN, in which case the result is
216 also a quiet NaN, but with the original sign, and an optional
217 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000218 """
219 def handle(self, context, *args):
220 if args:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000221 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
222 return ans._fix_nan(context)
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000223 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000224
225class ConversionSyntax(InvalidOperation):
226 """Trying to convert badly formed string.
227
228 This occurs and signals invalid-operation if an string is being
229 converted to a number and it does not conform to the numeric string
Facundo Batista59c58842007-04-10 12:58:45 +0000230 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000231 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000232 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000233 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000234
235class DivisionByZero(DecimalException, ZeroDivisionError):
236 """Division by 0.
237
238 This occurs and signals division-by-zero if division of a finite number
239 by zero was attempted (during a divide-integer or divide operation, or a
240 power operation with negative right-hand operand), and the dividend was
241 not zero.
242
243 The result of the operation is [sign,inf], where sign is the exclusive
244 or of the signs of the operands for divide, or is 1 for an odd power of
245 -0, for power.
246 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000247
Facundo Batistacce8df22007-09-18 16:53:18 +0000248 def handle(self, context, sign, *args):
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000249 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000250
251class DivisionImpossible(InvalidOperation):
252 """Cannot perform the division adequately.
253
254 This occurs and signals invalid-operation if the integer result of a
255 divide-integer or remainder operation had too many digits (would be
Facundo Batista59c58842007-04-10 12:58:45 +0000256 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000257 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000258
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000259 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000260 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000261
262class DivisionUndefined(InvalidOperation, ZeroDivisionError):
263 """Undefined result of division.
264
265 This occurs and signals invalid-operation if division by zero was
266 attempted (during a divide-integer, divide, or remainder operation), and
Facundo Batista59c58842007-04-10 12:58:45 +0000267 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000268 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000269
Facundo Batistacce8df22007-09-18 16:53:18 +0000270 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000271 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000272
273class Inexact(DecimalException):
274 """Had to round, losing information.
275
276 This occurs and signals inexact whenever the result of an operation is
277 not exact (that is, it needed to be rounded and any discarded digits
Facundo Batista59c58842007-04-10 12:58:45 +0000278 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000279 result in all cases is unchanged.
280
281 The inexact signal may be tested (or trapped) to determine if a given
282 operation (or sequence of operations) was inexact.
283 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000284
285class InvalidContext(InvalidOperation):
286 """Invalid context. Unknown rounding, for example.
287
288 This occurs and signals invalid-operation if an invalid context was
Facundo Batista59c58842007-04-10 12:58:45 +0000289 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000290 on creation and either the precision exceeds the capability of the
291 underlying concrete representation or an unknown or unsupported rounding
Facundo Batista59c58842007-04-10 12:58:45 +0000292 was specified. These aspects of the context need only be checked when
293 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000294 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000295
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000296 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000297 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000298
299class Rounded(DecimalException):
300 """Number got rounded (not necessarily changed during rounding).
301
302 This occurs and signals rounded whenever the result of an operation is
303 rounded (that is, some zero or non-zero digits were discarded from the
Facundo Batista59c58842007-04-10 12:58:45 +0000304 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000305 result in all cases is unchanged.
306
307 The rounded signal may be tested (or trapped) to determine if a given
308 operation (or sequence of operations) caused a loss of precision.
309 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000310
311class Subnormal(DecimalException):
312 """Exponent < Emin before rounding.
313
314 This occurs and signals subnormal whenever the result of a conversion or
315 operation is subnormal (that is, its adjusted exponent is less than
Facundo Batista59c58842007-04-10 12:58:45 +0000316 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000317
318 The subnormal signal may be tested (or trapped) to determine if a given
319 or operation (or sequence of operations) yielded a subnormal result.
320 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000321
322class Overflow(Inexact, Rounded):
323 """Numerical overflow.
324
325 This occurs and signals overflow if the adjusted exponent of a result
326 (from a conversion or from an operation that is not an attempt to divide
327 by zero), after rounding, would be greater than the largest value that
328 can be handled by the implementation (the value Emax).
329
330 The result depends on the rounding mode:
331
332 For round-half-up and round-half-even (and for round-half-down and
333 round-up, if implemented), the result of the operation is [sign,inf],
Facundo Batista59c58842007-04-10 12:58:45 +0000334 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000335 result is the largest finite number that can be represented in the
Facundo Batista59c58842007-04-10 12:58:45 +0000336 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000337 round-ceiling, the result is the same as for round-down if the sign of
Facundo Batista59c58842007-04-10 12:58:45 +0000338 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000339 the result is the same as for round-down if the sign of the intermediate
Facundo Batista59c58842007-04-10 12:58:45 +0000340 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000341 will also be raised.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000342 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000343
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000344 def handle(self, context, sign, *args):
345 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Facundo Batista353750c2007-09-13 18:13:15 +0000346 ROUND_HALF_DOWN, ROUND_UP):
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000347 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000348 if sign == 0:
349 if context.rounding == ROUND_CEILING:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000350 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000351 return _dec_from_triple(sign, '9'*context.prec,
352 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000353 if sign == 1:
354 if context.rounding == ROUND_FLOOR:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000355 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000356 return _dec_from_triple(sign, '9'*context.prec,
357 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000358
359
360class Underflow(Inexact, Rounded, Subnormal):
361 """Numerical underflow with result rounded to 0.
362
363 This occurs and signals underflow if a result is inexact and the
364 adjusted exponent of the result would be smaller (more negative) than
365 the smallest value that can be handled by the implementation (the value
Facundo Batista59c58842007-04-10 12:58:45 +0000366 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000367
368 The result after an underflow will be a subnormal number rounded, if
Facundo Batista59c58842007-04-10 12:58:45 +0000369 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000370 in 0 with the sign of the intermediate result and an exponent of Etiny.
371
372 In all cases, Inexact, Rounded, and Subnormal will also be raised.
373 """
374
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000375# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000376_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000377 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000378
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000379# Map conditions (per the spec) to signals
380_condition_map = {ConversionSyntax:InvalidOperation,
381 DivisionImpossible:InvalidOperation,
382 DivisionUndefined:InvalidOperation,
383 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000384
Facundo Batista59c58842007-04-10 12:58:45 +0000385##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000386
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000387# The getcontext() and setcontext() function manage access to a thread-local
388# current context. Py2.4 offers direct support for thread locals. If that
389# is not available, use threading.currentThread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000390# work for older Pythons. If threads are not part of the build, create a
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000391# mock threading object with threading.local() returning the module namespace.
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000392
393try:
394 import threading
395except ImportError:
396 # Python was compiled without threads; create a mock object instead
397 import sys
Facundo Batista59c58842007-04-10 12:58:45 +0000398 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000399 def local(self, sys=sys):
400 return sys.modules[__name__]
401 threading = MockThreading()
402 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000403
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000404try:
405 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000406
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000407except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000408
Facundo Batista59c58842007-04-10 12:58:45 +0000409 # To fix reloading, force it to create a new context
410 # Old contexts have different exceptions in their dicts, making problems.
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000411 if hasattr(threading.currentThread(), '__decimal_context__'):
412 del threading.currentThread().__decimal_context__
413
414 def setcontext(context):
415 """Set this thread's context to context."""
416 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000417 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000418 context.clear_flags()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000419 threading.currentThread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000420
421 def getcontext():
422 """Returns this thread's context.
423
424 If this thread does not yet have a context, returns
425 a new context and sets this thread's context.
426 New contexts are copies of DefaultContext.
427 """
428 try:
429 return threading.currentThread().__decimal_context__
430 except AttributeError:
431 context = Context()
432 threading.currentThread().__decimal_context__ = context
433 return context
434
435else:
436
437 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000438 if hasattr(local, '__decimal_context__'):
439 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000440
441 def getcontext(_local=local):
442 """Returns this thread's context.
443
444 If this thread does not yet have a context, returns
445 a new context and sets this thread's context.
446 New contexts are copies of DefaultContext.
447 """
448 try:
449 return _local.__decimal_context__
450 except AttributeError:
451 context = Context()
452 _local.__decimal_context__ = context
453 return context
454
455 def setcontext(context, _local=local):
456 """Set this thread's context to context."""
457 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000458 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000459 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000460 _local.__decimal_context__ = context
461
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000462 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000463
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000464def localcontext(ctx=None):
465 """Return a context manager for a copy of the supplied context
466
467 Uses a copy of the current context if no context is specified
468 The returned context manager creates a local decimal context
469 in a with statement:
470 def sin(x):
471 with localcontext() as ctx:
472 ctx.prec += 2
473 # Rest of sin calculation algorithm
474 # uses a precision 2 greater than normal
Facundo Batista59c58842007-04-10 12:58:45 +0000475 return +s # Convert result to normal precision
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000476
477 def sin(x):
478 with localcontext(ExtendedContext):
479 # Rest of sin calculation algorithm
480 # uses the Extended Context from the
481 # General Decimal Arithmetic Specification
Facundo Batista59c58842007-04-10 12:58:45 +0000482 return +s # Convert result to normal context
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000483
Facundo Batistaee340e52008-05-02 17:39:00 +0000484 >>> setcontext(DefaultContext)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000485 >>> print getcontext().prec
486 28
487 >>> with localcontext():
488 ... ctx = getcontext()
Raymond Hettinger495df472007-02-08 01:42:35 +0000489 ... ctx.prec += 2
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000490 ... print ctx.prec
491 ...
492 30
493 >>> with localcontext(ExtendedContext):
494 ... print getcontext().prec
495 ...
496 9
497 >>> print getcontext().prec
498 28
499 """
Nick Coghlanced12182006-09-02 03:54:17 +0000500 if ctx is None: ctx = getcontext()
501 return _ContextManager(ctx)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000502
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000503
Facundo Batista59c58842007-04-10 12:58:45 +0000504##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000505
506class Decimal(object):
507 """Floating point class for decimal arithmetic."""
508
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000509 __slots__ = ('_exp','_int','_sign', '_is_special')
510 # Generally, the value of the Decimal instance is given by
511 # (-1)**_sign * _int * 10**_exp
512 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000513
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000514 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000515 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000516 """Create a decimal point instance.
517
518 >>> Decimal('3.14') # string input
Raymond Hettingerabe32372008-02-14 02:41:22 +0000519 Decimal('3.14')
Facundo Batista59c58842007-04-10 12:58:45 +0000520 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Raymond Hettingerabe32372008-02-14 02:41:22 +0000521 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000522 >>> Decimal(314) # int or long
Raymond Hettingerabe32372008-02-14 02:41:22 +0000523 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000524 >>> Decimal(Decimal(314)) # another decimal instance
Raymond Hettingerabe32372008-02-14 02:41:22 +0000525 Decimal('314')
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000526 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Raymond Hettingerabe32372008-02-14 02:41:22 +0000527 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000528 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000529
Facundo Batista72bc54f2007-11-23 17:59:00 +0000530 # Note that the coefficient, self._int, is actually stored as
531 # a string rather than as a tuple of digits. This speeds up
532 # the "digits to integer" and "integer to digits" conversions
533 # that are used in almost every arithmetic operation on
534 # Decimals. This is an internal detail: the as_tuple function
535 # and the Decimal constructor still deal with tuples of
536 # digits.
537
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000538 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000539
Facundo Batista0d157a02007-11-30 17:15:25 +0000540 # From a string
541 # REs insist on real strings, so we can too.
542 if isinstance(value, basestring):
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000543 m = _parser(value.strip())
Facundo Batista0d157a02007-11-30 17:15:25 +0000544 if m is None:
545 if context is None:
546 context = getcontext()
547 return context._raise_error(ConversionSyntax,
548 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000549
Facundo Batista0d157a02007-11-30 17:15:25 +0000550 if m.group('sign') == "-":
551 self._sign = 1
552 else:
553 self._sign = 0
554 intpart = m.group('int')
555 if intpart is not None:
556 # finite number
Mark Dickinson4326ad82009-08-02 10:59:36 +0000557 fracpart = m.group('frac') or ''
Facundo Batista0d157a02007-11-30 17:15:25 +0000558 exp = int(m.group('exp') or '0')
Mark Dickinson4326ad82009-08-02 10:59:36 +0000559 self._int = str(int(intpart+fracpart))
560 self._exp = exp - len(fracpart)
Facundo Batista0d157a02007-11-30 17:15:25 +0000561 self._is_special = False
562 else:
563 diag = m.group('diag')
564 if diag is not None:
565 # NaN
Mark Dickinson4326ad82009-08-02 10:59:36 +0000566 self._int = str(int(diag or '0')).lstrip('0')
Facundo Batista0d157a02007-11-30 17:15:25 +0000567 if m.group('signal'):
568 self._exp = 'N'
569 else:
570 self._exp = 'n'
571 else:
572 # infinity
573 self._int = '0'
574 self._exp = 'F'
575 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000576 return self
577
578 # From an integer
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000579 if isinstance(value, (int,long)):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000580 if value >= 0:
581 self._sign = 0
582 else:
583 self._sign = 1
584 self._exp = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +0000585 self._int = str(abs(value))
Facundo Batista0d157a02007-11-30 17:15:25 +0000586 self._is_special = False
587 return self
588
589 # From another decimal
590 if isinstance(value, Decimal):
591 self._exp = value._exp
592 self._sign = value._sign
593 self._int = value._int
594 self._is_special = value._is_special
595 return self
596
597 # From an internal working value
598 if isinstance(value, _WorkRep):
599 self._sign = value.sign
600 self._int = str(value.int)
601 self._exp = int(value.exp)
602 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000603 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000604
605 # tuple/list conversion (possibly from as_tuple())
606 if isinstance(value, (list,tuple)):
607 if len(value) != 3:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000608 raise ValueError('Invalid tuple size in creation of Decimal '
609 'from list or tuple. The list or tuple '
610 'should have exactly three elements.')
611 # process sign. The isinstance test rejects floats
612 if not (isinstance(value[0], (int, long)) and value[0] in (0,1)):
613 raise ValueError("Invalid sign. The first value in the tuple "
614 "should be an integer; either 0 for a "
615 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000616 self._sign = value[0]
Facundo Batista9b5e2312007-10-19 19:25:57 +0000617 if value[2] == 'F':
618 # infinity: value[1] is ignored
Facundo Batista72bc54f2007-11-23 17:59:00 +0000619 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000620 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000621 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000622 else:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000623 # process and validate the digits in value[1]
624 digits = []
625 for digit in value[1]:
626 if isinstance(digit, (int, long)) and 0 <= digit <= 9:
627 # skip leading zeros
628 if digits or digit != 0:
629 digits.append(digit)
630 else:
631 raise ValueError("The second value in the tuple must "
632 "be composed of integers in the range "
633 "0 through 9.")
634 if value[2] in ('n', 'N'):
635 # NaN: digits form the diagnostic
Facundo Batista72bc54f2007-11-23 17:59:00 +0000636 self._int = ''.join(map(str, digits))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000637 self._exp = value[2]
638 self._is_special = True
639 elif isinstance(value[2], (int, long)):
640 # finite number: digits give the coefficient
Facundo Batista72bc54f2007-11-23 17:59:00 +0000641 self._int = ''.join(map(str, digits or [0]))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000642 self._exp = value[2]
643 self._is_special = False
644 else:
645 raise ValueError("The third value in the tuple must "
646 "be an integer, or one of the "
647 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000648 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000649
Raymond Hettingerbf440692004-07-10 14:14:37 +0000650 if isinstance(value, float):
Raymond Hettingered171ab2010-04-02 18:39:24 +0000651 value = Decimal.from_float(value)
652 self._exp = value._exp
653 self._sign = value._sign
654 self._int = value._int
655 self._is_special = value._is_special
656 return self
Raymond Hettingerbf440692004-07-10 14:14:37 +0000657
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000658 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000659
Mark Dickinson6a961632009-01-04 21:10:56 +0000660 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
661 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000662 def from_float(cls, f):
663 """Converts a float to a decimal number, exactly.
664
665 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
666 Since 0.1 is not exactly representable in binary floating point, the
667 value is stored as the nearest representable value which is
668 0x1.999999999999ap-4. The exact equivalent of the value in decimal
669 is 0.1000000000000000055511151231257827021181583404541015625.
670
671 >>> Decimal.from_float(0.1)
672 Decimal('0.1000000000000000055511151231257827021181583404541015625')
673 >>> Decimal.from_float(float('nan'))
674 Decimal('NaN')
675 >>> Decimal.from_float(float('inf'))
676 Decimal('Infinity')
677 >>> Decimal.from_float(-float('inf'))
678 Decimal('-Infinity')
679 >>> Decimal.from_float(-0.0)
680 Decimal('-0')
681
682 """
683 if isinstance(f, (int, long)): # handle integer inputs
684 return cls(f)
685 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
686 return cls(repr(f))
Mark Dickinson6a961632009-01-04 21:10:56 +0000687 if _math.copysign(1.0, f) == 1.0:
688 sign = 0
689 else:
690 sign = 1
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000691 n, d = abs(f).as_integer_ratio()
692 k = d.bit_length() - 1
693 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinson6a961632009-01-04 21:10:56 +0000694 if cls is Decimal:
695 return result
696 else:
697 return cls(result)
698 from_float = classmethod(from_float)
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000699
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000700 def _isnan(self):
701 """Returns whether the number is not actually one.
702
703 0 if a number
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000704 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000705 2 if sNaN
706 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000707 if self._is_special:
708 exp = self._exp
709 if exp == 'n':
710 return 1
711 elif exp == 'N':
712 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000713 return 0
714
715 def _isinfinity(self):
716 """Returns whether the number is infinite
717
718 0 if finite or not a number
719 1 if +INF
720 -1 if -INF
721 """
722 if self._exp == 'F':
723 if self._sign:
724 return -1
725 return 1
726 return 0
727
Facundo Batista353750c2007-09-13 18:13:15 +0000728 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000729 """Returns whether the number is not actually one.
730
731 if self, other are sNaN, signal
732 if self, other are NaN return nan
733 return 0
734
735 Done before operations.
736 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000737
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000738 self_is_nan = self._isnan()
739 if other is None:
740 other_is_nan = False
741 else:
742 other_is_nan = other._isnan()
743
744 if self_is_nan or other_is_nan:
745 if context is None:
746 context = getcontext()
747
748 if self_is_nan == 2:
749 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000750 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000751 if other_is_nan == 2:
752 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000753 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000754 if self_is_nan:
Facundo Batista353750c2007-09-13 18:13:15 +0000755 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000756
Facundo Batista353750c2007-09-13 18:13:15 +0000757 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000758 return 0
759
Mark Dickinson2fc92632008-02-06 22:10:50 +0000760 def _compare_check_nans(self, other, context):
761 """Version of _check_nans used for the signaling comparisons
762 compare_signal, __le__, __lt__, __ge__, __gt__.
763
764 Signal InvalidOperation if either self or other is a (quiet
765 or signaling) NaN. Signaling NaNs take precedence over quiet
766 NaNs.
767
768 Return 0 if neither operand is a NaN.
769
770 """
771 if context is None:
772 context = getcontext()
773
774 if self._is_special or other._is_special:
775 if self.is_snan():
776 return context._raise_error(InvalidOperation,
777 'comparison involving sNaN',
778 self)
779 elif other.is_snan():
780 return context._raise_error(InvalidOperation,
781 'comparison involving sNaN',
782 other)
783 elif self.is_qnan():
784 return context._raise_error(InvalidOperation,
785 'comparison involving NaN',
786 self)
787 elif other.is_qnan():
788 return context._raise_error(InvalidOperation,
789 'comparison involving NaN',
790 other)
791 return 0
792
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000793 def __nonzero__(self):
Facundo Batista1a191df2007-10-02 17:01:24 +0000794 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000795
Facundo Batista1a191df2007-10-02 17:01:24 +0000796 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000797 """
Facundo Batista72bc54f2007-11-23 17:59:00 +0000798 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000799
Mark Dickinson2fc92632008-02-06 22:10:50 +0000800 def _cmp(self, other):
801 """Compare the two non-NaN decimal instances self and other.
802
803 Returns -1 if self < other, 0 if self == other and 1
804 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000805
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000806 if self._is_special or other._is_special:
Mark Dickinsone52c3142009-01-25 10:39:15 +0000807 self_inf = self._isinfinity()
808 other_inf = other._isinfinity()
809 if self_inf == other_inf:
810 return 0
811 elif self_inf < other_inf:
812 return -1
813 else:
814 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000815
Mark Dickinsone52c3142009-01-25 10:39:15 +0000816 # check for zeros; Decimal('0') == Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +0000817 if not self:
818 if not other:
819 return 0
820 else:
821 return -((-1)**other._sign)
822 if not other:
823 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000824
Facundo Batista59c58842007-04-10 12:58:45 +0000825 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000826 if other._sign < self._sign:
827 return -1
828 if self._sign < other._sign:
829 return 1
830
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000831 self_adjusted = self.adjusted()
832 other_adjusted = other.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +0000833 if self_adjusted == other_adjusted:
Facundo Batista72bc54f2007-11-23 17:59:00 +0000834 self_padded = self._int + '0'*(self._exp - other._exp)
835 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone52c3142009-01-25 10:39:15 +0000836 if self_padded == other_padded:
837 return 0
838 elif self_padded < other_padded:
839 return -(-1)**self._sign
840 else:
841 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000842 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000843 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000844 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000845 return -((-1)**self._sign)
846
Mark Dickinson2fc92632008-02-06 22:10:50 +0000847 # Note: The Decimal standard doesn't cover rich comparisons for
848 # Decimals. In particular, the specification is silent on the
849 # subject of what should happen for a comparison involving a NaN.
850 # We take the following approach:
851 #
Mark Dickinsone096e822010-04-02 10:17:07 +0000852 # == comparisons involving a quiet NaN always return False
853 # != comparisons involving a quiet NaN always return True
854 # == or != comparisons involving a signaling NaN signal
855 # InvalidOperation, and return False or True as above if the
856 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000857 # <, >, <= and >= comparisons involving a (quiet or signaling)
858 # NaN signal InvalidOperation, and return False if the
Mark Dickinson3a94ee02008-02-10 15:19:58 +0000859 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000860 #
861 # This behavior is designed to conform as closely as possible to
862 # that specified by IEEE 754.
863
Mark Dickinsone096e822010-04-02 10:17:07 +0000864 def __eq__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000865 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000866 if other is NotImplemented:
867 return other
Mark Dickinsone096e822010-04-02 10:17:07 +0000868 if self._check_nans(other, context):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000869 return False
870 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000871
Mark Dickinsone096e822010-04-02 10:17:07 +0000872 def __ne__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000873 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000874 if other is NotImplemented:
875 return other
Mark Dickinsone096e822010-04-02 10:17:07 +0000876 if self._check_nans(other, context):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000877 return True
878 return self._cmp(other) != 0
879
880 def __lt__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000881 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000882 if other is NotImplemented:
883 return other
884 ans = self._compare_check_nans(other, context)
885 if ans:
886 return False
887 return self._cmp(other) < 0
888
889 def __le__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000890 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000891 if other is NotImplemented:
892 return other
893 ans = self._compare_check_nans(other, context)
894 if ans:
895 return False
896 return self._cmp(other) <= 0
897
898 def __gt__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000899 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000900 if other is NotImplemented:
901 return other
902 ans = self._compare_check_nans(other, context)
903 if ans:
904 return False
905 return self._cmp(other) > 0
906
907 def __ge__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000908 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000909 if other is NotImplemented:
910 return other
911 ans = self._compare_check_nans(other, context)
912 if ans:
913 return False
914 return self._cmp(other) >= 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000915
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000916 def compare(self, other, context=None):
917 """Compares one to another.
918
919 -1 => a < b
920 0 => a = b
921 1 => a > b
922 NaN => one is NaN
923 Like __cmp__, but returns Decimal instances.
924 """
Facundo Batista353750c2007-09-13 18:13:15 +0000925 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000926
Facundo Batista59c58842007-04-10 12:58:45 +0000927 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000928 if (self._is_special or other and other._is_special):
929 ans = self._check_nans(other, context)
930 if ans:
931 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000932
Mark Dickinson2fc92632008-02-06 22:10:50 +0000933 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000934
935 def __hash__(self):
936 """x.__hash__() <==> hash(x)"""
937 # Decimal integers must hash the same as the ints
Facundo Batista52b25792008-01-08 12:25:20 +0000938 #
939 # The hash of a nonspecial noninteger Decimal must depend only
940 # on the value of that Decimal, and not on its representation.
Raymond Hettingerabe32372008-02-14 02:41:22 +0000941 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Mark Dickinsonf3eeca12010-04-02 10:35:12 +0000942
943 # Equality comparisons involving signaling nans can raise an
944 # exception; since equality checks are implicitly and
945 # unpredictably used when checking set and dict membership, we
946 # prevent signaling nans from being used as set elements or
947 # dict keys by making __hash__ raise an exception.
948 if self._is_special:
949 if self.is_snan():
950 raise TypeError('Cannot hash a signaling NaN value.')
951 elif self.is_nan():
952 # 0 to match hash(float('nan'))
953 return 0
954 else:
955 # values chosen to match hash(float('inf')) and
956 # hash(float('-inf')).
957 if self._sign:
958 return -271828
959 else:
960 return 314159
Mark Dickinson99d80962010-04-02 08:53:22 +0000961
962 # In Python 2.7, we're allowing comparisons (but not
963 # arithmetic operations) between floats and Decimals; so if
964 # a Decimal instance is exactly representable as a float then
Mark Dickinsonf3eeca12010-04-02 10:35:12 +0000965 # its hash should match that of the float.
Mark Dickinson99d80962010-04-02 08:53:22 +0000966 self_as_float = float(self)
967 if Decimal.from_float(self_as_float) == self:
968 return hash(self_as_float)
969
Facundo Batista8c202442007-09-19 17:53:25 +0000970 if self._isinteger():
971 op = _WorkRep(self.to_integral_value())
972 # to make computation feasible for Decimals with large
973 # exponent, we use the fact that hash(n) == hash(m) for
974 # any two nonzero integers n and m such that (i) n and m
975 # have the same sign, and (ii) n is congruent to m modulo
976 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
977 # hash((-1)**s*c*pow(10, e, 2**64-1).
978 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Facundo Batista52b25792008-01-08 12:25:20 +0000979 # The value of a nonzero nonspecial Decimal instance is
980 # faithfully represented by the triple consisting of its sign,
981 # its adjusted exponent, and its coefficient with trailing
982 # zeros removed.
983 return hash((self._sign,
984 self._exp+len(self._int),
985 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000986
987 def as_tuple(self):
988 """Represents the number as a triple tuple.
989
990 To show the internals exactly as they are.
991 """
Raymond Hettinger097a1902008-01-11 02:24:13 +0000992 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000993
994 def __repr__(self):
995 """Represents the number as an instance of Decimal."""
996 # Invariant: eval(repr(d)) == d
Raymond Hettingerabe32372008-02-14 02:41:22 +0000997 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000998
Facundo Batista353750c2007-09-13 18:13:15 +0000999 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000 """Return string representation of the number in scientific notation.
1001
1002 Captures all of the information in the underlying representation.
1003 """
1004
Facundo Batista62edb712007-12-03 16:29:52 +00001005 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +00001006 if self._is_special:
Facundo Batista62edb712007-12-03 16:29:52 +00001007 if self._exp == 'F':
1008 return sign + 'Infinity'
1009 elif self._exp == 'n':
1010 return sign + 'NaN' + self._int
1011 else: # self._exp == 'N'
1012 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001013
Facundo Batista62edb712007-12-03 16:29:52 +00001014 # number of digits of self._int to left of decimal point
1015 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001016
Facundo Batista62edb712007-12-03 16:29:52 +00001017 # dotplace is number of digits of self._int to the left of the
1018 # decimal point in the mantissa of the output string (that is,
1019 # after adjusting the exponent)
1020 if self._exp <= 0 and leftdigits > -6:
1021 # no exponent required
1022 dotplace = leftdigits
1023 elif not eng:
1024 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001025 dotplace = 1
Facundo Batista62edb712007-12-03 16:29:52 +00001026 elif self._int == '0':
1027 # engineering notation, zero
1028 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001029 else:
Facundo Batista62edb712007-12-03 16:29:52 +00001030 # engineering notation, nonzero
1031 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001032
Facundo Batista62edb712007-12-03 16:29:52 +00001033 if dotplace <= 0:
1034 intpart = '0'
1035 fracpart = '.' + '0'*(-dotplace) + self._int
1036 elif dotplace >= len(self._int):
1037 intpart = self._int+'0'*(dotplace-len(self._int))
1038 fracpart = ''
1039 else:
1040 intpart = self._int[:dotplace]
1041 fracpart = '.' + self._int[dotplace:]
1042 if leftdigits == dotplace:
1043 exp = ''
1044 else:
1045 if context is None:
1046 context = getcontext()
1047 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1048
1049 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001050
1051 def to_eng_string(self, context=None):
1052 """Convert to engineering-type string.
1053
1054 Engineering notation has an exponent which is a multiple of 3, so there
1055 are up to 3 digits left of the decimal place.
1056
1057 Same rules for when in exponential and when as a value as in __str__.
1058 """
Facundo Batista353750c2007-09-13 18:13:15 +00001059 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001060
1061 def __neg__(self, context=None):
1062 """Returns a copy with the sign switched.
1063
1064 Rounds, if it has reason.
1065 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001066 if self._is_special:
1067 ans = self._check_nans(context=context)
1068 if ans:
1069 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001070
Mark Dickinson2c8c62e2011-03-12 11:05:32 +00001071 if context is None:
1072 context = getcontext()
1073
1074 if not self and context.rounding != ROUND_FLOOR:
1075 # -Decimal('0') is Decimal('0'), not Decimal('-0'), except
1076 # in ROUND_FLOOR rounding mode.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001077 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001078 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001079 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001080
Facundo Batistae64acfa2007-12-17 14:18:42 +00001081 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001082
1083 def __pos__(self, context=None):
1084 """Returns a copy, unless it is a sNaN.
1085
1086 Rounds the number (if more then precision digits)
1087 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001088 if self._is_special:
1089 ans = self._check_nans(context=context)
1090 if ans:
1091 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001092
Mark Dickinson2c8c62e2011-03-12 11:05:32 +00001093 if context is None:
1094 context = getcontext()
1095
1096 if not self and context.rounding != ROUND_FLOOR:
1097 # + (-0) = 0, except in ROUND_FLOOR rounding mode.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001098 ans = self.copy_abs()
Facundo Batista353750c2007-09-13 18:13:15 +00001099 else:
1100 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001101
Facundo Batistae64acfa2007-12-17 14:18:42 +00001102 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001103
Facundo Batistae64acfa2007-12-17 14:18:42 +00001104 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001105 """Returns the absolute value of self.
1106
Facundo Batistae64acfa2007-12-17 14:18:42 +00001107 If the keyword argument 'round' is false, do not round. The
1108 expression self.__abs__(round=False) is equivalent to
1109 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001110 """
Facundo Batistae64acfa2007-12-17 14:18:42 +00001111 if not round:
1112 return self.copy_abs()
1113
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001114 if self._is_special:
1115 ans = self._check_nans(context=context)
1116 if ans:
1117 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001118
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001119 if self._sign:
1120 ans = self.__neg__(context=context)
1121 else:
1122 ans = self.__pos__(context=context)
1123
1124 return ans
1125
1126 def __add__(self, other, context=None):
1127 """Returns self + other.
1128
1129 -INF + INF (or the reverse) cause InvalidOperation errors.
1130 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001131 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001132 if other is NotImplemented:
1133 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001134
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001135 if context is None:
1136 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001137
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001138 if self._is_special or other._is_special:
1139 ans = self._check_nans(other, context)
1140 if ans:
1141 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001142
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001143 if self._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001144 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001145 if self._sign != other._sign and other._isinfinity():
1146 return context._raise_error(InvalidOperation, '-INF + INF')
1147 return Decimal(self)
1148 if other._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001149 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001150
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001151 exp = min(self._exp, other._exp)
1152 negativezero = 0
1153 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Facundo Batista59c58842007-04-10 12:58:45 +00001154 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001155 negativezero = 1
1156
1157 if not self and not other:
1158 sign = min(self._sign, other._sign)
1159 if negativezero:
1160 sign = 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00001161 ans = _dec_from_triple(sign, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001162 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001163 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001164 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001165 exp = max(exp, other._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001166 ans = other._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001167 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001168 return ans
1169 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001170 exp = max(exp, self._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001171 ans = self._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001172 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001173 return ans
1174
1175 op1 = _WorkRep(self)
1176 op2 = _WorkRep(other)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001177 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178
1179 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001180 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001181 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001182 if op1.int == op2.int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001183 ans = _dec_from_triple(negativezero, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001184 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001185 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001186 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001187 op1, op2 = op2, op1
Facundo Batista59c58842007-04-10 12:58:45 +00001188 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001189 if op1.sign == 1:
1190 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001191 op1.sign, op2.sign = op2.sign, op1.sign
1192 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001193 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001194 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001195 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001196 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001197 op1.sign, op2.sign = (0, 0)
1198 else:
1199 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001200 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001201
Raymond Hettinger17931de2004-10-27 06:21:46 +00001202 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001203 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001205 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001206
1207 result.exp = op1.exp
1208 ans = Decimal(result)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001209 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001210 return ans
1211
1212 __radd__ = __add__
1213
1214 def __sub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001215 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001216 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001217 if other is NotImplemented:
1218 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001219
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001220 if self._is_special or other._is_special:
1221 ans = self._check_nans(other, context=context)
1222 if ans:
1223 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001224
Facundo Batista353750c2007-09-13 18:13:15 +00001225 # self - other is computed as self + other.copy_negate()
1226 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001227
1228 def __rsub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001229 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001230 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001231 if other is NotImplemented:
1232 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233
Facundo Batista353750c2007-09-13 18:13:15 +00001234 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001236 def __mul__(self, other, context=None):
1237 """Return self * other.
1238
1239 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1240 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001241 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001242 if other is NotImplemented:
1243 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001244
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001245 if context is None:
1246 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001247
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001248 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001249
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001250 if self._is_special or other._is_special:
1251 ans = self._check_nans(other, context)
1252 if ans:
1253 return ans
1254
1255 if self._isinfinity():
1256 if not other:
1257 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001258 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001259
1260 if other._isinfinity():
1261 if not self:
1262 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001263 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001264
1265 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001266
1267 # Special case for multiplying by zero
1268 if not self or not other:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001269 ans = _dec_from_triple(resultsign, '0', resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001270 # Fixing in case the exponent is out of bounds
1271 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001272 return ans
1273
1274 # Special case for multiplying by power of 10
Facundo Batista72bc54f2007-11-23 17:59:00 +00001275 if self._int == '1':
1276 ans = _dec_from_triple(resultsign, other._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001277 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001278 return ans
Facundo Batista72bc54f2007-11-23 17:59:00 +00001279 if other._int == '1':
1280 ans = _dec_from_triple(resultsign, self._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001281 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001282 return ans
1283
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001284 op1 = _WorkRep(self)
1285 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001286
Facundo Batista72bc54f2007-11-23 17:59:00 +00001287 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001288 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001289
1290 return ans
1291 __rmul__ = __mul__
1292
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001293 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001294 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001295 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001296 if other is NotImplemented:
Facundo Batistacce8df22007-09-18 16:53:18 +00001297 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001298
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001299 if context is None:
1300 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001301
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001302 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001303
1304 if self._is_special or other._is_special:
1305 ans = self._check_nans(other, context)
1306 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001307 return ans
1308
1309 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001310 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001311
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001312 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001313 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001314
1315 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001316 context._raise_error(Clamped, 'Division by infinity')
Facundo Batista72bc54f2007-11-23 17:59:00 +00001317 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001318
1319 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001320 if not other:
Facundo Batistacce8df22007-09-18 16:53:18 +00001321 if not self:
1322 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001323 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001324
Facundo Batistacce8df22007-09-18 16:53:18 +00001325 if not self:
1326 exp = self._exp - other._exp
1327 coeff = 0
1328 else:
1329 # OK, so neither = 0, INF or NaN
1330 shift = len(other._int) - len(self._int) + context.prec + 1
1331 exp = self._exp - other._exp - shift
1332 op1 = _WorkRep(self)
1333 op2 = _WorkRep(other)
1334 if shift >= 0:
1335 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1336 else:
1337 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1338 if remainder:
1339 # result is not exact; adjust to ensure correct rounding
1340 if coeff % 5 == 0:
1341 coeff += 1
1342 else:
1343 # result is exact; get as close to ideal exponent as possible
1344 ideal_exp = self._exp - other._exp
1345 while exp < ideal_exp and coeff % 10 == 0:
1346 coeff //= 10
1347 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001348
Facundo Batista72bc54f2007-11-23 17:59:00 +00001349 ans = _dec_from_triple(sign, str(coeff), exp)
Facundo Batistacce8df22007-09-18 16:53:18 +00001350 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001351
Facundo Batistacce8df22007-09-18 16:53:18 +00001352 def _divide(self, other, context):
1353 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001354
Facundo Batistacce8df22007-09-18 16:53:18 +00001355 Assumes that neither self nor other is a NaN, that self is not
1356 infinite and that other is nonzero.
1357 """
1358 sign = self._sign ^ other._sign
1359 if other._isinfinity():
1360 ideal_exp = self._exp
1361 else:
1362 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001363
Facundo Batistacce8df22007-09-18 16:53:18 +00001364 expdiff = self.adjusted() - other.adjusted()
1365 if not self or other._isinfinity() or expdiff <= -2:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001366 return (_dec_from_triple(sign, '0', 0),
Facundo Batistacce8df22007-09-18 16:53:18 +00001367 self._rescale(ideal_exp, context.rounding))
1368 if expdiff <= context.prec:
1369 op1 = _WorkRep(self)
1370 op2 = _WorkRep(other)
1371 if op1.exp >= op2.exp:
1372 op1.int *= 10**(op1.exp - op2.exp)
1373 else:
1374 op2.int *= 10**(op2.exp - op1.exp)
1375 q, r = divmod(op1.int, op2.int)
1376 if q < 10**context.prec:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001377 return (_dec_from_triple(sign, str(q), 0),
1378 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001379
Facundo Batistacce8df22007-09-18 16:53:18 +00001380 # Here the quotient is too large to be representable
1381 ans = context._raise_error(DivisionImpossible,
1382 'quotient too large in //, % or divmod')
1383 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001384
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001385 def __rtruediv__(self, other, context=None):
1386 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001387 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001388 if other is NotImplemented:
1389 return other
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001390 return other.__truediv__(self, context=context)
1391
1392 __div__ = __truediv__
1393 __rdiv__ = __rtruediv__
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001394
1395 def __divmod__(self, other, context=None):
1396 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001397 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001398 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001399 other = _convert_other(other)
1400 if other is NotImplemented:
1401 return other
1402
1403 if context is None:
1404 context = getcontext()
1405
1406 ans = self._check_nans(other, context)
1407 if ans:
1408 return (ans, ans)
1409
1410 sign = self._sign ^ other._sign
1411 if self._isinfinity():
1412 if other._isinfinity():
1413 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1414 return ans, ans
1415 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001416 return (_SignedInfinity[sign],
Facundo Batistacce8df22007-09-18 16:53:18 +00001417 context._raise_error(InvalidOperation, 'INF % x'))
1418
1419 if not other:
1420 if not self:
1421 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1422 return ans, ans
1423 else:
1424 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1425 context._raise_error(InvalidOperation, 'x % 0'))
1426
1427 quotient, remainder = self._divide(other, context)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001428 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001429 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001430
1431 def __rdivmod__(self, other, context=None):
1432 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001433 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001434 if other is NotImplemented:
1435 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001436 return other.__divmod__(self, context=context)
1437
1438 def __mod__(self, other, context=None):
1439 """
1440 self % other
1441 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001442 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001443 if other is NotImplemented:
1444 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001445
Facundo Batistacce8df22007-09-18 16:53:18 +00001446 if context is None:
1447 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001448
Facundo Batistacce8df22007-09-18 16:53:18 +00001449 ans = self._check_nans(other, context)
1450 if ans:
1451 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001452
Facundo Batistacce8df22007-09-18 16:53:18 +00001453 if self._isinfinity():
1454 return context._raise_error(InvalidOperation, 'INF % x')
1455 elif not other:
1456 if self:
1457 return context._raise_error(InvalidOperation, 'x % 0')
1458 else:
1459 return context._raise_error(DivisionUndefined, '0 % 0')
1460
1461 remainder = self._divide(other, context)[1]
Facundo Batistae64acfa2007-12-17 14:18:42 +00001462 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001463 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001464
1465 def __rmod__(self, other, context=None):
1466 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001467 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001468 if other is NotImplemented:
1469 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001470 return other.__mod__(self, context=context)
1471
1472 def remainder_near(self, other, context=None):
1473 """
1474 Remainder nearest to 0- abs(remainder-near) <= other/2
1475 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001476 if context is None:
1477 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001478
Facundo Batista353750c2007-09-13 18:13:15 +00001479 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001480
Facundo Batista353750c2007-09-13 18:13:15 +00001481 ans = self._check_nans(other, context)
1482 if ans:
1483 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001484
Facundo Batista353750c2007-09-13 18:13:15 +00001485 # self == +/-infinity -> InvalidOperation
1486 if self._isinfinity():
1487 return context._raise_error(InvalidOperation,
1488 'remainder_near(infinity, x)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001489
Facundo Batista353750c2007-09-13 18:13:15 +00001490 # other == 0 -> either InvalidOperation or DivisionUndefined
1491 if not other:
1492 if self:
1493 return context._raise_error(InvalidOperation,
1494 'remainder_near(x, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001495 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001496 return context._raise_error(DivisionUndefined,
1497 'remainder_near(0, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001498
Facundo Batista353750c2007-09-13 18:13:15 +00001499 # other = +/-infinity -> remainder = self
1500 if other._isinfinity():
1501 ans = Decimal(self)
1502 return ans._fix(context)
1503
1504 # self = 0 -> remainder = self, with ideal exponent
1505 ideal_exponent = min(self._exp, other._exp)
1506 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001507 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001508 return ans._fix(context)
1509
1510 # catch most cases of large or small quotient
1511 expdiff = self.adjusted() - other.adjusted()
1512 if expdiff >= context.prec + 1:
1513 # expdiff >= prec+1 => abs(self/other) > 10**prec
Facundo Batistacce8df22007-09-18 16:53:18 +00001514 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001515 if expdiff <= -2:
1516 # expdiff <= -2 => abs(self/other) < 0.1
1517 ans = self._rescale(ideal_exponent, context.rounding)
1518 return ans._fix(context)
1519
1520 # adjust both arguments to have the same exponent, then divide
1521 op1 = _WorkRep(self)
1522 op2 = _WorkRep(other)
1523 if op1.exp >= op2.exp:
1524 op1.int *= 10**(op1.exp - op2.exp)
1525 else:
1526 op2.int *= 10**(op2.exp - op1.exp)
1527 q, r = divmod(op1.int, op2.int)
1528 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1529 # 10**ideal_exponent. Apply correction to ensure that
1530 # abs(remainder) <= abs(other)/2
1531 if 2*r + (q&1) > op2.int:
1532 r -= op2.int
1533 q += 1
1534
1535 if q >= 10**context.prec:
Facundo Batistacce8df22007-09-18 16:53:18 +00001536 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001537
1538 # result has same sign as self unless r is negative
1539 sign = self._sign
1540 if r < 0:
1541 sign = 1-sign
1542 r = -r
1543
Facundo Batista72bc54f2007-11-23 17:59:00 +00001544 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001545 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001546
1547 def __floordiv__(self, other, context=None):
1548 """self // other"""
Facundo Batistacce8df22007-09-18 16:53:18 +00001549 other = _convert_other(other)
1550 if other is NotImplemented:
1551 return other
1552
1553 if context is None:
1554 context = getcontext()
1555
1556 ans = self._check_nans(other, context)
1557 if ans:
1558 return ans
1559
1560 if self._isinfinity():
1561 if other._isinfinity():
1562 return context._raise_error(InvalidOperation, 'INF // INF')
1563 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001564 return _SignedInfinity[self._sign ^ other._sign]
Facundo Batistacce8df22007-09-18 16:53:18 +00001565
1566 if not other:
1567 if self:
1568 return context._raise_error(DivisionByZero, 'x // 0',
1569 self._sign ^ other._sign)
1570 else:
1571 return context._raise_error(DivisionUndefined, '0 // 0')
1572
1573 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001574
1575 def __rfloordiv__(self, other, context=None):
1576 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001577 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001578 if other is NotImplemented:
1579 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001580 return other.__floordiv__(self, context=context)
1581
1582 def __float__(self):
1583 """Float representation."""
Mark Dickinson088cec32012-08-24 20:06:30 +01001584 if self._isnan():
1585 if self.is_snan():
1586 raise ValueError("Cannot convert signaling NaN to float")
1587 s = "-nan" if self._sign else "nan"
1588 else:
1589 s = str(self)
1590 return float(s)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001591
1592 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001593 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001594 if self._is_special:
1595 if self._isnan():
Mark Dickinson968f1692009-09-07 18:04:58 +00001596 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001597 elif self._isinfinity():
Mark Dickinson968f1692009-09-07 18:04:58 +00001598 raise OverflowError("Cannot convert infinity to integer")
Facundo Batista353750c2007-09-13 18:13:15 +00001599 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001600 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001601 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001602 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001603 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001604
Raymond Hettinger5a053642008-01-24 19:05:29 +00001605 __trunc__ = __int__
1606
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001607 def real(self):
1608 return self
Mark Dickinson65808ff2009-01-04 21:22:02 +00001609 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001610
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001611 def imag(self):
1612 return Decimal(0)
Mark Dickinson65808ff2009-01-04 21:22:02 +00001613 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001614
1615 def conjugate(self):
1616 return self
1617
1618 def __complex__(self):
1619 return complex(float(self))
1620
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001621 def __long__(self):
1622 """Converts to a long.
1623
1624 Equivalent to long(int(self))
1625 """
1626 return long(self.__int__())
1627
Facundo Batista353750c2007-09-13 18:13:15 +00001628 def _fix_nan(self, context):
1629 """Decapitate the payload of a NaN to fit the context"""
1630 payload = self._int
1631
1632 # maximum length of payload is precision if _clamp=0,
1633 # precision-1 if _clamp=1.
1634 max_payload_len = context.prec - context._clamp
1635 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001636 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1637 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001638 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001639
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001640 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001641 """Round if it is necessary to keep self within prec precision.
1642
1643 Rounds and fixes the exponent. Does not raise on a sNaN.
1644
1645 Arguments:
1646 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001647 context - context used.
1648 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001649
Facundo Batista353750c2007-09-13 18:13:15 +00001650 if self._is_special:
1651 if self._isnan():
1652 # decapitate payload if necessary
1653 return self._fix_nan(context)
1654 else:
1655 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001656 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001657
Facundo Batista353750c2007-09-13 18:13:15 +00001658 # if self is zero then exponent should be between Etiny and
1659 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1660 Etiny = context.Etiny()
1661 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001662 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001663 exp_max = [context.Emax, Etop][context._clamp]
1664 new_exp = min(max(self._exp, Etiny), exp_max)
1665 if new_exp != self._exp:
1666 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001667 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001668 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001669 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001670
1671 # exp_min is the smallest allowable exponent of the result,
1672 # equal to max(self.adjusted()-context.prec+1, Etiny)
1673 exp_min = len(self._int) + self._exp - context.prec
1674 if exp_min > Etop:
1675 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001676 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00001677 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001678 context._raise_error(Rounded)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001679 return ans
1680
Facundo Batista353750c2007-09-13 18:13:15 +00001681 self_is_subnormal = exp_min < Etiny
1682 if self_is_subnormal:
Facundo Batista353750c2007-09-13 18:13:15 +00001683 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001684
Facundo Batista353750c2007-09-13 18:13:15 +00001685 # round if self has too many digits
1686 if self._exp < exp_min:
Facundo Batista2ec74152007-12-03 17:55:00 +00001687 digits = len(self._int) + self._exp - exp_min
1688 if digits < 0:
1689 self = _dec_from_triple(self._sign, '1', exp_min-1)
1690 digits = 0
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001691 rounding_method = self._pick_rounding_function[context.rounding]
Raymond Hettingerd9223292011-04-12 09:06:01 -07001692 changed = rounding_method(self, digits)
Facundo Batista2ec74152007-12-03 17:55:00 +00001693 coeff = self._int[:digits] or '0'
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001694 if changed > 0:
Facundo Batista2ec74152007-12-03 17:55:00 +00001695 coeff = str(int(coeff)+1)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001696 if len(coeff) > context.prec:
1697 coeff = coeff[:-1]
1698 exp_min += 1
Facundo Batista2ec74152007-12-03 17:55:00 +00001699
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001700 # check whether the rounding pushed the exponent out of range
1701 if exp_min > Etop:
1702 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1703 else:
1704 ans = _dec_from_triple(self._sign, coeff, exp_min)
1705
1706 # raise the appropriate signals, taking care to respect
1707 # the precedence described in the specification
1708 if changed and self_is_subnormal:
1709 context._raise_error(Underflow)
1710 if self_is_subnormal:
1711 context._raise_error(Subnormal)
Facundo Batista2ec74152007-12-03 17:55:00 +00001712 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001713 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001714 context._raise_error(Rounded)
1715 if not ans:
1716 # raise Clamped on underflow to 0
1717 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001718 return ans
1719
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001720 if self_is_subnormal:
1721 context._raise_error(Subnormal)
1722
Facundo Batista353750c2007-09-13 18:13:15 +00001723 # fold down if _clamp == 1 and self has too few digits
1724 if context._clamp == 1 and self._exp > Etop:
1725 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001726 self_padded = self._int + '0'*(self._exp - Etop)
1727 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001728
Facundo Batista353750c2007-09-13 18:13:15 +00001729 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001730 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001731
Facundo Batista353750c2007-09-13 18:13:15 +00001732 # for each of the rounding functions below:
1733 # self is a finite, nonzero Decimal
1734 # prec is an integer satisfying 0 <= prec < len(self._int)
Facundo Batista2ec74152007-12-03 17:55:00 +00001735 #
1736 # each function returns either -1, 0, or 1, as follows:
1737 # 1 indicates that self should be rounded up (away from zero)
1738 # 0 indicates that self should be truncated, and that all the
1739 # digits to be truncated are zeros (so the value is unchanged)
1740 # -1 indicates that there are nonzero digits to be truncated
Facundo Batista353750c2007-09-13 18:13:15 +00001741
1742 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001743 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001744 if _all_zeros(self._int, prec):
1745 return 0
1746 else:
1747 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001748
Facundo Batista353750c2007-09-13 18:13:15 +00001749 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001750 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001751 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001752
Facundo Batista353750c2007-09-13 18:13:15 +00001753 def _round_half_up(self, prec):
1754 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001755 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001756 return 1
1757 elif _all_zeros(self._int, prec):
1758 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001759 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001760 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001761
1762 def _round_half_down(self, prec):
1763 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001764 if _exact_half(self._int, prec):
1765 return -1
1766 else:
1767 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001768
1769 def _round_half_even(self, prec):
1770 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001771 if _exact_half(self._int, prec) and \
1772 (prec == 0 or self._int[prec-1] in '02468'):
1773 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001774 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001775 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001776
1777 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001778 """Rounds up (not away from 0 if negative.)"""
1779 if self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001780 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001781 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001782 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001783
Facundo Batista353750c2007-09-13 18:13:15 +00001784 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001785 """Rounds down (not towards 0 if negative)"""
1786 if not self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001787 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001788 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001789 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001790
Facundo Batista353750c2007-09-13 18:13:15 +00001791 def _round_05up(self, prec):
1792 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001793 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001794 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001795 else:
1796 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001797
Raymond Hettingere4579c32011-04-11 17:27:42 -07001798 _pick_rounding_function = dict(
Raymond Hettingerd9223292011-04-12 09:06:01 -07001799 ROUND_DOWN = _round_down,
1800 ROUND_UP = _round_up,
1801 ROUND_HALF_UP = _round_half_up,
1802 ROUND_HALF_DOWN = _round_half_down,
1803 ROUND_HALF_EVEN = _round_half_even,
1804 ROUND_CEILING = _round_ceiling,
1805 ROUND_FLOOR = _round_floor,
1806 ROUND_05UP = _round_05up,
Raymond Hettingere4579c32011-04-11 17:27:42 -07001807 )
1808
Facundo Batista353750c2007-09-13 18:13:15 +00001809 def fma(self, other, third, context=None):
1810 """Fused multiply-add.
1811
1812 Returns self*other+third with no rounding of the intermediate
1813 product self*other.
1814
1815 self and other are multiplied together, with no rounding of
1816 the result. The third operand is then added to the result,
1817 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001818 """
Facundo Batista353750c2007-09-13 18:13:15 +00001819
1820 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001821
1822 # compute product; raise InvalidOperation if either operand is
1823 # a signaling NaN or if the product is zero times infinity.
1824 if self._is_special or other._is_special:
1825 if context is None:
1826 context = getcontext()
1827 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001828 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001829 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001830 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001831 if self._exp == 'n':
1832 product = self
1833 elif other._exp == 'n':
1834 product = other
1835 elif self._exp == 'F':
1836 if not other:
1837 return context._raise_error(InvalidOperation,
1838 'INF * 0 in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001839 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001840 elif other._exp == 'F':
1841 if not self:
1842 return context._raise_error(InvalidOperation,
1843 '0 * INF in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001844 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001845 else:
1846 product = _dec_from_triple(self._sign ^ other._sign,
1847 str(int(self._int) * int(other._int)),
1848 self._exp + other._exp)
1849
Facundo Batista353750c2007-09-13 18:13:15 +00001850 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001851 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001852
Facundo Batista353750c2007-09-13 18:13:15 +00001853 def _power_modulo(self, other, modulo, context=None):
1854 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001855
Facundo Batista353750c2007-09-13 18:13:15 +00001856 # if can't convert other and modulo to Decimal, raise
1857 # TypeError; there's no point returning NotImplemented (no
1858 # equivalent of __rpow__ for three argument pow)
1859 other = _convert_other(other, raiseit=True)
1860 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001861
Facundo Batista353750c2007-09-13 18:13:15 +00001862 if context is None:
1863 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001864
Facundo Batista353750c2007-09-13 18:13:15 +00001865 # deal with NaNs: if there are any sNaNs then first one wins,
1866 # (i.e. behaviour for NaNs is identical to that of fma)
1867 self_is_nan = self._isnan()
1868 other_is_nan = other._isnan()
1869 modulo_is_nan = modulo._isnan()
1870 if self_is_nan or other_is_nan or modulo_is_nan:
1871 if self_is_nan == 2:
1872 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001873 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001874 if other_is_nan == 2:
1875 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001876 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001877 if modulo_is_nan == 2:
1878 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001879 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001880 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001881 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001882 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001883 return other._fix_nan(context)
1884 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001885
Facundo Batista353750c2007-09-13 18:13:15 +00001886 # check inputs: we apply same restrictions as Python's pow()
1887 if not (self._isinteger() and
1888 other._isinteger() and
1889 modulo._isinteger()):
1890 return context._raise_error(InvalidOperation,
1891 'pow() 3rd argument not allowed '
1892 'unless all arguments are integers')
1893 if other < 0:
1894 return context._raise_error(InvalidOperation,
1895 'pow() 2nd argument cannot be '
1896 'negative when 3rd argument specified')
1897 if not modulo:
1898 return context._raise_error(InvalidOperation,
1899 'pow() 3rd argument cannot be 0')
1900
1901 # additional restriction for decimal: the modulus must be less
1902 # than 10**prec in absolute value
1903 if modulo.adjusted() >= context.prec:
1904 return context._raise_error(InvalidOperation,
1905 'insufficient precision: pow() 3rd '
1906 'argument must not have more than '
1907 'precision digits')
1908
1909 # define 0**0 == NaN, for consistency with two-argument pow
1910 # (even though it hurts!)
1911 if not other and not self:
1912 return context._raise_error(InvalidOperation,
1913 'at least one of pow() 1st argument '
1914 'and 2nd argument must be nonzero ;'
1915 '0**0 is not defined')
1916
1917 # compute sign of result
1918 if other._iseven():
1919 sign = 0
1920 else:
1921 sign = self._sign
1922
1923 # convert modulo to a Python integer, and self and other to
1924 # Decimal integers (i.e. force their exponents to be >= 0)
1925 modulo = abs(int(modulo))
1926 base = _WorkRep(self.to_integral_value())
1927 exponent = _WorkRep(other.to_integral_value())
1928
1929 # compute result using integer pow()
1930 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1931 for i in xrange(exponent.exp):
1932 base = pow(base, 10, modulo)
1933 base = pow(base, exponent.int, modulo)
1934
Facundo Batista72bc54f2007-11-23 17:59:00 +00001935 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001936
1937 def _power_exact(self, other, p):
1938 """Attempt to compute self**other exactly.
1939
1940 Given Decimals self and other and an integer p, attempt to
1941 compute an exact result for the power self**other, with p
1942 digits of precision. Return None if self**other is not
1943 exactly representable in p digits.
1944
1945 Assumes that elimination of special cases has already been
1946 performed: self and other must both be nonspecial; self must
1947 be positive and not numerically equal to 1; other must be
1948 nonzero. For efficiency, other._exp should not be too large,
1949 so that 10**abs(other._exp) is a feasible calculation."""
1950
Mark Dickinsona493ca32011-06-04 18:24:15 +01001951 # In the comments below, we write x for the value of self and y for the
1952 # value of other. Write x = xc*10**xe and abs(y) = yc*10**ye, with xc
1953 # and yc positive integers not divisible by 10.
Facundo Batista353750c2007-09-13 18:13:15 +00001954
1955 # The main purpose of this method is to identify the *failure*
1956 # of x**y to be exactly representable with as little effort as
1957 # possible. So we look for cheap and easy tests that
1958 # eliminate the possibility of x**y being exact. Only if all
1959 # these tests are passed do we go on to actually compute x**y.
1960
Mark Dickinsona493ca32011-06-04 18:24:15 +01001961 # Here's the main idea. Express y as a rational number m/n, with m and
1962 # n relatively prime and n>0. Then for x**y to be exactly
1963 # representable (at *any* precision), xc must be the nth power of a
1964 # positive integer and xe must be divisible by n. If y is negative
1965 # then additionally xc must be a power of either 2 or 5, hence a power
1966 # of 2**n or 5**n.
Facundo Batista353750c2007-09-13 18:13:15 +00001967 #
1968 # There's a limit to how small |y| can be: if y=m/n as above
1969 # then:
1970 #
1971 # (1) if xc != 1 then for the result to be representable we
1972 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1973 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1974 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1975 # representable.
1976 #
1977 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1978 # |y| < 1/|xe| then the result is not representable.
1979 #
1980 # Note that since x is not equal to 1, at least one of (1) and
1981 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1982 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1983 #
1984 # There's also a limit to how large y can be, at least if it's
1985 # positive: the normalized result will have coefficient xc**y,
1986 # so if it's representable then xc**y < 10**p, and y <
1987 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1988 # not exactly representable.
1989
1990 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1991 # so |y| < 1/xe and the result is not representable.
1992 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1993 # < 1/nbits(xc).
1994
1995 x = _WorkRep(self)
1996 xc, xe = x.int, x.exp
1997 while xc % 10 == 0:
1998 xc //= 10
1999 xe += 1
2000
2001 y = _WorkRep(other)
2002 yc, ye = y.int, y.exp
2003 while yc % 10 == 0:
2004 yc //= 10
2005 ye += 1
2006
2007 # case where xc == 1: result is 10**(xe*y), with xe*y
2008 # required to be an integer
2009 if xc == 1:
Mark Dickinsone85aa732010-07-08 19:24:40 +00002010 xe *= yc
2011 # result is now 10**(xe * 10**ye); xe * 10**ye must be integral
2012 while xe % 10 == 0:
2013 xe //= 10
2014 ye += 1
2015 if ye < 0:
2016 return None
2017 exponent = xe * 10**ye
Facundo Batista353750c2007-09-13 18:13:15 +00002018 if y.sign == 1:
2019 exponent = -exponent
2020 # if other is a nonnegative integer, use ideal exponent
2021 if other._isinteger() and other._sign == 0:
2022 ideal_exponent = self._exp*int(other)
2023 zeros = min(exponent-ideal_exponent, p-1)
2024 else:
2025 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002026 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002027
2028 # case where y is negative: xc must be either a power
2029 # of 2 or a power of 5.
2030 if y.sign == 1:
2031 last_digit = xc % 10
2032 if last_digit in (2,4,6,8):
2033 # quick test for power of 2
2034 if xc & -xc != xc:
2035 return None
2036 # now xc is a power of 2; e is its exponent
2037 e = _nbits(xc)-1
Facundo Batista353750c2007-09-13 18:13:15 +00002038
Mark Dickinsona493ca32011-06-04 18:24:15 +01002039 # We now have:
2040 #
2041 # x = 2**e * 10**xe, e > 0, and y < 0.
2042 #
2043 # The exact result is:
2044 #
2045 # x**y = 5**(-e*y) * 10**(e*y + xe*y)
2046 #
2047 # provided that both e*y and xe*y are integers. Note that if
2048 # 5**(-e*y) >= 10**p, then the result can't be expressed
2049 # exactly with p digits of precision.
2050 #
2051 # Using the above, we can guard against large values of ye.
2052 # 93/65 is an upper bound for log(10)/log(5), so if
2053 #
2054 # ye >= len(str(93*p//65))
2055 #
2056 # then
2057 #
2058 # -e*y >= -y >= 10**ye > 93*p/65 > p*log(10)/log(5),
2059 #
2060 # so 5**(-e*y) >= 10**p, and the coefficient of the result
2061 # can't be expressed in p digits.
2062
2063 # emax >= largest e such that 5**e < 10**p.
2064 emax = p*93//65
2065 if ye >= len(str(emax)):
2066 return None
2067
2068 # Find -e*y and -xe*y; both must be integers
2069 e = _decimal_lshift_exact(e * yc, ye)
2070 xe = _decimal_lshift_exact(xe * yc, ye)
2071 if e is None or xe is None:
2072 return None
2073
2074 if e > emax:
Facundo Batista353750c2007-09-13 18:13:15 +00002075 return None
2076 xc = 5**e
2077
2078 elif last_digit == 5:
2079 # e >= log_5(xc) if xc is a power of 5; we have
2080 # equality all the way up to xc=5**2658
2081 e = _nbits(xc)*28//65
2082 xc, remainder = divmod(5**e, xc)
2083 if remainder:
2084 return None
2085 while xc % 5 == 0:
2086 xc //= 5
2087 e -= 1
Mark Dickinsona493ca32011-06-04 18:24:15 +01002088
2089 # Guard against large values of ye, using the same logic as in
2090 # the 'xc is a power of 2' branch. 10/3 is an upper bound for
2091 # log(10)/log(2).
2092 emax = p*10//3
2093 if ye >= len(str(emax)):
2094 return None
2095
2096 e = _decimal_lshift_exact(e * yc, ye)
2097 xe = _decimal_lshift_exact(xe * yc, ye)
2098 if e is None or xe is None:
2099 return None
2100
2101 if e > emax:
Facundo Batista353750c2007-09-13 18:13:15 +00002102 return None
2103 xc = 2**e
2104 else:
2105 return None
2106
2107 if xc >= 10**p:
2108 return None
2109 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00002110 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00002111
2112 # now y is positive; find m and n such that y = m/n
2113 if ye >= 0:
2114 m, n = yc*10**ye, 1
2115 else:
2116 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2117 return None
2118 xc_bits = _nbits(xc)
2119 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2120 return None
2121 m, n = yc, 10**(-ye)
2122 while m % 2 == n % 2 == 0:
2123 m //= 2
2124 n //= 2
2125 while m % 5 == n % 5 == 0:
2126 m //= 5
2127 n //= 5
2128
2129 # compute nth root of xc*10**xe
2130 if n > 1:
2131 # if 1 < xc < 2**n then xc isn't an nth power
2132 if xc != 1 and xc_bits <= n:
2133 return None
2134
2135 xe, rem = divmod(xe, n)
2136 if rem != 0:
2137 return None
2138
2139 # compute nth root of xc using Newton's method
2140 a = 1L << -(-_nbits(xc)//n) # initial estimate
2141 while True:
2142 q, r = divmod(xc, a**(n-1))
2143 if a <= q:
2144 break
2145 else:
2146 a = (a*(n-1) + q)//n
2147 if not (a == q and r == 0):
2148 return None
2149 xc = a
2150
2151 # now xc*10**xe is the nth root of the original xc*10**xe
2152 # compute mth power of xc*10**xe
2153
2154 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2155 # 10**p and the result is not representable.
2156 if xc > 1 and m > p*100//_log10_lb(xc):
2157 return None
2158 xc = xc**m
2159 xe *= m
2160 if xc > 10**p:
2161 return None
2162
2163 # by this point the result *is* exactly representable
2164 # adjust the exponent to get as close as possible to the ideal
2165 # exponent, if necessary
2166 str_xc = str(xc)
2167 if other._isinteger() and other._sign == 0:
2168 ideal_exponent = self._exp*int(other)
2169 zeros = min(xe-ideal_exponent, p-len(str_xc))
2170 else:
2171 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002172 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002173
2174 def __pow__(self, other, modulo=None, context=None):
2175 """Return self ** other [ % modulo].
2176
2177 With two arguments, compute self**other.
2178
2179 With three arguments, compute (self**other) % modulo. For the
2180 three argument form, the following restrictions on the
2181 arguments hold:
2182
2183 - all three arguments must be integral
2184 - other must be nonnegative
2185 - either self or other (or both) must be nonzero
2186 - modulo must be nonzero and must have at most p digits,
2187 where p is the context precision.
2188
2189 If any of these restrictions is violated the InvalidOperation
2190 flag is raised.
2191
2192 The result of pow(self, other, modulo) is identical to the
2193 result that would be obtained by computing (self**other) %
2194 modulo with unbounded precision, but is computed more
2195 efficiently. It is always exact.
2196 """
2197
2198 if modulo is not None:
2199 return self._power_modulo(other, modulo, context)
2200
2201 other = _convert_other(other)
2202 if other is NotImplemented:
2203 return other
2204
2205 if context is None:
2206 context = getcontext()
2207
2208 # either argument is a NaN => result is NaN
2209 ans = self._check_nans(other, context)
2210 if ans:
2211 return ans
2212
2213 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2214 if not other:
2215 if not self:
2216 return context._raise_error(InvalidOperation, '0 ** 0')
2217 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002218 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002219
2220 # result has sign 1 iff self._sign is 1 and other is an odd integer
2221 result_sign = 0
2222 if self._sign == 1:
2223 if other._isinteger():
2224 if not other._iseven():
2225 result_sign = 1
2226 else:
2227 # -ve**noninteger = NaN
2228 # (-0)**noninteger = 0**noninteger
2229 if self:
2230 return context._raise_error(InvalidOperation,
2231 'x ** y with x negative and y not an integer')
2232 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002233 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002234
2235 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2236 if not self:
2237 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002238 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002239 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002240 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002241
2242 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002243 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002244 if other._sign == 0:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002245 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002246 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002247 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002248
Facundo Batista353750c2007-09-13 18:13:15 +00002249 # 1**other = 1, but the choice of exponent and the flags
2250 # depend on the exponent of self, and on whether other is a
2251 # positive integer, a negative integer, or neither
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002252 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002253 if other._isinteger():
2254 # exp = max(self._exp*max(int(other), 0),
2255 # 1-context.prec) but evaluating int(other) directly
2256 # is dangerous until we know other is small (other
2257 # could be 1e999999999)
2258 if other._sign == 1:
2259 multiplier = 0
2260 elif other > context.prec:
2261 multiplier = context.prec
2262 else:
2263 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002264
Facundo Batista353750c2007-09-13 18:13:15 +00002265 exp = self._exp * multiplier
2266 if exp < 1-context.prec:
2267 exp = 1-context.prec
2268 context._raise_error(Rounded)
2269 else:
2270 context._raise_error(Inexact)
2271 context._raise_error(Rounded)
2272 exp = 1-context.prec
2273
Facundo Batista72bc54f2007-11-23 17:59:00 +00002274 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002275
2276 # compute adjusted exponent of self
2277 self_adj = self.adjusted()
2278
2279 # self ** infinity is infinity if self > 1, 0 if self < 1
2280 # self ** -infinity is infinity if self < 1, 0 if self > 1
2281 if other._isinfinity():
2282 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002283 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002284 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002285 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002286
2287 # from here on, the result always goes through the call
2288 # to _fix at the end of this function.
2289 ans = None
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002290 exact = False
Facundo Batista353750c2007-09-13 18:13:15 +00002291
2292 # crude test to catch cases of extreme overflow/underflow. If
2293 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2294 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2295 # self**other >= 10**(Emax+1), so overflow occurs. The test
2296 # for underflow is similar.
2297 bound = self._log10_exp_bound() + other.adjusted()
2298 if (self_adj >= 0) == (other._sign == 0):
2299 # self > 1 and other +ve, or self < 1 and other -ve
2300 # possibility of overflow
2301 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002302 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002303 else:
2304 # self > 1 and other -ve, or self < 1 and other +ve
2305 # possibility of underflow to 0
2306 Etiny = context.Etiny()
2307 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002308 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002309
2310 # try for an exact result with precision +1
2311 if ans is None:
2312 ans = self._power_exact(other, context.prec + 1)
Mark Dickinsone85aa732010-07-08 19:24:40 +00002313 if ans is not None:
2314 if result_sign == 1:
2315 ans = _dec_from_triple(1, ans._int, ans._exp)
2316 exact = True
Facundo Batista353750c2007-09-13 18:13:15 +00002317
2318 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2319 if ans is None:
2320 p = context.prec
2321 x = _WorkRep(self)
2322 xc, xe = x.int, x.exp
2323 y = _WorkRep(other)
2324 yc, ye = y.int, y.exp
2325 if y.sign == 1:
2326 yc = -yc
2327
2328 # compute correctly rounded result: start with precision +3,
2329 # then increase precision until result is unambiguously roundable
2330 extra = 3
2331 while True:
2332 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2333 if coeff % (5*10**(len(str(coeff))-p-1)):
2334 break
2335 extra += 3
2336
Facundo Batista72bc54f2007-11-23 17:59:00 +00002337 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002338
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002339 # unlike exp, ln and log10, the power function respects the
2340 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2341
2342 # There's a difficulty here when 'other' is not an integer and
2343 # the result is exact. In this case, the specification
2344 # requires that the Inexact flag be raised (in spite of
2345 # exactness), but since the result is exact _fix won't do this
2346 # for us. (Correspondingly, the Underflow signal should also
2347 # be raised for subnormal results.) We can't directly raise
2348 # these signals either before or after calling _fix, since
2349 # that would violate the precedence for signals. So we wrap
2350 # the ._fix call in a temporary context, and reraise
2351 # afterwards.
2352 if exact and not other._isinteger():
2353 # pad with zeros up to length context.prec+1 if necessary; this
2354 # ensures that the Rounded signal will be raised.
Facundo Batista353750c2007-09-13 18:13:15 +00002355 if len(ans._int) <= context.prec:
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002356 expdiff = context.prec + 1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002357 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2358 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002359
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002360 # create a copy of the current context, with cleared flags/traps
2361 newcontext = context.copy()
2362 newcontext.clear_flags()
2363 for exception in _signals:
2364 newcontext.traps[exception] = 0
2365
2366 # round in the new context
2367 ans = ans._fix(newcontext)
2368
2369 # raise Inexact, and if necessary, Underflow
2370 newcontext._raise_error(Inexact)
2371 if newcontext.flags[Subnormal]:
2372 newcontext._raise_error(Underflow)
2373
2374 # propagate signals to the original context; _fix could
2375 # have raised any of Overflow, Underflow, Subnormal,
2376 # Inexact, Rounded, Clamped. Overflow needs the correct
2377 # arguments. Note that the order of the exceptions is
2378 # important here.
2379 if newcontext.flags[Overflow]:
2380 context._raise_error(Overflow, 'above Emax', ans._sign)
2381 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2382 if newcontext.flags[exception]:
2383 context._raise_error(exception)
2384
2385 else:
2386 ans = ans._fix(context)
2387
Facundo Batista353750c2007-09-13 18:13:15 +00002388 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002389
2390 def __rpow__(self, other, context=None):
2391 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002392 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002393 if other is NotImplemented:
2394 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002395 return other.__pow__(self, context=context)
2396
2397 def normalize(self, context=None):
2398 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002399
Facundo Batista353750c2007-09-13 18:13:15 +00002400 if context is None:
2401 context = getcontext()
2402
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002403 if self._is_special:
2404 ans = self._check_nans(context=context)
2405 if ans:
2406 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002407
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002408 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002409 if dup._isinfinity():
2410 return dup
2411
2412 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002413 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002414 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002415 end = len(dup._int)
2416 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002417 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002418 exp += 1
2419 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002420 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002421
Facundo Batistabd2fe832007-09-13 18:42:09 +00002422 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002423 """Quantize self so its exponent is the same as that of exp.
2424
2425 Similar to self._rescale(exp._exp) but with error checking.
2426 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002427 exp = _convert_other(exp, raiseit=True)
2428
Facundo Batista353750c2007-09-13 18:13:15 +00002429 if context is None:
2430 context = getcontext()
2431 if rounding is None:
2432 rounding = context.rounding
2433
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002434 if self._is_special or exp._is_special:
2435 ans = self._check_nans(exp, context)
2436 if ans:
2437 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002438
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002439 if exp._isinfinity() or self._isinfinity():
2440 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002441 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002442 return context._raise_error(InvalidOperation,
2443 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002444
Facundo Batistabd2fe832007-09-13 18:42:09 +00002445 # if we're not watching exponents, do a simple rescale
2446 if not watchexp:
2447 ans = self._rescale(exp._exp, rounding)
2448 # raise Inexact and Rounded where appropriate
2449 if ans._exp > self._exp:
2450 context._raise_error(Rounded)
2451 if ans != self:
2452 context._raise_error(Inexact)
2453 return ans
2454
Facundo Batista353750c2007-09-13 18:13:15 +00002455 # exp._exp should be between Etiny and Emax
2456 if not (context.Etiny() <= exp._exp <= context.Emax):
2457 return context._raise_error(InvalidOperation,
2458 'target exponent out of bounds in quantize')
2459
2460 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002461 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002462 return ans._fix(context)
2463
2464 self_adjusted = self.adjusted()
2465 if self_adjusted > context.Emax:
2466 return context._raise_error(InvalidOperation,
2467 'exponent of quantize result too large for current context')
2468 if self_adjusted - exp._exp + 1 > context.prec:
2469 return context._raise_error(InvalidOperation,
2470 'quantize result has too many digits for current context')
2471
2472 ans = self._rescale(exp._exp, rounding)
2473 if ans.adjusted() > context.Emax:
2474 return context._raise_error(InvalidOperation,
2475 'exponent of quantize result too large for current context')
2476 if len(ans._int) > context.prec:
2477 return context._raise_error(InvalidOperation,
2478 'quantize result has too many digits for current context')
2479
2480 # raise appropriate flags
Facundo Batista353750c2007-09-13 18:13:15 +00002481 if ans and ans.adjusted() < context.Emin:
2482 context._raise_error(Subnormal)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002483 if ans._exp > self._exp:
2484 if ans != self:
2485 context._raise_error(Inexact)
2486 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00002487
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002488 # call to fix takes care of any necessary folddown, and
2489 # signals Clamped if necessary
Facundo Batista353750c2007-09-13 18:13:15 +00002490 ans = ans._fix(context)
2491 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002492
2493 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002494 """Return True if self and other have the same exponent; otherwise
2495 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002496
Facundo Batista1a191df2007-10-02 17:01:24 +00002497 If either operand is a special value, the following rules are used:
2498 * return True if both operands are infinities
2499 * return True if both operands are NaNs
2500 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002501 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002502 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002503 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002504 return (self.is_nan() and other.is_nan() or
2505 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002506 return self._exp == other._exp
2507
Facundo Batista353750c2007-09-13 18:13:15 +00002508 def _rescale(self, exp, rounding):
2509 """Rescale self so that the exponent is exp, either by padding with zeros
2510 or by truncating digits, using the given rounding mode.
2511
2512 Specials are returned without change. This operation is
2513 quiet: it raises no flags, and uses no information from the
2514 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002515
2516 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002517 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002518 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002519 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002520 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002521 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002522 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002523
Facundo Batista353750c2007-09-13 18:13:15 +00002524 if self._exp >= exp:
2525 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002526 return _dec_from_triple(self._sign,
2527 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002528
Facundo Batista353750c2007-09-13 18:13:15 +00002529 # too many digits; round and lose data. If self.adjusted() <
2530 # exp-1, replace self by 10**(exp-1) before rounding
2531 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002532 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002533 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002534 digits = 0
Raymond Hettingerd9223292011-04-12 09:06:01 -07002535 this_function = self._pick_rounding_function[rounding]
2536 changed = this_function(self, digits)
Facundo Batista2ec74152007-12-03 17:55:00 +00002537 coeff = self._int[:digits] or '0'
2538 if changed == 1:
2539 coeff = str(int(coeff)+1)
2540 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002541
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002542 def _round(self, places, rounding):
2543 """Round a nonzero, nonspecial Decimal to a fixed number of
2544 significant figures, using the given rounding mode.
2545
2546 Infinities, NaNs and zeros are returned unaltered.
2547
2548 This operation is quiet: it raises no flags, and uses no
2549 information from the context.
2550
2551 """
2552 if places <= 0:
2553 raise ValueError("argument should be at least 1 in _round")
2554 if self._is_special or not self:
2555 return Decimal(self)
2556 ans = self._rescale(self.adjusted()+1-places, rounding)
2557 # it can happen that the rescale alters the adjusted exponent;
2558 # for example when rounding 99.97 to 3 significant figures.
2559 # When this happens we end up with an extra 0 at the end of
2560 # the number; a second rescale fixes this.
2561 if ans.adjusted() != self.adjusted():
2562 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2563 return ans
2564
Facundo Batista353750c2007-09-13 18:13:15 +00002565 def to_integral_exact(self, rounding=None, context=None):
2566 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002567
Facundo Batista353750c2007-09-13 18:13:15 +00002568 If no rounding mode is specified, take the rounding mode from
2569 the context. This method raises the Rounded and Inexact flags
2570 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002571
Facundo Batista353750c2007-09-13 18:13:15 +00002572 See also: to_integral_value, which does exactly the same as
2573 this method except that it doesn't raise Inexact or Rounded.
2574 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002575 if self._is_special:
2576 ans = self._check_nans(context=context)
2577 if ans:
2578 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002579 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002580 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002581 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002582 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002583 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002584 if context is None:
2585 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002586 if rounding is None:
2587 rounding = context.rounding
Facundo Batista353750c2007-09-13 18:13:15 +00002588 ans = self._rescale(0, rounding)
2589 if ans != self:
2590 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002591 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002592 return ans
2593
Facundo Batista353750c2007-09-13 18:13:15 +00002594 def to_integral_value(self, rounding=None, context=None):
2595 """Rounds to the nearest integer, without raising inexact, rounded."""
2596 if context is None:
2597 context = getcontext()
2598 if rounding is None:
2599 rounding = context.rounding
2600 if self._is_special:
2601 ans = self._check_nans(context=context)
2602 if ans:
2603 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002604 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002605 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002606 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002607 else:
2608 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002609
Facundo Batista353750c2007-09-13 18:13:15 +00002610 # the method name changed, but we provide also the old one, for compatibility
2611 to_integral = to_integral_value
2612
2613 def sqrt(self, context=None):
2614 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002615 if context is None:
2616 context = getcontext()
2617
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002618 if self._is_special:
2619 ans = self._check_nans(context=context)
2620 if ans:
2621 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002622
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002623 if self._isinfinity() and self._sign == 0:
2624 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002625
2626 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002627 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002628 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002629 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002630
2631 if self._sign == 1:
2632 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2633
Facundo Batista353750c2007-09-13 18:13:15 +00002634 # At this point self represents a positive number. Let p be
2635 # the desired precision and express self in the form c*100**e
2636 # with c a positive real number and e an integer, c and e
2637 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2638 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2639 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2640 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2641 # the closest integer to sqrt(c) with the even integer chosen
2642 # in the case of a tie.
2643 #
2644 # To ensure correct rounding in all cases, we use the
2645 # following trick: we compute the square root to an extra
2646 # place (precision p+1 instead of precision p), rounding down.
2647 # Then, if the result is inexact and its last digit is 0 or 5,
2648 # we increase the last digit to 1 or 6 respectively; if it's
2649 # exact we leave the last digit alone. Now the final round to
2650 # p places (or fewer in the case of underflow) will round
2651 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002652
Facundo Batista353750c2007-09-13 18:13:15 +00002653 # use an extra digit of precision
2654 prec = context.prec+1
2655
2656 # write argument in the form c*100**e where e = self._exp//2
2657 # is the 'ideal' exponent, to be used if the square root is
2658 # exactly representable. l is the number of 'digits' of c in
2659 # base 100, so that 100**(l-1) <= c < 100**l.
2660 op = _WorkRep(self)
2661 e = op.exp >> 1
2662 if op.exp & 1:
2663 c = op.int * 10
2664 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002665 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002666 c = op.int
2667 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002668
Facundo Batista353750c2007-09-13 18:13:15 +00002669 # rescale so that c has exactly prec base 100 'digits'
2670 shift = prec-l
2671 if shift >= 0:
2672 c *= 100**shift
2673 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002674 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002675 c, remainder = divmod(c, 100**-shift)
2676 exact = not remainder
2677 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002678
Facundo Batista353750c2007-09-13 18:13:15 +00002679 # find n = floor(sqrt(c)) using Newton's method
2680 n = 10**prec
2681 while True:
2682 q = c//n
2683 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002684 break
Facundo Batista353750c2007-09-13 18:13:15 +00002685 else:
2686 n = n + q >> 1
2687 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002688
Facundo Batista353750c2007-09-13 18:13:15 +00002689 if exact:
2690 # result is exact; rescale to use ideal exponent e
2691 if shift >= 0:
2692 # assert n % 10**shift == 0
2693 n //= 10**shift
2694 else:
2695 n *= 10**-shift
2696 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002697 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002698 # result is not exact; fix last digit as described above
2699 if n % 5 == 0:
2700 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002701
Facundo Batista72bc54f2007-11-23 17:59:00 +00002702 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002703
Facundo Batista353750c2007-09-13 18:13:15 +00002704 # round, and fit to current context
2705 context = context._shallow_copy()
2706 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002707 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002708 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002709
Facundo Batista353750c2007-09-13 18:13:15 +00002710 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002711
2712 def max(self, other, context=None):
2713 """Returns the larger value.
2714
Facundo Batista353750c2007-09-13 18:13:15 +00002715 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002716 NaN (and signals if one is sNaN). Also rounds.
2717 """
Facundo Batista353750c2007-09-13 18:13:15 +00002718 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002719
Facundo Batista6c398da2007-09-17 17:30:13 +00002720 if context is None:
2721 context = getcontext()
2722
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002723 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002724 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002725 # number is always returned
2726 sn = self._isnan()
2727 on = other._isnan()
2728 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002729 if on == 1 and sn == 0:
2730 return self._fix(context)
2731 if sn == 1 and on == 0:
2732 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002733 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002734
Mark Dickinson2fc92632008-02-06 22:10:50 +00002735 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002736 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002737 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002738 # then an ordering is applied:
2739 #
Facundo Batista59c58842007-04-10 12:58:45 +00002740 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002741 # positive sign and min returns the operand with the negative sign
2742 #
Facundo Batista59c58842007-04-10 12:58:45 +00002743 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002744 # the result. This is exactly the ordering used in compare_total.
2745 c = self.compare_total(other)
2746
2747 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002748 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002749 else:
2750 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002751
Facundo Batistae64acfa2007-12-17 14:18:42 +00002752 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002753
2754 def min(self, other, context=None):
2755 """Returns the smaller value.
2756
Facundo Batista59c58842007-04-10 12:58:45 +00002757 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002758 NaN (and signals if one is sNaN). Also rounds.
2759 """
Facundo Batista353750c2007-09-13 18:13:15 +00002760 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002761
Facundo Batista6c398da2007-09-17 17:30:13 +00002762 if context is None:
2763 context = getcontext()
2764
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002765 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002766 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002767 # number is always returned
2768 sn = self._isnan()
2769 on = other._isnan()
2770 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002771 if on == 1 and sn == 0:
2772 return self._fix(context)
2773 if sn == 1 and on == 0:
2774 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002775 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002776
Mark Dickinson2fc92632008-02-06 22:10:50 +00002777 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002778 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002779 c = self.compare_total(other)
2780
2781 if c == -1:
2782 ans = self
2783 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002784 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002785
Facundo Batistae64acfa2007-12-17 14:18:42 +00002786 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002787
2788 def _isinteger(self):
2789 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002790 if self._is_special:
2791 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002792 if self._exp >= 0:
2793 return True
2794 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002795 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002796
2797 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002798 """Returns True if self is even. Assumes self is an integer."""
2799 if not self or self._exp > 0:
2800 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002801 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002802
2803 def adjusted(self):
2804 """Return the adjusted exponent of self"""
2805 try:
2806 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002807 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002808 except TypeError:
2809 return 0
2810
Facundo Batista353750c2007-09-13 18:13:15 +00002811 def canonical(self, context=None):
2812 """Returns the same Decimal object.
2813
2814 As we do not have different encodings for the same number, the
2815 received object already is in its canonical form.
2816 """
2817 return self
2818
2819 def compare_signal(self, other, context=None):
2820 """Compares self to the other operand numerically.
2821
2822 It's pretty much like compare(), but all NaNs signal, with signaling
2823 NaNs taking precedence over quiet NaNs.
2824 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002825 other = _convert_other(other, raiseit = True)
2826 ans = self._compare_check_nans(other, context)
2827 if ans:
2828 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002829 return self.compare(other, context=context)
2830
2831 def compare_total(self, other):
2832 """Compares self to other using the abstract representations.
2833
2834 This is not like the standard compare, which use their numerical
2835 value. Note that a total ordering is defined for all possible abstract
2836 representations.
2837 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002838 other = _convert_other(other, raiseit=True)
2839
Facundo Batista353750c2007-09-13 18:13:15 +00002840 # if one is negative and the other is positive, it's easy
2841 if self._sign and not other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002842 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002843 if not self._sign and other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002844 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002845 sign = self._sign
2846
2847 # let's handle both NaN types
2848 self_nan = self._isnan()
2849 other_nan = other._isnan()
2850 if self_nan or other_nan:
2851 if self_nan == other_nan:
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002852 # compare payloads as though they're integers
2853 self_key = len(self._int), self._int
2854 other_key = len(other._int), other._int
2855 if self_key < other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002856 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002857 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002858 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002859 return _NegativeOne
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002860 if self_key > other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002861 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002862 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002863 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002864 return _One
2865 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002866
2867 if sign:
2868 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002869 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002870 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002871 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002872 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002873 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002874 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002875 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002876 else:
2877 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002878 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002879 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002880 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002881 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002882 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002883 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002884 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002885
2886 if self < other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002887 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002888 if self > other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002889 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002890
2891 if self._exp < other._exp:
2892 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002893 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002894 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002895 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002896 if self._exp > other._exp:
2897 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002898 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002899 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002900 return _One
2901 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002902
2903
2904 def compare_total_mag(self, other):
2905 """Compares self to other using abstract repr., ignoring sign.
2906
2907 Like compare_total, but with operand's sign ignored and assumed to be 0.
2908 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002909 other = _convert_other(other, raiseit=True)
2910
Facundo Batista353750c2007-09-13 18:13:15 +00002911 s = self.copy_abs()
2912 o = other.copy_abs()
2913 return s.compare_total(o)
2914
2915 def copy_abs(self):
2916 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002917 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002918
2919 def copy_negate(self):
2920 """Returns a copy with the sign inverted."""
2921 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002922 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002923 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002924 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002925
2926 def copy_sign(self, other):
2927 """Returns self with the sign of other."""
Mark Dickinson6d8effb2010-02-18 14:27:02 +00002928 other = _convert_other(other, raiseit=True)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002929 return _dec_from_triple(other._sign, self._int,
2930 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002931
2932 def exp(self, context=None):
2933 """Returns e ** self."""
2934
2935 if context is None:
2936 context = getcontext()
2937
2938 # exp(NaN) = NaN
2939 ans = self._check_nans(context=context)
2940 if ans:
2941 return ans
2942
2943 # exp(-Infinity) = 0
2944 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002945 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002946
2947 # exp(0) = 1
2948 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002949 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002950
2951 # exp(Infinity) = Infinity
2952 if self._isinfinity() == 1:
2953 return Decimal(self)
2954
2955 # the result is now guaranteed to be inexact (the true
2956 # mathematical result is transcendental). There's no need to
2957 # raise Rounded and Inexact here---they'll always be raised as
2958 # a result of the call to _fix.
2959 p = context.prec
2960 adj = self.adjusted()
2961
2962 # we only need to do any computation for quite a small range
2963 # of adjusted exponents---for example, -29 <= adj <= 10 for
2964 # the default context. For smaller exponent the result is
2965 # indistinguishable from 1 at the given precision, while for
2966 # larger exponent the result either overflows or underflows.
2967 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2968 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002969 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002970 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2971 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002972 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002973 elif self._sign == 0 and adj < -p:
2974 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002975 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002976 elif self._sign == 1 and adj < -p-1:
2977 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002978 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002979 # general case
2980 else:
2981 op = _WorkRep(self)
2982 c, e = op.int, op.exp
2983 if op.sign == 1:
2984 c = -c
2985
2986 # compute correctly rounded result: increase precision by
2987 # 3 digits at a time until we get an unambiguously
2988 # roundable result
2989 extra = 3
2990 while True:
2991 coeff, exp = _dexp(c, e, p+extra)
2992 if coeff % (5*10**(len(str(coeff))-p-1)):
2993 break
2994 extra += 3
2995
Facundo Batista72bc54f2007-11-23 17:59:00 +00002996 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002997
2998 # at this stage, ans should round correctly with *any*
2999 # rounding mode, not just with ROUND_HALF_EVEN
3000 context = context._shallow_copy()
3001 rounding = context._set_rounding(ROUND_HALF_EVEN)
3002 ans = ans._fix(context)
3003 context.rounding = rounding
3004
3005 return ans
3006
3007 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003008 """Return True if self is canonical; otherwise return False.
3009
3010 Currently, the encoding of a Decimal instance is always
3011 canonical, so this method returns True for any Decimal.
3012 """
3013 return True
Facundo Batista353750c2007-09-13 18:13:15 +00003014
3015 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003016 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00003017
Facundo Batista1a191df2007-10-02 17:01:24 +00003018 A Decimal instance is considered finite if it is neither
3019 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00003020 """
Facundo Batista1a191df2007-10-02 17:01:24 +00003021 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00003022
3023 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003024 """Return True if self is infinite; otherwise return False."""
3025 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00003026
3027 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003028 """Return True if self is a qNaN or sNaN; otherwise return False."""
3029 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00003030
3031 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00003032 """Return True if self is a normal number; otherwise return False."""
3033 if self._is_special or not self:
3034 return False
Facundo Batista353750c2007-09-13 18:13:15 +00003035 if context is None:
3036 context = getcontext()
Mark Dickinsona7a52ab2009-10-20 13:33:03 +00003037 return context.Emin <= self.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +00003038
3039 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003040 """Return True if self is a quiet NaN; otherwise return False."""
3041 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00003042
3043 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003044 """Return True if self is negative; otherwise return False."""
3045 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00003046
3047 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003048 """Return True if self is a signaling NaN; otherwise return False."""
3049 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00003050
3051 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00003052 """Return True if self is subnormal; otherwise return False."""
3053 if self._is_special or not self:
3054 return False
Facundo Batista353750c2007-09-13 18:13:15 +00003055 if context is None:
3056 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00003057 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00003058
3059 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003060 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00003061 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00003062
3063 def _ln_exp_bound(self):
3064 """Compute a lower bound for the adjusted exponent of self.ln().
3065 In other words, compute r such that self.ln() >= 10**r. Assumes
3066 that self is finite and positive and that self != 1.
3067 """
3068
3069 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3070 adj = self._exp + len(self._int) - 1
3071 if adj >= 1:
3072 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3073 return len(str(adj*23//10)) - 1
3074 if adj <= -2:
3075 # argument <= 0.1
3076 return len(str((-1-adj)*23//10)) - 1
3077 op = _WorkRep(self)
3078 c, e = op.int, op.exp
3079 if adj == 0:
3080 # 1 < self < 10
3081 num = str(c-10**-e)
3082 den = str(c)
3083 return len(num) - len(den) - (num < den)
3084 # adj == -1, 0.1 <= self < 1
3085 return e + len(str(10**-e - c)) - 1
3086
3087
3088 def ln(self, context=None):
3089 """Returns the natural (base e) logarithm of self."""
3090
3091 if context is None:
3092 context = getcontext()
3093
3094 # ln(NaN) = NaN
3095 ans = self._check_nans(context=context)
3096 if ans:
3097 return ans
3098
3099 # ln(0.0) == -Infinity
3100 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003101 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003102
3103 # ln(Infinity) = Infinity
3104 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003105 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003106
3107 # ln(1.0) == 0.0
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003108 if self == _One:
3109 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00003110
3111 # ln(negative) raises InvalidOperation
3112 if self._sign == 1:
3113 return context._raise_error(InvalidOperation,
3114 'ln of a negative value')
3115
3116 # result is irrational, so necessarily inexact
3117 op = _WorkRep(self)
3118 c, e = op.int, op.exp
3119 p = context.prec
3120
3121 # correctly rounded result: repeatedly increase precision by 3
3122 # until we get an unambiguously roundable result
3123 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3124 while True:
3125 coeff = _dlog(c, e, places)
3126 # assert len(str(abs(coeff)))-p >= 1
3127 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3128 break
3129 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003130 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003131
3132 context = context._shallow_copy()
3133 rounding = context._set_rounding(ROUND_HALF_EVEN)
3134 ans = ans._fix(context)
3135 context.rounding = rounding
3136 return ans
3137
3138 def _log10_exp_bound(self):
3139 """Compute a lower bound for the adjusted exponent of self.log10().
3140 In other words, find r such that self.log10() >= 10**r.
3141 Assumes that self is finite and positive and that self != 1.
3142 """
3143
3144 # For x >= 10 or x < 0.1 we only need a bound on the integer
3145 # part of log10(self), and this comes directly from the
3146 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3147 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3148 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3149
3150 adj = self._exp + len(self._int) - 1
3151 if adj >= 1:
3152 # self >= 10
3153 return len(str(adj))-1
3154 if adj <= -2:
3155 # self < 0.1
3156 return len(str(-1-adj))-1
3157 op = _WorkRep(self)
3158 c, e = op.int, op.exp
3159 if adj == 0:
3160 # 1 < self < 10
3161 num = str(c-10**-e)
3162 den = str(231*c)
3163 return len(num) - len(den) - (num < den) + 2
3164 # adj == -1, 0.1 <= self < 1
3165 num = str(10**-e-c)
3166 return len(num) + e - (num < "231") - 1
3167
3168 def log10(self, context=None):
3169 """Returns the base 10 logarithm of self."""
3170
3171 if context is None:
3172 context = getcontext()
3173
3174 # log10(NaN) = NaN
3175 ans = self._check_nans(context=context)
3176 if ans:
3177 return ans
3178
3179 # log10(0.0) == -Infinity
3180 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003181 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003182
3183 # log10(Infinity) = Infinity
3184 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003185 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003186
3187 # log10(negative or -Infinity) raises InvalidOperation
3188 if self._sign == 1:
3189 return context._raise_error(InvalidOperation,
3190 'log10 of a negative value')
3191
3192 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003193 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003194 # answer may need rounding
3195 ans = Decimal(self._exp + len(self._int) - 1)
3196 else:
3197 # result is irrational, so necessarily inexact
3198 op = _WorkRep(self)
3199 c, e = op.int, op.exp
3200 p = context.prec
3201
3202 # correctly rounded result: repeatedly increase precision
3203 # until result is unambiguously roundable
3204 places = p-self._log10_exp_bound()+2
3205 while True:
3206 coeff = _dlog10(c, e, places)
3207 # assert len(str(abs(coeff)))-p >= 1
3208 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3209 break
3210 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003211 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003212
3213 context = context._shallow_copy()
3214 rounding = context._set_rounding(ROUND_HALF_EVEN)
3215 ans = ans._fix(context)
3216 context.rounding = rounding
3217 return ans
3218
3219 def logb(self, context=None):
3220 """ Returns the exponent of the magnitude of self's MSD.
3221
3222 The result is the integer which is the exponent of the magnitude
3223 of the most significant digit of self (as though it were truncated
3224 to a single digit while maintaining the value of that digit and
3225 without limiting the resulting exponent).
3226 """
3227 # logb(NaN) = NaN
3228 ans = self._check_nans(context=context)
3229 if ans:
3230 return ans
3231
3232 if context is None:
3233 context = getcontext()
3234
3235 # logb(+/-Inf) = +Inf
3236 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003237 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003238
3239 # logb(0) = -Inf, DivisionByZero
3240 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003241 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003242
3243 # otherwise, simply return the adjusted exponent of self, as a
3244 # Decimal. Note that no attempt is made to fit the result
3245 # into the current context.
Mark Dickinson15ae41c2009-10-07 19:22:05 +00003246 ans = Decimal(self.adjusted())
3247 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003248
3249 def _islogical(self):
3250 """Return True if self is a logical operand.
3251
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003252 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003253 an exponent of 0, and a coefficient whose digits must all be
3254 either 0 or 1.
3255 """
3256 if self._sign != 0 or self._exp != 0:
3257 return False
3258 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003259 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003260 return False
3261 return True
3262
3263 def _fill_logical(self, context, opa, opb):
3264 dif = context.prec - len(opa)
3265 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003266 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003267 elif dif < 0:
3268 opa = opa[-context.prec:]
3269 dif = context.prec - len(opb)
3270 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003271 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003272 elif dif < 0:
3273 opb = opb[-context.prec:]
3274 return opa, opb
3275
3276 def logical_and(self, other, context=None):
3277 """Applies an 'and' operation between self and other's digits."""
3278 if context is None:
3279 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003280
3281 other = _convert_other(other, raiseit=True)
3282
Facundo Batista353750c2007-09-13 18:13:15 +00003283 if not self._islogical() or not other._islogical():
3284 return context._raise_error(InvalidOperation)
3285
3286 # fill to context.prec
3287 (opa, opb) = self._fill_logical(context, self._int, other._int)
3288
3289 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003290 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3291 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003292
3293 def logical_invert(self, context=None):
3294 """Invert all its digits."""
3295 if context is None:
3296 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003297 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3298 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003299
3300 def logical_or(self, other, context=None):
3301 """Applies an 'or' operation between self and other's digits."""
3302 if context is None:
3303 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003304
3305 other = _convert_other(other, raiseit=True)
3306
Facundo Batista353750c2007-09-13 18:13:15 +00003307 if not self._islogical() or not other._islogical():
3308 return context._raise_error(InvalidOperation)
3309
3310 # fill to context.prec
3311 (opa, opb) = self._fill_logical(context, self._int, other._int)
3312
3313 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003314 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003315 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003316
3317 def logical_xor(self, other, context=None):
3318 """Applies an 'xor' operation between self and other's digits."""
3319 if context is None:
3320 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003321
3322 other = _convert_other(other, raiseit=True)
3323
Facundo Batista353750c2007-09-13 18:13:15 +00003324 if not self._islogical() or not other._islogical():
3325 return context._raise_error(InvalidOperation)
3326
3327 # fill to context.prec
3328 (opa, opb) = self._fill_logical(context, self._int, other._int)
3329
3330 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003331 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003332 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003333
3334 def max_mag(self, other, context=None):
3335 """Compares the values numerically with their sign ignored."""
3336 other = _convert_other(other, raiseit=True)
3337
Facundo Batista6c398da2007-09-17 17:30:13 +00003338 if context is None:
3339 context = getcontext()
3340
Facundo Batista353750c2007-09-13 18:13:15 +00003341 if self._is_special or other._is_special:
3342 # If one operand is a quiet NaN and the other is number, then the
3343 # number is always returned
3344 sn = self._isnan()
3345 on = other._isnan()
3346 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003347 if on == 1 and sn == 0:
3348 return self._fix(context)
3349 if sn == 1 and on == 0:
3350 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003351 return self._check_nans(other, context)
3352
Mark Dickinson2fc92632008-02-06 22:10:50 +00003353 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003354 if c == 0:
3355 c = self.compare_total(other)
3356
3357 if c == -1:
3358 ans = other
3359 else:
3360 ans = self
3361
Facundo Batistae64acfa2007-12-17 14:18:42 +00003362 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003363
3364 def min_mag(self, other, context=None):
3365 """Compares the values numerically with their sign ignored."""
3366 other = _convert_other(other, raiseit=True)
3367
Facundo Batista6c398da2007-09-17 17:30:13 +00003368 if context is None:
3369 context = getcontext()
3370
Facundo Batista353750c2007-09-13 18:13:15 +00003371 if self._is_special or other._is_special:
3372 # If one operand is a quiet NaN and the other is number, then the
3373 # number is always returned
3374 sn = self._isnan()
3375 on = other._isnan()
3376 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003377 if on == 1 and sn == 0:
3378 return self._fix(context)
3379 if sn == 1 and on == 0:
3380 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003381 return self._check_nans(other, context)
3382
Mark Dickinson2fc92632008-02-06 22:10:50 +00003383 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003384 if c == 0:
3385 c = self.compare_total(other)
3386
3387 if c == -1:
3388 ans = self
3389 else:
3390 ans = other
3391
Facundo Batistae64acfa2007-12-17 14:18:42 +00003392 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003393
3394 def next_minus(self, context=None):
3395 """Returns the largest representable number smaller than itself."""
3396 if context is None:
3397 context = getcontext()
3398
3399 ans = self._check_nans(context=context)
3400 if ans:
3401 return ans
3402
3403 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003404 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003405 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003406 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003407
3408 context = context.copy()
3409 context._set_rounding(ROUND_FLOOR)
3410 context._ignore_all_flags()
3411 new_self = self._fix(context)
3412 if new_self != self:
3413 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003414 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3415 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003416
3417 def next_plus(self, context=None):
3418 """Returns the smallest representable number larger than itself."""
3419 if context is None:
3420 context = getcontext()
3421
3422 ans = self._check_nans(context=context)
3423 if ans:
3424 return ans
3425
3426 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003427 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003428 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003429 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003430
3431 context = context.copy()
3432 context._set_rounding(ROUND_CEILING)
3433 context._ignore_all_flags()
3434 new_self = self._fix(context)
3435 if new_self != self:
3436 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003437 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3438 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003439
3440 def next_toward(self, other, context=None):
3441 """Returns the number closest to self, in the direction towards other.
3442
3443 The result is the closest representable number to self
3444 (excluding self) that is in the direction towards other,
3445 unless both have the same value. If the two operands are
3446 numerically equal, then the result is a copy of self with the
3447 sign set to be the same as the sign of other.
3448 """
3449 other = _convert_other(other, raiseit=True)
3450
3451 if context is None:
3452 context = getcontext()
3453
3454 ans = self._check_nans(other, context)
3455 if ans:
3456 return ans
3457
Mark Dickinson2fc92632008-02-06 22:10:50 +00003458 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003459 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003460 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003461
3462 if comparison == -1:
3463 ans = self.next_plus(context)
3464 else: # comparison == 1
3465 ans = self.next_minus(context)
3466
3467 # decide which flags to raise using value of ans
3468 if ans._isinfinity():
3469 context._raise_error(Overflow,
3470 'Infinite result from next_toward',
3471 ans._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00003472 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00003473 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003474 elif ans.adjusted() < context.Emin:
3475 context._raise_error(Underflow)
3476 context._raise_error(Subnormal)
Facundo Batista353750c2007-09-13 18:13:15 +00003477 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00003478 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003479 # if precision == 1 then we don't raise Clamped for a
3480 # result 0E-Etiny.
3481 if not ans:
3482 context._raise_error(Clamped)
3483
3484 return ans
3485
3486 def number_class(self, context=None):
3487 """Returns an indication of the class of self.
3488
3489 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003490 sNaN
3491 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003492 -Infinity
3493 -Normal
3494 -Subnormal
3495 -Zero
3496 +Zero
3497 +Subnormal
3498 +Normal
3499 +Infinity
3500 """
3501 if self.is_snan():
3502 return "sNaN"
3503 if self.is_qnan():
3504 return "NaN"
3505 inf = self._isinfinity()
3506 if inf == 1:
3507 return "+Infinity"
3508 if inf == -1:
3509 return "-Infinity"
3510 if self.is_zero():
3511 if self._sign:
3512 return "-Zero"
3513 else:
3514 return "+Zero"
3515 if context is None:
3516 context = getcontext()
3517 if self.is_subnormal(context=context):
3518 if self._sign:
3519 return "-Subnormal"
3520 else:
3521 return "+Subnormal"
3522 # just a normal, regular, boring number, :)
3523 if self._sign:
3524 return "-Normal"
3525 else:
3526 return "+Normal"
3527
3528 def radix(self):
3529 """Just returns 10, as this is Decimal, :)"""
3530 return Decimal(10)
3531
3532 def rotate(self, other, context=None):
3533 """Returns a rotated copy of self, value-of-other times."""
3534 if context is None:
3535 context = getcontext()
3536
Mark Dickinson0c673122009-10-29 12:04:00 +00003537 other = _convert_other(other, raiseit=True)
3538
Facundo Batista353750c2007-09-13 18:13:15 +00003539 ans = self._check_nans(other, context)
3540 if ans:
3541 return ans
3542
3543 if other._exp != 0:
3544 return context._raise_error(InvalidOperation)
3545 if not (-context.prec <= int(other) <= context.prec):
3546 return context._raise_error(InvalidOperation)
3547
3548 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003549 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003550
3551 # get values, pad if necessary
3552 torot = int(other)
3553 rotdig = self._int
3554 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003555 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003556 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003557 elif topad < 0:
3558 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003559
3560 # let's rotate!
3561 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003562 return _dec_from_triple(self._sign,
3563 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003564
Mark Dickinson0c673122009-10-29 12:04:00 +00003565 def scaleb(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00003566 """Returns self operand after adding the second value to its exp."""
3567 if context is None:
3568 context = getcontext()
3569
Mark Dickinson0c673122009-10-29 12:04:00 +00003570 other = _convert_other(other, raiseit=True)
3571
Facundo Batista353750c2007-09-13 18:13:15 +00003572 ans = self._check_nans(other, context)
3573 if ans:
3574 return ans
3575
3576 if other._exp != 0:
3577 return context._raise_error(InvalidOperation)
3578 liminf = -2 * (context.Emax + context.prec)
3579 limsup = 2 * (context.Emax + context.prec)
3580 if not (liminf <= int(other) <= limsup):
3581 return context._raise_error(InvalidOperation)
3582
3583 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003584 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003585
Facundo Batista72bc54f2007-11-23 17:59:00 +00003586 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003587 d = d._fix(context)
3588 return d
3589
3590 def shift(self, other, context=None):
3591 """Returns a shifted copy of self, value-of-other times."""
3592 if context is None:
3593 context = getcontext()
3594
Mark Dickinson0c673122009-10-29 12:04:00 +00003595 other = _convert_other(other, raiseit=True)
3596
Facundo Batista353750c2007-09-13 18:13:15 +00003597 ans = self._check_nans(other, context)
3598 if ans:
3599 return ans
3600
3601 if other._exp != 0:
3602 return context._raise_error(InvalidOperation)
3603 if not (-context.prec <= int(other) <= context.prec):
3604 return context._raise_error(InvalidOperation)
3605
3606 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003607 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003608
3609 # get values, pad if necessary
3610 torot = int(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003611 rotdig = self._int
3612 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003613 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003614 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003615 elif topad < 0:
3616 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003617
3618 # let's shift!
3619 if torot < 0:
Mark Dickinson6f390012009-10-29 12:11:18 +00003620 shifted = rotdig[:torot]
Facundo Batista353750c2007-09-13 18:13:15 +00003621 else:
Mark Dickinson6f390012009-10-29 12:11:18 +00003622 shifted = rotdig + '0'*torot
3623 shifted = shifted[-context.prec:]
Facundo Batista353750c2007-09-13 18:13:15 +00003624
Facundo Batista72bc54f2007-11-23 17:59:00 +00003625 return _dec_from_triple(self._sign,
Mark Dickinson6f390012009-10-29 12:11:18 +00003626 shifted.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003627
Facundo Batista59c58842007-04-10 12:58:45 +00003628 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003629 def __reduce__(self):
3630 return (self.__class__, (str(self),))
3631
3632 def __copy__(self):
Benjamin Peterson28e369a2010-01-25 03:58:21 +00003633 if type(self) is Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003634 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003635 return self.__class__(str(self))
3636
3637 def __deepcopy__(self, memo):
Benjamin Peterson28e369a2010-01-25 03:58:21 +00003638 if type(self) is Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003639 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003640 return self.__class__(str(self))
3641
Mark Dickinson277859d2009-03-17 23:03:46 +00003642 # PEP 3101 support. the _localeconv keyword argument should be
3643 # considered private: it's provided for ease of testing only.
3644 def __format__(self, specifier, context=None, _localeconv=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003645 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003646
3647 The specifier should be a standard format specifier, with the
3648 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson277859d2009-03-17 23:03:46 +00003649 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3650 type is omitted it defaults to 'g' or 'G', depending on the
3651 value of context.capitals.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003652 """
3653
3654 # Note: PEP 3101 says that if the type is not present then
3655 # there should be at least one digit after the decimal point.
3656 # We take the liberty of ignoring this requirement for
3657 # Decimal---it's presumably there to make sure that
3658 # format(float, '') behaves similarly to str(float).
3659 if context is None:
3660 context = getcontext()
3661
Mark Dickinson277859d2009-03-17 23:03:46 +00003662 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003663
Mark Dickinson277859d2009-03-17 23:03:46 +00003664 # special values don't care about the type or precision
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003665 if self._is_special:
Mark Dickinson277859d2009-03-17 23:03:46 +00003666 sign = _format_sign(self._sign, spec)
3667 body = str(self.copy_abs())
Stefan Krahce2ec492014-08-26 20:49:57 +02003668 if spec['type'] == '%':
3669 body += '%'
Mark Dickinson277859d2009-03-17 23:03:46 +00003670 return _format_align(sign, body, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003671
3672 # a type of None defaults to 'g' or 'G', depending on context
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003673 if spec['type'] is None:
3674 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson277859d2009-03-17 23:03:46 +00003675
3676 # if type is '%', adjust exponent of self accordingly
3677 if spec['type'] == '%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003678 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3679
3680 # round if necessary, taking rounding mode from the context
3681 rounding = context.rounding
3682 precision = spec['precision']
3683 if precision is not None:
3684 if spec['type'] in 'eE':
3685 self = self._round(precision+1, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003686 elif spec['type'] in 'fF%':
3687 self = self._rescale(-precision, rounding)
Mark Dickinson277859d2009-03-17 23:03:46 +00003688 elif spec['type'] in 'gG' and len(self._int) > precision:
3689 self = self._round(precision, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003690 # special case: zeros with a positive exponent can't be
3691 # represented in fixed point; rescale them to 0e0.
Mark Dickinson277859d2009-03-17 23:03:46 +00003692 if not self and self._exp > 0 and spec['type'] in 'fF%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003693 self = self._rescale(0, rounding)
3694
3695 # figure out placement of the decimal point
3696 leftdigits = self._exp + len(self._int)
Mark Dickinson277859d2009-03-17 23:03:46 +00003697 if spec['type'] in 'eE':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003698 if not self and precision is not None:
3699 dotplace = 1 - precision
3700 else:
3701 dotplace = 1
Mark Dickinson277859d2009-03-17 23:03:46 +00003702 elif spec['type'] in 'fF%':
3703 dotplace = leftdigits
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003704 elif spec['type'] in 'gG':
3705 if self._exp <= 0 and leftdigits > -6:
3706 dotplace = leftdigits
3707 else:
3708 dotplace = 1
3709
Mark Dickinson277859d2009-03-17 23:03:46 +00003710 # find digits before and after decimal point, and get exponent
3711 if dotplace < 0:
3712 intpart = '0'
3713 fracpart = '0'*(-dotplace) + self._int
3714 elif dotplace > len(self._int):
3715 intpart = self._int + '0'*(dotplace-len(self._int))
3716 fracpart = ''
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003717 else:
Mark Dickinson277859d2009-03-17 23:03:46 +00003718 intpart = self._int[:dotplace] or '0'
3719 fracpart = self._int[dotplace:]
3720 exp = leftdigits-dotplace
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003721
Mark Dickinson277859d2009-03-17 23:03:46 +00003722 # done with the decimal-specific stuff; hand over the rest
3723 # of the formatting to the _format_number function
3724 return _format_number(self._sign, intpart, fracpart, exp, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003725
Facundo Batista72bc54f2007-11-23 17:59:00 +00003726def _dec_from_triple(sign, coefficient, exponent, special=False):
3727 """Create a decimal instance directly, without any validation,
3728 normalization (e.g. removal of leading zeros) or argument
3729 conversion.
3730
3731 This function is for *internal use only*.
3732 """
3733
3734 self = object.__new__(Decimal)
3735 self._sign = sign
3736 self._int = coefficient
3737 self._exp = exponent
3738 self._is_special = special
3739
3740 return self
3741
Raymond Hettinger2c8585b2009-02-03 03:37:03 +00003742# Register Decimal as a kind of Number (an abstract base class).
3743# However, do not register it as Real (because Decimals are not
3744# interoperable with floats).
3745_numbers.Number.register(Decimal)
3746
3747
Facundo Batista59c58842007-04-10 12:58:45 +00003748##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003749
Nick Coghlanced12182006-09-02 03:54:17 +00003750class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003751 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003752
Nick Coghlanced12182006-09-02 03:54:17 +00003753 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003754 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003755 """
3756 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003757 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003758 def __enter__(self):
3759 self.saved_context = getcontext()
3760 setcontext(self.new_context)
3761 return self.new_context
3762 def __exit__(self, t, v, tb):
3763 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003764
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003765class Context(object):
3766 """Contains the context for a Decimal instance.
3767
3768 Contains:
3769 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003770 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003771 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003772 raised when it is caused. Otherwise, a value is
3773 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003774 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003775 (Whether or not the trap_enabler is set)
3776 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003777 Emin - Minimum exponent
3778 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003779 capitals - If 1, 1*10^1 is printed as 1E+1.
3780 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003781 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003782 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003783
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003784 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003785 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003786 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003787 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003788 _ignored_flags=None):
Mark Dickinson9b9e1252010-07-08 21:22:54 +00003789 # Set defaults; for everything except flags and _ignored_flags,
3790 # inherit from DefaultContext.
3791 try:
3792 dc = DefaultContext
3793 except NameError:
3794 pass
3795
3796 self.prec = prec if prec is not None else dc.prec
3797 self.rounding = rounding if rounding is not None else dc.rounding
3798 self.Emin = Emin if Emin is not None else dc.Emin
3799 self.Emax = Emax if Emax is not None else dc.Emax
3800 self.capitals = capitals if capitals is not None else dc.capitals
3801 self._clamp = _clamp if _clamp is not None else dc._clamp
3802
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003803 if _ignored_flags is None:
Mark Dickinson9b9e1252010-07-08 21:22:54 +00003804 self._ignored_flags = []
3805 else:
3806 self._ignored_flags = _ignored_flags
3807
3808 if traps is None:
3809 self.traps = dc.traps.copy()
3810 elif not isinstance(traps, dict):
3811 self.traps = dict((s, int(s in traps)) for s in _signals)
3812 else:
3813 self.traps = traps
3814
3815 if flags is None:
3816 self.flags = dict.fromkeys(_signals, 0)
3817 elif not isinstance(flags, dict):
3818 self.flags = dict((s, int(s in flags)) for s in _signals)
3819 else:
3820 self.flags = flags
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003821
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003822 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003823 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003824 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003825 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3826 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3827 % vars(self))
3828 names = [f.__name__ for f, v in self.flags.items() if v]
3829 s.append('flags=[' + ', '.join(names) + ']')
3830 names = [t.__name__ for t, v in self.traps.items() if v]
3831 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003832 return ', '.join(s) + ')'
3833
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003834 def clear_flags(self):
3835 """Reset all flags to zero"""
3836 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003837 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003838
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003839 def _shallow_copy(self):
3840 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003841 nc = Context(self.prec, self.rounding, self.traps,
3842 self.flags, self.Emin, self.Emax,
3843 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003844 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003845
3846 def copy(self):
3847 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003848 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003849 self.flags.copy(), self.Emin, self.Emax,
3850 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003851 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003852 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003853
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003854 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003855 """Handles an error
3856
3857 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003858 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah8a6f3fe2010-05-19 15:46:39 +00003859 trap_enabler is set, it reraises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003860 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003861 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003862 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003863 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003864 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003865 return error().handle(self, *args)
3866
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003867 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003868 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003869 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003870 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003871
3872 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003873 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003874 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003875
3876 def _ignore_all_flags(self):
3877 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003878 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003879
3880 def _ignore_flags(self, *flags):
3881 """Ignore the flags, if they are raised"""
3882 # Do not mutate-- This way, copies of a context leave the original
3883 # alone.
3884 self._ignored_flags = (self._ignored_flags + list(flags))
3885 return list(flags)
3886
3887 def _regard_flags(self, *flags):
3888 """Stop ignoring the flags, if they are raised"""
3889 if flags and isinstance(flags[0], (tuple,list)):
3890 flags = flags[0]
3891 for flag in flags:
3892 self._ignored_flags.remove(flag)
3893
Nick Coghlan53663a62008-07-15 14:27:37 +00003894 # We inherit object.__hash__, so we must deny this explicitly
3895 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003896
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003897 def Etiny(self):
3898 """Returns Etiny (= Emin - prec + 1)"""
3899 return int(self.Emin - self.prec + 1)
3900
3901 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003902 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003903 return int(self.Emax - self.prec + 1)
3904
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003905 def _set_rounding(self, type):
3906 """Sets the rounding type.
3907
3908 Sets the rounding type, and returns the current (previous)
3909 rounding type. Often used like:
3910
3911 context = context.copy()
3912 # so you don't change the calling context
3913 # if an error occurs in the middle.
3914 rounding = context._set_rounding(ROUND_UP)
3915 val = self.__sub__(other, context=context)
3916 context._set_rounding(rounding)
3917
3918 This will make it round up for that operation.
3919 """
3920 rounding = self.rounding
3921 self.rounding= type
3922 return rounding
3923
Raymond Hettingerfed52962004-07-14 15:41:57 +00003924 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003925 """Creates a new Decimal instance but using self as context.
3926
3927 This method implements the to-number operation of the
3928 IBM Decimal specification."""
3929
3930 if isinstance(num, basestring) and num != num.strip():
3931 return self._raise_error(ConversionSyntax,
3932 "no trailing or leading whitespace is "
3933 "permitted.")
3934
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003935 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003936 if d._isnan() and len(d._int) > self.prec - self._clamp:
3937 return self._raise_error(ConversionSyntax,
3938 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003939 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003940
Raymond Hettingerf4d85972009-01-03 19:02:23 +00003941 def create_decimal_from_float(self, f):
3942 """Creates a new Decimal instance from a float but rounding using self
3943 as the context.
3944
3945 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3946 >>> context.create_decimal_from_float(3.1415926535897932)
3947 Decimal('3.1415')
3948 >>> context = Context(prec=5, traps=[Inexact])
3949 >>> context.create_decimal_from_float(3.1415926535897932)
3950 Traceback (most recent call last):
3951 ...
3952 Inexact: None
3953
3954 """
3955 d = Decimal.from_float(f) # An exact conversion
3956 return d._fix(self) # Apply the context rounding
3957
Facundo Batista59c58842007-04-10 12:58:45 +00003958 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003959 def abs(self, a):
3960 """Returns the absolute value of the operand.
3961
3962 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003963 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003964 the plus operation on the operand.
3965
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003966 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003967 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003968 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003969 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003970 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003971 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003972 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003973 Decimal('101.5')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003974 >>> ExtendedContext.abs(-1)
3975 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003976 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003977 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003978 return a.__abs__(context=self)
3979
3980 def add(self, a, b):
3981 """Return the sum of the two operands.
3982
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003983 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003984 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003985 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003986 Decimal('1.02E+4')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003987 >>> ExtendedContext.add(1, Decimal(2))
3988 Decimal('3')
3989 >>> ExtendedContext.add(Decimal(8), 5)
3990 Decimal('13')
3991 >>> ExtendedContext.add(5, 5)
3992 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003993 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003994 a = _convert_other(a, raiseit=True)
3995 r = a.__add__(b, context=self)
3996 if r is NotImplemented:
3997 raise TypeError("Unable to convert %s to Decimal" % b)
3998 else:
3999 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004000
4001 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00004002 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004003
Facundo Batista353750c2007-09-13 18:13:15 +00004004 def canonical(self, a):
4005 """Returns the same Decimal object.
4006
4007 As we do not have different encodings for the same number, the
4008 received object already is in its canonical form.
4009
4010 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004011 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004012 """
4013 return a.canonical(context=self)
4014
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004015 def compare(self, a, b):
4016 """Compares values numerically.
4017
4018 If the signs of the operands differ, a value representing each operand
4019 ('-1' if the operand is less than zero, '0' if the operand is zero or
4020 negative zero, or '1' if the operand is greater than zero) is used in
4021 place of that operand for the comparison instead of the actual
4022 operand.
4023
4024 The comparison is then effected by subtracting the second operand from
4025 the first and then returning a value according to the result of the
4026 subtraction: '-1' if the result is less than zero, '0' if the result is
4027 zero or negative zero, or '1' if the result is greater than zero.
4028
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004029 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004030 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004031 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004032 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004033 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004034 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004035 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004036 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004037 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004038 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004039 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004040 Decimal('-1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004041 >>> ExtendedContext.compare(1, 2)
4042 Decimal('-1')
4043 >>> ExtendedContext.compare(Decimal(1), 2)
4044 Decimal('-1')
4045 >>> ExtendedContext.compare(1, Decimal(2))
4046 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004047 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004048 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004049 return a.compare(b, context=self)
4050
Facundo Batista353750c2007-09-13 18:13:15 +00004051 def compare_signal(self, a, b):
4052 """Compares the values of the two operands numerically.
4053
4054 It's pretty much like compare(), but all NaNs signal, with signaling
4055 NaNs taking precedence over quiet NaNs.
4056
4057 >>> c = ExtendedContext
4058 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004059 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004060 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004061 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004062 >>> c.flags[InvalidOperation] = 0
4063 >>> print c.flags[InvalidOperation]
4064 0
4065 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004066 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004067 >>> print c.flags[InvalidOperation]
4068 1
4069 >>> c.flags[InvalidOperation] = 0
4070 >>> print c.flags[InvalidOperation]
4071 0
4072 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004073 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004074 >>> print c.flags[InvalidOperation]
4075 1
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004076 >>> c.compare_signal(-1, 2)
4077 Decimal('-1')
4078 >>> c.compare_signal(Decimal(-1), 2)
4079 Decimal('-1')
4080 >>> c.compare_signal(-1, Decimal(2))
4081 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004082 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004083 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004084 return a.compare_signal(b, context=self)
4085
4086 def compare_total(self, a, b):
4087 """Compares two operands using their abstract representation.
4088
4089 This is not like the standard compare, which use their numerical
4090 value. Note that a total ordering is defined for all possible abstract
4091 representations.
4092
4093 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004094 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004095 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004096 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004097 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004098 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004099 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004100 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004101 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004102 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004103 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004104 Decimal('-1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004105 >>> ExtendedContext.compare_total(1, 2)
4106 Decimal('-1')
4107 >>> ExtendedContext.compare_total(Decimal(1), 2)
4108 Decimal('-1')
4109 >>> ExtendedContext.compare_total(1, Decimal(2))
4110 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004111 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004112 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004113 return a.compare_total(b)
4114
4115 def compare_total_mag(self, a, b):
4116 """Compares two operands using their abstract representation ignoring sign.
4117
4118 Like compare_total, but with operand's sign ignored and assumed to be 0.
4119 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004120 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004121 return a.compare_total_mag(b)
4122
4123 def copy_abs(self, a):
4124 """Returns a copy of the operand with the sign set to 0.
4125
4126 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004127 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00004128 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004129 Decimal('100')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004130 >>> ExtendedContext.copy_abs(-1)
4131 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004132 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004133 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004134 return a.copy_abs()
4135
4136 def copy_decimal(self, a):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004137 """Returns a copy of the decimal object.
Facundo Batista353750c2007-09-13 18:13:15 +00004138
4139 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004140 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00004141 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004142 Decimal('-1.00')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004143 >>> ExtendedContext.copy_decimal(1)
4144 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004145 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004146 a = _convert_other(a, raiseit=True)
Facundo Batista6c398da2007-09-17 17:30:13 +00004147 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00004148
4149 def copy_negate(self, a):
4150 """Returns a copy of the operand with the sign inverted.
4151
4152 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004153 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00004154 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004155 Decimal('101.5')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004156 >>> ExtendedContext.copy_negate(1)
4157 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004158 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004159 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004160 return a.copy_negate()
4161
4162 def copy_sign(self, a, b):
4163 """Copies the second operand's sign to the first one.
4164
4165 In detail, it returns a copy of the first operand with the sign
4166 equal to the sign of the second operand.
4167
4168 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004169 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004170 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004171 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004172 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004173 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004174 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004175 Decimal('-1.50')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004176 >>> ExtendedContext.copy_sign(1, -2)
4177 Decimal('-1')
4178 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4179 Decimal('-1')
4180 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4181 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004182 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004183 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004184 return a.copy_sign(b)
4185
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004186 def divide(self, a, b):
4187 """Decimal division in a specified context.
4188
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004189 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004190 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004191 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004192 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004193 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004194 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004195 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004196 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004197 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004198 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004199 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004200 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004201 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004202 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004203 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004204 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004205 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004206 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004207 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004208 Decimal('1.20E+6')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004209 >>> ExtendedContext.divide(5, 5)
4210 Decimal('1')
4211 >>> ExtendedContext.divide(Decimal(5), 5)
4212 Decimal('1')
4213 >>> ExtendedContext.divide(5, Decimal(5))
4214 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004215 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004216 a = _convert_other(a, raiseit=True)
4217 r = a.__div__(b, context=self)
4218 if r is NotImplemented:
4219 raise TypeError("Unable to convert %s to Decimal" % b)
4220 else:
4221 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004222
4223 def divide_int(self, a, b):
4224 """Divides two numbers and returns the integer part of the result.
4225
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004226 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004227 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004228 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004229 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004230 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004231 Decimal('3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004232 >>> ExtendedContext.divide_int(10, 3)
4233 Decimal('3')
4234 >>> ExtendedContext.divide_int(Decimal(10), 3)
4235 Decimal('3')
4236 >>> ExtendedContext.divide_int(10, Decimal(3))
4237 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004238 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004239 a = _convert_other(a, raiseit=True)
4240 r = a.__floordiv__(b, context=self)
4241 if r is NotImplemented:
4242 raise TypeError("Unable to convert %s to Decimal" % b)
4243 else:
4244 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004245
4246 def divmod(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004247 """Return (a // b, a % b).
Mark Dickinson202eb902010-01-06 16:20:22 +00004248
4249 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4250 (Decimal('2'), Decimal('2'))
4251 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4252 (Decimal('2'), Decimal('0'))
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004253 >>> ExtendedContext.divmod(8, 4)
4254 (Decimal('2'), Decimal('0'))
4255 >>> ExtendedContext.divmod(Decimal(8), 4)
4256 (Decimal('2'), Decimal('0'))
4257 >>> ExtendedContext.divmod(8, Decimal(4))
4258 (Decimal('2'), Decimal('0'))
Mark Dickinson202eb902010-01-06 16:20:22 +00004259 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004260 a = _convert_other(a, raiseit=True)
4261 r = a.__divmod__(b, context=self)
4262 if r is NotImplemented:
4263 raise TypeError("Unable to convert %s to Decimal" % b)
4264 else:
4265 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004266
Facundo Batista353750c2007-09-13 18:13:15 +00004267 def exp(self, a):
4268 """Returns e ** a.
4269
4270 >>> c = ExtendedContext.copy()
4271 >>> c.Emin = -999
4272 >>> c.Emax = 999
4273 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004274 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004275 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004276 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00004277 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004278 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004279 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004280 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00004281 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004282 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004283 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004284 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004285 >>> c.exp(10)
4286 Decimal('22026.4658')
Facundo Batista353750c2007-09-13 18:13:15 +00004287 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004288 a =_convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004289 return a.exp(context=self)
4290
4291 def fma(self, a, b, c):
4292 """Returns a multiplied by b, plus c.
4293
4294 The first two operands are multiplied together, using multiply,
4295 the third operand is then added to the result of that
4296 multiplication, using add, all with only one final rounding.
4297
4298 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004299 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004300 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004301 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004302 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004303 Decimal('1.38435736E+12')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004304 >>> ExtendedContext.fma(1, 3, 4)
4305 Decimal('7')
4306 >>> ExtendedContext.fma(1, Decimal(3), 4)
4307 Decimal('7')
4308 >>> ExtendedContext.fma(1, 3, Decimal(4))
4309 Decimal('7')
Facundo Batista353750c2007-09-13 18:13:15 +00004310 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004311 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004312 return a.fma(b, c, context=self)
4313
4314 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004315 """Return True if the operand is canonical; otherwise return False.
4316
4317 Currently, the encoding of a Decimal instance is always
4318 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004319
4320 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004321 True
Facundo Batista353750c2007-09-13 18:13:15 +00004322 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004323 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004324
4325 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004326 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004327
Facundo Batista1a191df2007-10-02 17:01:24 +00004328 A Decimal instance is considered finite if it is neither
4329 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004330
4331 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004332 True
Facundo Batista353750c2007-09-13 18:13:15 +00004333 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004334 True
Facundo Batista353750c2007-09-13 18:13:15 +00004335 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004336 True
Facundo Batista353750c2007-09-13 18:13:15 +00004337 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004338 False
Facundo Batista353750c2007-09-13 18:13:15 +00004339 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004340 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004341 >>> ExtendedContext.is_finite(1)
4342 True
Facundo Batista353750c2007-09-13 18:13:15 +00004343 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004344 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004345 return a.is_finite()
4346
4347 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004348 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004349
4350 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004351 False
Facundo Batista353750c2007-09-13 18:13:15 +00004352 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004353 True
Facundo Batista353750c2007-09-13 18:13:15 +00004354 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004355 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004356 >>> ExtendedContext.is_infinite(1)
4357 False
Facundo Batista353750c2007-09-13 18:13:15 +00004358 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004359 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004360 return a.is_infinite()
4361
4362 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004363 """Return True if the operand is a qNaN or sNaN;
4364 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004365
4366 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004367 False
Facundo Batista353750c2007-09-13 18:13:15 +00004368 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004369 True
Facundo Batista353750c2007-09-13 18:13:15 +00004370 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004371 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004372 >>> ExtendedContext.is_nan(1)
4373 False
Facundo Batista353750c2007-09-13 18:13:15 +00004374 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004375 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004376 return a.is_nan()
4377
4378 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004379 """Return True if the operand is a normal number;
4380 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004381
4382 >>> c = ExtendedContext.copy()
4383 >>> c.Emin = -999
4384 >>> c.Emax = 999
4385 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004386 True
Facundo Batista353750c2007-09-13 18:13:15 +00004387 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004388 False
Facundo Batista353750c2007-09-13 18:13:15 +00004389 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004390 False
Facundo Batista353750c2007-09-13 18:13:15 +00004391 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004392 False
Facundo Batista353750c2007-09-13 18:13:15 +00004393 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004394 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004395 >>> c.is_normal(1)
4396 True
Facundo Batista353750c2007-09-13 18:13:15 +00004397 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004398 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004399 return a.is_normal(context=self)
4400
4401 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004402 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004403
4404 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004405 False
Facundo Batista353750c2007-09-13 18:13:15 +00004406 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004407 True
Facundo Batista353750c2007-09-13 18:13:15 +00004408 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004409 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004410 >>> ExtendedContext.is_qnan(1)
4411 False
Facundo Batista353750c2007-09-13 18:13:15 +00004412 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004413 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004414 return a.is_qnan()
4415
4416 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004417 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004418
4419 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004420 False
Facundo Batista353750c2007-09-13 18:13:15 +00004421 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004422 True
Facundo Batista353750c2007-09-13 18:13:15 +00004423 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004424 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004425 >>> ExtendedContext.is_signed(8)
4426 False
4427 >>> ExtendedContext.is_signed(-8)
4428 True
Facundo Batista353750c2007-09-13 18:13:15 +00004429 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004430 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004431 return a.is_signed()
4432
4433 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004434 """Return True if the operand is a signaling NaN;
4435 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004436
4437 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004438 False
Facundo Batista353750c2007-09-13 18:13:15 +00004439 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004440 False
Facundo Batista353750c2007-09-13 18:13:15 +00004441 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004442 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004443 >>> ExtendedContext.is_snan(1)
4444 False
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.is_snan()
4448
4449 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004450 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004451
4452 >>> c = ExtendedContext.copy()
4453 >>> c.Emin = -999
4454 >>> c.Emax = 999
4455 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004456 False
Facundo Batista353750c2007-09-13 18:13:15 +00004457 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004458 True
Facundo Batista353750c2007-09-13 18:13:15 +00004459 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004460 False
Facundo Batista353750c2007-09-13 18:13:15 +00004461 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004462 False
Facundo Batista353750c2007-09-13 18:13:15 +00004463 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004464 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004465 >>> c.is_subnormal(1)
4466 False
Facundo Batista353750c2007-09-13 18:13:15 +00004467 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004468 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004469 return a.is_subnormal(context=self)
4470
4471 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004472 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004473
4474 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004475 True
Facundo Batista353750c2007-09-13 18:13:15 +00004476 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004477 False
Facundo Batista353750c2007-09-13 18:13:15 +00004478 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004479 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004480 >>> ExtendedContext.is_zero(1)
4481 False
4482 >>> ExtendedContext.is_zero(0)
4483 True
Facundo Batista353750c2007-09-13 18:13:15 +00004484 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004485 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004486 return a.is_zero()
4487
4488 def ln(self, a):
4489 """Returns the natural (base e) logarithm of the operand.
4490
4491 >>> c = ExtendedContext.copy()
4492 >>> c.Emin = -999
4493 >>> c.Emax = 999
4494 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004495 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004496 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004497 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004498 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004499 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004500 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004501 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004502 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004503 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004504 >>> c.ln(1)
4505 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004506 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004507 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004508 return a.ln(context=self)
4509
4510 def log10(self, a):
4511 """Returns the base 10 logarithm of the operand.
4512
4513 >>> c = ExtendedContext.copy()
4514 >>> c.Emin = -999
4515 >>> c.Emax = 999
4516 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004517 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004518 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004519 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004520 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004521 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004522 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004523 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004524 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004525 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004526 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004527 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004528 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004529 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004530 >>> c.log10(0)
4531 Decimal('-Infinity')
4532 >>> c.log10(1)
4533 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004534 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004535 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004536 return a.log10(context=self)
4537
4538 def logb(self, a):
4539 """ Returns the exponent of the magnitude of the operand's MSD.
4540
4541 The result is the integer which is the exponent of the magnitude
4542 of the most significant digit of the operand (as though the
4543 operand were truncated to a single digit while maintaining the
4544 value of that digit and without limiting the resulting exponent).
4545
4546 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004547 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004548 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004549 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004550 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004551 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004552 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004553 Decimal('-Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004554 >>> ExtendedContext.logb(1)
4555 Decimal('0')
4556 >>> ExtendedContext.logb(10)
4557 Decimal('1')
4558 >>> ExtendedContext.logb(100)
4559 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004560 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004561 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004562 return a.logb(context=self)
4563
4564 def logical_and(self, a, b):
4565 """Applies the logical operation 'and' between each operand's digits.
4566
4567 The operands must be both logical numbers.
4568
4569 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004570 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004571 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004572 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004573 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004574 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004575 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004576 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004577 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004578 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004579 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004580 Decimal('10')
Mark Dickinson456e1652010-02-18 14:45:33 +00004581 >>> ExtendedContext.logical_and(110, 1101)
4582 Decimal('100')
4583 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4584 Decimal('100')
4585 >>> ExtendedContext.logical_and(110, Decimal(1101))
4586 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004587 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004588 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004589 return a.logical_and(b, context=self)
4590
4591 def logical_invert(self, a):
4592 """Invert all the digits in the operand.
4593
4594 The operand must be a logical number.
4595
4596 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004597 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004598 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004599 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004600 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004601 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004602 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004603 Decimal('10101010')
Mark Dickinson456e1652010-02-18 14:45:33 +00004604 >>> ExtendedContext.logical_invert(1101)
4605 Decimal('111110010')
Facundo Batista353750c2007-09-13 18:13:15 +00004606 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004607 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004608 return a.logical_invert(context=self)
4609
4610 def logical_or(self, a, b):
4611 """Applies the logical operation 'or' between each operand's digits.
4612
4613 The operands must be both logical numbers.
4614
4615 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004616 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004617 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004618 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004619 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004620 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004621 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004622 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004623 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004624 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004625 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004626 Decimal('1110')
Mark Dickinson456e1652010-02-18 14:45:33 +00004627 >>> ExtendedContext.logical_or(110, 1101)
4628 Decimal('1111')
4629 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4630 Decimal('1111')
4631 >>> ExtendedContext.logical_or(110, Decimal(1101))
4632 Decimal('1111')
Facundo Batista353750c2007-09-13 18:13:15 +00004633 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004634 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004635 return a.logical_or(b, context=self)
4636
4637 def logical_xor(self, a, b):
4638 """Applies the logical operation 'xor' between each operand's digits.
4639
4640 The operands must be both logical numbers.
4641
4642 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004643 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004644 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004645 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004646 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004647 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004648 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004649 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004650 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004651 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004652 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004653 Decimal('1101')
Mark Dickinson456e1652010-02-18 14:45:33 +00004654 >>> ExtendedContext.logical_xor(110, 1101)
4655 Decimal('1011')
4656 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4657 Decimal('1011')
4658 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4659 Decimal('1011')
Facundo Batista353750c2007-09-13 18:13:15 +00004660 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004661 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004662 return a.logical_xor(b, context=self)
4663
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004664 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004665 """max compares two values numerically and returns the maximum.
4666
4667 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004668 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004669 operation. If they are numerically equal then the left-hand operand
4670 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004671 infinity) of the two operands is chosen as the result.
4672
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004673 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004674 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004675 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004676 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004677 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004678 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004679 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004680 Decimal('7')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004681 >>> ExtendedContext.max(1, 2)
4682 Decimal('2')
4683 >>> ExtendedContext.max(Decimal(1), 2)
4684 Decimal('2')
4685 >>> ExtendedContext.max(1, Decimal(2))
4686 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004687 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004688 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004689 return a.max(b, context=self)
4690
Facundo Batista353750c2007-09-13 18:13:15 +00004691 def max_mag(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004692 """Compares the values numerically with their sign ignored.
4693
4694 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4695 Decimal('7')
4696 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4697 Decimal('-10')
4698 >>> ExtendedContext.max_mag(1, -2)
4699 Decimal('-2')
4700 >>> ExtendedContext.max_mag(Decimal(1), -2)
4701 Decimal('-2')
4702 >>> ExtendedContext.max_mag(1, Decimal(-2))
4703 Decimal('-2')
4704 """
4705 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004706 return a.max_mag(b, context=self)
4707
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004708 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004709 """min compares two values numerically and returns the minimum.
4710
4711 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004712 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004713 operation. If they are numerically equal then the left-hand operand
4714 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004715 infinity) of the two operands is chosen as the result.
4716
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004717 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004718 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004719 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004720 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004721 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004722 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004723 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004724 Decimal('7')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004725 >>> ExtendedContext.min(1, 2)
4726 Decimal('1')
4727 >>> ExtendedContext.min(Decimal(1), 2)
4728 Decimal('1')
4729 >>> ExtendedContext.min(1, Decimal(29))
4730 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004731 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004732 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004733 return a.min(b, context=self)
4734
Facundo Batista353750c2007-09-13 18:13:15 +00004735 def min_mag(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004736 """Compares the values numerically with their sign ignored.
4737
4738 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4739 Decimal('-2')
4740 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4741 Decimal('-3')
4742 >>> ExtendedContext.min_mag(1, -2)
4743 Decimal('1')
4744 >>> ExtendedContext.min_mag(Decimal(1), -2)
4745 Decimal('1')
4746 >>> ExtendedContext.min_mag(1, Decimal(-2))
4747 Decimal('1')
4748 """
4749 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004750 return a.min_mag(b, context=self)
4751
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004752 def minus(self, a):
4753 """Minus corresponds to unary prefix minus in Python.
4754
4755 The operation is evaluated using the same rules as subtract; the
4756 operation minus(a) is calculated as subtract('0', a) where the '0'
4757 has the same exponent as the operand.
4758
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004759 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004760 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004761 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004762 Decimal('1.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004763 >>> ExtendedContext.minus(1)
4764 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004765 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004766 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004767 return a.__neg__(context=self)
4768
4769 def multiply(self, a, b):
4770 """multiply multiplies two operands.
4771
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004772 If either operand is a special value then the general rules apply.
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004773 Otherwise, the operands are multiplied together
4774 ('long multiplication'), resulting in a number which may be as long as
4775 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004776
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004777 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004778 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004779 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004780 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004781 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004782 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004783 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004784 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004785 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004786 Decimal('4.28135971E+11')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004787 >>> ExtendedContext.multiply(7, 7)
4788 Decimal('49')
4789 >>> ExtendedContext.multiply(Decimal(7), 7)
4790 Decimal('49')
4791 >>> ExtendedContext.multiply(7, Decimal(7))
4792 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004793 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004794 a = _convert_other(a, raiseit=True)
4795 r = a.__mul__(b, context=self)
4796 if r is NotImplemented:
4797 raise TypeError("Unable to convert %s to Decimal" % b)
4798 else:
4799 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004800
Facundo Batista353750c2007-09-13 18:13:15 +00004801 def next_minus(self, a):
4802 """Returns the largest representable number smaller than a.
4803
4804 >>> c = ExtendedContext.copy()
4805 >>> c.Emin = -999
4806 >>> c.Emax = 999
4807 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004808 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004809 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004810 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004811 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004812 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004813 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004814 Decimal('9.99999999E+999')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004815 >>> c.next_minus(1)
4816 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004817 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004818 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004819 return a.next_minus(context=self)
4820
4821 def next_plus(self, a):
4822 """Returns the smallest representable number larger than a.
4823
4824 >>> c = ExtendedContext.copy()
4825 >>> c.Emin = -999
4826 >>> c.Emax = 999
4827 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004828 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004829 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004830 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004831 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004832 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004833 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004834 Decimal('-9.99999999E+999')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004835 >>> c.next_plus(1)
4836 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004837 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004838 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004839 return a.next_plus(context=self)
4840
4841 def next_toward(self, a, b):
4842 """Returns the number closest to a, in direction towards b.
4843
4844 The result is the closest representable number from the first
4845 operand (but not the first operand) that is in the direction
4846 towards the second operand, unless the operands have the same
4847 value.
4848
4849 >>> c = ExtendedContext.copy()
4850 >>> c.Emin = -999
4851 >>> c.Emax = 999
4852 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004853 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004854 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004855 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004856 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004857 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004858 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004859 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004860 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004861 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004862 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004863 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004864 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004865 Decimal('-0.00')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004866 >>> c.next_toward(0, 1)
4867 Decimal('1E-1007')
4868 >>> c.next_toward(Decimal(0), 1)
4869 Decimal('1E-1007')
4870 >>> c.next_toward(0, Decimal(1))
4871 Decimal('1E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004872 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004873 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004874 return a.next_toward(b, context=self)
4875
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004876 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004877 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004878
4879 Essentially a plus operation with all trailing zeros removed from the
4880 result.
4881
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004882 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004883 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004884 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004885 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004886 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004887 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004888 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004889 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004890 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004891 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004892 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004893 Decimal('0')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004894 >>> ExtendedContext.normalize(6)
4895 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004896 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004897 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004898 return a.normalize(context=self)
4899
Facundo Batista353750c2007-09-13 18:13:15 +00004900 def number_class(self, a):
4901 """Returns an indication of the class of the operand.
4902
4903 The class is one of the following strings:
4904 -sNaN
4905 -NaN
4906 -Infinity
4907 -Normal
4908 -Subnormal
4909 -Zero
4910 +Zero
4911 +Subnormal
4912 +Normal
4913 +Infinity
4914
4915 >>> c = Context(ExtendedContext)
4916 >>> c.Emin = -999
4917 >>> c.Emax = 999
4918 >>> c.number_class(Decimal('Infinity'))
4919 '+Infinity'
4920 >>> c.number_class(Decimal('1E-10'))
4921 '+Normal'
4922 >>> c.number_class(Decimal('2.50'))
4923 '+Normal'
4924 >>> c.number_class(Decimal('0.1E-999'))
4925 '+Subnormal'
4926 >>> c.number_class(Decimal('0'))
4927 '+Zero'
4928 >>> c.number_class(Decimal('-0'))
4929 '-Zero'
4930 >>> c.number_class(Decimal('-0.1E-999'))
4931 '-Subnormal'
4932 >>> c.number_class(Decimal('-1E-10'))
4933 '-Normal'
4934 >>> c.number_class(Decimal('-2.50'))
4935 '-Normal'
4936 >>> c.number_class(Decimal('-Infinity'))
4937 '-Infinity'
4938 >>> c.number_class(Decimal('NaN'))
4939 'NaN'
4940 >>> c.number_class(Decimal('-NaN'))
4941 'NaN'
4942 >>> c.number_class(Decimal('sNaN'))
4943 'sNaN'
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004944 >>> c.number_class(123)
4945 '+Normal'
Facundo Batista353750c2007-09-13 18:13:15 +00004946 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004947 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004948 return a.number_class(context=self)
4949
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004950 def plus(self, a):
4951 """Plus corresponds to unary prefix plus in Python.
4952
4953 The operation is evaluated using the same rules as add; the
4954 operation plus(a) is calculated as add('0', a) where the '0'
4955 has the same exponent as the operand.
4956
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004957 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004958 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004959 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004960 Decimal('-1.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004961 >>> ExtendedContext.plus(-1)
4962 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004963 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004964 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004965 return a.__pos__(context=self)
4966
4967 def power(self, a, b, modulo=None):
4968 """Raises a to the power of b, to modulo if given.
4969
Facundo Batista353750c2007-09-13 18:13:15 +00004970 With two arguments, compute a**b. If a is negative then b
4971 must be integral. The result will be inexact unless b is
4972 integral and the result is finite and can be expressed exactly
4973 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004974
Facundo Batista353750c2007-09-13 18:13:15 +00004975 With three arguments, compute (a**b) % modulo. For the
4976 three argument form, the following restrictions on the
4977 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004978
Facundo Batista353750c2007-09-13 18:13:15 +00004979 - all three arguments must be integral
4980 - b must be nonnegative
4981 - at least one of a or b must be nonzero
4982 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004983
Facundo Batista353750c2007-09-13 18:13:15 +00004984 The result of pow(a, b, modulo) is identical to the result
4985 that would be obtained by computing (a**b) % modulo with
4986 unbounded precision, but is computed more efficiently. It is
4987 always exact.
4988
4989 >>> c = ExtendedContext.copy()
4990 >>> c.Emin = -999
4991 >>> c.Emax = 999
4992 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004993 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004994 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004995 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004996 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004997 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004998 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004999 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00005000 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005001 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00005002 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005003 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00005004 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005005 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00005006 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005007 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005008 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005009 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00005010 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005011 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00005012 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005013 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005014 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005015 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005016 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005017 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00005018
5019 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005020 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00005021 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005022 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00005023 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005024 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00005025 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005026 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00005027 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005028 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00005029 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005030 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00005031 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005032 Decimal('1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005033 >>> ExtendedContext.power(7, 7)
5034 Decimal('823543')
5035 >>> ExtendedContext.power(Decimal(7), 7)
5036 Decimal('823543')
5037 >>> ExtendedContext.power(7, Decimal(7), 2)
5038 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005039 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005040 a = _convert_other(a, raiseit=True)
5041 r = a.__pow__(b, modulo, context=self)
5042 if r is NotImplemented:
5043 raise TypeError("Unable to convert %s to Decimal" % b)
5044 else:
5045 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005046
5047 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00005048 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005049
5050 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00005051 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005052 exponent is being increased), multiplied by a positive power of ten (if
5053 the exponent is being decreased), or is unchanged (if the exponent is
5054 already equal to that of the right-hand operand).
5055
5056 Unlike other operations, if the length of the coefficient after the
5057 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00005058 operation condition is raised. This guarantees that, unless there is
5059 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005060 equal to that of the right-hand operand.
5061
5062 Also unlike other operations, quantize will never raise Underflow, even
5063 if the result is subnormal and inexact.
5064
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005065 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005066 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005067 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005068 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005069 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005070 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005071 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005072 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005073 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005074 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005075 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005076 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005077 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005078 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005079 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005080 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005081 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005082 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005083 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005084 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005085 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005086 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005087 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005088 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005089 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005090 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005091 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005092 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005093 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005094 Decimal('2E+2')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005095 >>> ExtendedContext.quantize(1, 2)
5096 Decimal('1')
5097 >>> ExtendedContext.quantize(Decimal(1), 2)
5098 Decimal('1')
5099 >>> ExtendedContext.quantize(1, Decimal(2))
5100 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005101 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005102 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005103 return a.quantize(b, context=self)
5104
Facundo Batista353750c2007-09-13 18:13:15 +00005105 def radix(self):
5106 """Just returns 10, as this is Decimal, :)
5107
5108 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00005109 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00005110 """
5111 return Decimal(10)
5112
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005113 def remainder(self, a, b):
5114 """Returns the remainder from integer division.
5115
5116 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00005117 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00005118 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00005119 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005120
5121 This operation will fail under the same conditions as integer division
5122 (that is, if integer division on the same two operands would fail, the
5123 remainder cannot be calculated).
5124
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005125 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005126 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005127 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005128 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005129 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005130 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005131 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005132 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005133 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005134 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005135 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005136 Decimal('1.0')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005137 >>> ExtendedContext.remainder(22, 6)
5138 Decimal('4')
5139 >>> ExtendedContext.remainder(Decimal(22), 6)
5140 Decimal('4')
5141 >>> ExtendedContext.remainder(22, Decimal(6))
5142 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005143 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005144 a = _convert_other(a, raiseit=True)
5145 r = a.__mod__(b, context=self)
5146 if r is NotImplemented:
5147 raise TypeError("Unable to convert %s to Decimal" % b)
5148 else:
5149 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005150
5151 def remainder_near(self, a, b):
5152 """Returns to be "a - b * n", where n is the integer nearest the exact
5153 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00005154 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005155 sign of a.
5156
5157 This operation will fail under the same conditions as integer division
5158 (that is, if integer division on the same two operands would fail, the
5159 remainder cannot be calculated).
5160
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005161 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005162 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005163 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005164 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005165 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005166 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005167 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005168 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005169 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005170 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005171 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005172 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005173 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005174 Decimal('-0.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005175 >>> ExtendedContext.remainder_near(3, 11)
5176 Decimal('3')
5177 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5178 Decimal('3')
5179 >>> ExtendedContext.remainder_near(3, Decimal(11))
5180 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005181 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005182 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005183 return a.remainder_near(b, context=self)
5184
Facundo Batista353750c2007-09-13 18:13:15 +00005185 def rotate(self, a, b):
5186 """Returns a rotated copy of a, b times.
5187
5188 The coefficient of the result is a rotated copy of the digits in
5189 the coefficient of the first operand. The number of places of
5190 rotation is taken from the absolute value of the second operand,
5191 with the rotation being to the left if the second operand is
5192 positive or to the right otherwise.
5193
5194 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005195 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00005196 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005197 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00005198 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005199 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00005200 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005201 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00005202 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005203 Decimal('345678912')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005204 >>> ExtendedContext.rotate(1333333, 1)
5205 Decimal('13333330')
5206 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5207 Decimal('13333330')
5208 >>> ExtendedContext.rotate(1333333, Decimal(1))
5209 Decimal('13333330')
Facundo Batista353750c2007-09-13 18:13:15 +00005210 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005211 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005212 return a.rotate(b, context=self)
5213
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005214 def same_quantum(self, a, b):
5215 """Returns True if the two operands have the same exponent.
5216
5217 The result is never affected by either the sign or the coefficient of
5218 either operand.
5219
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005220 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005221 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005222 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005223 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005224 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005225 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005226 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005227 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005228 >>> ExtendedContext.same_quantum(10000, -1)
5229 True
5230 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5231 True
5232 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5233 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005234 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005235 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005236 return a.same_quantum(b)
5237
Facundo Batista353750c2007-09-13 18:13:15 +00005238 def scaleb (self, a, b):
5239 """Returns the first operand after adding the second value its exp.
5240
5241 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005242 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00005243 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005244 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00005245 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005246 Decimal('7.50E+3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005247 >>> ExtendedContext.scaleb(1, 4)
5248 Decimal('1E+4')
5249 >>> ExtendedContext.scaleb(Decimal(1), 4)
5250 Decimal('1E+4')
5251 >>> ExtendedContext.scaleb(1, Decimal(4))
5252 Decimal('1E+4')
Facundo Batista353750c2007-09-13 18:13:15 +00005253 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005254 a = _convert_other(a, raiseit=True)
5255 return a.scaleb(b, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00005256
5257 def shift(self, a, b):
5258 """Returns a shifted copy of a, b times.
5259
5260 The coefficient of the result is a shifted copy of the digits
5261 in the coefficient of the first operand. The number of places
5262 to shift is taken from the absolute value of the second operand,
5263 with the shift being to the left if the second operand is
5264 positive or to the right otherwise. Digits shifted into the
5265 coefficient are zeros.
5266
5267 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005268 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00005269 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005270 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00005271 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005272 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00005273 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005274 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00005275 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005276 Decimal('345678900')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005277 >>> ExtendedContext.shift(88888888, 2)
5278 Decimal('888888800')
5279 >>> ExtendedContext.shift(Decimal(88888888), 2)
5280 Decimal('888888800')
5281 >>> ExtendedContext.shift(88888888, Decimal(2))
5282 Decimal('888888800')
Facundo Batista353750c2007-09-13 18:13:15 +00005283 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005284 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005285 return a.shift(b, context=self)
5286
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005287 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00005288 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005289
5290 If the result must be inexact, it is rounded using the round-half-even
5291 algorithm.
5292
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005293 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005294 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005295 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005296 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005297 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005298 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005299 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005300 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005301 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005302 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005303 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005304 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005305 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005306 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005307 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005308 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005309 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005310 Decimal('3.16227766')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005311 >>> ExtendedContext.sqrt(2)
5312 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005313 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005314 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005315 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005316 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005317 return a.sqrt(context=self)
5318
5319 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005320 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005321
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005322 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005323 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005324 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005325 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005326 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005327 Decimal('-0.77')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005328 >>> ExtendedContext.subtract(8, 5)
5329 Decimal('3')
5330 >>> ExtendedContext.subtract(Decimal(8), 5)
5331 Decimal('3')
5332 >>> ExtendedContext.subtract(8, Decimal(5))
5333 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005334 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005335 a = _convert_other(a, raiseit=True)
5336 r = a.__sub__(b, context=self)
5337 if r is NotImplemented:
5338 raise TypeError("Unable to convert %s to Decimal" % b)
5339 else:
5340 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005341
5342 def to_eng_string(self, a):
5343 """Converts a number to a string, using scientific notation.
5344
5345 The operation is not affected by the context.
5346 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005347 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005348 return a.to_eng_string(context=self)
5349
5350 def to_sci_string(self, a):
5351 """Converts a number to a string, using scientific notation.
5352
5353 The operation is not affected by the context.
5354 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005355 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005356 return a.__str__(context=self)
5357
Facundo Batista353750c2007-09-13 18:13:15 +00005358 def to_integral_exact(self, a):
5359 """Rounds to an integer.
5360
5361 When the operand has a negative exponent, the result is the same
5362 as using the quantize() operation using the given operand as the
5363 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5364 of the operand as the precision setting; Inexact and Rounded flags
5365 are allowed in this operation. The rounding mode is taken from the
5366 context.
5367
5368 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005369 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00005370 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005371 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005372 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005373 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005374 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005375 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00005376 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005377 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00005378 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005379 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00005380 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005381 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00005382 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005383 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005384 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005385 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005386 return a.to_integral_exact(context=self)
5387
5388 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005389 """Rounds to an integer.
5390
5391 When the operand has a negative exponent, the result is the same
5392 as using the quantize() operation using the given operand as the
5393 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5394 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00005395 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005396
Facundo Batista353750c2007-09-13 18:13:15 +00005397 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005398 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00005399 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005400 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005401 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005402 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005403 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005404 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00005405 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005406 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00005407 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005408 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00005409 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005410 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00005411 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005412 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005413 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005414 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005415 return a.to_integral_value(context=self)
5416
5417 # the method name changed, but we provide also the old one, for compatibility
5418 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005419
5420class _WorkRep(object):
5421 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005422 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005423 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005424 # exp: None, int, or string
5425
5426 def __init__(self, value=None):
5427 if value is None:
5428 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005429 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005430 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005431 elif isinstance(value, Decimal):
5432 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00005433 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005434 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005435 else:
5436 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005437 self.sign = value[0]
5438 self.int = value[1]
5439 self.exp = value[2]
5440
5441 def __repr__(self):
5442 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5443
5444 __str__ = __repr__
5445
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005446
5447
Facundo Batistae64acfa2007-12-17 14:18:42 +00005448def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005449 """Normalizes op1, op2 to have the same exp and length of coefficient.
5450
5451 Done during addition.
5452 """
Facundo Batista353750c2007-09-13 18:13:15 +00005453 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005454 tmp = op2
5455 other = op1
5456 else:
5457 tmp = op1
5458 other = op2
5459
Facundo Batista353750c2007-09-13 18:13:15 +00005460 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5461 # Then adding 10**exp to tmp has the same effect (after rounding)
5462 # as adding any positive quantity smaller than 10**exp; similarly
5463 # for subtraction. So if other is smaller than 10**exp we replace
5464 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00005465 tmp_len = len(str(tmp.int))
5466 other_len = len(str(other.int))
5467 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5468 if other_len + other.exp - 1 < exp:
5469 other.int = 1
5470 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005471
Facundo Batista353750c2007-09-13 18:13:15 +00005472 tmp.int *= 10 ** (tmp.exp - other.exp)
5473 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005474 return op1, op2
5475
Facundo Batista353750c2007-09-13 18:13:15 +00005476##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
5477
5478# This function from Tim Peters was taken from here:
5479# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5480# The correction being in the function definition is for speed, and
5481# the whole function is not resolved with math.log because of avoiding
5482# the use of floats.
5483def _nbits(n, correction = {
5484 '0': 4, '1': 3, '2': 2, '3': 2,
5485 '4': 1, '5': 1, '6': 1, '7': 1,
5486 '8': 0, '9': 0, 'a': 0, 'b': 0,
5487 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5488 """Number of bits in binary representation of the positive integer n,
5489 or 0 if n == 0.
5490 """
5491 if n < 0:
5492 raise ValueError("The argument to _nbits should be nonnegative.")
5493 hex_n = "%x" % n
5494 return 4*len(hex_n) - correction[hex_n[0]]
5495
Mark Dickinsona493ca32011-06-04 18:24:15 +01005496def _decimal_lshift_exact(n, e):
5497 """ Given integers n and e, return n * 10**e if it's an integer, else None.
5498
5499 The computation is designed to avoid computing large powers of 10
5500 unnecessarily.
5501
5502 >>> _decimal_lshift_exact(3, 4)
5503 30000
5504 >>> _decimal_lshift_exact(300, -999999999) # returns None
5505
5506 """
5507 if n == 0:
5508 return 0
5509 elif e >= 0:
5510 return n * 10**e
5511 else:
5512 # val_n = largest power of 10 dividing n.
5513 str_n = str(abs(n))
5514 val_n = len(str_n) - len(str_n.rstrip('0'))
5515 return None if val_n < -e else n // 10**-e
5516
Facundo Batista353750c2007-09-13 18:13:15 +00005517def _sqrt_nearest(n, a):
5518 """Closest integer to the square root of the positive integer n. a is
5519 an initial approximation to the square root. Any positive integer
5520 will do for a, but the closer a is to the square root of n the
5521 faster convergence will be.
5522
5523 """
5524 if n <= 0 or a <= 0:
5525 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5526
5527 b=0
5528 while a != b:
5529 b, a = a, a--n//a>>1
5530 return a
5531
5532def _rshift_nearest(x, shift):
5533 """Given an integer x and a nonnegative integer shift, return closest
5534 integer to x / 2**shift; use round-to-even in case of a tie.
5535
5536 """
5537 b, q = 1L << shift, x >> shift
5538 return q + (2*(x & (b-1)) + (q&1) > b)
5539
5540def _div_nearest(a, b):
5541 """Closest integer to a/b, a and b positive integers; rounds to even
5542 in the case of a tie.
5543
5544 """
5545 q, r = divmod(a, b)
5546 return q + (2*r + (q&1) > b)
5547
5548def _ilog(x, M, L = 8):
5549 """Integer approximation to M*log(x/M), with absolute error boundable
5550 in terms only of x/M.
5551
5552 Given positive integers x and M, return an integer approximation to
5553 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5554 between the approximation and the exact result is at most 22. For
5555 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5556 both cases these are upper bounds on the error; it will usually be
5557 much smaller."""
5558
5559 # The basic algorithm is the following: let log1p be the function
5560 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5561 # the reduction
5562 #
5563 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5564 #
5565 # repeatedly until the argument to log1p is small (< 2**-L in
5566 # absolute value). For small y we can use the Taylor series
5567 # expansion
5568 #
5569 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5570 #
5571 # truncating at T such that y**T is small enough. The whole
5572 # computation is carried out in a form of fixed-point arithmetic,
5573 # with a real number z being represented by an integer
5574 # approximation to z*M. To avoid loss of precision, the y below
5575 # is actually an integer approximation to 2**R*y*M, where R is the
5576 # number of reductions performed so far.
5577
5578 y = x-M
5579 # argument reduction; R = number of reductions performed
5580 R = 0
5581 while (R <= L and long(abs(y)) << L-R >= M or
5582 R > L and abs(y) >> R-L >= M):
5583 y = _div_nearest(long(M*y) << 1,
5584 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5585 R += 1
5586
5587 # Taylor series with T terms
5588 T = -int(-10*len(str(M))//(3*L))
5589 yshift = _rshift_nearest(y, R)
5590 w = _div_nearest(M, T)
5591 for k in xrange(T-1, 0, -1):
5592 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5593
5594 return _div_nearest(w*y, M)
5595
5596def _dlog10(c, e, p):
5597 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5598 approximation to 10**p * log10(c*10**e), with an absolute error of
5599 at most 1. Assumes that c*10**e is not exactly 1."""
5600
5601 # increase precision by 2; compensate for this by dividing
5602 # final result by 100
5603 p += 2
5604
5605 # write c*10**e as d*10**f with either:
5606 # f >= 0 and 1 <= d <= 10, or
5607 # f <= 0 and 0.1 <= d <= 1.
5608 # Thus for c*10**e close to 1, f = 0
5609 l = len(str(c))
5610 f = e+l - (e+l >= 1)
5611
5612 if p > 0:
5613 M = 10**p
5614 k = e+p-f
5615 if k >= 0:
5616 c *= 10**k
5617 else:
5618 c = _div_nearest(c, 10**-k)
5619
5620 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005621 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005622 log_d = _div_nearest(log_d*M, log_10)
5623 log_tenpower = f*M # exact
5624 else:
5625 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005626 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005627
5628 return _div_nearest(log_tenpower+log_d, 100)
5629
5630def _dlog(c, e, p):
5631 """Given integers c, e and p with c > 0, compute an integer
5632 approximation to 10**p * log(c*10**e), with an absolute error of
5633 at most 1. Assumes that c*10**e is not exactly 1."""
5634
5635 # Increase precision by 2. The precision increase is compensated
5636 # for at the end with a division by 100.
5637 p += 2
5638
5639 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5640 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5641 # as 10**p * log(d) + 10**p*f * log(10).
5642 l = len(str(c))
5643 f = e+l - (e+l >= 1)
5644
5645 # compute approximation to 10**p*log(d), with error < 27
5646 if p > 0:
5647 k = e+p-f
5648 if k >= 0:
5649 c *= 10**k
5650 else:
5651 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5652
5653 # _ilog magnifies existing error in c by a factor of at most 10
5654 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5655 else:
5656 # p <= 0: just approximate the whole thing by 0; error < 2.31
5657 log_d = 0
5658
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005659 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005660 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005661 extra = len(str(abs(f)))-1
5662 if p + extra >= 0:
5663 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5664 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5665 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005666 else:
5667 f_log_ten = 0
5668 else:
5669 f_log_ten = 0
5670
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005671 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005672 return _div_nearest(f_log_ten + log_d, 100)
5673
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005674class _Log10Memoize(object):
5675 """Class to compute, store, and allow retrieval of, digits of the
5676 constant log(10) = 2.302585.... This constant is needed by
5677 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5678 def __init__(self):
5679 self.digits = "23025850929940456840179914546843642076011014886"
5680
5681 def getdigits(self, p):
5682 """Given an integer p >= 0, return floor(10**p)*log(10).
5683
5684 For example, self.getdigits(3) returns 2302.
5685 """
5686 # digits are stored as a string, for quick conversion to
5687 # integer in the case that we've already computed enough
5688 # digits; the stored digits should always be correct
5689 # (truncated, not rounded to nearest).
5690 if p < 0:
5691 raise ValueError("p should be nonnegative")
5692
5693 if p >= len(self.digits):
5694 # compute p+3, p+6, p+9, ... digits; continue until at
5695 # least one of the extra digits is nonzero
5696 extra = 3
5697 while True:
5698 # compute p+extra digits, correct to within 1ulp
5699 M = 10**(p+extra+2)
5700 digits = str(_div_nearest(_ilog(10*M, M), 100))
5701 if digits[-extra:] != '0'*extra:
5702 break
5703 extra += 3
5704 # keep all reliable digits so far; remove trailing zeros
5705 # and next nonzero digit
5706 self.digits = digits.rstrip('0')[:-1]
5707 return int(self.digits[:p+1])
5708
5709_log10_digits = _Log10Memoize().getdigits
5710
Facundo Batista353750c2007-09-13 18:13:15 +00005711def _iexp(x, M, L=8):
5712 """Given integers x and M, M > 0, such that x/M is small in absolute
5713 value, compute an integer approximation to M*exp(x/M). For 0 <=
5714 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5715 is usually much smaller)."""
5716
5717 # Algorithm: to compute exp(z) for a real number z, first divide z
5718 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5719 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5720 # series
5721 #
5722 # expm1(x) = x + x**2/2! + x**3/3! + ...
5723 #
5724 # Now use the identity
5725 #
5726 # expm1(2x) = expm1(x)*(expm1(x)+2)
5727 #
5728 # R times to compute the sequence expm1(z/2**R),
5729 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5730
5731 # Find R such that x/2**R/M <= 2**-L
5732 R = _nbits((long(x)<<L)//M)
5733
5734 # Taylor series. (2**L)**T > M
5735 T = -int(-10*len(str(M))//(3*L))
5736 y = _div_nearest(x, T)
5737 Mshift = long(M)<<R
5738 for i in xrange(T-1, 0, -1):
5739 y = _div_nearest(x*(Mshift + y), Mshift * i)
5740
5741 # Expansion
5742 for k in xrange(R-1, -1, -1):
5743 Mshift = long(M)<<(k+2)
5744 y = _div_nearest(y*(y+Mshift), Mshift)
5745
5746 return M+y
5747
5748def _dexp(c, e, p):
5749 """Compute an approximation to exp(c*10**e), with p decimal places of
5750 precision.
5751
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005752 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005753
5754 10**(p-1) <= d <= 10**p, and
5755 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5756
5757 In other words, d*10**f is an approximation to exp(c*10**e) with p
5758 digits of precision, and with an error in d of at most 1. This is
5759 almost, but not quite, the same as the error being < 1ulp: when d
5760 = 10**(p-1) the error could be up to 10 ulp."""
5761
5762 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5763 p += 2
5764
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005765 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005766 extra = max(0, e + len(str(c)) - 1)
5767 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005768
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005769 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005770 # rounding down
5771 shift = e+q
5772 if shift >= 0:
5773 cshift = c*10**shift
5774 else:
5775 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005776 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005777
5778 # reduce remainder back to original precision
5779 rem = _div_nearest(rem, 10**extra)
5780
5781 # error in result of _iexp < 120; error after division < 0.62
5782 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5783
5784def _dpower(xc, xe, yc, ye, p):
5785 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5786 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5787
5788 10**(p-1) <= c <= 10**p, and
5789 (c-1)*10**e < x**y < (c+1)*10**e
5790
5791 in other words, c*10**e is an approximation to x**y with p digits
5792 of precision, and with an error in c of at most 1. (This is
5793 almost, but not quite, the same as the error being < 1ulp: when c
5794 == 10**(p-1) we can only guarantee error < 10ulp.)
5795
5796 We assume that: x is positive and not equal to 1, and y is nonzero.
5797 """
5798
5799 # Find b such that 10**(b-1) <= |y| <= 10**b
5800 b = len(str(abs(yc))) + ye
5801
5802 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5803 lxc = _dlog(xc, xe, p+b+1)
5804
5805 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5806 shift = ye-b
5807 if shift >= 0:
5808 pc = lxc*yc*10**shift
5809 else:
5810 pc = _div_nearest(lxc*yc, 10**-shift)
5811
5812 if pc == 0:
5813 # we prefer a result that isn't exactly 1; this makes it
5814 # easier to compute a correctly rounded result in __pow__
5815 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5816 coeff, exp = 10**(p-1)+1, 1-p
5817 else:
5818 coeff, exp = 10**p-1, -p
5819 else:
5820 coeff, exp = _dexp(pc, -(p+1), p+1)
5821 coeff = _div_nearest(coeff, 10)
5822 exp += 1
5823
5824 return coeff, exp
5825
5826def _log10_lb(c, correction = {
5827 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5828 '6': 23, '7': 16, '8': 10, '9': 5}):
5829 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5830 if c <= 0:
5831 raise ValueError("The argument to _log10_lb should be nonnegative.")
5832 str_c = str(c)
5833 return 100*len(str_c) - correction[str_c[0]]
5834
Facundo Batista59c58842007-04-10 12:58:45 +00005835##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005836
Mark Dickinson99d80962010-04-02 08:53:22 +00005837def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005838 """Convert other to Decimal.
5839
5840 Verifies that it's ok to use in an implicit construction.
Mark Dickinson99d80962010-04-02 08:53:22 +00005841 If allow_float is true, allow conversion from float; this
5842 is used in the comparison methods (__eq__ and friends).
5843
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005844 """
5845 if isinstance(other, Decimal):
5846 return other
5847 if isinstance(other, (int, long)):
5848 return Decimal(other)
Mark Dickinson99d80962010-04-02 08:53:22 +00005849 if allow_float and isinstance(other, float):
5850 return Decimal.from_float(other)
5851
Facundo Batista353750c2007-09-13 18:13:15 +00005852 if raiseit:
5853 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005854 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005855
Facundo Batista59c58842007-04-10 12:58:45 +00005856##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005857
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005858# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005859# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005860
5861DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005862 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005863 traps=[DivisionByZero, Overflow, InvalidOperation],
5864 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005865 Emax=999999999,
5866 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005867 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005868)
5869
5870# Pre-made alternate contexts offered by the specification
5871# Don't change these; the user should be able to select these
5872# contexts and be able to reproduce results from other implementations
5873# of the spec.
5874
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005875BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005876 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005877 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5878 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005879)
5880
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005881ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005882 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005883 traps=[],
5884 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005885)
5886
5887
Facundo Batista72bc54f2007-11-23 17:59:00 +00005888##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005889#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005890# Regular expression used for parsing numeric strings. Additional
5891# comments:
5892#
5893# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5894# whitespace. But note that the specification disallows whitespace in
5895# a numeric string.
5896#
5897# 2. For finite numbers (not infinities and NaNs) the body of the
5898# number between the optional sign and the optional exponent must have
5899# at least one decimal digit, possibly after the decimal point. The
5900# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005901
5902import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005903_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005904# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005905 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005906 (
Mark Dickinson4326ad82009-08-02 10:59:36 +00005907 (?=\d|\.\d) # ...a number (with at least one digit)
5908 (?P<int>\d*) # having a (possibly empty) integer part
5909 (\.(?P<frac>\d*))? # followed by an optional fractional part
5910 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005911 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005912 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005913 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005914 (?P<signal>s)? # ...an (optionally signaling)
5915 NaN # NaN
Mark Dickinson4326ad82009-08-02 10:59:36 +00005916 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005917 )
5918# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005919 \Z
Mark Dickinson4326ad82009-08-02 10:59:36 +00005920""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005921
Facundo Batista2ec74152007-12-03 17:55:00 +00005922_all_zeros = re.compile('0*$').match
5923_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005924
5925##### PEP3101 support functions ##############################################
Mark Dickinson277859d2009-03-17 23:03:46 +00005926# The functions in this section have little to do with the Decimal
5927# class, and could potentially be reused or adapted for other pure
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005928# Python numeric classes that want to implement __format__
5929#
5930# A format specifier for Decimal looks like:
5931#
Mark Dickinson277859d2009-03-17 23:03:46 +00005932# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005933
5934_parse_format_specifier_regex = re.compile(r"""\A
5935(?:
5936 (?P<fill>.)?
5937 (?P<align>[<>=^])
5938)?
5939(?P<sign>[-+ ])?
5940(?P<zeropad>0)?
5941(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson277859d2009-03-17 23:03:46 +00005942(?P<thousands_sep>,)?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005943(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson277859d2009-03-17 23:03:46 +00005944(?P<type>[eEfFgGn%])?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005945\Z
5946""", re.VERBOSE)
5947
Facundo Batista72bc54f2007-11-23 17:59:00 +00005948del re
5949
Mark Dickinson277859d2009-03-17 23:03:46 +00005950# The locale module is only needed for the 'n' format specifier. The
5951# rest of the PEP 3101 code functions quite happily without it, so we
5952# don't care too much if locale isn't present.
5953try:
5954 import locale as _locale
5955except ImportError:
5956 pass
5957
5958def _parse_format_specifier(format_spec, _localeconv=None):
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005959 """Parse and validate a format specifier.
5960
5961 Turns a standard numeric format specifier into a dict, with the
5962 following entries:
5963
5964 fill: fill character to pad field to minimum width
5965 align: alignment type, either '<', '>', '=' or '^'
5966 sign: either '+', '-' or ' '
5967 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson277859d2009-03-17 23:03:46 +00005968 zeropad: boolean, indicating whether to pad with zeros
5969 thousands_sep: string to use as thousands separator, or ''
5970 grouping: grouping for thousands separators, in format
5971 used by localeconv
5972 decimal_point: string to use for decimal point
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005973 precision: nonnegative integer giving precision, or None
5974 type: one of the characters 'eEfFgG%', or None
Mark Dickinson277859d2009-03-17 23:03:46 +00005975 unicode: boolean (always True for Python 3.x)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005976
5977 """
5978 m = _parse_format_specifier_regex.match(format_spec)
5979 if m is None:
5980 raise ValueError("Invalid format specifier: " + format_spec)
5981
5982 # get the dictionary
5983 format_dict = m.groupdict()
5984
Mark Dickinson277859d2009-03-17 23:03:46 +00005985 # zeropad; defaults for fill and alignment. If zero padding
5986 # is requested, the fill and align fields should be absent.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005987 fill = format_dict['fill']
5988 align = format_dict['align']
Mark Dickinson277859d2009-03-17 23:03:46 +00005989 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5990 if format_dict['zeropad']:
5991 if fill is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005992 raise ValueError("Fill character conflicts with '0'"
5993 " in format specifier: " + format_spec)
Mark Dickinson277859d2009-03-17 23:03:46 +00005994 if align is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005995 raise ValueError("Alignment conflicts with '0' in "
5996 "format specifier: " + format_spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005997 format_dict['fill'] = fill or ' '
Mark Dickinson5cfa8042009-09-08 20:20:19 +00005998 # PEP 3101 originally specified that the default alignment should
5999 # be left; it was later agreed that right-aligned makes more sense
6000 # for numeric types. See http://bugs.python.org/issue6857.
6001 format_dict['align'] = align or '>'
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006002
Mark Dickinson277859d2009-03-17 23:03:46 +00006003 # default sign handling: '-' for negative, '' for positive
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006004 if format_dict['sign'] is None:
6005 format_dict['sign'] = '-'
6006
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006007 # minimumwidth defaults to 0; precision remains None if not given
6008 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
6009 if format_dict['precision'] is not None:
6010 format_dict['precision'] = int(format_dict['precision'])
6011
6012 # if format type is 'g' or 'G' then a precision of 0 makes little
6013 # sense; convert it to 1. Same if format type is unspecified.
6014 if format_dict['precision'] == 0:
Mark Dickinson491ea552009-09-07 16:17:41 +00006015 if format_dict['type'] is None or format_dict['type'] in 'gG':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006016 format_dict['precision'] = 1
6017
Mark Dickinson277859d2009-03-17 23:03:46 +00006018 # determine thousands separator, grouping, and decimal separator, and
6019 # add appropriate entries to format_dict
6020 if format_dict['type'] == 'n':
6021 # apart from separators, 'n' behaves just like 'g'
6022 format_dict['type'] = 'g'
6023 if _localeconv is None:
6024 _localeconv = _locale.localeconv()
6025 if format_dict['thousands_sep'] is not None:
6026 raise ValueError("Explicit thousands separator conflicts with "
6027 "'n' type in format specifier: " + format_spec)
6028 format_dict['thousands_sep'] = _localeconv['thousands_sep']
6029 format_dict['grouping'] = _localeconv['grouping']
6030 format_dict['decimal_point'] = _localeconv['decimal_point']
6031 else:
6032 if format_dict['thousands_sep'] is None:
6033 format_dict['thousands_sep'] = ''
6034 format_dict['grouping'] = [3, 0]
6035 format_dict['decimal_point'] = '.'
6036
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006037 # record whether return type should be str or unicode
6038 format_dict['unicode'] = isinstance(format_spec, unicode)
6039
6040 return format_dict
6041
Mark Dickinson277859d2009-03-17 23:03:46 +00006042def _format_align(sign, body, spec):
6043 """Given an unpadded, non-aligned numeric string 'body' and sign
Ezio Melotti24b07bc2011-03-15 18:55:01 +02006044 string 'sign', add padding and alignment conforming to the given
Mark Dickinson277859d2009-03-17 23:03:46 +00006045 format specifier dictionary 'spec' (as produced by
6046 parse_format_specifier).
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006047
Mark Dickinson277859d2009-03-17 23:03:46 +00006048 Also converts result to unicode if necessary.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006049
6050 """
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006051 # how much extra space do we have to play with?
Mark Dickinson277859d2009-03-17 23:03:46 +00006052 minimumwidth = spec['minimumwidth']
6053 fill = spec['fill']
6054 padding = fill*(minimumwidth - len(sign) - len(body))
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006055
Mark Dickinson277859d2009-03-17 23:03:46 +00006056 align = spec['align']
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006057 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006058 result = sign + body + padding
Mark Dickinsonb065e522009-03-17 18:01:03 +00006059 elif align == '>':
6060 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006061 elif align == '=':
6062 result = sign + padding + body
Mark Dickinson277859d2009-03-17 23:03:46 +00006063 elif align == '^':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006064 half = len(padding)//2
6065 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson277859d2009-03-17 23:03:46 +00006066 else:
6067 raise ValueError('Unrecognised alignment field')
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006068
6069 # make sure that result is unicode if necessary
Mark Dickinson277859d2009-03-17 23:03:46 +00006070 if spec['unicode']:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006071 result = unicode(result)
6072
6073 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00006074
Mark Dickinson277859d2009-03-17 23:03:46 +00006075def _group_lengths(grouping):
6076 """Convert a localeconv-style grouping into a (possibly infinite)
6077 iterable of integers representing group lengths.
6078
6079 """
6080 # The result from localeconv()['grouping'], and the input to this
6081 # function, should be a list of integers in one of the
6082 # following three forms:
6083 #
6084 # (1) an empty list, or
6085 # (2) nonempty list of positive integers + [0]
6086 # (3) list of positive integers + [locale.CHAR_MAX], or
6087
6088 from itertools import chain, repeat
6089 if not grouping:
6090 return []
6091 elif grouping[-1] == 0 and len(grouping) >= 2:
6092 return chain(grouping[:-1], repeat(grouping[-2]))
6093 elif grouping[-1] == _locale.CHAR_MAX:
6094 return grouping[:-1]
6095 else:
6096 raise ValueError('unrecognised format for grouping')
6097
6098def _insert_thousands_sep(digits, spec, min_width=1):
6099 """Insert thousands separators into a digit string.
6100
6101 spec is a dictionary whose keys should include 'thousands_sep' and
6102 'grouping'; typically it's the result of parsing the format
6103 specifier using _parse_format_specifier.
6104
6105 The min_width keyword argument gives the minimum length of the
6106 result, which will be padded on the left with zeros if necessary.
6107
6108 If necessary, the zero padding adds an extra '0' on the left to
6109 avoid a leading thousands separator. For example, inserting
6110 commas every three digits in '123456', with min_width=8, gives
6111 '0,123,456', even though that has length 9.
6112
6113 """
6114
6115 sep = spec['thousands_sep']
6116 grouping = spec['grouping']
6117
6118 groups = []
6119 for l in _group_lengths(grouping):
Mark Dickinson277859d2009-03-17 23:03:46 +00006120 if l <= 0:
6121 raise ValueError("group length should be positive")
6122 # max(..., 1) forces at least 1 digit to the left of a separator
6123 l = min(max(len(digits), min_width, 1), l)
6124 groups.append('0'*(l - len(digits)) + digits[-l:])
6125 digits = digits[:-l]
6126 min_width -= l
6127 if not digits and min_width <= 0:
6128 break
Mark Dickinsonb14514a2009-03-18 08:22:51 +00006129 min_width -= len(sep)
Mark Dickinson277859d2009-03-17 23:03:46 +00006130 else:
6131 l = max(len(digits), min_width, 1)
6132 groups.append('0'*(l - len(digits)) + digits[-l:])
6133 return sep.join(reversed(groups))
6134
6135def _format_sign(is_negative, spec):
6136 """Determine sign character."""
6137
6138 if is_negative:
6139 return '-'
6140 elif spec['sign'] in ' +':
6141 return spec['sign']
6142 else:
6143 return ''
6144
6145def _format_number(is_negative, intpart, fracpart, exp, spec):
6146 """Format a number, given the following data:
6147
6148 is_negative: true if the number is negative, else false
6149 intpart: string of digits that must appear before the decimal point
6150 fracpart: string of digits that must come after the point
6151 exp: exponent, as an integer
6152 spec: dictionary resulting from parsing the format specifier
6153
6154 This function uses the information in spec to:
6155 insert separators (decimal separator and thousands separators)
6156 format the sign
6157 format the exponent
6158 add trailing '%' for the '%' type
6159 zero-pad if necessary
6160 fill and align if necessary
6161 """
6162
6163 sign = _format_sign(is_negative, spec)
6164
6165 if fracpart:
6166 fracpart = spec['decimal_point'] + fracpart
6167
6168 if exp != 0 or spec['type'] in 'eE':
6169 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6170 fracpart += "{0}{1:+}".format(echar, exp)
6171 if spec['type'] == '%':
6172 fracpart += '%'
6173
6174 if spec['zeropad']:
6175 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6176 else:
6177 min_width = 0
6178 intpart = _insert_thousands_sep(intpart, spec, min_width)
6179
6180 return _format_align(sign, intpart+fracpart, spec)
6181
6182
Facundo Batista59c58842007-04-10 12:58:45 +00006183##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006184
Facundo Batista59c58842007-04-10 12:58:45 +00006185# Reusable defaults
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006186_Infinity = Decimal('Inf')
6187_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonc5de0962009-01-02 23:07:08 +00006188_NaN = Decimal('NaN')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006189_Zero = Decimal(0)
6190_One = Decimal(1)
6191_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006192
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006193# _SignedInfinity[sign] is infinity w/ that sign
6194_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006195
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006196
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006197
6198if __name__ == '__main__':
6199 import doctest, sys
6200 doctest.testmod(sys.modules[__name__])