blob: 13d3566393ae5d504c6ab3206ae2d6adf78d8416 [file] [log] [blame]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001# Copyright (c) 2004 Python Software Foundation.
2# All rights reserved.
3
4# Written by Eric Price <eprice at tjhsst.edu>
5# and Facundo Batista <facundo at taniquetil.com.ar>
6# and Raymond Hettinger <python at rcn.com>
Fred Drake1f34eb12004-07-01 14:28:36 +00007# and Aahz <aahz at pobox.com>
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00008# and Tim Peters
9
Raymond Hettinger27dbcf22004-08-19 22:39:55 +000010# This module is currently Py2.3 compatible and should be kept that way
11# unless a major compelling advantage arises. IOW, 2.3 compatibility is
12# strongly preferred, but not guaranteed.
13
14# Also, this module should be kept in sync with the latest updates of
15# the IBM specification as it evolves. Those updates will be treated
16# as bug fixes (deviation from the spec is a compatibility, usability
17# bug) and will be backported. At this point the spec is stabilizing
18# and the updates are becoming fewer, smaller, and less significant.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000019
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000020"""
21This is a Py2.3 implementation of decimal floating point arithmetic based on
22the General Decimal Arithmetic Specification:
23
24 www2.hursley.ibm.com/decimal/decarith.html
25
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000026and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000027
28 www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html
29
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030Decimal floating point has finite precision with arbitrarily large bounds.
31
Facundo Batista59c58842007-04-10 12:58:45 +000032The purpose of this module is to support arithmetic using familiar
33"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000034issues associated with binary floating point. The package is especially
35useful for financial applications or for contexts where users have
36expectations that are at odds with binary floating point (for instance,
37in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Raymond Hettingerabe32372008-02-14 02:41:22 +000038of the expected Decimal('0.00') returned by decimal floating point).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000039
40Here are some examples of using the decimal module:
41
42>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000043>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000044>>> Decimal(0)
Raymond Hettingerabe32372008-02-14 02:41:22 +000045Decimal('0')
46>>> Decimal('1')
47Decimal('1')
48>>> Decimal('-.0123')
49Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000050>>> Decimal(123456)
Raymond Hettingerabe32372008-02-14 02:41:22 +000051Decimal('123456')
52>>> Decimal('123.45e12345678901234567890')
53Decimal('1.2345E+12345678901234567892')
54>>> Decimal('1.33') + Decimal('1.27')
55Decimal('2.60')
56>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
57Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000058>>> dig = Decimal(1)
59>>> print dig / Decimal(3)
600.333333333
61>>> getcontext().prec = 18
62>>> print dig / Decimal(3)
630.333333333333333333
64>>> print dig.sqrt()
651
66>>> print Decimal(3).sqrt()
671.73205080756887729
68>>> print Decimal(3) ** 123
694.85192780976896427E+58
70>>> inf = Decimal(1) / Decimal(0)
71>>> print inf
72Infinity
73>>> neginf = Decimal(-1) / Decimal(0)
74>>> print neginf
75-Infinity
76>>> print neginf + inf
77NaN
78>>> print neginf * inf
79-Infinity
80>>> print dig / 0
81Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000082>>> getcontext().traps[DivisionByZero] = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000083>>> print dig / 0
84Traceback (most recent call last):
85 ...
86 ...
87 ...
88DivisionByZero: x / 0
89>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000090>>> c.traps[InvalidOperation] = 0
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000091>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
93>>> c.divide(Decimal(0), Decimal(0))
Raymond Hettingerabe32372008-02-14 02:41:22 +000094Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000095>>> c.traps[InvalidOperation] = 1
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000096>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000971
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000098>>> c.flags[InvalidOperation] = 0
99>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000
101>>> print c.divide(Decimal(0), Decimal(0))
102Traceback (most recent call last):
103 ...
104 ...
105 ...
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000106InvalidOperation: 0 / 0
107>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001081
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000109>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000110>>> c.traps[InvalidOperation] = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000111>>> print c.divide(Decimal(0), Decimal(0))
112NaN
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000113>>> print c.flags[InvalidOperation]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001141
115>>>
116"""
117
118__all__ = [
119 # Two major classes
120 'Decimal', 'Context',
121
122 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000123 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000124
125 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000126 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
127 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000128
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000129 # Constants for use in setting up contexts
130 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Facundo Batista353750c2007-09-13 18:13:15 +0000131 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000132
133 # Functions for manipulating contexts
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000134 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000135]
136
Raymond Hettingera016deb2009-04-27 21:12:27 +0000137__version__ = '1.70' # Highest version of the spec this complies with
Raymond Hettingerdaeceb22009-03-10 04:49:21 +0000138
Raymond Hettingereb260842005-06-07 18:52:34 +0000139import copy as _copy
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000140import math as _math
Raymond Hettinger2c8585b2009-02-03 03:37:03 +0000141import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000142
Raymond Hettinger097a1902008-01-11 02:24:13 +0000143try:
144 from collections import namedtuple as _namedtuple
145 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
146except ImportError:
147 DecimalTuple = lambda *args: args
148
Facundo Batista59c58842007-04-10 12:58:45 +0000149# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000150ROUND_DOWN = 'ROUND_DOWN'
151ROUND_HALF_UP = 'ROUND_HALF_UP'
152ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
153ROUND_CEILING = 'ROUND_CEILING'
154ROUND_FLOOR = 'ROUND_FLOOR'
155ROUND_UP = 'ROUND_UP'
156ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Facundo Batista353750c2007-09-13 18:13:15 +0000157ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000158
Facundo Batista59c58842007-04-10 12:58:45 +0000159# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000160
161class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000162 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000163
164 Used exceptions derive from this.
165 If an exception derives from another exception besides this (such as
166 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
167 called if the others are present. This isn't actually used for
168 anything, though.
169
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000170 handle -- Called when context._raise_error is called and the
Stefan Krah8a6f3fe2010-05-19 15:46:39 +0000171 trap_enabler is not set. First argument is self, second is the
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000172 context. More arguments can be given, those being after
173 the explanation in _raise_error (For example,
174 context._raise_error(NewError, '(-x)!', self._sign) would
175 call NewError().handle(context, self._sign).)
176
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000177 To define a new exception, it should be sufficient to have it derive
178 from DecimalException.
179 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000180 def handle(self, context, *args):
181 pass
182
183
184class Clamped(DecimalException):
185 """Exponent of a 0 changed to fit bounds.
186
187 This occurs and signals clamped if the exponent of a result has been
188 altered in order to fit the constraints of a specific concrete
Facundo Batista59c58842007-04-10 12:58:45 +0000189 representation. This may occur when the exponent of a zero result would
190 be outside the bounds of a representation, or when a large normal
191 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000192 this latter case, the exponent is reduced to fit and the corresponding
193 number of zero digits are appended to the coefficient ("fold-down").
194 """
195
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000196class InvalidOperation(DecimalException):
197 """An invalid operation was performed.
198
199 Various bad things cause this:
200
201 Something creates a signaling NaN
202 -INF + INF
Facundo Batista59c58842007-04-10 12:58:45 +0000203 0 * (+-)INF
204 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000205 x % 0
206 (+-)INF % x
207 x._rescale( non-integer )
208 sqrt(-x) , x > 0
209 0 ** 0
210 x ** (non-integer)
211 x ** (+-)INF
212 An operand is invalid
Facundo Batista353750c2007-09-13 18:13:15 +0000213
214 The result of the operation after these is a quiet positive NaN,
215 except when the cause is a signaling NaN, in which case the result is
216 also a quiet NaN, but with the original sign, and an optional
217 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000218 """
219 def handle(self, context, *args):
220 if args:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000221 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
222 return ans._fix_nan(context)
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000223 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000224
225class ConversionSyntax(InvalidOperation):
226 """Trying to convert badly formed string.
227
228 This occurs and signals invalid-operation if an string is being
229 converted to a number and it does not conform to the numeric string
Facundo Batista59c58842007-04-10 12:58:45 +0000230 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000231 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000232 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000233 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000234
235class DivisionByZero(DecimalException, ZeroDivisionError):
236 """Division by 0.
237
238 This occurs and signals division-by-zero if division of a finite number
239 by zero was attempted (during a divide-integer or divide operation, or a
240 power operation with negative right-hand operand), and the dividend was
241 not zero.
242
243 The result of the operation is [sign,inf], where sign is the exclusive
244 or of the signs of the operands for divide, or is 1 for an odd power of
245 -0, for power.
246 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000247
Facundo Batistacce8df22007-09-18 16:53:18 +0000248 def handle(self, context, sign, *args):
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000249 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000250
251class DivisionImpossible(InvalidOperation):
252 """Cannot perform the division adequately.
253
254 This occurs and signals invalid-operation if the integer result of a
255 divide-integer or remainder operation had too many digits (would be
Facundo Batista59c58842007-04-10 12:58:45 +0000256 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000257 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000258
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000259 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000260 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000261
262class DivisionUndefined(InvalidOperation, ZeroDivisionError):
263 """Undefined result of division.
264
265 This occurs and signals invalid-operation if division by zero was
266 attempted (during a divide-integer, divide, or remainder operation), and
Facundo Batista59c58842007-04-10 12:58:45 +0000267 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000268 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000269
Facundo Batistacce8df22007-09-18 16:53:18 +0000270 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000271 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000272
273class Inexact(DecimalException):
274 """Had to round, losing information.
275
276 This occurs and signals inexact whenever the result of an operation is
277 not exact (that is, it needed to be rounded and any discarded digits
Facundo Batista59c58842007-04-10 12:58:45 +0000278 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000279 result in all cases is unchanged.
280
281 The inexact signal may be tested (or trapped) to determine if a given
282 operation (or sequence of operations) was inexact.
283 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000284
285class InvalidContext(InvalidOperation):
286 """Invalid context. Unknown rounding, for example.
287
288 This occurs and signals invalid-operation if an invalid context was
Facundo Batista59c58842007-04-10 12:58:45 +0000289 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000290 on creation and either the precision exceeds the capability of the
291 underlying concrete representation or an unknown or unsupported rounding
Facundo Batista59c58842007-04-10 12:58:45 +0000292 was specified. These aspects of the context need only be checked when
293 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000294 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000295
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000296 def handle(self, context, *args):
Mark Dickinsonc5de0962009-01-02 23:07:08 +0000297 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000298
299class Rounded(DecimalException):
300 """Number got rounded (not necessarily changed during rounding).
301
302 This occurs and signals rounded whenever the result of an operation is
303 rounded (that is, some zero or non-zero digits were discarded from the
Facundo Batista59c58842007-04-10 12:58:45 +0000304 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000305 result in all cases is unchanged.
306
307 The rounded signal may be tested (or trapped) to determine if a given
308 operation (or sequence of operations) caused a loss of precision.
309 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000310
311class Subnormal(DecimalException):
312 """Exponent < Emin before rounding.
313
314 This occurs and signals subnormal whenever the result of a conversion or
315 operation is subnormal (that is, its adjusted exponent is less than
Facundo Batista59c58842007-04-10 12:58:45 +0000316 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000317
318 The subnormal signal may be tested (or trapped) to determine if a given
319 or operation (or sequence of operations) yielded a subnormal result.
320 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000321
322class Overflow(Inexact, Rounded):
323 """Numerical overflow.
324
325 This occurs and signals overflow if the adjusted exponent of a result
326 (from a conversion or from an operation that is not an attempt to divide
327 by zero), after rounding, would be greater than the largest value that
328 can be handled by the implementation (the value Emax).
329
330 The result depends on the rounding mode:
331
332 For round-half-up and round-half-even (and for round-half-down and
333 round-up, if implemented), the result of the operation is [sign,inf],
Facundo Batista59c58842007-04-10 12:58:45 +0000334 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000335 result is the largest finite number that can be represented in the
Facundo Batista59c58842007-04-10 12:58:45 +0000336 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000337 round-ceiling, the result is the same as for round-down if the sign of
Facundo Batista59c58842007-04-10 12:58:45 +0000338 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000339 the result is the same as for round-down if the sign of the intermediate
Facundo Batista59c58842007-04-10 12:58:45 +0000340 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000341 will also be raised.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000342 """
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000343
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000344 def handle(self, context, sign, *args):
345 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Facundo Batista353750c2007-09-13 18:13:15 +0000346 ROUND_HALF_DOWN, ROUND_UP):
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000347 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000348 if sign == 0:
349 if context.rounding == ROUND_CEILING:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000350 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000351 return _dec_from_triple(sign, '9'*context.prec,
352 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000353 if sign == 1:
354 if context.rounding == ROUND_FLOOR:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +0000355 return _SignedInfinity[sign]
Facundo Batista72bc54f2007-11-23 17:59:00 +0000356 return _dec_from_triple(sign, '9'*context.prec,
357 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000358
359
360class Underflow(Inexact, Rounded, Subnormal):
361 """Numerical underflow with result rounded to 0.
362
363 This occurs and signals underflow if a result is inexact and the
364 adjusted exponent of the result would be smaller (more negative) than
365 the smallest value that can be handled by the implementation (the value
Facundo Batista59c58842007-04-10 12:58:45 +0000366 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000367
368 The result after an underflow will be a subnormal number rounded, if
Facundo Batista59c58842007-04-10 12:58:45 +0000369 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000370 in 0 with the sign of the intermediate result and an exponent of Etiny.
371
372 In all cases, Inexact, Rounded, and Subnormal will also be raised.
373 """
374
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000375# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000376_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000377 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000378
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000379# Map conditions (per the spec) to signals
380_condition_map = {ConversionSyntax:InvalidOperation,
381 DivisionImpossible:InvalidOperation,
382 DivisionUndefined:InvalidOperation,
383 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000384
Facundo Batista59c58842007-04-10 12:58:45 +0000385##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000386
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000387# The getcontext() and setcontext() function manage access to a thread-local
388# current context. Py2.4 offers direct support for thread locals. If that
389# is not available, use threading.currentThread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000390# work for older Pythons. If threads are not part of the build, create a
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000391# mock threading object with threading.local() returning the module namespace.
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000392
393try:
394 import threading
395except ImportError:
396 # Python was compiled without threads; create a mock object instead
397 import sys
Facundo Batista59c58842007-04-10 12:58:45 +0000398 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000399 def local(self, sys=sys):
400 return sys.modules[__name__]
401 threading = MockThreading()
402 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000403
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000404try:
405 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000406
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000407except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000408
Facundo Batista59c58842007-04-10 12:58:45 +0000409 # To fix reloading, force it to create a new context
410 # Old contexts have different exceptions in their dicts, making problems.
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000411 if hasattr(threading.currentThread(), '__decimal_context__'):
412 del threading.currentThread().__decimal_context__
413
414 def setcontext(context):
415 """Set this thread's context to context."""
416 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000417 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000418 context.clear_flags()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000419 threading.currentThread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000420
421 def getcontext():
422 """Returns this thread's context.
423
424 If this thread does not yet have a context, returns
425 a new context and sets this thread's context.
426 New contexts are copies of DefaultContext.
427 """
428 try:
429 return threading.currentThread().__decimal_context__
430 except AttributeError:
431 context = Context()
432 threading.currentThread().__decimal_context__ = context
433 return context
434
435else:
436
437 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000438 if hasattr(local, '__decimal_context__'):
439 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000440
441 def getcontext(_local=local):
442 """Returns this thread's context.
443
444 If this thread does not yet have a context, returns
445 a new context and sets this thread's context.
446 New contexts are copies of DefaultContext.
447 """
448 try:
449 return _local.__decimal_context__
450 except AttributeError:
451 context = Context()
452 _local.__decimal_context__ = context
453 return context
454
455 def setcontext(context, _local=local):
456 """Set this thread's context to context."""
457 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000458 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000459 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000460 _local.__decimal_context__ = context
461
Martin v. Löwiscfe31282006-07-19 17:18:32 +0000462 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000463
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000464def localcontext(ctx=None):
465 """Return a context manager for a copy of the supplied context
466
467 Uses a copy of the current context if no context is specified
468 The returned context manager creates a local decimal context
469 in a with statement:
470 def sin(x):
471 with localcontext() as ctx:
472 ctx.prec += 2
473 # Rest of sin calculation algorithm
474 # uses a precision 2 greater than normal
Facundo Batista59c58842007-04-10 12:58:45 +0000475 return +s # Convert result to normal precision
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000476
477 def sin(x):
478 with localcontext(ExtendedContext):
479 # Rest of sin calculation algorithm
480 # uses the Extended Context from the
481 # General Decimal Arithmetic Specification
Facundo Batista59c58842007-04-10 12:58:45 +0000482 return +s # Convert result to normal context
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000483
Facundo Batistaee340e52008-05-02 17:39:00 +0000484 >>> setcontext(DefaultContext)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000485 >>> print getcontext().prec
486 28
487 >>> with localcontext():
488 ... ctx = getcontext()
Raymond Hettinger495df472007-02-08 01:42:35 +0000489 ... ctx.prec += 2
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000490 ... print ctx.prec
491 ...
492 30
493 >>> with localcontext(ExtendedContext):
494 ... print getcontext().prec
495 ...
496 9
497 >>> print getcontext().prec
498 28
499 """
Nick Coghlanced12182006-09-02 03:54:17 +0000500 if ctx is None: ctx = getcontext()
501 return _ContextManager(ctx)
Nick Coghlan8b6999b2006-08-31 12:00:43 +0000502
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000503
Facundo Batista59c58842007-04-10 12:58:45 +0000504##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000505
506class Decimal(object):
507 """Floating point class for decimal arithmetic."""
508
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000509 __slots__ = ('_exp','_int','_sign', '_is_special')
510 # Generally, the value of the Decimal instance is given by
511 # (-1)**_sign * _int * 10**_exp
512 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000513
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000514 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000515 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000516 """Create a decimal point instance.
517
518 >>> Decimal('3.14') # string input
Raymond Hettingerabe32372008-02-14 02:41:22 +0000519 Decimal('3.14')
Facundo Batista59c58842007-04-10 12:58:45 +0000520 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Raymond Hettingerabe32372008-02-14 02:41:22 +0000521 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000522 >>> Decimal(314) # int or long
Raymond Hettingerabe32372008-02-14 02:41:22 +0000523 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000524 >>> Decimal(Decimal(314)) # another decimal instance
Raymond Hettingerabe32372008-02-14 02:41:22 +0000525 Decimal('314')
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000526 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Raymond Hettingerabe32372008-02-14 02:41:22 +0000527 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000528 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000529
Facundo Batista72bc54f2007-11-23 17:59:00 +0000530 # Note that the coefficient, self._int, is actually stored as
531 # a string rather than as a tuple of digits. This speeds up
532 # the "digits to integer" and "integer to digits" conversions
533 # that are used in almost every arithmetic operation on
534 # Decimals. This is an internal detail: the as_tuple function
535 # and the Decimal constructor still deal with tuples of
536 # digits.
537
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000538 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000539
Facundo Batista0d157a02007-11-30 17:15:25 +0000540 # From a string
541 # REs insist on real strings, so we can too.
542 if isinstance(value, basestring):
Mark Dickinson59bc20b2008-01-12 01:56:00 +0000543 m = _parser(value.strip())
Facundo Batista0d157a02007-11-30 17:15:25 +0000544 if m is None:
545 if context is None:
546 context = getcontext()
547 return context._raise_error(ConversionSyntax,
548 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000549
Facundo Batista0d157a02007-11-30 17:15:25 +0000550 if m.group('sign') == "-":
551 self._sign = 1
552 else:
553 self._sign = 0
554 intpart = m.group('int')
555 if intpart is not None:
556 # finite number
Mark Dickinson4326ad82009-08-02 10:59:36 +0000557 fracpart = m.group('frac') or ''
Facundo Batista0d157a02007-11-30 17:15:25 +0000558 exp = int(m.group('exp') or '0')
Mark Dickinson4326ad82009-08-02 10:59:36 +0000559 self._int = str(int(intpart+fracpart))
560 self._exp = exp - len(fracpart)
Facundo Batista0d157a02007-11-30 17:15:25 +0000561 self._is_special = False
562 else:
563 diag = m.group('diag')
564 if diag is not None:
565 # NaN
Mark Dickinson4326ad82009-08-02 10:59:36 +0000566 self._int = str(int(diag or '0')).lstrip('0')
Facundo Batista0d157a02007-11-30 17:15:25 +0000567 if m.group('signal'):
568 self._exp = 'N'
569 else:
570 self._exp = 'n'
571 else:
572 # infinity
573 self._int = '0'
574 self._exp = 'F'
575 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000576 return self
577
578 # From an integer
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000579 if isinstance(value, (int,long)):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000580 if value >= 0:
581 self._sign = 0
582 else:
583 self._sign = 1
584 self._exp = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +0000585 self._int = str(abs(value))
Facundo Batista0d157a02007-11-30 17:15:25 +0000586 self._is_special = False
587 return self
588
589 # From another decimal
590 if isinstance(value, Decimal):
591 self._exp = value._exp
592 self._sign = value._sign
593 self._int = value._int
594 self._is_special = value._is_special
595 return self
596
597 # From an internal working value
598 if isinstance(value, _WorkRep):
599 self._sign = value.sign
600 self._int = str(value.int)
601 self._exp = int(value.exp)
602 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000603 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000604
605 # tuple/list conversion (possibly from as_tuple())
606 if isinstance(value, (list,tuple)):
607 if len(value) != 3:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000608 raise ValueError('Invalid tuple size in creation of Decimal '
609 'from list or tuple. The list or tuple '
610 'should have exactly three elements.')
611 # process sign. The isinstance test rejects floats
612 if not (isinstance(value[0], (int, long)) and value[0] in (0,1)):
613 raise ValueError("Invalid sign. The first value in the tuple "
614 "should be an integer; either 0 for a "
615 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000616 self._sign = value[0]
Facundo Batista9b5e2312007-10-19 19:25:57 +0000617 if value[2] == 'F':
618 # infinity: value[1] is ignored
Facundo Batista72bc54f2007-11-23 17:59:00 +0000619 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000620 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000621 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000622 else:
Facundo Batista9b5e2312007-10-19 19:25:57 +0000623 # process and validate the digits in value[1]
624 digits = []
625 for digit in value[1]:
626 if isinstance(digit, (int, long)) and 0 <= digit <= 9:
627 # skip leading zeros
628 if digits or digit != 0:
629 digits.append(digit)
630 else:
631 raise ValueError("The second value in the tuple must "
632 "be composed of integers in the range "
633 "0 through 9.")
634 if value[2] in ('n', 'N'):
635 # NaN: digits form the diagnostic
Facundo Batista72bc54f2007-11-23 17:59:00 +0000636 self._int = ''.join(map(str, digits))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000637 self._exp = value[2]
638 self._is_special = True
639 elif isinstance(value[2], (int, long)):
640 # finite number: digits give the coefficient
Facundo Batista72bc54f2007-11-23 17:59:00 +0000641 self._int = ''.join(map(str, digits or [0]))
Facundo Batista9b5e2312007-10-19 19:25:57 +0000642 self._exp = value[2]
643 self._is_special = False
644 else:
645 raise ValueError("The third value in the tuple must "
646 "be an integer, or one of the "
647 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000648 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000649
Raymond Hettingerbf440692004-07-10 14:14:37 +0000650 if isinstance(value, float):
Raymond Hettingered171ab2010-04-02 18:39:24 +0000651 value = Decimal.from_float(value)
652 self._exp = value._exp
653 self._sign = value._sign
654 self._int = value._int
655 self._is_special = value._is_special
656 return self
Raymond Hettingerbf440692004-07-10 14:14:37 +0000657
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000658 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000659
Mark Dickinson6a961632009-01-04 21:10:56 +0000660 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
661 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000662 def from_float(cls, f):
663 """Converts a float to a decimal number, exactly.
664
665 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
666 Since 0.1 is not exactly representable in binary floating point, the
667 value is stored as the nearest representable value which is
668 0x1.999999999999ap-4. The exact equivalent of the value in decimal
669 is 0.1000000000000000055511151231257827021181583404541015625.
670
671 >>> Decimal.from_float(0.1)
672 Decimal('0.1000000000000000055511151231257827021181583404541015625')
673 >>> Decimal.from_float(float('nan'))
674 Decimal('NaN')
675 >>> Decimal.from_float(float('inf'))
676 Decimal('Infinity')
677 >>> Decimal.from_float(-float('inf'))
678 Decimal('-Infinity')
679 >>> Decimal.from_float(-0.0)
680 Decimal('-0')
681
682 """
683 if isinstance(f, (int, long)): # handle integer inputs
684 return cls(f)
685 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
686 return cls(repr(f))
Mark Dickinson6a961632009-01-04 21:10:56 +0000687 if _math.copysign(1.0, f) == 1.0:
688 sign = 0
689 else:
690 sign = 1
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000691 n, d = abs(f).as_integer_ratio()
692 k = d.bit_length() - 1
693 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinson6a961632009-01-04 21:10:56 +0000694 if cls is Decimal:
695 return result
696 else:
697 return cls(result)
698 from_float = classmethod(from_float)
Raymond Hettingerf4d85972009-01-03 19:02:23 +0000699
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000700 def _isnan(self):
701 """Returns whether the number is not actually one.
702
703 0 if a number
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000704 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000705 2 if sNaN
706 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000707 if self._is_special:
708 exp = self._exp
709 if exp == 'n':
710 return 1
711 elif exp == 'N':
712 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000713 return 0
714
715 def _isinfinity(self):
716 """Returns whether the number is infinite
717
718 0 if finite or not a number
719 1 if +INF
720 -1 if -INF
721 """
722 if self._exp == 'F':
723 if self._sign:
724 return -1
725 return 1
726 return 0
727
Facundo Batista353750c2007-09-13 18:13:15 +0000728 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000729 """Returns whether the number is not actually one.
730
731 if self, other are sNaN, signal
732 if self, other are NaN return nan
733 return 0
734
735 Done before operations.
736 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000737
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000738 self_is_nan = self._isnan()
739 if other is None:
740 other_is_nan = False
741 else:
742 other_is_nan = other._isnan()
743
744 if self_is_nan or other_is_nan:
745 if context is None:
746 context = getcontext()
747
748 if self_is_nan == 2:
749 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000750 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000751 if other_is_nan == 2:
752 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +0000753 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000754 if self_is_nan:
Facundo Batista353750c2007-09-13 18:13:15 +0000755 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000756
Facundo Batista353750c2007-09-13 18:13:15 +0000757 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000758 return 0
759
Mark Dickinson2fc92632008-02-06 22:10:50 +0000760 def _compare_check_nans(self, other, context):
761 """Version of _check_nans used for the signaling comparisons
762 compare_signal, __le__, __lt__, __ge__, __gt__.
763
764 Signal InvalidOperation if either self or other is a (quiet
765 or signaling) NaN. Signaling NaNs take precedence over quiet
766 NaNs.
767
768 Return 0 if neither operand is a NaN.
769
770 """
771 if context is None:
772 context = getcontext()
773
774 if self._is_special or other._is_special:
775 if self.is_snan():
776 return context._raise_error(InvalidOperation,
777 'comparison involving sNaN',
778 self)
779 elif other.is_snan():
780 return context._raise_error(InvalidOperation,
781 'comparison involving sNaN',
782 other)
783 elif self.is_qnan():
784 return context._raise_error(InvalidOperation,
785 'comparison involving NaN',
786 self)
787 elif other.is_qnan():
788 return context._raise_error(InvalidOperation,
789 'comparison involving NaN',
790 other)
791 return 0
792
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000793 def __nonzero__(self):
Facundo Batista1a191df2007-10-02 17:01:24 +0000794 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000795
Facundo Batista1a191df2007-10-02 17:01:24 +0000796 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000797 """
Facundo Batista72bc54f2007-11-23 17:59:00 +0000798 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000799
Mark Dickinson2fc92632008-02-06 22:10:50 +0000800 def _cmp(self, other):
801 """Compare the two non-NaN decimal instances self and other.
802
803 Returns -1 if self < other, 0 if self == other and 1
804 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000805
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000806 if self._is_special or other._is_special:
Mark Dickinsone52c3142009-01-25 10:39:15 +0000807 self_inf = self._isinfinity()
808 other_inf = other._isinfinity()
809 if self_inf == other_inf:
810 return 0
811 elif self_inf < other_inf:
812 return -1
813 else:
814 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000815
Mark Dickinsone52c3142009-01-25 10:39:15 +0000816 # check for zeros; Decimal('0') == Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +0000817 if not self:
818 if not other:
819 return 0
820 else:
821 return -((-1)**other._sign)
822 if not other:
823 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000824
Facundo Batista59c58842007-04-10 12:58:45 +0000825 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000826 if other._sign < self._sign:
827 return -1
828 if self._sign < other._sign:
829 return 1
830
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000831 self_adjusted = self.adjusted()
832 other_adjusted = other.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +0000833 if self_adjusted == other_adjusted:
Facundo Batista72bc54f2007-11-23 17:59:00 +0000834 self_padded = self._int + '0'*(self._exp - other._exp)
835 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone52c3142009-01-25 10:39:15 +0000836 if self_padded == other_padded:
837 return 0
838 elif self_padded < other_padded:
839 return -(-1)**self._sign
840 else:
841 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000842 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000843 return (-1)**self._sign
Facundo Batista353750c2007-09-13 18:13:15 +0000844 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000845 return -((-1)**self._sign)
846
Mark Dickinson2fc92632008-02-06 22:10:50 +0000847 # Note: The Decimal standard doesn't cover rich comparisons for
848 # Decimals. In particular, the specification is silent on the
849 # subject of what should happen for a comparison involving a NaN.
850 # We take the following approach:
851 #
Mark Dickinsone096e822010-04-02 10:17:07 +0000852 # == comparisons involving a quiet NaN always return False
853 # != comparisons involving a quiet NaN always return True
854 # == or != comparisons involving a signaling NaN signal
855 # InvalidOperation, and return False or True as above if the
856 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000857 # <, >, <= and >= comparisons involving a (quiet or signaling)
858 # NaN signal InvalidOperation, and return False if the
Mark Dickinson3a94ee02008-02-10 15:19:58 +0000859 # InvalidOperation is not trapped.
Mark Dickinson2fc92632008-02-06 22:10:50 +0000860 #
861 # This behavior is designed to conform as closely as possible to
862 # that specified by IEEE 754.
863
Mark Dickinsone096e822010-04-02 10:17:07 +0000864 def __eq__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000865 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000866 if other is NotImplemented:
867 return other
Mark Dickinsone096e822010-04-02 10:17:07 +0000868 if self._check_nans(other, context):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000869 return False
870 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000871
Mark Dickinsone096e822010-04-02 10:17:07 +0000872 def __ne__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000873 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000874 if other is NotImplemented:
875 return other
Mark Dickinsone096e822010-04-02 10:17:07 +0000876 if self._check_nans(other, context):
Mark Dickinson2fc92632008-02-06 22:10:50 +0000877 return True
878 return self._cmp(other) != 0
879
880 def __lt__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000881 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000882 if other is NotImplemented:
883 return other
884 ans = self._compare_check_nans(other, context)
885 if ans:
886 return False
887 return self._cmp(other) < 0
888
889 def __le__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000890 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000891 if other is NotImplemented:
892 return other
893 ans = self._compare_check_nans(other, context)
894 if ans:
895 return False
896 return self._cmp(other) <= 0
897
898 def __gt__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000899 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000900 if other is NotImplemented:
901 return other
902 ans = self._compare_check_nans(other, context)
903 if ans:
904 return False
905 return self._cmp(other) > 0
906
907 def __ge__(self, other, context=None):
Mark Dickinson99d80962010-04-02 08:53:22 +0000908 other = _convert_other(other, allow_float=True)
Mark Dickinson2fc92632008-02-06 22:10:50 +0000909 if other is NotImplemented:
910 return other
911 ans = self._compare_check_nans(other, context)
912 if ans:
913 return False
914 return self._cmp(other) >= 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000915
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000916 def compare(self, other, context=None):
917 """Compares one to another.
918
919 -1 => a < b
920 0 => a = b
921 1 => a > b
922 NaN => one is NaN
923 Like __cmp__, but returns Decimal instances.
924 """
Facundo Batista353750c2007-09-13 18:13:15 +0000925 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000926
Facundo Batista59c58842007-04-10 12:58:45 +0000927 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000928 if (self._is_special or other and other._is_special):
929 ans = self._check_nans(other, context)
930 if ans:
931 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000932
Mark Dickinson2fc92632008-02-06 22:10:50 +0000933 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000934
935 def __hash__(self):
936 """x.__hash__() <==> hash(x)"""
937 # Decimal integers must hash the same as the ints
Facundo Batista52b25792008-01-08 12:25:20 +0000938 #
939 # The hash of a nonspecial noninteger Decimal must depend only
940 # on the value of that Decimal, and not on its representation.
Raymond Hettingerabe32372008-02-14 02:41:22 +0000941 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Mark Dickinsonf3eeca12010-04-02 10:35:12 +0000942
943 # Equality comparisons involving signaling nans can raise an
944 # exception; since equality checks are implicitly and
945 # unpredictably used when checking set and dict membership, we
946 # prevent signaling nans from being used as set elements or
947 # dict keys by making __hash__ raise an exception.
948 if self._is_special:
949 if self.is_snan():
950 raise TypeError('Cannot hash a signaling NaN value.')
951 elif self.is_nan():
952 # 0 to match hash(float('nan'))
953 return 0
954 else:
955 # values chosen to match hash(float('inf')) and
956 # hash(float('-inf')).
957 if self._sign:
958 return -271828
959 else:
960 return 314159
Mark Dickinson99d80962010-04-02 08:53:22 +0000961
962 # In Python 2.7, we're allowing comparisons (but not
963 # arithmetic operations) between floats and Decimals; so if
964 # a Decimal instance is exactly representable as a float then
Mark Dickinsonf3eeca12010-04-02 10:35:12 +0000965 # its hash should match that of the float.
Mark Dickinson99d80962010-04-02 08:53:22 +0000966 self_as_float = float(self)
967 if Decimal.from_float(self_as_float) == self:
968 return hash(self_as_float)
969
Facundo Batista8c202442007-09-19 17:53:25 +0000970 if self._isinteger():
971 op = _WorkRep(self.to_integral_value())
972 # to make computation feasible for Decimals with large
973 # exponent, we use the fact that hash(n) == hash(m) for
974 # any two nonzero integers n and m such that (i) n and m
975 # have the same sign, and (ii) n is congruent to m modulo
976 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
977 # hash((-1)**s*c*pow(10, e, 2**64-1).
978 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Facundo Batista52b25792008-01-08 12:25:20 +0000979 # The value of a nonzero nonspecial Decimal instance is
980 # faithfully represented by the triple consisting of its sign,
981 # its adjusted exponent, and its coefficient with trailing
982 # zeros removed.
983 return hash((self._sign,
984 self._exp+len(self._int),
985 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000986
987 def as_tuple(self):
988 """Represents the number as a triple tuple.
989
990 To show the internals exactly as they are.
991 """
Raymond Hettinger097a1902008-01-11 02:24:13 +0000992 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000993
994 def __repr__(self):
995 """Represents the number as an instance of Decimal."""
996 # Invariant: eval(repr(d)) == d
Raymond Hettingerabe32372008-02-14 02:41:22 +0000997 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000998
Facundo Batista353750c2007-09-13 18:13:15 +0000999 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001000 """Return string representation of the number in scientific notation.
1001
1002 Captures all of the information in the underlying representation.
1003 """
1004
Facundo Batista62edb712007-12-03 16:29:52 +00001005 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +00001006 if self._is_special:
Facundo Batista62edb712007-12-03 16:29:52 +00001007 if self._exp == 'F':
1008 return sign + 'Infinity'
1009 elif self._exp == 'n':
1010 return sign + 'NaN' + self._int
1011 else: # self._exp == 'N'
1012 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001013
Facundo Batista62edb712007-12-03 16:29:52 +00001014 # number of digits of self._int to left of decimal point
1015 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001016
Facundo Batista62edb712007-12-03 16:29:52 +00001017 # dotplace is number of digits of self._int to the left of the
1018 # decimal point in the mantissa of the output string (that is,
1019 # after adjusting the exponent)
1020 if self._exp <= 0 and leftdigits > -6:
1021 # no exponent required
1022 dotplace = leftdigits
1023 elif not eng:
1024 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001025 dotplace = 1
Facundo Batista62edb712007-12-03 16:29:52 +00001026 elif self._int == '0':
1027 # engineering notation, zero
1028 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001029 else:
Facundo Batista62edb712007-12-03 16:29:52 +00001030 # engineering notation, nonzero
1031 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001032
Facundo Batista62edb712007-12-03 16:29:52 +00001033 if dotplace <= 0:
1034 intpart = '0'
1035 fracpart = '.' + '0'*(-dotplace) + self._int
1036 elif dotplace >= len(self._int):
1037 intpart = self._int+'0'*(dotplace-len(self._int))
1038 fracpart = ''
1039 else:
1040 intpart = self._int[:dotplace]
1041 fracpart = '.' + self._int[dotplace:]
1042 if leftdigits == dotplace:
1043 exp = ''
1044 else:
1045 if context is None:
1046 context = getcontext()
1047 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1048
1049 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001050
1051 def to_eng_string(self, context=None):
1052 """Convert to engineering-type string.
1053
1054 Engineering notation has an exponent which is a multiple of 3, so there
1055 are up to 3 digits left of the decimal place.
1056
1057 Same rules for when in exponential and when as a value as in __str__.
1058 """
Facundo Batista353750c2007-09-13 18:13:15 +00001059 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001060
1061 def __neg__(self, context=None):
1062 """Returns a copy with the sign switched.
1063
1064 Rounds, if it has reason.
1065 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001066 if self._is_special:
1067 ans = self._check_nans(context=context)
1068 if ans:
1069 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001070
Mark Dickinson2c8c62e2011-03-12 11:05:32 +00001071 if context is None:
1072 context = getcontext()
1073
1074 if not self and context.rounding != ROUND_FLOOR:
1075 # -Decimal('0') is Decimal('0'), not Decimal('-0'), except
1076 # in ROUND_FLOOR rounding mode.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001077 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001078 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001079 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001080
Facundo Batistae64acfa2007-12-17 14:18:42 +00001081 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001082
1083 def __pos__(self, context=None):
1084 """Returns a copy, unless it is a sNaN.
1085
1086 Rounds the number (if more then precision digits)
1087 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001088 if self._is_special:
1089 ans = self._check_nans(context=context)
1090 if ans:
1091 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001092
Mark Dickinson2c8c62e2011-03-12 11:05:32 +00001093 if context is None:
1094 context = getcontext()
1095
1096 if not self and context.rounding != ROUND_FLOOR:
1097 # + (-0) = 0, except in ROUND_FLOOR rounding mode.
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001098 ans = self.copy_abs()
Facundo Batista353750c2007-09-13 18:13:15 +00001099 else:
1100 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001101
Facundo Batistae64acfa2007-12-17 14:18:42 +00001102 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001103
Facundo Batistae64acfa2007-12-17 14:18:42 +00001104 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001105 """Returns the absolute value of self.
1106
Facundo Batistae64acfa2007-12-17 14:18:42 +00001107 If the keyword argument 'round' is false, do not round. The
1108 expression self.__abs__(round=False) is equivalent to
1109 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001110 """
Facundo Batistae64acfa2007-12-17 14:18:42 +00001111 if not round:
1112 return self.copy_abs()
1113
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001114 if self._is_special:
1115 ans = self._check_nans(context=context)
1116 if ans:
1117 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001118
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001119 if self._sign:
1120 ans = self.__neg__(context=context)
1121 else:
1122 ans = self.__pos__(context=context)
1123
1124 return ans
1125
1126 def __add__(self, other, context=None):
1127 """Returns self + other.
1128
1129 -INF + INF (or the reverse) cause InvalidOperation errors.
1130 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001131 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001132 if other is NotImplemented:
1133 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001134
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001135 if context is None:
1136 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001137
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001138 if self._is_special or other._is_special:
1139 ans = self._check_nans(other, context)
1140 if ans:
1141 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001142
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001143 if self._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001144 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001145 if self._sign != other._sign and other._isinfinity():
1146 return context._raise_error(InvalidOperation, '-INF + INF')
1147 return Decimal(self)
1148 if other._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001149 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001150
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001151 exp = min(self._exp, other._exp)
1152 negativezero = 0
1153 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Facundo Batista59c58842007-04-10 12:58:45 +00001154 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001155 negativezero = 1
1156
1157 if not self and not other:
1158 sign = min(self._sign, other._sign)
1159 if negativezero:
1160 sign = 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00001161 ans = _dec_from_triple(sign, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001162 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001163 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001164 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001165 exp = max(exp, other._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001166 ans = other._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001167 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001168 return ans
1169 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001170 exp = max(exp, self._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001171 ans = self._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001172 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001173 return ans
1174
1175 op1 = _WorkRep(self)
1176 op2 = _WorkRep(other)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001177 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178
1179 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001180 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001181 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001182 if op1.int == op2.int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001183 ans = _dec_from_triple(negativezero, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001184 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001185 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001186 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001187 op1, op2 = op2, op1
Facundo Batista59c58842007-04-10 12:58:45 +00001188 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001189 if op1.sign == 1:
1190 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001191 op1.sign, op2.sign = op2.sign, op1.sign
1192 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001193 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001194 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001195 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001196 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001197 op1.sign, op2.sign = (0, 0)
1198 else:
1199 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001200 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001201
Raymond Hettinger17931de2004-10-27 06:21:46 +00001202 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001203 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001205 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001206
1207 result.exp = op1.exp
1208 ans = Decimal(result)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001209 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001210 return ans
1211
1212 __radd__ = __add__
1213
1214 def __sub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001215 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001216 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001217 if other is NotImplemented:
1218 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001219
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001220 if self._is_special or other._is_special:
1221 ans = self._check_nans(other, context=context)
1222 if ans:
1223 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001224
Facundo Batista353750c2007-09-13 18:13:15 +00001225 # self - other is computed as self + other.copy_negate()
1226 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001227
1228 def __rsub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001229 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001230 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001231 if other is NotImplemented:
1232 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233
Facundo Batista353750c2007-09-13 18:13:15 +00001234 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001236 def __mul__(self, other, context=None):
1237 """Return self * other.
1238
1239 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1240 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001241 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001242 if other is NotImplemented:
1243 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001244
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001245 if context is None:
1246 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001247
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001248 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001249
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001250 if self._is_special or other._is_special:
1251 ans = self._check_nans(other, context)
1252 if ans:
1253 return ans
1254
1255 if self._isinfinity():
1256 if not other:
1257 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001258 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001259
1260 if other._isinfinity():
1261 if not self:
1262 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001263 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001264
1265 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001266
1267 # Special case for multiplying by zero
1268 if not self or not other:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001269 ans = _dec_from_triple(resultsign, '0', resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001270 # Fixing in case the exponent is out of bounds
1271 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001272 return ans
1273
1274 # Special case for multiplying by power of 10
Facundo Batista72bc54f2007-11-23 17:59:00 +00001275 if self._int == '1':
1276 ans = _dec_from_triple(resultsign, other._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001277 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001278 return ans
Facundo Batista72bc54f2007-11-23 17:59:00 +00001279 if other._int == '1':
1280 ans = _dec_from_triple(resultsign, self._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001281 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001282 return ans
1283
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001284 op1 = _WorkRep(self)
1285 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001286
Facundo Batista72bc54f2007-11-23 17:59:00 +00001287 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001288 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001289
1290 return ans
1291 __rmul__ = __mul__
1292
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001293 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001294 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001295 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001296 if other is NotImplemented:
Facundo Batistacce8df22007-09-18 16:53:18 +00001297 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001298
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001299 if context is None:
1300 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001301
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001302 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001303
1304 if self._is_special or other._is_special:
1305 ans = self._check_nans(other, context)
1306 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001307 return ans
1308
1309 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001310 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001311
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001312 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001313 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001314
1315 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001316 context._raise_error(Clamped, 'Division by infinity')
Facundo Batista72bc54f2007-11-23 17:59:00 +00001317 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001318
1319 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001320 if not other:
Facundo Batistacce8df22007-09-18 16:53:18 +00001321 if not self:
1322 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001323 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001324
Facundo Batistacce8df22007-09-18 16:53:18 +00001325 if not self:
1326 exp = self._exp - other._exp
1327 coeff = 0
1328 else:
1329 # OK, so neither = 0, INF or NaN
1330 shift = len(other._int) - len(self._int) + context.prec + 1
1331 exp = self._exp - other._exp - shift
1332 op1 = _WorkRep(self)
1333 op2 = _WorkRep(other)
1334 if shift >= 0:
1335 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1336 else:
1337 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1338 if remainder:
1339 # result is not exact; adjust to ensure correct rounding
1340 if coeff % 5 == 0:
1341 coeff += 1
1342 else:
1343 # result is exact; get as close to ideal exponent as possible
1344 ideal_exp = self._exp - other._exp
1345 while exp < ideal_exp and coeff % 10 == 0:
1346 coeff //= 10
1347 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001348
Facundo Batista72bc54f2007-11-23 17:59:00 +00001349 ans = _dec_from_triple(sign, str(coeff), exp)
Facundo Batistacce8df22007-09-18 16:53:18 +00001350 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001351
Facundo Batistacce8df22007-09-18 16:53:18 +00001352 def _divide(self, other, context):
1353 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001354
Facundo Batistacce8df22007-09-18 16:53:18 +00001355 Assumes that neither self nor other is a NaN, that self is not
1356 infinite and that other is nonzero.
1357 """
1358 sign = self._sign ^ other._sign
1359 if other._isinfinity():
1360 ideal_exp = self._exp
1361 else:
1362 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001363
Facundo Batistacce8df22007-09-18 16:53:18 +00001364 expdiff = self.adjusted() - other.adjusted()
1365 if not self or other._isinfinity() or expdiff <= -2:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001366 return (_dec_from_triple(sign, '0', 0),
Facundo Batistacce8df22007-09-18 16:53:18 +00001367 self._rescale(ideal_exp, context.rounding))
1368 if expdiff <= context.prec:
1369 op1 = _WorkRep(self)
1370 op2 = _WorkRep(other)
1371 if op1.exp >= op2.exp:
1372 op1.int *= 10**(op1.exp - op2.exp)
1373 else:
1374 op2.int *= 10**(op2.exp - op1.exp)
1375 q, r = divmod(op1.int, op2.int)
1376 if q < 10**context.prec:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001377 return (_dec_from_triple(sign, str(q), 0),
1378 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001379
Facundo Batistacce8df22007-09-18 16:53:18 +00001380 # Here the quotient is too large to be representable
1381 ans = context._raise_error(DivisionImpossible,
1382 'quotient too large in //, % or divmod')
1383 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001384
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001385 def __rtruediv__(self, other, context=None):
1386 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001387 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001388 if other is NotImplemented:
1389 return other
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001390 return other.__truediv__(self, context=context)
1391
1392 __div__ = __truediv__
1393 __rdiv__ = __rtruediv__
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001394
1395 def __divmod__(self, other, context=None):
1396 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001397 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001398 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001399 other = _convert_other(other)
1400 if other is NotImplemented:
1401 return other
1402
1403 if context is None:
1404 context = getcontext()
1405
1406 ans = self._check_nans(other, context)
1407 if ans:
1408 return (ans, ans)
1409
1410 sign = self._sign ^ other._sign
1411 if self._isinfinity():
1412 if other._isinfinity():
1413 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1414 return ans, ans
1415 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001416 return (_SignedInfinity[sign],
Facundo Batistacce8df22007-09-18 16:53:18 +00001417 context._raise_error(InvalidOperation, 'INF % x'))
1418
1419 if not other:
1420 if not self:
1421 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1422 return ans, ans
1423 else:
1424 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1425 context._raise_error(InvalidOperation, 'x % 0'))
1426
1427 quotient, remainder = self._divide(other, context)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001428 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001429 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001430
1431 def __rdivmod__(self, other, context=None):
1432 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001433 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001434 if other is NotImplemented:
1435 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001436 return other.__divmod__(self, context=context)
1437
1438 def __mod__(self, other, context=None):
1439 """
1440 self % other
1441 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001442 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001443 if other is NotImplemented:
1444 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001445
Facundo Batistacce8df22007-09-18 16:53:18 +00001446 if context is None:
1447 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001448
Facundo Batistacce8df22007-09-18 16:53:18 +00001449 ans = self._check_nans(other, context)
1450 if ans:
1451 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001452
Facundo Batistacce8df22007-09-18 16:53:18 +00001453 if self._isinfinity():
1454 return context._raise_error(InvalidOperation, 'INF % x')
1455 elif not other:
1456 if self:
1457 return context._raise_error(InvalidOperation, 'x % 0')
1458 else:
1459 return context._raise_error(DivisionUndefined, '0 % 0')
1460
1461 remainder = self._divide(other, context)[1]
Facundo Batistae64acfa2007-12-17 14:18:42 +00001462 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001463 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001464
1465 def __rmod__(self, other, context=None):
1466 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001467 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001468 if other is NotImplemented:
1469 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001470 return other.__mod__(self, context=context)
1471
1472 def remainder_near(self, other, context=None):
1473 """
1474 Remainder nearest to 0- abs(remainder-near) <= other/2
1475 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001476 if context is None:
1477 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001478
Facundo Batista353750c2007-09-13 18:13:15 +00001479 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001480
Facundo Batista353750c2007-09-13 18:13:15 +00001481 ans = self._check_nans(other, context)
1482 if ans:
1483 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001484
Facundo Batista353750c2007-09-13 18:13:15 +00001485 # self == +/-infinity -> InvalidOperation
1486 if self._isinfinity():
1487 return context._raise_error(InvalidOperation,
1488 'remainder_near(infinity, x)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001489
Facundo Batista353750c2007-09-13 18:13:15 +00001490 # other == 0 -> either InvalidOperation or DivisionUndefined
1491 if not other:
1492 if self:
1493 return context._raise_error(InvalidOperation,
1494 'remainder_near(x, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001495 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001496 return context._raise_error(DivisionUndefined,
1497 'remainder_near(0, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001498
Facundo Batista353750c2007-09-13 18:13:15 +00001499 # other = +/-infinity -> remainder = self
1500 if other._isinfinity():
1501 ans = Decimal(self)
1502 return ans._fix(context)
1503
1504 # self = 0 -> remainder = self, with ideal exponent
1505 ideal_exponent = min(self._exp, other._exp)
1506 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001507 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001508 return ans._fix(context)
1509
1510 # catch most cases of large or small quotient
1511 expdiff = self.adjusted() - other.adjusted()
1512 if expdiff >= context.prec + 1:
1513 # expdiff >= prec+1 => abs(self/other) > 10**prec
Facundo Batistacce8df22007-09-18 16:53:18 +00001514 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001515 if expdiff <= -2:
1516 # expdiff <= -2 => abs(self/other) < 0.1
1517 ans = self._rescale(ideal_exponent, context.rounding)
1518 return ans._fix(context)
1519
1520 # adjust both arguments to have the same exponent, then divide
1521 op1 = _WorkRep(self)
1522 op2 = _WorkRep(other)
1523 if op1.exp >= op2.exp:
1524 op1.int *= 10**(op1.exp - op2.exp)
1525 else:
1526 op2.int *= 10**(op2.exp - op1.exp)
1527 q, r = divmod(op1.int, op2.int)
1528 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1529 # 10**ideal_exponent. Apply correction to ensure that
1530 # abs(remainder) <= abs(other)/2
1531 if 2*r + (q&1) > op2.int:
1532 r -= op2.int
1533 q += 1
1534
1535 if q >= 10**context.prec:
Facundo Batistacce8df22007-09-18 16:53:18 +00001536 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001537
1538 # result has same sign as self unless r is negative
1539 sign = self._sign
1540 if r < 0:
1541 sign = 1-sign
1542 r = -r
1543
Facundo Batista72bc54f2007-11-23 17:59:00 +00001544 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001545 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001546
1547 def __floordiv__(self, other, context=None):
1548 """self // other"""
Facundo Batistacce8df22007-09-18 16:53:18 +00001549 other = _convert_other(other)
1550 if other is NotImplemented:
1551 return other
1552
1553 if context is None:
1554 context = getcontext()
1555
1556 ans = self._check_nans(other, context)
1557 if ans:
1558 return ans
1559
1560 if self._isinfinity():
1561 if other._isinfinity():
1562 return context._raise_error(InvalidOperation, 'INF // INF')
1563 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001564 return _SignedInfinity[self._sign ^ other._sign]
Facundo Batistacce8df22007-09-18 16:53:18 +00001565
1566 if not other:
1567 if self:
1568 return context._raise_error(DivisionByZero, 'x // 0',
1569 self._sign ^ other._sign)
1570 else:
1571 return context._raise_error(DivisionUndefined, '0 // 0')
1572
1573 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001574
1575 def __rfloordiv__(self, other, context=None):
1576 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001577 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001578 if other is NotImplemented:
1579 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001580 return other.__floordiv__(self, context=context)
1581
1582 def __float__(self):
1583 """Float representation."""
1584 return float(str(self))
1585
1586 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001587 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001588 if self._is_special:
1589 if self._isnan():
Mark Dickinson968f1692009-09-07 18:04:58 +00001590 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001591 elif self._isinfinity():
Mark Dickinson968f1692009-09-07 18:04:58 +00001592 raise OverflowError("Cannot convert infinity to integer")
Facundo Batista353750c2007-09-13 18:13:15 +00001593 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001594 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001595 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001596 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001597 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001598
Raymond Hettinger5a053642008-01-24 19:05:29 +00001599 __trunc__ = __int__
1600
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001601 def real(self):
1602 return self
Mark Dickinson65808ff2009-01-04 21:22:02 +00001603 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001604
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001605 def imag(self):
1606 return Decimal(0)
Mark Dickinson65808ff2009-01-04 21:22:02 +00001607 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001608
1609 def conjugate(self):
1610 return self
1611
1612 def __complex__(self):
1613 return complex(float(self))
1614
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001615 def __long__(self):
1616 """Converts to a long.
1617
1618 Equivalent to long(int(self))
1619 """
1620 return long(self.__int__())
1621
Facundo Batista353750c2007-09-13 18:13:15 +00001622 def _fix_nan(self, context):
1623 """Decapitate the payload of a NaN to fit the context"""
1624 payload = self._int
1625
1626 # maximum length of payload is precision if _clamp=0,
1627 # precision-1 if _clamp=1.
1628 max_payload_len = context.prec - context._clamp
1629 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001630 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1631 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001632 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001633
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001634 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001635 """Round if it is necessary to keep self within prec precision.
1636
1637 Rounds and fixes the exponent. Does not raise on a sNaN.
1638
1639 Arguments:
1640 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001641 context - context used.
1642 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001643
Facundo Batista353750c2007-09-13 18:13:15 +00001644 if self._is_special:
1645 if self._isnan():
1646 # decapitate payload if necessary
1647 return self._fix_nan(context)
1648 else:
1649 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001650 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001651
Facundo Batista353750c2007-09-13 18:13:15 +00001652 # if self is zero then exponent should be between Etiny and
1653 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1654 Etiny = context.Etiny()
1655 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001656 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001657 exp_max = [context.Emax, Etop][context._clamp]
1658 new_exp = min(max(self._exp, Etiny), exp_max)
1659 if new_exp != self._exp:
1660 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001661 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001662 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001663 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001664
1665 # exp_min is the smallest allowable exponent of the result,
1666 # equal to max(self.adjusted()-context.prec+1, Etiny)
1667 exp_min = len(self._int) + self._exp - context.prec
1668 if exp_min > Etop:
1669 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001670 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00001671 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001672 context._raise_error(Rounded)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001673 return ans
1674
Facundo Batista353750c2007-09-13 18:13:15 +00001675 self_is_subnormal = exp_min < Etiny
1676 if self_is_subnormal:
Facundo Batista353750c2007-09-13 18:13:15 +00001677 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001678
Facundo Batista353750c2007-09-13 18:13:15 +00001679 # round if self has too many digits
1680 if self._exp < exp_min:
Facundo Batista2ec74152007-12-03 17:55:00 +00001681 digits = len(self._int) + self._exp - exp_min
1682 if digits < 0:
1683 self = _dec_from_triple(self._sign, '1', exp_min-1)
1684 digits = 0
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001685 rounding_method = self._pick_rounding_function[context.rounding]
Raymond Hettingerd9223292011-04-12 09:06:01 -07001686 changed = rounding_method(self, digits)
Facundo Batista2ec74152007-12-03 17:55:00 +00001687 coeff = self._int[:digits] or '0'
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001688 if changed > 0:
Facundo Batista2ec74152007-12-03 17:55:00 +00001689 coeff = str(int(coeff)+1)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001690 if len(coeff) > context.prec:
1691 coeff = coeff[:-1]
1692 exp_min += 1
Facundo Batista2ec74152007-12-03 17:55:00 +00001693
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001694 # check whether the rounding pushed the exponent out of range
1695 if exp_min > Etop:
1696 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1697 else:
1698 ans = _dec_from_triple(self._sign, coeff, exp_min)
1699
1700 # raise the appropriate signals, taking care to respect
1701 # the precedence described in the specification
1702 if changed and self_is_subnormal:
1703 context._raise_error(Underflow)
1704 if self_is_subnormal:
1705 context._raise_error(Subnormal)
Facundo Batista2ec74152007-12-03 17:55:00 +00001706 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001707 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001708 context._raise_error(Rounded)
1709 if not ans:
1710 # raise Clamped on underflow to 0
1711 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001712 return ans
1713
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001714 if self_is_subnormal:
1715 context._raise_error(Subnormal)
1716
Facundo Batista353750c2007-09-13 18:13:15 +00001717 # fold down if _clamp == 1 and self has too few digits
1718 if context._clamp == 1 and self._exp > Etop:
1719 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001720 self_padded = self._int + '0'*(self._exp - Etop)
1721 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001722
Facundo Batista353750c2007-09-13 18:13:15 +00001723 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001724 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001725
Facundo Batista353750c2007-09-13 18:13:15 +00001726 # for each of the rounding functions below:
1727 # self is a finite, nonzero Decimal
1728 # prec is an integer satisfying 0 <= prec < len(self._int)
Facundo Batista2ec74152007-12-03 17:55:00 +00001729 #
1730 # each function returns either -1, 0, or 1, as follows:
1731 # 1 indicates that self should be rounded up (away from zero)
1732 # 0 indicates that self should be truncated, and that all the
1733 # digits to be truncated are zeros (so the value is unchanged)
1734 # -1 indicates that there are nonzero digits to be truncated
Facundo Batista353750c2007-09-13 18:13:15 +00001735
1736 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001737 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001738 if _all_zeros(self._int, prec):
1739 return 0
1740 else:
1741 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001742
Facundo Batista353750c2007-09-13 18:13:15 +00001743 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001744 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001745 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001746
Facundo Batista353750c2007-09-13 18:13:15 +00001747 def _round_half_up(self, prec):
1748 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001749 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001750 return 1
1751 elif _all_zeros(self._int, prec):
1752 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001753 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001754 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001755
1756 def _round_half_down(self, prec):
1757 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001758 if _exact_half(self._int, prec):
1759 return -1
1760 else:
1761 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001762
1763 def _round_half_even(self, prec):
1764 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001765 if _exact_half(self._int, prec) and \
1766 (prec == 0 or self._int[prec-1] in '02468'):
1767 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001768 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001769 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001770
1771 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001772 """Rounds up (not away from 0 if negative.)"""
1773 if self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001774 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001775 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001776 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001777
Facundo Batista353750c2007-09-13 18:13:15 +00001778 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001779 """Rounds down (not towards 0 if negative)"""
1780 if not self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001781 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001782 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001783 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001784
Facundo Batista353750c2007-09-13 18:13:15 +00001785 def _round_05up(self, prec):
1786 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001787 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001788 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001789 else:
1790 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001791
Raymond Hettingere4579c32011-04-11 17:27:42 -07001792 _pick_rounding_function = dict(
Raymond Hettingerd9223292011-04-12 09:06:01 -07001793 ROUND_DOWN = _round_down,
1794 ROUND_UP = _round_up,
1795 ROUND_HALF_UP = _round_half_up,
1796 ROUND_HALF_DOWN = _round_half_down,
1797 ROUND_HALF_EVEN = _round_half_even,
1798 ROUND_CEILING = _round_ceiling,
1799 ROUND_FLOOR = _round_floor,
1800 ROUND_05UP = _round_05up,
Raymond Hettingere4579c32011-04-11 17:27:42 -07001801 )
1802
Facundo Batista353750c2007-09-13 18:13:15 +00001803 def fma(self, other, third, context=None):
1804 """Fused multiply-add.
1805
1806 Returns self*other+third with no rounding of the intermediate
1807 product self*other.
1808
1809 self and other are multiplied together, with no rounding of
1810 the result. The third operand is then added to the result,
1811 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001812 """
Facundo Batista353750c2007-09-13 18:13:15 +00001813
1814 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001815
1816 # compute product; raise InvalidOperation if either operand is
1817 # a signaling NaN or if the product is zero times infinity.
1818 if self._is_special or other._is_special:
1819 if context is None:
1820 context = getcontext()
1821 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001822 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001823 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001824 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001825 if self._exp == 'n':
1826 product = self
1827 elif other._exp == 'n':
1828 product = other
1829 elif self._exp == 'F':
1830 if not other:
1831 return context._raise_error(InvalidOperation,
1832 'INF * 0 in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001833 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001834 elif other._exp == 'F':
1835 if not self:
1836 return context._raise_error(InvalidOperation,
1837 '0 * INF in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001838 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001839 else:
1840 product = _dec_from_triple(self._sign ^ other._sign,
1841 str(int(self._int) * int(other._int)),
1842 self._exp + other._exp)
1843
Facundo Batista353750c2007-09-13 18:13:15 +00001844 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001845 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001846
Facundo Batista353750c2007-09-13 18:13:15 +00001847 def _power_modulo(self, other, modulo, context=None):
1848 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001849
Facundo Batista353750c2007-09-13 18:13:15 +00001850 # if can't convert other and modulo to Decimal, raise
1851 # TypeError; there's no point returning NotImplemented (no
1852 # equivalent of __rpow__ for three argument pow)
1853 other = _convert_other(other, raiseit=True)
1854 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001855
Facundo Batista353750c2007-09-13 18:13:15 +00001856 if context is None:
1857 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001858
Facundo Batista353750c2007-09-13 18:13:15 +00001859 # deal with NaNs: if there are any sNaNs then first one wins,
1860 # (i.e. behaviour for NaNs is identical to that of fma)
1861 self_is_nan = self._isnan()
1862 other_is_nan = other._isnan()
1863 modulo_is_nan = modulo._isnan()
1864 if self_is_nan or other_is_nan or modulo_is_nan:
1865 if self_is_nan == 2:
1866 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001867 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001868 if other_is_nan == 2:
1869 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001870 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001871 if modulo_is_nan == 2:
1872 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001873 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001874 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001875 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001876 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001877 return other._fix_nan(context)
1878 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001879
Facundo Batista353750c2007-09-13 18:13:15 +00001880 # check inputs: we apply same restrictions as Python's pow()
1881 if not (self._isinteger() and
1882 other._isinteger() and
1883 modulo._isinteger()):
1884 return context._raise_error(InvalidOperation,
1885 'pow() 3rd argument not allowed '
1886 'unless all arguments are integers')
1887 if other < 0:
1888 return context._raise_error(InvalidOperation,
1889 'pow() 2nd argument cannot be '
1890 'negative when 3rd argument specified')
1891 if not modulo:
1892 return context._raise_error(InvalidOperation,
1893 'pow() 3rd argument cannot be 0')
1894
1895 # additional restriction for decimal: the modulus must be less
1896 # than 10**prec in absolute value
1897 if modulo.adjusted() >= context.prec:
1898 return context._raise_error(InvalidOperation,
1899 'insufficient precision: pow() 3rd '
1900 'argument must not have more than '
1901 'precision digits')
1902
1903 # define 0**0 == NaN, for consistency with two-argument pow
1904 # (even though it hurts!)
1905 if not other and not self:
1906 return context._raise_error(InvalidOperation,
1907 'at least one of pow() 1st argument '
1908 'and 2nd argument must be nonzero ;'
1909 '0**0 is not defined')
1910
1911 # compute sign of result
1912 if other._iseven():
1913 sign = 0
1914 else:
1915 sign = self._sign
1916
1917 # convert modulo to a Python integer, and self and other to
1918 # Decimal integers (i.e. force their exponents to be >= 0)
1919 modulo = abs(int(modulo))
1920 base = _WorkRep(self.to_integral_value())
1921 exponent = _WorkRep(other.to_integral_value())
1922
1923 # compute result using integer pow()
1924 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1925 for i in xrange(exponent.exp):
1926 base = pow(base, 10, modulo)
1927 base = pow(base, exponent.int, modulo)
1928
Facundo Batista72bc54f2007-11-23 17:59:00 +00001929 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001930
1931 def _power_exact(self, other, p):
1932 """Attempt to compute self**other exactly.
1933
1934 Given Decimals self and other and an integer p, attempt to
1935 compute an exact result for the power self**other, with p
1936 digits of precision. Return None if self**other is not
1937 exactly representable in p digits.
1938
1939 Assumes that elimination of special cases has already been
1940 performed: self and other must both be nonspecial; self must
1941 be positive and not numerically equal to 1; other must be
1942 nonzero. For efficiency, other._exp should not be too large,
1943 so that 10**abs(other._exp) is a feasible calculation."""
1944
Mark Dickinsona493ca32011-06-04 18:24:15 +01001945 # In the comments below, we write x for the value of self and y for the
1946 # value of other. Write x = xc*10**xe and abs(y) = yc*10**ye, with xc
1947 # and yc positive integers not divisible by 10.
Facundo Batista353750c2007-09-13 18:13:15 +00001948
1949 # The main purpose of this method is to identify the *failure*
1950 # of x**y to be exactly representable with as little effort as
1951 # possible. So we look for cheap and easy tests that
1952 # eliminate the possibility of x**y being exact. Only if all
1953 # these tests are passed do we go on to actually compute x**y.
1954
Mark Dickinsona493ca32011-06-04 18:24:15 +01001955 # Here's the main idea. Express y as a rational number m/n, with m and
1956 # n relatively prime and n>0. Then for x**y to be exactly
1957 # representable (at *any* precision), xc must be the nth power of a
1958 # positive integer and xe must be divisible by n. If y is negative
1959 # then additionally xc must be a power of either 2 or 5, hence a power
1960 # of 2**n or 5**n.
Facundo Batista353750c2007-09-13 18:13:15 +00001961 #
1962 # There's a limit to how small |y| can be: if y=m/n as above
1963 # then:
1964 #
1965 # (1) if xc != 1 then for the result to be representable we
1966 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1967 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1968 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1969 # representable.
1970 #
1971 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1972 # |y| < 1/|xe| then the result is not representable.
1973 #
1974 # Note that since x is not equal to 1, at least one of (1) and
1975 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1976 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1977 #
1978 # There's also a limit to how large y can be, at least if it's
1979 # positive: the normalized result will have coefficient xc**y,
1980 # so if it's representable then xc**y < 10**p, and y <
1981 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1982 # not exactly representable.
1983
1984 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1985 # so |y| < 1/xe and the result is not representable.
1986 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1987 # < 1/nbits(xc).
1988
1989 x = _WorkRep(self)
1990 xc, xe = x.int, x.exp
1991 while xc % 10 == 0:
1992 xc //= 10
1993 xe += 1
1994
1995 y = _WorkRep(other)
1996 yc, ye = y.int, y.exp
1997 while yc % 10 == 0:
1998 yc //= 10
1999 ye += 1
2000
2001 # case where xc == 1: result is 10**(xe*y), with xe*y
2002 # required to be an integer
2003 if xc == 1:
Mark Dickinsone85aa732010-07-08 19:24:40 +00002004 xe *= yc
2005 # result is now 10**(xe * 10**ye); xe * 10**ye must be integral
2006 while xe % 10 == 0:
2007 xe //= 10
2008 ye += 1
2009 if ye < 0:
2010 return None
2011 exponent = xe * 10**ye
Facundo Batista353750c2007-09-13 18:13:15 +00002012 if y.sign == 1:
2013 exponent = -exponent
2014 # if other is a nonnegative integer, use ideal exponent
2015 if other._isinteger() and other._sign == 0:
2016 ideal_exponent = self._exp*int(other)
2017 zeros = min(exponent-ideal_exponent, p-1)
2018 else:
2019 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002020 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002021
2022 # case where y is negative: xc must be either a power
2023 # of 2 or a power of 5.
2024 if y.sign == 1:
2025 last_digit = xc % 10
2026 if last_digit in (2,4,6,8):
2027 # quick test for power of 2
2028 if xc & -xc != xc:
2029 return None
2030 # now xc is a power of 2; e is its exponent
2031 e = _nbits(xc)-1
Facundo Batista353750c2007-09-13 18:13:15 +00002032
Mark Dickinsona493ca32011-06-04 18:24:15 +01002033 # We now have:
2034 #
2035 # x = 2**e * 10**xe, e > 0, and y < 0.
2036 #
2037 # The exact result is:
2038 #
2039 # x**y = 5**(-e*y) * 10**(e*y + xe*y)
2040 #
2041 # provided that both e*y and xe*y are integers. Note that if
2042 # 5**(-e*y) >= 10**p, then the result can't be expressed
2043 # exactly with p digits of precision.
2044 #
2045 # Using the above, we can guard against large values of ye.
2046 # 93/65 is an upper bound for log(10)/log(5), so if
2047 #
2048 # ye >= len(str(93*p//65))
2049 #
2050 # then
2051 #
2052 # -e*y >= -y >= 10**ye > 93*p/65 > p*log(10)/log(5),
2053 #
2054 # so 5**(-e*y) >= 10**p, and the coefficient of the result
2055 # can't be expressed in p digits.
2056
2057 # emax >= largest e such that 5**e < 10**p.
2058 emax = p*93//65
2059 if ye >= len(str(emax)):
2060 return None
2061
2062 # Find -e*y and -xe*y; both must be integers
2063 e = _decimal_lshift_exact(e * yc, ye)
2064 xe = _decimal_lshift_exact(xe * yc, ye)
2065 if e is None or xe is None:
2066 return None
2067
2068 if e > emax:
Facundo Batista353750c2007-09-13 18:13:15 +00002069 return None
2070 xc = 5**e
2071
2072 elif last_digit == 5:
2073 # e >= log_5(xc) if xc is a power of 5; we have
2074 # equality all the way up to xc=5**2658
2075 e = _nbits(xc)*28//65
2076 xc, remainder = divmod(5**e, xc)
2077 if remainder:
2078 return None
2079 while xc % 5 == 0:
2080 xc //= 5
2081 e -= 1
Mark Dickinsona493ca32011-06-04 18:24:15 +01002082
2083 # Guard against large values of ye, using the same logic as in
2084 # the 'xc is a power of 2' branch. 10/3 is an upper bound for
2085 # log(10)/log(2).
2086 emax = p*10//3
2087 if ye >= len(str(emax)):
2088 return None
2089
2090 e = _decimal_lshift_exact(e * yc, ye)
2091 xe = _decimal_lshift_exact(xe * yc, ye)
2092 if e is None or xe is None:
2093 return None
2094
2095 if e > emax:
Facundo Batista353750c2007-09-13 18:13:15 +00002096 return None
2097 xc = 2**e
2098 else:
2099 return None
2100
2101 if xc >= 10**p:
2102 return None
2103 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00002104 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00002105
2106 # now y is positive; find m and n such that y = m/n
2107 if ye >= 0:
2108 m, n = yc*10**ye, 1
2109 else:
2110 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2111 return None
2112 xc_bits = _nbits(xc)
2113 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2114 return None
2115 m, n = yc, 10**(-ye)
2116 while m % 2 == n % 2 == 0:
2117 m //= 2
2118 n //= 2
2119 while m % 5 == n % 5 == 0:
2120 m //= 5
2121 n //= 5
2122
2123 # compute nth root of xc*10**xe
2124 if n > 1:
2125 # if 1 < xc < 2**n then xc isn't an nth power
2126 if xc != 1 and xc_bits <= n:
2127 return None
2128
2129 xe, rem = divmod(xe, n)
2130 if rem != 0:
2131 return None
2132
2133 # compute nth root of xc using Newton's method
2134 a = 1L << -(-_nbits(xc)//n) # initial estimate
2135 while True:
2136 q, r = divmod(xc, a**(n-1))
2137 if a <= q:
2138 break
2139 else:
2140 a = (a*(n-1) + q)//n
2141 if not (a == q and r == 0):
2142 return None
2143 xc = a
2144
2145 # now xc*10**xe is the nth root of the original xc*10**xe
2146 # compute mth power of xc*10**xe
2147
2148 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2149 # 10**p and the result is not representable.
2150 if xc > 1 and m > p*100//_log10_lb(xc):
2151 return None
2152 xc = xc**m
2153 xe *= m
2154 if xc > 10**p:
2155 return None
2156
2157 # by this point the result *is* exactly representable
2158 # adjust the exponent to get as close as possible to the ideal
2159 # exponent, if necessary
2160 str_xc = str(xc)
2161 if other._isinteger() and other._sign == 0:
2162 ideal_exponent = self._exp*int(other)
2163 zeros = min(xe-ideal_exponent, p-len(str_xc))
2164 else:
2165 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002166 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002167
2168 def __pow__(self, other, modulo=None, context=None):
2169 """Return self ** other [ % modulo].
2170
2171 With two arguments, compute self**other.
2172
2173 With three arguments, compute (self**other) % modulo. For the
2174 three argument form, the following restrictions on the
2175 arguments hold:
2176
2177 - all three arguments must be integral
2178 - other must be nonnegative
2179 - either self or other (or both) must be nonzero
2180 - modulo must be nonzero and must have at most p digits,
2181 where p is the context precision.
2182
2183 If any of these restrictions is violated the InvalidOperation
2184 flag is raised.
2185
2186 The result of pow(self, other, modulo) is identical to the
2187 result that would be obtained by computing (self**other) %
2188 modulo with unbounded precision, but is computed more
2189 efficiently. It is always exact.
2190 """
2191
2192 if modulo is not None:
2193 return self._power_modulo(other, modulo, context)
2194
2195 other = _convert_other(other)
2196 if other is NotImplemented:
2197 return other
2198
2199 if context is None:
2200 context = getcontext()
2201
2202 # either argument is a NaN => result is NaN
2203 ans = self._check_nans(other, context)
2204 if ans:
2205 return ans
2206
2207 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2208 if not other:
2209 if not self:
2210 return context._raise_error(InvalidOperation, '0 ** 0')
2211 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002212 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002213
2214 # result has sign 1 iff self._sign is 1 and other is an odd integer
2215 result_sign = 0
2216 if self._sign == 1:
2217 if other._isinteger():
2218 if not other._iseven():
2219 result_sign = 1
2220 else:
2221 # -ve**noninteger = NaN
2222 # (-0)**noninteger = 0**noninteger
2223 if self:
2224 return context._raise_error(InvalidOperation,
2225 'x ** y with x negative and y not an integer')
2226 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002227 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002228
2229 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2230 if not self:
2231 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002232 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002233 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002234 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002235
2236 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002237 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002238 if other._sign == 0:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002239 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002240 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002241 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002242
Facundo Batista353750c2007-09-13 18:13:15 +00002243 # 1**other = 1, but the choice of exponent and the flags
2244 # depend on the exponent of self, and on whether other is a
2245 # positive integer, a negative integer, or neither
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002246 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002247 if other._isinteger():
2248 # exp = max(self._exp*max(int(other), 0),
2249 # 1-context.prec) but evaluating int(other) directly
2250 # is dangerous until we know other is small (other
2251 # could be 1e999999999)
2252 if other._sign == 1:
2253 multiplier = 0
2254 elif other > context.prec:
2255 multiplier = context.prec
2256 else:
2257 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002258
Facundo Batista353750c2007-09-13 18:13:15 +00002259 exp = self._exp * multiplier
2260 if exp < 1-context.prec:
2261 exp = 1-context.prec
2262 context._raise_error(Rounded)
2263 else:
2264 context._raise_error(Inexact)
2265 context._raise_error(Rounded)
2266 exp = 1-context.prec
2267
Facundo Batista72bc54f2007-11-23 17:59:00 +00002268 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002269
2270 # compute adjusted exponent of self
2271 self_adj = self.adjusted()
2272
2273 # self ** infinity is infinity if self > 1, 0 if self < 1
2274 # self ** -infinity is infinity if self < 1, 0 if self > 1
2275 if other._isinfinity():
2276 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002277 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002278 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002279 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002280
2281 # from here on, the result always goes through the call
2282 # to _fix at the end of this function.
2283 ans = None
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002284 exact = False
Facundo Batista353750c2007-09-13 18:13:15 +00002285
2286 # crude test to catch cases of extreme overflow/underflow. If
2287 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2288 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2289 # self**other >= 10**(Emax+1), so overflow occurs. The test
2290 # for underflow is similar.
2291 bound = self._log10_exp_bound() + other.adjusted()
2292 if (self_adj >= 0) == (other._sign == 0):
2293 # self > 1 and other +ve, or self < 1 and other -ve
2294 # possibility of overflow
2295 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002296 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002297 else:
2298 # self > 1 and other -ve, or self < 1 and other +ve
2299 # possibility of underflow to 0
2300 Etiny = context.Etiny()
2301 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002302 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002303
2304 # try for an exact result with precision +1
2305 if ans is None:
2306 ans = self._power_exact(other, context.prec + 1)
Mark Dickinsone85aa732010-07-08 19:24:40 +00002307 if ans is not None:
2308 if result_sign == 1:
2309 ans = _dec_from_triple(1, ans._int, ans._exp)
2310 exact = True
Facundo Batista353750c2007-09-13 18:13:15 +00002311
2312 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2313 if ans is None:
2314 p = context.prec
2315 x = _WorkRep(self)
2316 xc, xe = x.int, x.exp
2317 y = _WorkRep(other)
2318 yc, ye = y.int, y.exp
2319 if y.sign == 1:
2320 yc = -yc
2321
2322 # compute correctly rounded result: start with precision +3,
2323 # then increase precision until result is unambiguously roundable
2324 extra = 3
2325 while True:
2326 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2327 if coeff % (5*10**(len(str(coeff))-p-1)):
2328 break
2329 extra += 3
2330
Facundo Batista72bc54f2007-11-23 17:59:00 +00002331 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002332
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002333 # unlike exp, ln and log10, the power function respects the
2334 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2335
2336 # There's a difficulty here when 'other' is not an integer and
2337 # the result is exact. In this case, the specification
2338 # requires that the Inexact flag be raised (in spite of
2339 # exactness), but since the result is exact _fix won't do this
2340 # for us. (Correspondingly, the Underflow signal should also
2341 # be raised for subnormal results.) We can't directly raise
2342 # these signals either before or after calling _fix, since
2343 # that would violate the precedence for signals. So we wrap
2344 # the ._fix call in a temporary context, and reraise
2345 # afterwards.
2346 if exact and not other._isinteger():
2347 # pad with zeros up to length context.prec+1 if necessary; this
2348 # ensures that the Rounded signal will be raised.
Facundo Batista353750c2007-09-13 18:13:15 +00002349 if len(ans._int) <= context.prec:
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002350 expdiff = context.prec + 1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002351 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2352 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002353
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002354 # create a copy of the current context, with cleared flags/traps
2355 newcontext = context.copy()
2356 newcontext.clear_flags()
2357 for exception in _signals:
2358 newcontext.traps[exception] = 0
2359
2360 # round in the new context
2361 ans = ans._fix(newcontext)
2362
2363 # raise Inexact, and if necessary, Underflow
2364 newcontext._raise_error(Inexact)
2365 if newcontext.flags[Subnormal]:
2366 newcontext._raise_error(Underflow)
2367
2368 # propagate signals to the original context; _fix could
2369 # have raised any of Overflow, Underflow, Subnormal,
2370 # Inexact, Rounded, Clamped. Overflow needs the correct
2371 # arguments. Note that the order of the exceptions is
2372 # important here.
2373 if newcontext.flags[Overflow]:
2374 context._raise_error(Overflow, 'above Emax', ans._sign)
2375 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2376 if newcontext.flags[exception]:
2377 context._raise_error(exception)
2378
2379 else:
2380 ans = ans._fix(context)
2381
Facundo Batista353750c2007-09-13 18:13:15 +00002382 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002383
2384 def __rpow__(self, other, context=None):
2385 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002386 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002387 if other is NotImplemented:
2388 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002389 return other.__pow__(self, context=context)
2390
2391 def normalize(self, context=None):
2392 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002393
Facundo Batista353750c2007-09-13 18:13:15 +00002394 if context is None:
2395 context = getcontext()
2396
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002397 if self._is_special:
2398 ans = self._check_nans(context=context)
2399 if ans:
2400 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002401
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002402 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002403 if dup._isinfinity():
2404 return dup
2405
2406 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002407 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002408 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002409 end = len(dup._int)
2410 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002411 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002412 exp += 1
2413 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002414 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002415
Facundo Batistabd2fe832007-09-13 18:42:09 +00002416 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002417 """Quantize self so its exponent is the same as that of exp.
2418
2419 Similar to self._rescale(exp._exp) but with error checking.
2420 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002421 exp = _convert_other(exp, raiseit=True)
2422
Facundo Batista353750c2007-09-13 18:13:15 +00002423 if context is None:
2424 context = getcontext()
2425 if rounding is None:
2426 rounding = context.rounding
2427
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002428 if self._is_special or exp._is_special:
2429 ans = self._check_nans(exp, context)
2430 if ans:
2431 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002432
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002433 if exp._isinfinity() or self._isinfinity():
2434 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002435 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002436 return context._raise_error(InvalidOperation,
2437 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002438
Facundo Batistabd2fe832007-09-13 18:42:09 +00002439 # if we're not watching exponents, do a simple rescale
2440 if not watchexp:
2441 ans = self._rescale(exp._exp, rounding)
2442 # raise Inexact and Rounded where appropriate
2443 if ans._exp > self._exp:
2444 context._raise_error(Rounded)
2445 if ans != self:
2446 context._raise_error(Inexact)
2447 return ans
2448
Facundo Batista353750c2007-09-13 18:13:15 +00002449 # exp._exp should be between Etiny and Emax
2450 if not (context.Etiny() <= exp._exp <= context.Emax):
2451 return context._raise_error(InvalidOperation,
2452 'target exponent out of bounds in quantize')
2453
2454 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002455 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002456 return ans._fix(context)
2457
2458 self_adjusted = self.adjusted()
2459 if self_adjusted > context.Emax:
2460 return context._raise_error(InvalidOperation,
2461 'exponent of quantize result too large for current context')
2462 if self_adjusted - exp._exp + 1 > context.prec:
2463 return context._raise_error(InvalidOperation,
2464 'quantize result has too many digits for current context')
2465
2466 ans = self._rescale(exp._exp, rounding)
2467 if ans.adjusted() > context.Emax:
2468 return context._raise_error(InvalidOperation,
2469 'exponent of quantize result too large for current context')
2470 if len(ans._int) > context.prec:
2471 return context._raise_error(InvalidOperation,
2472 'quantize result has too many digits for current context')
2473
2474 # raise appropriate flags
Facundo Batista353750c2007-09-13 18:13:15 +00002475 if ans and ans.adjusted() < context.Emin:
2476 context._raise_error(Subnormal)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002477 if ans._exp > self._exp:
2478 if ans != self:
2479 context._raise_error(Inexact)
2480 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00002481
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002482 # call to fix takes care of any necessary folddown, and
2483 # signals Clamped if necessary
Facundo Batista353750c2007-09-13 18:13:15 +00002484 ans = ans._fix(context)
2485 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002486
2487 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002488 """Return True if self and other have the same exponent; otherwise
2489 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002490
Facundo Batista1a191df2007-10-02 17:01:24 +00002491 If either operand is a special value, the following rules are used:
2492 * return True if both operands are infinities
2493 * return True if both operands are NaNs
2494 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002495 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002496 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002497 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002498 return (self.is_nan() and other.is_nan() or
2499 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002500 return self._exp == other._exp
2501
Facundo Batista353750c2007-09-13 18:13:15 +00002502 def _rescale(self, exp, rounding):
2503 """Rescale self so that the exponent is exp, either by padding with zeros
2504 or by truncating digits, using the given rounding mode.
2505
2506 Specials are returned without change. This operation is
2507 quiet: it raises no flags, and uses no information from the
2508 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002509
2510 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002511 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002512 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002513 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002514 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002515 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002516 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002517
Facundo Batista353750c2007-09-13 18:13:15 +00002518 if self._exp >= exp:
2519 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002520 return _dec_from_triple(self._sign,
2521 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002522
Facundo Batista353750c2007-09-13 18:13:15 +00002523 # too many digits; round and lose data. If self.adjusted() <
2524 # exp-1, replace self by 10**(exp-1) before rounding
2525 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002526 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002527 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002528 digits = 0
Raymond Hettingerd9223292011-04-12 09:06:01 -07002529 this_function = self._pick_rounding_function[rounding]
2530 changed = this_function(self, digits)
Facundo Batista2ec74152007-12-03 17:55:00 +00002531 coeff = self._int[:digits] or '0'
2532 if changed == 1:
2533 coeff = str(int(coeff)+1)
2534 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002535
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002536 def _round(self, places, rounding):
2537 """Round a nonzero, nonspecial Decimal to a fixed number of
2538 significant figures, using the given rounding mode.
2539
2540 Infinities, NaNs and zeros are returned unaltered.
2541
2542 This operation is quiet: it raises no flags, and uses no
2543 information from the context.
2544
2545 """
2546 if places <= 0:
2547 raise ValueError("argument should be at least 1 in _round")
2548 if self._is_special or not self:
2549 return Decimal(self)
2550 ans = self._rescale(self.adjusted()+1-places, rounding)
2551 # it can happen that the rescale alters the adjusted exponent;
2552 # for example when rounding 99.97 to 3 significant figures.
2553 # When this happens we end up with an extra 0 at the end of
2554 # the number; a second rescale fixes this.
2555 if ans.adjusted() != self.adjusted():
2556 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2557 return ans
2558
Facundo Batista353750c2007-09-13 18:13:15 +00002559 def to_integral_exact(self, rounding=None, context=None):
2560 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002561
Facundo Batista353750c2007-09-13 18:13:15 +00002562 If no rounding mode is specified, take the rounding mode from
2563 the context. This method raises the Rounded and Inexact flags
2564 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002565
Facundo Batista353750c2007-09-13 18:13:15 +00002566 See also: to_integral_value, which does exactly the same as
2567 this method except that it doesn't raise Inexact or Rounded.
2568 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002569 if self._is_special:
2570 ans = self._check_nans(context=context)
2571 if ans:
2572 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002573 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002574 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002575 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002576 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002577 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002578 if context is None:
2579 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002580 if rounding is None:
2581 rounding = context.rounding
Facundo Batista353750c2007-09-13 18:13:15 +00002582 ans = self._rescale(0, rounding)
2583 if ans != self:
2584 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002585 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002586 return ans
2587
Facundo Batista353750c2007-09-13 18:13:15 +00002588 def to_integral_value(self, rounding=None, context=None):
2589 """Rounds to the nearest integer, without raising inexact, rounded."""
2590 if context is None:
2591 context = getcontext()
2592 if rounding is None:
2593 rounding = context.rounding
2594 if self._is_special:
2595 ans = self._check_nans(context=context)
2596 if ans:
2597 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002598 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002599 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002600 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002601 else:
2602 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002603
Facundo Batista353750c2007-09-13 18:13:15 +00002604 # the method name changed, but we provide also the old one, for compatibility
2605 to_integral = to_integral_value
2606
2607 def sqrt(self, context=None):
2608 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002609 if context is None:
2610 context = getcontext()
2611
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002612 if self._is_special:
2613 ans = self._check_nans(context=context)
2614 if ans:
2615 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002616
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002617 if self._isinfinity() and self._sign == 0:
2618 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002619
2620 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002621 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002622 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002623 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002624
2625 if self._sign == 1:
2626 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2627
Facundo Batista353750c2007-09-13 18:13:15 +00002628 # At this point self represents a positive number. Let p be
2629 # the desired precision and express self in the form c*100**e
2630 # with c a positive real number and e an integer, c and e
2631 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2632 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2633 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2634 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2635 # the closest integer to sqrt(c) with the even integer chosen
2636 # in the case of a tie.
2637 #
2638 # To ensure correct rounding in all cases, we use the
2639 # following trick: we compute the square root to an extra
2640 # place (precision p+1 instead of precision p), rounding down.
2641 # Then, if the result is inexact and its last digit is 0 or 5,
2642 # we increase the last digit to 1 or 6 respectively; if it's
2643 # exact we leave the last digit alone. Now the final round to
2644 # p places (or fewer in the case of underflow) will round
2645 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002646
Facundo Batista353750c2007-09-13 18:13:15 +00002647 # use an extra digit of precision
2648 prec = context.prec+1
2649
2650 # write argument in the form c*100**e where e = self._exp//2
2651 # is the 'ideal' exponent, to be used if the square root is
2652 # exactly representable. l is the number of 'digits' of c in
2653 # base 100, so that 100**(l-1) <= c < 100**l.
2654 op = _WorkRep(self)
2655 e = op.exp >> 1
2656 if op.exp & 1:
2657 c = op.int * 10
2658 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002659 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002660 c = op.int
2661 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002662
Facundo Batista353750c2007-09-13 18:13:15 +00002663 # rescale so that c has exactly prec base 100 'digits'
2664 shift = prec-l
2665 if shift >= 0:
2666 c *= 100**shift
2667 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002668 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002669 c, remainder = divmod(c, 100**-shift)
2670 exact = not remainder
2671 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002672
Facundo Batista353750c2007-09-13 18:13:15 +00002673 # find n = floor(sqrt(c)) using Newton's method
2674 n = 10**prec
2675 while True:
2676 q = c//n
2677 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002678 break
Facundo Batista353750c2007-09-13 18:13:15 +00002679 else:
2680 n = n + q >> 1
2681 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002682
Facundo Batista353750c2007-09-13 18:13:15 +00002683 if exact:
2684 # result is exact; rescale to use ideal exponent e
2685 if shift >= 0:
2686 # assert n % 10**shift == 0
2687 n //= 10**shift
2688 else:
2689 n *= 10**-shift
2690 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002691 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002692 # result is not exact; fix last digit as described above
2693 if n % 5 == 0:
2694 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002695
Facundo Batista72bc54f2007-11-23 17:59:00 +00002696 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002697
Facundo Batista353750c2007-09-13 18:13:15 +00002698 # round, and fit to current context
2699 context = context._shallow_copy()
2700 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002701 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002702 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002703
Facundo Batista353750c2007-09-13 18:13:15 +00002704 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002705
2706 def max(self, other, context=None):
2707 """Returns the larger value.
2708
Facundo Batista353750c2007-09-13 18:13:15 +00002709 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002710 NaN (and signals if one is sNaN). Also rounds.
2711 """
Facundo Batista353750c2007-09-13 18:13:15 +00002712 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002713
Facundo Batista6c398da2007-09-17 17:30:13 +00002714 if context is None:
2715 context = getcontext()
2716
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002717 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002718 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002719 # number is always returned
2720 sn = self._isnan()
2721 on = other._isnan()
2722 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002723 if on == 1 and sn == 0:
2724 return self._fix(context)
2725 if sn == 1 and on == 0:
2726 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002727 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002728
Mark Dickinson2fc92632008-02-06 22:10:50 +00002729 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002730 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002731 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002732 # then an ordering is applied:
2733 #
Facundo Batista59c58842007-04-10 12:58:45 +00002734 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002735 # positive sign and min returns the operand with the negative sign
2736 #
Facundo Batista59c58842007-04-10 12:58:45 +00002737 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002738 # the result. This is exactly the ordering used in compare_total.
2739 c = self.compare_total(other)
2740
2741 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002742 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002743 else:
2744 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002745
Facundo Batistae64acfa2007-12-17 14:18:42 +00002746 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002747
2748 def min(self, other, context=None):
2749 """Returns the smaller value.
2750
Facundo Batista59c58842007-04-10 12:58:45 +00002751 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002752 NaN (and signals if one is sNaN). Also rounds.
2753 """
Facundo Batista353750c2007-09-13 18:13:15 +00002754 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002755
Facundo Batista6c398da2007-09-17 17:30:13 +00002756 if context is None:
2757 context = getcontext()
2758
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002759 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002760 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002761 # number is always returned
2762 sn = self._isnan()
2763 on = other._isnan()
2764 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002765 if on == 1 and sn == 0:
2766 return self._fix(context)
2767 if sn == 1 and on == 0:
2768 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002769 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002770
Mark Dickinson2fc92632008-02-06 22:10:50 +00002771 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002772 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002773 c = self.compare_total(other)
2774
2775 if c == -1:
2776 ans = self
2777 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002778 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002779
Facundo Batistae64acfa2007-12-17 14:18:42 +00002780 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002781
2782 def _isinteger(self):
2783 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002784 if self._is_special:
2785 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002786 if self._exp >= 0:
2787 return True
2788 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002789 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002790
2791 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002792 """Returns True if self is even. Assumes self is an integer."""
2793 if not self or self._exp > 0:
2794 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002795 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002796
2797 def adjusted(self):
2798 """Return the adjusted exponent of self"""
2799 try:
2800 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002801 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002802 except TypeError:
2803 return 0
2804
Facundo Batista353750c2007-09-13 18:13:15 +00002805 def canonical(self, context=None):
2806 """Returns the same Decimal object.
2807
2808 As we do not have different encodings for the same number, the
2809 received object already is in its canonical form.
2810 """
2811 return self
2812
2813 def compare_signal(self, other, context=None):
2814 """Compares self to the other operand numerically.
2815
2816 It's pretty much like compare(), but all NaNs signal, with signaling
2817 NaNs taking precedence over quiet NaNs.
2818 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002819 other = _convert_other(other, raiseit = True)
2820 ans = self._compare_check_nans(other, context)
2821 if ans:
2822 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002823 return self.compare(other, context=context)
2824
2825 def compare_total(self, other):
2826 """Compares self to other using the abstract representations.
2827
2828 This is not like the standard compare, which use their numerical
2829 value. Note that a total ordering is defined for all possible abstract
2830 representations.
2831 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002832 other = _convert_other(other, raiseit=True)
2833
Facundo Batista353750c2007-09-13 18:13:15 +00002834 # if one is negative and the other is positive, it's easy
2835 if self._sign and not other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002836 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002837 if not self._sign and other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002838 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002839 sign = self._sign
2840
2841 # let's handle both NaN types
2842 self_nan = self._isnan()
2843 other_nan = other._isnan()
2844 if self_nan or other_nan:
2845 if self_nan == other_nan:
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002846 # compare payloads as though they're integers
2847 self_key = len(self._int), self._int
2848 other_key = len(other._int), other._int
2849 if self_key < other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002850 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002851 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002852 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002853 return _NegativeOne
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002854 if self_key > other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002855 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002856 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002857 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002858 return _One
2859 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002860
2861 if sign:
2862 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002863 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002864 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002865 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002866 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002867 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002868 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002869 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002870 else:
2871 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002872 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002873 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002874 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002875 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002876 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002877 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002878 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002879
2880 if self < other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002881 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002882 if self > other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002883 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002884
2885 if self._exp < other._exp:
2886 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002887 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002888 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002889 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002890 if self._exp > other._exp:
2891 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002892 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002893 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002894 return _One
2895 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002896
2897
2898 def compare_total_mag(self, other):
2899 """Compares self to other using abstract repr., ignoring sign.
2900
2901 Like compare_total, but with operand's sign ignored and assumed to be 0.
2902 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002903 other = _convert_other(other, raiseit=True)
2904
Facundo Batista353750c2007-09-13 18:13:15 +00002905 s = self.copy_abs()
2906 o = other.copy_abs()
2907 return s.compare_total(o)
2908
2909 def copy_abs(self):
2910 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002911 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002912
2913 def copy_negate(self):
2914 """Returns a copy with the sign inverted."""
2915 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002916 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002917 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002918 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002919
2920 def copy_sign(self, other):
2921 """Returns self with the sign of other."""
Mark Dickinson6d8effb2010-02-18 14:27:02 +00002922 other = _convert_other(other, raiseit=True)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002923 return _dec_from_triple(other._sign, self._int,
2924 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002925
2926 def exp(self, context=None):
2927 """Returns e ** self."""
2928
2929 if context is None:
2930 context = getcontext()
2931
2932 # exp(NaN) = NaN
2933 ans = self._check_nans(context=context)
2934 if ans:
2935 return ans
2936
2937 # exp(-Infinity) = 0
2938 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002939 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002940
2941 # exp(0) = 1
2942 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002943 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002944
2945 # exp(Infinity) = Infinity
2946 if self._isinfinity() == 1:
2947 return Decimal(self)
2948
2949 # the result is now guaranteed to be inexact (the true
2950 # mathematical result is transcendental). There's no need to
2951 # raise Rounded and Inexact here---they'll always be raised as
2952 # a result of the call to _fix.
2953 p = context.prec
2954 adj = self.adjusted()
2955
2956 # we only need to do any computation for quite a small range
2957 # of adjusted exponents---for example, -29 <= adj <= 10 for
2958 # the default context. For smaller exponent the result is
2959 # indistinguishable from 1 at the given precision, while for
2960 # larger exponent the result either overflows or underflows.
2961 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2962 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002963 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002964 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2965 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002966 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002967 elif self._sign == 0 and adj < -p:
2968 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002969 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002970 elif self._sign == 1 and adj < -p-1:
2971 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002972 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002973 # general case
2974 else:
2975 op = _WorkRep(self)
2976 c, e = op.int, op.exp
2977 if op.sign == 1:
2978 c = -c
2979
2980 # compute correctly rounded result: increase precision by
2981 # 3 digits at a time until we get an unambiguously
2982 # roundable result
2983 extra = 3
2984 while True:
2985 coeff, exp = _dexp(c, e, p+extra)
2986 if coeff % (5*10**(len(str(coeff))-p-1)):
2987 break
2988 extra += 3
2989
Facundo Batista72bc54f2007-11-23 17:59:00 +00002990 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002991
2992 # at this stage, ans should round correctly with *any*
2993 # rounding mode, not just with ROUND_HALF_EVEN
2994 context = context._shallow_copy()
2995 rounding = context._set_rounding(ROUND_HALF_EVEN)
2996 ans = ans._fix(context)
2997 context.rounding = rounding
2998
2999 return ans
3000
3001 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003002 """Return True if self is canonical; otherwise return False.
3003
3004 Currently, the encoding of a Decimal instance is always
3005 canonical, so this method returns True for any Decimal.
3006 """
3007 return True
Facundo Batista353750c2007-09-13 18:13:15 +00003008
3009 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003010 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00003011
Facundo Batista1a191df2007-10-02 17:01:24 +00003012 A Decimal instance is considered finite if it is neither
3013 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00003014 """
Facundo Batista1a191df2007-10-02 17:01:24 +00003015 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00003016
3017 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003018 """Return True if self is infinite; otherwise return False."""
3019 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00003020
3021 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003022 """Return True if self is a qNaN or sNaN; otherwise return False."""
3023 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00003024
3025 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00003026 """Return True if self is a normal number; otherwise return False."""
3027 if self._is_special or not self:
3028 return False
Facundo Batista353750c2007-09-13 18:13:15 +00003029 if context is None:
3030 context = getcontext()
Mark Dickinsona7a52ab2009-10-20 13:33:03 +00003031 return context.Emin <= self.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +00003032
3033 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003034 """Return True if self is a quiet NaN; otherwise return False."""
3035 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00003036
3037 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003038 """Return True if self is negative; otherwise return False."""
3039 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00003040
3041 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003042 """Return True if self is a signaling NaN; otherwise return False."""
3043 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00003044
3045 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00003046 """Return True if self is subnormal; otherwise return False."""
3047 if self._is_special or not self:
3048 return False
Facundo Batista353750c2007-09-13 18:13:15 +00003049 if context is None:
3050 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00003051 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00003052
3053 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003054 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00003055 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00003056
3057 def _ln_exp_bound(self):
3058 """Compute a lower bound for the adjusted exponent of self.ln().
3059 In other words, compute r such that self.ln() >= 10**r. Assumes
3060 that self is finite and positive and that self != 1.
3061 """
3062
3063 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3064 adj = self._exp + len(self._int) - 1
3065 if adj >= 1:
3066 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3067 return len(str(adj*23//10)) - 1
3068 if adj <= -2:
3069 # argument <= 0.1
3070 return len(str((-1-adj)*23//10)) - 1
3071 op = _WorkRep(self)
3072 c, e = op.int, op.exp
3073 if adj == 0:
3074 # 1 < self < 10
3075 num = str(c-10**-e)
3076 den = str(c)
3077 return len(num) - len(den) - (num < den)
3078 # adj == -1, 0.1 <= self < 1
3079 return e + len(str(10**-e - c)) - 1
3080
3081
3082 def ln(self, context=None):
3083 """Returns the natural (base e) logarithm of self."""
3084
3085 if context is None:
3086 context = getcontext()
3087
3088 # ln(NaN) = NaN
3089 ans = self._check_nans(context=context)
3090 if ans:
3091 return ans
3092
3093 # ln(0.0) == -Infinity
3094 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003095 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003096
3097 # ln(Infinity) = Infinity
3098 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003099 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003100
3101 # ln(1.0) == 0.0
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003102 if self == _One:
3103 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00003104
3105 # ln(negative) raises InvalidOperation
3106 if self._sign == 1:
3107 return context._raise_error(InvalidOperation,
3108 'ln of a negative value')
3109
3110 # result is irrational, so necessarily inexact
3111 op = _WorkRep(self)
3112 c, e = op.int, op.exp
3113 p = context.prec
3114
3115 # correctly rounded result: repeatedly increase precision by 3
3116 # until we get an unambiguously roundable result
3117 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3118 while True:
3119 coeff = _dlog(c, e, places)
3120 # assert len(str(abs(coeff)))-p >= 1
3121 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3122 break
3123 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003124 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003125
3126 context = context._shallow_copy()
3127 rounding = context._set_rounding(ROUND_HALF_EVEN)
3128 ans = ans._fix(context)
3129 context.rounding = rounding
3130 return ans
3131
3132 def _log10_exp_bound(self):
3133 """Compute a lower bound for the adjusted exponent of self.log10().
3134 In other words, find r such that self.log10() >= 10**r.
3135 Assumes that self is finite and positive and that self != 1.
3136 """
3137
3138 # For x >= 10 or x < 0.1 we only need a bound on the integer
3139 # part of log10(self), and this comes directly from the
3140 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3141 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3142 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3143
3144 adj = self._exp + len(self._int) - 1
3145 if adj >= 1:
3146 # self >= 10
3147 return len(str(adj))-1
3148 if adj <= -2:
3149 # self < 0.1
3150 return len(str(-1-adj))-1
3151 op = _WorkRep(self)
3152 c, e = op.int, op.exp
3153 if adj == 0:
3154 # 1 < self < 10
3155 num = str(c-10**-e)
3156 den = str(231*c)
3157 return len(num) - len(den) - (num < den) + 2
3158 # adj == -1, 0.1 <= self < 1
3159 num = str(10**-e-c)
3160 return len(num) + e - (num < "231") - 1
3161
3162 def log10(self, context=None):
3163 """Returns the base 10 logarithm of self."""
3164
3165 if context is None:
3166 context = getcontext()
3167
3168 # log10(NaN) = NaN
3169 ans = self._check_nans(context=context)
3170 if ans:
3171 return ans
3172
3173 # log10(0.0) == -Infinity
3174 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003175 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003176
3177 # log10(Infinity) = Infinity
3178 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003179 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003180
3181 # log10(negative or -Infinity) raises InvalidOperation
3182 if self._sign == 1:
3183 return context._raise_error(InvalidOperation,
3184 'log10 of a negative value')
3185
3186 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003187 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003188 # answer may need rounding
3189 ans = Decimal(self._exp + len(self._int) - 1)
3190 else:
3191 # result is irrational, so necessarily inexact
3192 op = _WorkRep(self)
3193 c, e = op.int, op.exp
3194 p = context.prec
3195
3196 # correctly rounded result: repeatedly increase precision
3197 # until result is unambiguously roundable
3198 places = p-self._log10_exp_bound()+2
3199 while True:
3200 coeff = _dlog10(c, e, places)
3201 # assert len(str(abs(coeff)))-p >= 1
3202 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3203 break
3204 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003205 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003206
3207 context = context._shallow_copy()
3208 rounding = context._set_rounding(ROUND_HALF_EVEN)
3209 ans = ans._fix(context)
3210 context.rounding = rounding
3211 return ans
3212
3213 def logb(self, context=None):
3214 """ Returns the exponent of the magnitude of self's MSD.
3215
3216 The result is the integer which is the exponent of the magnitude
3217 of the most significant digit of self (as though it were truncated
3218 to a single digit while maintaining the value of that digit and
3219 without limiting the resulting exponent).
3220 """
3221 # logb(NaN) = NaN
3222 ans = self._check_nans(context=context)
3223 if ans:
3224 return ans
3225
3226 if context is None:
3227 context = getcontext()
3228
3229 # logb(+/-Inf) = +Inf
3230 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003231 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003232
3233 # logb(0) = -Inf, DivisionByZero
3234 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003235 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003236
3237 # otherwise, simply return the adjusted exponent of self, as a
3238 # Decimal. Note that no attempt is made to fit the result
3239 # into the current context.
Mark Dickinson15ae41c2009-10-07 19:22:05 +00003240 ans = Decimal(self.adjusted())
3241 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003242
3243 def _islogical(self):
3244 """Return True if self is a logical operand.
3245
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003246 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003247 an exponent of 0, and a coefficient whose digits must all be
3248 either 0 or 1.
3249 """
3250 if self._sign != 0 or self._exp != 0:
3251 return False
3252 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003253 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003254 return False
3255 return True
3256
3257 def _fill_logical(self, context, opa, opb):
3258 dif = context.prec - len(opa)
3259 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003260 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003261 elif dif < 0:
3262 opa = opa[-context.prec:]
3263 dif = context.prec - len(opb)
3264 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003265 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003266 elif dif < 0:
3267 opb = opb[-context.prec:]
3268 return opa, opb
3269
3270 def logical_and(self, other, context=None):
3271 """Applies an 'and' operation between self and other's digits."""
3272 if context is None:
3273 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003274
3275 other = _convert_other(other, raiseit=True)
3276
Facundo Batista353750c2007-09-13 18:13:15 +00003277 if not self._islogical() or not other._islogical():
3278 return context._raise_error(InvalidOperation)
3279
3280 # fill to context.prec
3281 (opa, opb) = self._fill_logical(context, self._int, other._int)
3282
3283 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003284 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3285 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003286
3287 def logical_invert(self, context=None):
3288 """Invert all its digits."""
3289 if context is None:
3290 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003291 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3292 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003293
3294 def logical_or(self, other, context=None):
3295 """Applies an 'or' operation between self and other's digits."""
3296 if context is None:
3297 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003298
3299 other = _convert_other(other, raiseit=True)
3300
Facundo Batista353750c2007-09-13 18:13:15 +00003301 if not self._islogical() or not other._islogical():
3302 return context._raise_error(InvalidOperation)
3303
3304 # fill to context.prec
3305 (opa, opb) = self._fill_logical(context, self._int, other._int)
3306
3307 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003308 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003309 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003310
3311 def logical_xor(self, other, context=None):
3312 """Applies an 'xor' operation between self and other's digits."""
3313 if context is None:
3314 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003315
3316 other = _convert_other(other, raiseit=True)
3317
Facundo Batista353750c2007-09-13 18:13:15 +00003318 if not self._islogical() or not other._islogical():
3319 return context._raise_error(InvalidOperation)
3320
3321 # fill to context.prec
3322 (opa, opb) = self._fill_logical(context, self._int, other._int)
3323
3324 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003325 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003326 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003327
3328 def max_mag(self, other, context=None):
3329 """Compares the values numerically with their sign ignored."""
3330 other = _convert_other(other, raiseit=True)
3331
Facundo Batista6c398da2007-09-17 17:30:13 +00003332 if context is None:
3333 context = getcontext()
3334
Facundo Batista353750c2007-09-13 18:13:15 +00003335 if self._is_special or other._is_special:
3336 # If one operand is a quiet NaN and the other is number, then the
3337 # number is always returned
3338 sn = self._isnan()
3339 on = other._isnan()
3340 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003341 if on == 1 and sn == 0:
3342 return self._fix(context)
3343 if sn == 1 and on == 0:
3344 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003345 return self._check_nans(other, context)
3346
Mark Dickinson2fc92632008-02-06 22:10:50 +00003347 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003348 if c == 0:
3349 c = self.compare_total(other)
3350
3351 if c == -1:
3352 ans = other
3353 else:
3354 ans = self
3355
Facundo Batistae64acfa2007-12-17 14:18:42 +00003356 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003357
3358 def min_mag(self, other, context=None):
3359 """Compares the values numerically with their sign ignored."""
3360 other = _convert_other(other, raiseit=True)
3361
Facundo Batista6c398da2007-09-17 17:30:13 +00003362 if context is None:
3363 context = getcontext()
3364
Facundo Batista353750c2007-09-13 18:13:15 +00003365 if self._is_special or other._is_special:
3366 # If one operand is a quiet NaN and the other is number, then the
3367 # number is always returned
3368 sn = self._isnan()
3369 on = other._isnan()
3370 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003371 if on == 1 and sn == 0:
3372 return self._fix(context)
3373 if sn == 1 and on == 0:
3374 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003375 return self._check_nans(other, context)
3376
Mark Dickinson2fc92632008-02-06 22:10:50 +00003377 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003378 if c == 0:
3379 c = self.compare_total(other)
3380
3381 if c == -1:
3382 ans = self
3383 else:
3384 ans = other
3385
Facundo Batistae64acfa2007-12-17 14:18:42 +00003386 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003387
3388 def next_minus(self, context=None):
3389 """Returns the largest representable number smaller than itself."""
3390 if context is None:
3391 context = getcontext()
3392
3393 ans = self._check_nans(context=context)
3394 if ans:
3395 return ans
3396
3397 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003398 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003399 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003400 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003401
3402 context = context.copy()
3403 context._set_rounding(ROUND_FLOOR)
3404 context._ignore_all_flags()
3405 new_self = self._fix(context)
3406 if new_self != self:
3407 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003408 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3409 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003410
3411 def next_plus(self, context=None):
3412 """Returns the smallest representable number larger than itself."""
3413 if context is None:
3414 context = getcontext()
3415
3416 ans = self._check_nans(context=context)
3417 if ans:
3418 return ans
3419
3420 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003421 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003422 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003423 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003424
3425 context = context.copy()
3426 context._set_rounding(ROUND_CEILING)
3427 context._ignore_all_flags()
3428 new_self = self._fix(context)
3429 if new_self != self:
3430 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003431 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3432 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003433
3434 def next_toward(self, other, context=None):
3435 """Returns the number closest to self, in the direction towards other.
3436
3437 The result is the closest representable number to self
3438 (excluding self) that is in the direction towards other,
3439 unless both have the same value. If the two operands are
3440 numerically equal, then the result is a copy of self with the
3441 sign set to be the same as the sign of other.
3442 """
3443 other = _convert_other(other, raiseit=True)
3444
3445 if context is None:
3446 context = getcontext()
3447
3448 ans = self._check_nans(other, context)
3449 if ans:
3450 return ans
3451
Mark Dickinson2fc92632008-02-06 22:10:50 +00003452 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003453 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003454 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003455
3456 if comparison == -1:
3457 ans = self.next_plus(context)
3458 else: # comparison == 1
3459 ans = self.next_minus(context)
3460
3461 # decide which flags to raise using value of ans
3462 if ans._isinfinity():
3463 context._raise_error(Overflow,
3464 'Infinite result from next_toward',
3465 ans._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00003466 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00003467 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003468 elif ans.adjusted() < context.Emin:
3469 context._raise_error(Underflow)
3470 context._raise_error(Subnormal)
Facundo Batista353750c2007-09-13 18:13:15 +00003471 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00003472 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003473 # if precision == 1 then we don't raise Clamped for a
3474 # result 0E-Etiny.
3475 if not ans:
3476 context._raise_error(Clamped)
3477
3478 return ans
3479
3480 def number_class(self, context=None):
3481 """Returns an indication of the class of self.
3482
3483 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003484 sNaN
3485 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003486 -Infinity
3487 -Normal
3488 -Subnormal
3489 -Zero
3490 +Zero
3491 +Subnormal
3492 +Normal
3493 +Infinity
3494 """
3495 if self.is_snan():
3496 return "sNaN"
3497 if self.is_qnan():
3498 return "NaN"
3499 inf = self._isinfinity()
3500 if inf == 1:
3501 return "+Infinity"
3502 if inf == -1:
3503 return "-Infinity"
3504 if self.is_zero():
3505 if self._sign:
3506 return "-Zero"
3507 else:
3508 return "+Zero"
3509 if context is None:
3510 context = getcontext()
3511 if self.is_subnormal(context=context):
3512 if self._sign:
3513 return "-Subnormal"
3514 else:
3515 return "+Subnormal"
3516 # just a normal, regular, boring number, :)
3517 if self._sign:
3518 return "-Normal"
3519 else:
3520 return "+Normal"
3521
3522 def radix(self):
3523 """Just returns 10, as this is Decimal, :)"""
3524 return Decimal(10)
3525
3526 def rotate(self, other, context=None):
3527 """Returns a rotated copy of self, value-of-other times."""
3528 if context is None:
3529 context = getcontext()
3530
Mark Dickinson0c673122009-10-29 12:04:00 +00003531 other = _convert_other(other, raiseit=True)
3532
Facundo Batista353750c2007-09-13 18:13:15 +00003533 ans = self._check_nans(other, context)
3534 if ans:
3535 return ans
3536
3537 if other._exp != 0:
3538 return context._raise_error(InvalidOperation)
3539 if not (-context.prec <= int(other) <= context.prec):
3540 return context._raise_error(InvalidOperation)
3541
3542 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003543 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003544
3545 # get values, pad if necessary
3546 torot = int(other)
3547 rotdig = self._int
3548 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003549 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003550 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003551 elif topad < 0:
3552 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003553
3554 # let's rotate!
3555 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003556 return _dec_from_triple(self._sign,
3557 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003558
Mark Dickinson0c673122009-10-29 12:04:00 +00003559 def scaleb(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00003560 """Returns self operand after adding the second value to its exp."""
3561 if context is None:
3562 context = getcontext()
3563
Mark Dickinson0c673122009-10-29 12:04:00 +00003564 other = _convert_other(other, raiseit=True)
3565
Facundo Batista353750c2007-09-13 18:13:15 +00003566 ans = self._check_nans(other, context)
3567 if ans:
3568 return ans
3569
3570 if other._exp != 0:
3571 return context._raise_error(InvalidOperation)
3572 liminf = -2 * (context.Emax + context.prec)
3573 limsup = 2 * (context.Emax + context.prec)
3574 if not (liminf <= int(other) <= limsup):
3575 return context._raise_error(InvalidOperation)
3576
3577 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003578 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003579
Facundo Batista72bc54f2007-11-23 17:59:00 +00003580 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003581 d = d._fix(context)
3582 return d
3583
3584 def shift(self, other, context=None):
3585 """Returns a shifted copy of self, value-of-other times."""
3586 if context is None:
3587 context = getcontext()
3588
Mark Dickinson0c673122009-10-29 12:04:00 +00003589 other = _convert_other(other, raiseit=True)
3590
Facundo Batista353750c2007-09-13 18:13:15 +00003591 ans = self._check_nans(other, context)
3592 if ans:
3593 return ans
3594
3595 if other._exp != 0:
3596 return context._raise_error(InvalidOperation)
3597 if not (-context.prec <= int(other) <= context.prec):
3598 return context._raise_error(InvalidOperation)
3599
3600 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003601 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003602
3603 # get values, pad if necessary
3604 torot = int(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003605 rotdig = self._int
3606 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003607 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003608 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003609 elif topad < 0:
3610 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003611
3612 # let's shift!
3613 if torot < 0:
Mark Dickinson6f390012009-10-29 12:11:18 +00003614 shifted = rotdig[:torot]
Facundo Batista353750c2007-09-13 18:13:15 +00003615 else:
Mark Dickinson6f390012009-10-29 12:11:18 +00003616 shifted = rotdig + '0'*torot
3617 shifted = shifted[-context.prec:]
Facundo Batista353750c2007-09-13 18:13:15 +00003618
Facundo Batista72bc54f2007-11-23 17:59:00 +00003619 return _dec_from_triple(self._sign,
Mark Dickinson6f390012009-10-29 12:11:18 +00003620 shifted.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003621
Facundo Batista59c58842007-04-10 12:58:45 +00003622 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003623 def __reduce__(self):
3624 return (self.__class__, (str(self),))
3625
3626 def __copy__(self):
Benjamin Peterson28e369a2010-01-25 03:58:21 +00003627 if type(self) is Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003628 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003629 return self.__class__(str(self))
3630
3631 def __deepcopy__(self, memo):
Benjamin Peterson28e369a2010-01-25 03:58:21 +00003632 if type(self) is Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003633 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003634 return self.__class__(str(self))
3635
Mark Dickinson277859d2009-03-17 23:03:46 +00003636 # PEP 3101 support. the _localeconv keyword argument should be
3637 # considered private: it's provided for ease of testing only.
3638 def __format__(self, specifier, context=None, _localeconv=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003639 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003640
3641 The specifier should be a standard format specifier, with the
3642 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson277859d2009-03-17 23:03:46 +00003643 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3644 type is omitted it defaults to 'g' or 'G', depending on the
3645 value of context.capitals.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003646 """
3647
3648 # Note: PEP 3101 says that if the type is not present then
3649 # there should be at least one digit after the decimal point.
3650 # We take the liberty of ignoring this requirement for
3651 # Decimal---it's presumably there to make sure that
3652 # format(float, '') behaves similarly to str(float).
3653 if context is None:
3654 context = getcontext()
3655
Mark Dickinson277859d2009-03-17 23:03:46 +00003656 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003657
Mark Dickinson277859d2009-03-17 23:03:46 +00003658 # special values don't care about the type or precision
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003659 if self._is_special:
Mark Dickinson277859d2009-03-17 23:03:46 +00003660 sign = _format_sign(self._sign, spec)
3661 body = str(self.copy_abs())
3662 return _format_align(sign, body, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003663
3664 # a type of None defaults to 'g' or 'G', depending on context
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003665 if spec['type'] is None:
3666 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson277859d2009-03-17 23:03:46 +00003667
3668 # if type is '%', adjust exponent of self accordingly
3669 if spec['type'] == '%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003670 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3671
3672 # round if necessary, taking rounding mode from the context
3673 rounding = context.rounding
3674 precision = spec['precision']
3675 if precision is not None:
3676 if spec['type'] in 'eE':
3677 self = self._round(precision+1, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003678 elif spec['type'] in 'fF%':
3679 self = self._rescale(-precision, rounding)
Mark Dickinson277859d2009-03-17 23:03:46 +00003680 elif spec['type'] in 'gG' and len(self._int) > precision:
3681 self = self._round(precision, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003682 # special case: zeros with a positive exponent can't be
3683 # represented in fixed point; rescale them to 0e0.
Mark Dickinson277859d2009-03-17 23:03:46 +00003684 if not self and self._exp > 0 and spec['type'] in 'fF%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003685 self = self._rescale(0, rounding)
3686
3687 # figure out placement of the decimal point
3688 leftdigits = self._exp + len(self._int)
Mark Dickinson277859d2009-03-17 23:03:46 +00003689 if spec['type'] in 'eE':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003690 if not self and precision is not None:
3691 dotplace = 1 - precision
3692 else:
3693 dotplace = 1
Mark Dickinson277859d2009-03-17 23:03:46 +00003694 elif spec['type'] in 'fF%':
3695 dotplace = leftdigits
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003696 elif spec['type'] in 'gG':
3697 if self._exp <= 0 and leftdigits > -6:
3698 dotplace = leftdigits
3699 else:
3700 dotplace = 1
3701
Mark Dickinson277859d2009-03-17 23:03:46 +00003702 # find digits before and after decimal point, and get exponent
3703 if dotplace < 0:
3704 intpart = '0'
3705 fracpart = '0'*(-dotplace) + self._int
3706 elif dotplace > len(self._int):
3707 intpart = self._int + '0'*(dotplace-len(self._int))
3708 fracpart = ''
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003709 else:
Mark Dickinson277859d2009-03-17 23:03:46 +00003710 intpart = self._int[:dotplace] or '0'
3711 fracpart = self._int[dotplace:]
3712 exp = leftdigits-dotplace
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003713
Mark Dickinson277859d2009-03-17 23:03:46 +00003714 # done with the decimal-specific stuff; hand over the rest
3715 # of the formatting to the _format_number function
3716 return _format_number(self._sign, intpart, fracpart, exp, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003717
Facundo Batista72bc54f2007-11-23 17:59:00 +00003718def _dec_from_triple(sign, coefficient, exponent, special=False):
3719 """Create a decimal instance directly, without any validation,
3720 normalization (e.g. removal of leading zeros) or argument
3721 conversion.
3722
3723 This function is for *internal use only*.
3724 """
3725
3726 self = object.__new__(Decimal)
3727 self._sign = sign
3728 self._int = coefficient
3729 self._exp = exponent
3730 self._is_special = special
3731
3732 return self
3733
Raymond Hettinger2c8585b2009-02-03 03:37:03 +00003734# Register Decimal as a kind of Number (an abstract base class).
3735# However, do not register it as Real (because Decimals are not
3736# interoperable with floats).
3737_numbers.Number.register(Decimal)
3738
3739
Facundo Batista59c58842007-04-10 12:58:45 +00003740##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003741
Nick Coghlanced12182006-09-02 03:54:17 +00003742class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003743 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003744
Nick Coghlanced12182006-09-02 03:54:17 +00003745 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003746 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003747 """
3748 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003749 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003750 def __enter__(self):
3751 self.saved_context = getcontext()
3752 setcontext(self.new_context)
3753 return self.new_context
3754 def __exit__(self, t, v, tb):
3755 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003756
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003757class Context(object):
3758 """Contains the context for a Decimal instance.
3759
3760 Contains:
3761 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003762 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003763 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003764 raised when it is caused. Otherwise, a value is
3765 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003766 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003767 (Whether or not the trap_enabler is set)
3768 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003769 Emin - Minimum exponent
3770 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003771 capitals - If 1, 1*10^1 is printed as 1E+1.
3772 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003773 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003774 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003775
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003776 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003777 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003778 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003779 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003780 _ignored_flags=None):
Mark Dickinson9b9e1252010-07-08 21:22:54 +00003781 # Set defaults; for everything except flags and _ignored_flags,
3782 # inherit from DefaultContext.
3783 try:
3784 dc = DefaultContext
3785 except NameError:
3786 pass
3787
3788 self.prec = prec if prec is not None else dc.prec
3789 self.rounding = rounding if rounding is not None else dc.rounding
3790 self.Emin = Emin if Emin is not None else dc.Emin
3791 self.Emax = Emax if Emax is not None else dc.Emax
3792 self.capitals = capitals if capitals is not None else dc.capitals
3793 self._clamp = _clamp if _clamp is not None else dc._clamp
3794
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003795 if _ignored_flags is None:
Mark Dickinson9b9e1252010-07-08 21:22:54 +00003796 self._ignored_flags = []
3797 else:
3798 self._ignored_flags = _ignored_flags
3799
3800 if traps is None:
3801 self.traps = dc.traps.copy()
3802 elif not isinstance(traps, dict):
3803 self.traps = dict((s, int(s in traps)) for s in _signals)
3804 else:
3805 self.traps = traps
3806
3807 if flags is None:
3808 self.flags = dict.fromkeys(_signals, 0)
3809 elif not isinstance(flags, dict):
3810 self.flags = dict((s, int(s in flags)) for s in _signals)
3811 else:
3812 self.flags = flags
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003813
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003814 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003815 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003816 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003817 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3818 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3819 % vars(self))
3820 names = [f.__name__ for f, v in self.flags.items() if v]
3821 s.append('flags=[' + ', '.join(names) + ']')
3822 names = [t.__name__ for t, v in self.traps.items() if v]
3823 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003824 return ', '.join(s) + ')'
3825
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003826 def clear_flags(self):
3827 """Reset all flags to zero"""
3828 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003829 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003830
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003831 def _shallow_copy(self):
3832 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003833 nc = Context(self.prec, self.rounding, self.traps,
3834 self.flags, self.Emin, self.Emax,
3835 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003836 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003837
3838 def copy(self):
3839 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003840 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003841 self.flags.copy(), self.Emin, self.Emax,
3842 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003843 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003844 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003845
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003846 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003847 """Handles an error
3848
3849 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003850 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah8a6f3fe2010-05-19 15:46:39 +00003851 trap_enabler is set, it reraises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003852 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003853 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003854 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003855 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003856 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003857 return error().handle(self, *args)
3858
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003859 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003860 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003861 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003862 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003863
3864 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003865 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003866 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003867
3868 def _ignore_all_flags(self):
3869 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003870 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003871
3872 def _ignore_flags(self, *flags):
3873 """Ignore the flags, if they are raised"""
3874 # Do not mutate-- This way, copies of a context leave the original
3875 # alone.
3876 self._ignored_flags = (self._ignored_flags + list(flags))
3877 return list(flags)
3878
3879 def _regard_flags(self, *flags):
3880 """Stop ignoring the flags, if they are raised"""
3881 if flags and isinstance(flags[0], (tuple,list)):
3882 flags = flags[0]
3883 for flag in flags:
3884 self._ignored_flags.remove(flag)
3885
Nick Coghlan53663a62008-07-15 14:27:37 +00003886 # We inherit object.__hash__, so we must deny this explicitly
3887 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003888
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003889 def Etiny(self):
3890 """Returns Etiny (= Emin - prec + 1)"""
3891 return int(self.Emin - self.prec + 1)
3892
3893 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003894 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003895 return int(self.Emax - self.prec + 1)
3896
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003897 def _set_rounding(self, type):
3898 """Sets the rounding type.
3899
3900 Sets the rounding type, and returns the current (previous)
3901 rounding type. Often used like:
3902
3903 context = context.copy()
3904 # so you don't change the calling context
3905 # if an error occurs in the middle.
3906 rounding = context._set_rounding(ROUND_UP)
3907 val = self.__sub__(other, context=context)
3908 context._set_rounding(rounding)
3909
3910 This will make it round up for that operation.
3911 """
3912 rounding = self.rounding
3913 self.rounding= type
3914 return rounding
3915
Raymond Hettingerfed52962004-07-14 15:41:57 +00003916 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003917 """Creates a new Decimal instance but using self as context.
3918
3919 This method implements the to-number operation of the
3920 IBM Decimal specification."""
3921
3922 if isinstance(num, basestring) and num != num.strip():
3923 return self._raise_error(ConversionSyntax,
3924 "no trailing or leading whitespace is "
3925 "permitted.")
3926
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003927 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003928 if d._isnan() and len(d._int) > self.prec - self._clamp:
3929 return self._raise_error(ConversionSyntax,
3930 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003931 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003932
Raymond Hettingerf4d85972009-01-03 19:02:23 +00003933 def create_decimal_from_float(self, f):
3934 """Creates a new Decimal instance from a float but rounding using self
3935 as the context.
3936
3937 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3938 >>> context.create_decimal_from_float(3.1415926535897932)
3939 Decimal('3.1415')
3940 >>> context = Context(prec=5, traps=[Inexact])
3941 >>> context.create_decimal_from_float(3.1415926535897932)
3942 Traceback (most recent call last):
3943 ...
3944 Inexact: None
3945
3946 """
3947 d = Decimal.from_float(f) # An exact conversion
3948 return d._fix(self) # Apply the context rounding
3949
Facundo Batista59c58842007-04-10 12:58:45 +00003950 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003951 def abs(self, a):
3952 """Returns the absolute value of the operand.
3953
3954 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003955 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003956 the plus operation on the operand.
3957
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003958 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003959 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003960 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003961 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003962 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003963 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003964 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003965 Decimal('101.5')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003966 >>> ExtendedContext.abs(-1)
3967 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003968 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003969 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003970 return a.__abs__(context=self)
3971
3972 def add(self, a, b):
3973 """Return the sum of the two operands.
3974
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003975 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003976 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003977 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003978 Decimal('1.02E+4')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003979 >>> ExtendedContext.add(1, Decimal(2))
3980 Decimal('3')
3981 >>> ExtendedContext.add(Decimal(8), 5)
3982 Decimal('13')
3983 >>> ExtendedContext.add(5, 5)
3984 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003985 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003986 a = _convert_other(a, raiseit=True)
3987 r = a.__add__(b, context=self)
3988 if r is NotImplemented:
3989 raise TypeError("Unable to convert %s to Decimal" % b)
3990 else:
3991 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003992
3993 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003994 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003995
Facundo Batista353750c2007-09-13 18:13:15 +00003996 def canonical(self, a):
3997 """Returns the same Decimal object.
3998
3999 As we do not have different encodings for the same number, the
4000 received object already is in its canonical form.
4001
4002 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004003 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004004 """
4005 return a.canonical(context=self)
4006
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004007 def compare(self, a, b):
4008 """Compares values numerically.
4009
4010 If the signs of the operands differ, a value representing each operand
4011 ('-1' if the operand is less than zero, '0' if the operand is zero or
4012 negative zero, or '1' if the operand is greater than zero) is used in
4013 place of that operand for the comparison instead of the actual
4014 operand.
4015
4016 The comparison is then effected by subtracting the second operand from
4017 the first and then returning a value according to the result of the
4018 subtraction: '-1' if the result is less than zero, '0' if the result is
4019 zero or negative zero, or '1' if the result is greater than zero.
4020
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004021 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004022 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004023 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004024 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004025 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004026 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004027 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004028 Decimal('1')
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('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004032 Decimal('-1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004033 >>> ExtendedContext.compare(1, 2)
4034 Decimal('-1')
4035 >>> ExtendedContext.compare(Decimal(1), 2)
4036 Decimal('-1')
4037 >>> ExtendedContext.compare(1, Decimal(2))
4038 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004039 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004040 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004041 return a.compare(b, context=self)
4042
Facundo Batista353750c2007-09-13 18:13:15 +00004043 def compare_signal(self, a, b):
4044 """Compares the values of the two operands numerically.
4045
4046 It's pretty much like compare(), but all NaNs signal, with signaling
4047 NaNs taking precedence over quiet NaNs.
4048
4049 >>> c = ExtendedContext
4050 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004051 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004052 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004053 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004054 >>> c.flags[InvalidOperation] = 0
4055 >>> print c.flags[InvalidOperation]
4056 0
4057 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004058 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004059 >>> print c.flags[InvalidOperation]
4060 1
4061 >>> c.flags[InvalidOperation] = 0
4062 >>> print c.flags[InvalidOperation]
4063 0
4064 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004065 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004066 >>> print c.flags[InvalidOperation]
4067 1
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004068 >>> c.compare_signal(-1, 2)
4069 Decimal('-1')
4070 >>> c.compare_signal(Decimal(-1), 2)
4071 Decimal('-1')
4072 >>> c.compare_signal(-1, Decimal(2))
4073 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004074 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004075 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004076 return a.compare_signal(b, context=self)
4077
4078 def compare_total(self, a, b):
4079 """Compares two operands using their abstract representation.
4080
4081 This is not like the standard compare, which use their numerical
4082 value. Note that a total ordering is defined for all possible abstract
4083 representations.
4084
4085 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004086 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004087 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004088 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004089 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004090 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004091 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004092 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004093 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004094 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004095 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004096 Decimal('-1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004097 >>> ExtendedContext.compare_total(1, 2)
4098 Decimal('-1')
4099 >>> ExtendedContext.compare_total(Decimal(1), 2)
4100 Decimal('-1')
4101 >>> ExtendedContext.compare_total(1, Decimal(2))
4102 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004103 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004104 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004105 return a.compare_total(b)
4106
4107 def compare_total_mag(self, a, b):
4108 """Compares two operands using their abstract representation ignoring sign.
4109
4110 Like compare_total, but with operand's sign ignored and assumed to be 0.
4111 """
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_mag(b)
4114
4115 def copy_abs(self, a):
4116 """Returns a copy of the operand with the sign set to 0.
4117
4118 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004119 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00004120 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004121 Decimal('100')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004122 >>> ExtendedContext.copy_abs(-1)
4123 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004124 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004125 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004126 return a.copy_abs()
4127
4128 def copy_decimal(self, a):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004129 """Returns a copy of the decimal object.
Facundo Batista353750c2007-09-13 18:13:15 +00004130
4131 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004132 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00004133 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004134 Decimal('-1.00')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004135 >>> ExtendedContext.copy_decimal(1)
4136 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004137 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004138 a = _convert_other(a, raiseit=True)
Facundo Batista6c398da2007-09-17 17:30:13 +00004139 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00004140
4141 def copy_negate(self, a):
4142 """Returns a copy of the operand with the sign inverted.
4143
4144 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004145 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00004146 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004147 Decimal('101.5')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004148 >>> ExtendedContext.copy_negate(1)
4149 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004150 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004151 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004152 return a.copy_negate()
4153
4154 def copy_sign(self, a, b):
4155 """Copies the second operand's sign to the first one.
4156
4157 In detail, it returns a copy of the first operand with the sign
4158 equal to the sign of the second operand.
4159
4160 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004161 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004162 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004163 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004164 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004165 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004166 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004167 Decimal('-1.50')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004168 >>> ExtendedContext.copy_sign(1, -2)
4169 Decimal('-1')
4170 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4171 Decimal('-1')
4172 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4173 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004174 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004175 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004176 return a.copy_sign(b)
4177
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004178 def divide(self, a, b):
4179 """Decimal division in a specified context.
4180
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004181 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004182 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004183 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004184 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004185 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004186 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004187 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004188 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004189 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004190 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004191 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004192 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004193 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004194 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004195 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004196 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004197 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004198 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004199 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004200 Decimal('1.20E+6')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004201 >>> ExtendedContext.divide(5, 5)
4202 Decimal('1')
4203 >>> ExtendedContext.divide(Decimal(5), 5)
4204 Decimal('1')
4205 >>> ExtendedContext.divide(5, Decimal(5))
4206 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004207 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004208 a = _convert_other(a, raiseit=True)
4209 r = a.__div__(b, context=self)
4210 if r is NotImplemented:
4211 raise TypeError("Unable to convert %s to Decimal" % b)
4212 else:
4213 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004214
4215 def divide_int(self, a, b):
4216 """Divides two numbers and returns the integer part of the result.
4217
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004218 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004219 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004220 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004221 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004222 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004223 Decimal('3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004224 >>> ExtendedContext.divide_int(10, 3)
4225 Decimal('3')
4226 >>> ExtendedContext.divide_int(Decimal(10), 3)
4227 Decimal('3')
4228 >>> ExtendedContext.divide_int(10, Decimal(3))
4229 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004230 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004231 a = _convert_other(a, raiseit=True)
4232 r = a.__floordiv__(b, context=self)
4233 if r is NotImplemented:
4234 raise TypeError("Unable to convert %s to Decimal" % b)
4235 else:
4236 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004237
4238 def divmod(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004239 """Return (a // b, a % b).
Mark Dickinson202eb902010-01-06 16:20:22 +00004240
4241 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4242 (Decimal('2'), Decimal('2'))
4243 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4244 (Decimal('2'), Decimal('0'))
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004245 >>> ExtendedContext.divmod(8, 4)
4246 (Decimal('2'), Decimal('0'))
4247 >>> ExtendedContext.divmod(Decimal(8), 4)
4248 (Decimal('2'), Decimal('0'))
4249 >>> ExtendedContext.divmod(8, Decimal(4))
4250 (Decimal('2'), Decimal('0'))
Mark Dickinson202eb902010-01-06 16:20:22 +00004251 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004252 a = _convert_other(a, raiseit=True)
4253 r = a.__divmod__(b, context=self)
4254 if r is NotImplemented:
4255 raise TypeError("Unable to convert %s to Decimal" % b)
4256 else:
4257 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004258
Facundo Batista353750c2007-09-13 18:13:15 +00004259 def exp(self, a):
4260 """Returns e ** a.
4261
4262 >>> c = ExtendedContext.copy()
4263 >>> c.Emin = -999
4264 >>> c.Emax = 999
4265 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004266 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004267 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004268 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00004269 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004270 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004271 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004272 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00004273 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004274 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004275 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004276 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004277 >>> c.exp(10)
4278 Decimal('22026.4658')
Facundo Batista353750c2007-09-13 18:13:15 +00004279 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004280 a =_convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004281 return a.exp(context=self)
4282
4283 def fma(self, a, b, c):
4284 """Returns a multiplied by b, plus c.
4285
4286 The first two operands are multiplied together, using multiply,
4287 the third operand is then added to the result of that
4288 multiplication, using add, all with only one final rounding.
4289
4290 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004291 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004292 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004293 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004294 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004295 Decimal('1.38435736E+12')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004296 >>> ExtendedContext.fma(1, 3, 4)
4297 Decimal('7')
4298 >>> ExtendedContext.fma(1, Decimal(3), 4)
4299 Decimal('7')
4300 >>> ExtendedContext.fma(1, 3, Decimal(4))
4301 Decimal('7')
Facundo Batista353750c2007-09-13 18:13:15 +00004302 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004303 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004304 return a.fma(b, c, context=self)
4305
4306 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004307 """Return True if the operand is canonical; otherwise return False.
4308
4309 Currently, the encoding of a Decimal instance is always
4310 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004311
4312 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004313 True
Facundo Batista353750c2007-09-13 18:13:15 +00004314 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004315 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004316
4317 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004318 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004319
Facundo Batista1a191df2007-10-02 17:01:24 +00004320 A Decimal instance is considered finite if it is neither
4321 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004322
4323 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004324 True
Facundo Batista353750c2007-09-13 18:13:15 +00004325 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004326 True
Facundo Batista353750c2007-09-13 18:13:15 +00004327 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004328 True
Facundo Batista353750c2007-09-13 18:13:15 +00004329 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004330 False
Facundo Batista353750c2007-09-13 18:13:15 +00004331 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004332 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004333 >>> ExtendedContext.is_finite(1)
4334 True
Facundo Batista353750c2007-09-13 18:13:15 +00004335 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004336 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004337 return a.is_finite()
4338
4339 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004340 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004341
4342 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004343 False
Facundo Batista353750c2007-09-13 18:13:15 +00004344 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004345 True
Facundo Batista353750c2007-09-13 18:13:15 +00004346 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004347 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004348 >>> ExtendedContext.is_infinite(1)
4349 False
Facundo Batista353750c2007-09-13 18:13:15 +00004350 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004351 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004352 return a.is_infinite()
4353
4354 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004355 """Return True if the operand is a qNaN or sNaN;
4356 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004357
4358 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004359 False
Facundo Batista353750c2007-09-13 18:13:15 +00004360 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004361 True
Facundo Batista353750c2007-09-13 18:13:15 +00004362 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004363 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004364 >>> ExtendedContext.is_nan(1)
4365 False
Facundo Batista353750c2007-09-13 18:13:15 +00004366 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004367 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004368 return a.is_nan()
4369
4370 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004371 """Return True if the operand is a normal number;
4372 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004373
4374 >>> c = ExtendedContext.copy()
4375 >>> c.Emin = -999
4376 >>> c.Emax = 999
4377 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004378 True
Facundo Batista353750c2007-09-13 18:13:15 +00004379 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004380 False
Facundo Batista353750c2007-09-13 18:13:15 +00004381 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004382 False
Facundo Batista353750c2007-09-13 18:13:15 +00004383 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004384 False
Facundo Batista353750c2007-09-13 18:13:15 +00004385 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004386 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004387 >>> c.is_normal(1)
4388 True
Facundo Batista353750c2007-09-13 18:13:15 +00004389 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004390 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004391 return a.is_normal(context=self)
4392
4393 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004394 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004395
4396 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004397 False
Facundo Batista353750c2007-09-13 18:13:15 +00004398 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004399 True
Facundo Batista353750c2007-09-13 18:13:15 +00004400 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004401 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004402 >>> ExtendedContext.is_qnan(1)
4403 False
Facundo Batista353750c2007-09-13 18:13:15 +00004404 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004405 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004406 return a.is_qnan()
4407
4408 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004409 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004410
4411 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004412 False
Facundo Batista353750c2007-09-13 18:13:15 +00004413 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004414 True
Facundo Batista353750c2007-09-13 18:13:15 +00004415 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004416 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004417 >>> ExtendedContext.is_signed(8)
4418 False
4419 >>> ExtendedContext.is_signed(-8)
4420 True
Facundo Batista353750c2007-09-13 18:13:15 +00004421 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004422 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004423 return a.is_signed()
4424
4425 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004426 """Return True if the operand is a signaling NaN;
4427 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004428
4429 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004430 False
Facundo Batista353750c2007-09-13 18:13:15 +00004431 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004432 False
Facundo Batista353750c2007-09-13 18:13:15 +00004433 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004434 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004435 >>> ExtendedContext.is_snan(1)
4436 False
Facundo Batista353750c2007-09-13 18:13:15 +00004437 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004438 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004439 return a.is_snan()
4440
4441 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004442 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004443
4444 >>> c = ExtendedContext.copy()
4445 >>> c.Emin = -999
4446 >>> c.Emax = 999
4447 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004448 False
Facundo Batista353750c2007-09-13 18:13:15 +00004449 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004450 True
Facundo Batista353750c2007-09-13 18:13:15 +00004451 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004452 False
Facundo Batista353750c2007-09-13 18:13:15 +00004453 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004454 False
Facundo Batista353750c2007-09-13 18:13:15 +00004455 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004456 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004457 >>> c.is_subnormal(1)
4458 False
Facundo Batista353750c2007-09-13 18:13:15 +00004459 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004460 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004461 return a.is_subnormal(context=self)
4462
4463 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004464 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004465
4466 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004467 True
Facundo Batista353750c2007-09-13 18:13:15 +00004468 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004469 False
Facundo Batista353750c2007-09-13 18:13:15 +00004470 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004471 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004472 >>> ExtendedContext.is_zero(1)
4473 False
4474 >>> ExtendedContext.is_zero(0)
4475 True
Facundo Batista353750c2007-09-13 18:13:15 +00004476 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004477 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004478 return a.is_zero()
4479
4480 def ln(self, a):
4481 """Returns the natural (base e) logarithm of the operand.
4482
4483 >>> c = ExtendedContext.copy()
4484 >>> c.Emin = -999
4485 >>> c.Emax = 999
4486 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004487 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004488 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004489 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004490 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004491 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004492 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004493 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004494 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004495 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004496 >>> c.ln(1)
4497 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004498 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004499 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004500 return a.ln(context=self)
4501
4502 def log10(self, a):
4503 """Returns the base 10 logarithm of the operand.
4504
4505 >>> c = ExtendedContext.copy()
4506 >>> c.Emin = -999
4507 >>> c.Emax = 999
4508 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004509 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004510 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004511 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004512 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004513 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004514 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004515 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004516 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004517 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004518 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004519 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004520 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004521 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004522 >>> c.log10(0)
4523 Decimal('-Infinity')
4524 >>> c.log10(1)
4525 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004526 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004527 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004528 return a.log10(context=self)
4529
4530 def logb(self, a):
4531 """ Returns the exponent of the magnitude of the operand's MSD.
4532
4533 The result is the integer which is the exponent of the magnitude
4534 of the most significant digit of the operand (as though the
4535 operand were truncated to a single digit while maintaining the
4536 value of that digit and without limiting the resulting exponent).
4537
4538 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004539 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004540 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004541 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004542 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004543 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004544 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004545 Decimal('-Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004546 >>> ExtendedContext.logb(1)
4547 Decimal('0')
4548 >>> ExtendedContext.logb(10)
4549 Decimal('1')
4550 >>> ExtendedContext.logb(100)
4551 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004552 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004553 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004554 return a.logb(context=self)
4555
4556 def logical_and(self, a, b):
4557 """Applies the logical operation 'and' between each operand's digits.
4558
4559 The operands must be both logical numbers.
4560
4561 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004562 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004563 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004564 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004565 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004566 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004567 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004568 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004569 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004570 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004571 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004572 Decimal('10')
Mark Dickinson456e1652010-02-18 14:45:33 +00004573 >>> ExtendedContext.logical_and(110, 1101)
4574 Decimal('100')
4575 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4576 Decimal('100')
4577 >>> ExtendedContext.logical_and(110, Decimal(1101))
4578 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004579 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004580 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004581 return a.logical_and(b, context=self)
4582
4583 def logical_invert(self, a):
4584 """Invert all the digits in the operand.
4585
4586 The operand must be a logical number.
4587
4588 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004589 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004590 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004591 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004592 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004593 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004594 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004595 Decimal('10101010')
Mark Dickinson456e1652010-02-18 14:45:33 +00004596 >>> ExtendedContext.logical_invert(1101)
4597 Decimal('111110010')
Facundo Batista353750c2007-09-13 18:13:15 +00004598 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004599 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004600 return a.logical_invert(context=self)
4601
4602 def logical_or(self, a, b):
4603 """Applies the logical operation 'or' between each operand's digits.
4604
4605 The operands must be both logical numbers.
4606
4607 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004608 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004609 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004610 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004611 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004612 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004613 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004614 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004615 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004616 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004617 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004618 Decimal('1110')
Mark Dickinson456e1652010-02-18 14:45:33 +00004619 >>> ExtendedContext.logical_or(110, 1101)
4620 Decimal('1111')
4621 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4622 Decimal('1111')
4623 >>> ExtendedContext.logical_or(110, Decimal(1101))
4624 Decimal('1111')
Facundo Batista353750c2007-09-13 18:13:15 +00004625 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004626 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004627 return a.logical_or(b, context=self)
4628
4629 def logical_xor(self, a, b):
4630 """Applies the logical operation 'xor' between each operand's digits.
4631
4632 The operands must be both logical numbers.
4633
4634 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004635 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004636 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004637 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004638 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004639 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004640 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004641 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004642 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004643 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004644 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004645 Decimal('1101')
Mark Dickinson456e1652010-02-18 14:45:33 +00004646 >>> ExtendedContext.logical_xor(110, 1101)
4647 Decimal('1011')
4648 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4649 Decimal('1011')
4650 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4651 Decimal('1011')
Facundo Batista353750c2007-09-13 18:13:15 +00004652 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004653 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004654 return a.logical_xor(b, context=self)
4655
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004656 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004657 """max compares two values numerically and returns the maximum.
4658
4659 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004660 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004661 operation. If they are numerically equal then the left-hand operand
4662 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004663 infinity) of the two operands is chosen as the result.
4664
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004665 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004666 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004667 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004668 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004669 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004670 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004671 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004672 Decimal('7')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004673 >>> ExtendedContext.max(1, 2)
4674 Decimal('2')
4675 >>> ExtendedContext.max(Decimal(1), 2)
4676 Decimal('2')
4677 >>> ExtendedContext.max(1, Decimal(2))
4678 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004679 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004680 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004681 return a.max(b, context=self)
4682
Facundo Batista353750c2007-09-13 18:13:15 +00004683 def max_mag(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004684 """Compares the values numerically with their sign ignored.
4685
4686 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4687 Decimal('7')
4688 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4689 Decimal('-10')
4690 >>> ExtendedContext.max_mag(1, -2)
4691 Decimal('-2')
4692 >>> ExtendedContext.max_mag(Decimal(1), -2)
4693 Decimal('-2')
4694 >>> ExtendedContext.max_mag(1, Decimal(-2))
4695 Decimal('-2')
4696 """
4697 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004698 return a.max_mag(b, context=self)
4699
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004700 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004701 """min compares two values numerically and returns the minimum.
4702
4703 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004704 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004705 operation. If they are numerically equal then the left-hand operand
4706 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004707 infinity) of the two operands is chosen as the result.
4708
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004709 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004710 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004711 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004712 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004713 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004714 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004715 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004716 Decimal('7')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004717 >>> ExtendedContext.min(1, 2)
4718 Decimal('1')
4719 >>> ExtendedContext.min(Decimal(1), 2)
4720 Decimal('1')
4721 >>> ExtendedContext.min(1, Decimal(29))
4722 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004723 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004724 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004725 return a.min(b, context=self)
4726
Facundo Batista353750c2007-09-13 18:13:15 +00004727 def min_mag(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004728 """Compares the values numerically with their sign ignored.
4729
4730 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4731 Decimal('-2')
4732 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4733 Decimal('-3')
4734 >>> ExtendedContext.min_mag(1, -2)
4735 Decimal('1')
4736 >>> ExtendedContext.min_mag(Decimal(1), -2)
4737 Decimal('1')
4738 >>> ExtendedContext.min_mag(1, Decimal(-2))
4739 Decimal('1')
4740 """
4741 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004742 return a.min_mag(b, context=self)
4743
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004744 def minus(self, a):
4745 """Minus corresponds to unary prefix minus in Python.
4746
4747 The operation is evaluated using the same rules as subtract; the
4748 operation minus(a) is calculated as subtract('0', a) where the '0'
4749 has the same exponent as the operand.
4750
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004751 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004752 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004753 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004754 Decimal('1.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004755 >>> ExtendedContext.minus(1)
4756 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004757 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004758 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004759 return a.__neg__(context=self)
4760
4761 def multiply(self, a, b):
4762 """multiply multiplies two operands.
4763
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004764 If either operand is a special value then the general rules apply.
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004765 Otherwise, the operands are multiplied together
4766 ('long multiplication'), resulting in a number which may be as long as
4767 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004768
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004769 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004770 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004771 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004772 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004773 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004774 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004775 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004776 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004777 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004778 Decimal('4.28135971E+11')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004779 >>> ExtendedContext.multiply(7, 7)
4780 Decimal('49')
4781 >>> ExtendedContext.multiply(Decimal(7), 7)
4782 Decimal('49')
4783 >>> ExtendedContext.multiply(7, Decimal(7))
4784 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004785 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004786 a = _convert_other(a, raiseit=True)
4787 r = a.__mul__(b, context=self)
4788 if r is NotImplemented:
4789 raise TypeError("Unable to convert %s to Decimal" % b)
4790 else:
4791 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004792
Facundo Batista353750c2007-09-13 18:13:15 +00004793 def next_minus(self, a):
4794 """Returns the largest representable number smaller than a.
4795
4796 >>> c = ExtendedContext.copy()
4797 >>> c.Emin = -999
4798 >>> c.Emax = 999
4799 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004800 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004801 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004802 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004803 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004804 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004805 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004806 Decimal('9.99999999E+999')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004807 >>> c.next_minus(1)
4808 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004809 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004810 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004811 return a.next_minus(context=self)
4812
4813 def next_plus(self, a):
4814 """Returns the smallest representable number larger than a.
4815
4816 >>> c = ExtendedContext.copy()
4817 >>> c.Emin = -999
4818 >>> c.Emax = 999
4819 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004820 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004821 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004822 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004823 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004824 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004825 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004826 Decimal('-9.99999999E+999')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004827 >>> c.next_plus(1)
4828 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004829 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004830 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004831 return a.next_plus(context=self)
4832
4833 def next_toward(self, a, b):
4834 """Returns the number closest to a, in direction towards b.
4835
4836 The result is the closest representable number from the first
4837 operand (but not the first operand) that is in the direction
4838 towards the second operand, unless the operands have the same
4839 value.
4840
4841 >>> c = ExtendedContext.copy()
4842 >>> c.Emin = -999
4843 >>> c.Emax = 999
4844 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004845 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004846 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004847 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004848 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004849 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004850 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004851 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004852 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004853 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004854 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004855 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004856 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004857 Decimal('-0.00')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004858 >>> c.next_toward(0, 1)
4859 Decimal('1E-1007')
4860 >>> c.next_toward(Decimal(0), 1)
4861 Decimal('1E-1007')
4862 >>> c.next_toward(0, Decimal(1))
4863 Decimal('1E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004864 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004865 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004866 return a.next_toward(b, context=self)
4867
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004868 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004869 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004870
4871 Essentially a plus operation with all trailing zeros removed from the
4872 result.
4873
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004874 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004875 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004876 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004877 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004878 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004879 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004880 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004881 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004882 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004883 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004884 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004885 Decimal('0')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004886 >>> ExtendedContext.normalize(6)
4887 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004888 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004889 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004890 return a.normalize(context=self)
4891
Facundo Batista353750c2007-09-13 18:13:15 +00004892 def number_class(self, a):
4893 """Returns an indication of the class of the operand.
4894
4895 The class is one of the following strings:
4896 -sNaN
4897 -NaN
4898 -Infinity
4899 -Normal
4900 -Subnormal
4901 -Zero
4902 +Zero
4903 +Subnormal
4904 +Normal
4905 +Infinity
4906
4907 >>> c = Context(ExtendedContext)
4908 >>> c.Emin = -999
4909 >>> c.Emax = 999
4910 >>> c.number_class(Decimal('Infinity'))
4911 '+Infinity'
4912 >>> c.number_class(Decimal('1E-10'))
4913 '+Normal'
4914 >>> c.number_class(Decimal('2.50'))
4915 '+Normal'
4916 >>> c.number_class(Decimal('0.1E-999'))
4917 '+Subnormal'
4918 >>> c.number_class(Decimal('0'))
4919 '+Zero'
4920 >>> c.number_class(Decimal('-0'))
4921 '-Zero'
4922 >>> c.number_class(Decimal('-0.1E-999'))
4923 '-Subnormal'
4924 >>> c.number_class(Decimal('-1E-10'))
4925 '-Normal'
4926 >>> c.number_class(Decimal('-2.50'))
4927 '-Normal'
4928 >>> c.number_class(Decimal('-Infinity'))
4929 '-Infinity'
4930 >>> c.number_class(Decimal('NaN'))
4931 'NaN'
4932 >>> c.number_class(Decimal('-NaN'))
4933 'NaN'
4934 >>> c.number_class(Decimal('sNaN'))
4935 'sNaN'
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004936 >>> c.number_class(123)
4937 '+Normal'
Facundo Batista353750c2007-09-13 18:13:15 +00004938 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004939 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004940 return a.number_class(context=self)
4941
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004942 def plus(self, a):
4943 """Plus corresponds to unary prefix plus in Python.
4944
4945 The operation is evaluated using the same rules as add; the
4946 operation plus(a) is calculated as add('0', a) where the '0'
4947 has the same exponent as the operand.
4948
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004949 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004950 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004951 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004952 Decimal('-1.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004953 >>> ExtendedContext.plus(-1)
4954 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004955 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004956 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004957 return a.__pos__(context=self)
4958
4959 def power(self, a, b, modulo=None):
4960 """Raises a to the power of b, to modulo if given.
4961
Facundo Batista353750c2007-09-13 18:13:15 +00004962 With two arguments, compute a**b. If a is negative then b
4963 must be integral. The result will be inexact unless b is
4964 integral and the result is finite and can be expressed exactly
4965 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004966
Facundo Batista353750c2007-09-13 18:13:15 +00004967 With three arguments, compute (a**b) % modulo. For the
4968 three argument form, the following restrictions on the
4969 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004970
Facundo Batista353750c2007-09-13 18:13:15 +00004971 - all three arguments must be integral
4972 - b must be nonnegative
4973 - at least one of a or b must be nonzero
4974 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004975
Facundo Batista353750c2007-09-13 18:13:15 +00004976 The result of pow(a, b, modulo) is identical to the result
4977 that would be obtained by computing (a**b) % modulo with
4978 unbounded precision, but is computed more efficiently. It is
4979 always exact.
4980
4981 >>> c = ExtendedContext.copy()
4982 >>> c.Emin = -999
4983 >>> c.Emax = 999
4984 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004985 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004986 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004987 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004988 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004989 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004990 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004991 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004992 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004993 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004994 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004995 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004996 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004997 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004998 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004999 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005000 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005001 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00005002 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005003 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00005004 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005005 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005006 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005007 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005008 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005009 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00005010
5011 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005012 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00005013 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005014 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00005015 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005016 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00005017 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005018 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00005019 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005020 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00005021 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005022 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00005023 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005024 Decimal('1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005025 >>> ExtendedContext.power(7, 7)
5026 Decimal('823543')
5027 >>> ExtendedContext.power(Decimal(7), 7)
5028 Decimal('823543')
5029 >>> ExtendedContext.power(7, Decimal(7), 2)
5030 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005031 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005032 a = _convert_other(a, raiseit=True)
5033 r = a.__pow__(b, modulo, context=self)
5034 if r is NotImplemented:
5035 raise TypeError("Unable to convert %s to Decimal" % b)
5036 else:
5037 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005038
5039 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00005040 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005041
5042 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00005043 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005044 exponent is being increased), multiplied by a positive power of ten (if
5045 the exponent is being decreased), or is unchanged (if the exponent is
5046 already equal to that of the right-hand operand).
5047
5048 Unlike other operations, if the length of the coefficient after the
5049 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00005050 operation condition is raised. This guarantees that, unless there is
5051 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005052 equal to that of the right-hand operand.
5053
5054 Also unlike other operations, quantize will never raise Underflow, even
5055 if the result is subnormal and inexact.
5056
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005057 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005058 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005059 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005060 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005061 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005062 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005063 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005064 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005065 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005066 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005067 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005068 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005069 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005070 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005071 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005072 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005073 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005074 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005075 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005076 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005077 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005078 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005079 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005080 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005081 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005082 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005083 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005084 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005085 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005086 Decimal('2E+2')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005087 >>> ExtendedContext.quantize(1, 2)
5088 Decimal('1')
5089 >>> ExtendedContext.quantize(Decimal(1), 2)
5090 Decimal('1')
5091 >>> ExtendedContext.quantize(1, Decimal(2))
5092 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005093 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005094 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005095 return a.quantize(b, context=self)
5096
Facundo Batista353750c2007-09-13 18:13:15 +00005097 def radix(self):
5098 """Just returns 10, as this is Decimal, :)
5099
5100 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00005101 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00005102 """
5103 return Decimal(10)
5104
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005105 def remainder(self, a, b):
5106 """Returns the remainder from integer division.
5107
5108 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00005109 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00005110 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00005111 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005112
5113 This operation will fail under the same conditions as integer division
5114 (that is, if integer division on the same two operands would fail, the
5115 remainder cannot be calculated).
5116
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005117 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005118 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005119 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005120 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005121 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005122 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005123 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005124 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005125 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005126 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005127 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005128 Decimal('1.0')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005129 >>> ExtendedContext.remainder(22, 6)
5130 Decimal('4')
5131 >>> ExtendedContext.remainder(Decimal(22), 6)
5132 Decimal('4')
5133 >>> ExtendedContext.remainder(22, Decimal(6))
5134 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005135 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005136 a = _convert_other(a, raiseit=True)
5137 r = a.__mod__(b, context=self)
5138 if r is NotImplemented:
5139 raise TypeError("Unable to convert %s to Decimal" % b)
5140 else:
5141 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005142
5143 def remainder_near(self, a, b):
5144 """Returns to be "a - b * n", where n is the integer nearest the exact
5145 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00005146 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005147 sign of a.
5148
5149 This operation will fail under the same conditions as integer division
5150 (that is, if integer division on the same two operands would fail, the
5151 remainder cannot be calculated).
5152
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005153 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005154 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005155 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005156 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005157 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005158 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005159 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005160 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005161 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005162 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005163 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005164 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005165 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005166 Decimal('-0.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005167 >>> ExtendedContext.remainder_near(3, 11)
5168 Decimal('3')
5169 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5170 Decimal('3')
5171 >>> ExtendedContext.remainder_near(3, Decimal(11))
5172 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005173 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005174 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005175 return a.remainder_near(b, context=self)
5176
Facundo Batista353750c2007-09-13 18:13:15 +00005177 def rotate(self, a, b):
5178 """Returns a rotated copy of a, b times.
5179
5180 The coefficient of the result is a rotated copy of the digits in
5181 the coefficient of the first operand. The number of places of
5182 rotation is taken from the absolute value of the second operand,
5183 with the rotation being to the left if the second operand is
5184 positive or to the right otherwise.
5185
5186 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005187 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00005188 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005189 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00005190 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005191 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00005192 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005193 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00005194 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005195 Decimal('345678912')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005196 >>> ExtendedContext.rotate(1333333, 1)
5197 Decimal('13333330')
5198 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5199 Decimal('13333330')
5200 >>> ExtendedContext.rotate(1333333, Decimal(1))
5201 Decimal('13333330')
Facundo Batista353750c2007-09-13 18:13:15 +00005202 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005203 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005204 return a.rotate(b, context=self)
5205
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005206 def same_quantum(self, a, b):
5207 """Returns True if the two operands have the same exponent.
5208
5209 The result is never affected by either the sign or the coefficient of
5210 either operand.
5211
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005212 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005213 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005214 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005215 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005216 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005217 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005218 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005219 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005220 >>> ExtendedContext.same_quantum(10000, -1)
5221 True
5222 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5223 True
5224 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5225 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005226 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005227 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005228 return a.same_quantum(b)
5229
Facundo Batista353750c2007-09-13 18:13:15 +00005230 def scaleb (self, a, b):
5231 """Returns the first operand after adding the second value its exp.
5232
5233 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005234 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00005235 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005236 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00005237 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005238 Decimal('7.50E+3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005239 >>> ExtendedContext.scaleb(1, 4)
5240 Decimal('1E+4')
5241 >>> ExtendedContext.scaleb(Decimal(1), 4)
5242 Decimal('1E+4')
5243 >>> ExtendedContext.scaleb(1, Decimal(4))
5244 Decimal('1E+4')
Facundo Batista353750c2007-09-13 18:13:15 +00005245 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005246 a = _convert_other(a, raiseit=True)
5247 return a.scaleb(b, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00005248
5249 def shift(self, a, b):
5250 """Returns a shifted copy of a, b times.
5251
5252 The coefficient of the result is a shifted copy of the digits
5253 in the coefficient of the first operand. The number of places
5254 to shift is taken from the absolute value of the second operand,
5255 with the shift being to the left if the second operand is
5256 positive or to the right otherwise. Digits shifted into the
5257 coefficient are zeros.
5258
5259 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005260 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00005261 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005262 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00005263 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005264 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00005265 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005266 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00005267 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005268 Decimal('345678900')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005269 >>> ExtendedContext.shift(88888888, 2)
5270 Decimal('888888800')
5271 >>> ExtendedContext.shift(Decimal(88888888), 2)
5272 Decimal('888888800')
5273 >>> ExtendedContext.shift(88888888, Decimal(2))
5274 Decimal('888888800')
Facundo Batista353750c2007-09-13 18:13:15 +00005275 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005276 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005277 return a.shift(b, context=self)
5278
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005279 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00005280 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005281
5282 If the result must be inexact, it is rounded using the round-half-even
5283 algorithm.
5284
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005285 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005286 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005287 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005288 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005289 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005290 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005291 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005292 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005293 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005294 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005295 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005296 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005297 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005298 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005299 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005300 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005301 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005302 Decimal('3.16227766')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005303 >>> ExtendedContext.sqrt(2)
5304 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005305 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005306 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005307 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005308 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005309 return a.sqrt(context=self)
5310
5311 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005312 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005313
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005314 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005315 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005316 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005317 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005318 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005319 Decimal('-0.77')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005320 >>> ExtendedContext.subtract(8, 5)
5321 Decimal('3')
5322 >>> ExtendedContext.subtract(Decimal(8), 5)
5323 Decimal('3')
5324 >>> ExtendedContext.subtract(8, Decimal(5))
5325 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005326 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005327 a = _convert_other(a, raiseit=True)
5328 r = a.__sub__(b, context=self)
5329 if r is NotImplemented:
5330 raise TypeError("Unable to convert %s to Decimal" % b)
5331 else:
5332 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005333
5334 def to_eng_string(self, a):
5335 """Converts a number to a string, using scientific notation.
5336
5337 The operation is not affected by the context.
5338 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005339 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005340 return a.to_eng_string(context=self)
5341
5342 def to_sci_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.__str__(context=self)
5349
Facundo Batista353750c2007-09-13 18:13:15 +00005350 def to_integral_exact(self, a):
5351 """Rounds to an integer.
5352
5353 When the operand has a negative exponent, the result is the same
5354 as using the quantize() operation using the given operand as the
5355 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5356 of the operand as the precision setting; Inexact and Rounded flags
5357 are allowed in this operation. The rounding mode is taken from the
5358 context.
5359
5360 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005361 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00005362 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005363 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005364 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005365 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005366 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005367 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00005368 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005369 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00005370 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005371 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00005372 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005373 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00005374 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005375 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005376 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005377 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005378 return a.to_integral_exact(context=self)
5379
5380 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005381 """Rounds to an integer.
5382
5383 When the operand has a negative exponent, the result is the same
5384 as using the quantize() operation using the given operand as the
5385 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5386 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00005387 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005388
Facundo Batista353750c2007-09-13 18:13:15 +00005389 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005390 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00005391 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005392 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005393 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005394 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005395 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005396 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00005397 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005398 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00005399 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005400 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00005401 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005402 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00005403 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005404 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005405 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005406 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005407 return a.to_integral_value(context=self)
5408
5409 # the method name changed, but we provide also the old one, for compatibility
5410 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005411
5412class _WorkRep(object):
5413 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005414 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005415 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005416 # exp: None, int, or string
5417
5418 def __init__(self, value=None):
5419 if value is None:
5420 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005421 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005422 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005423 elif isinstance(value, Decimal):
5424 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00005425 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005426 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005427 else:
5428 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005429 self.sign = value[0]
5430 self.int = value[1]
5431 self.exp = value[2]
5432
5433 def __repr__(self):
5434 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5435
5436 __str__ = __repr__
5437
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005438
5439
Facundo Batistae64acfa2007-12-17 14:18:42 +00005440def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005441 """Normalizes op1, op2 to have the same exp and length of coefficient.
5442
5443 Done during addition.
5444 """
Facundo Batista353750c2007-09-13 18:13:15 +00005445 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005446 tmp = op2
5447 other = op1
5448 else:
5449 tmp = op1
5450 other = op2
5451
Facundo Batista353750c2007-09-13 18:13:15 +00005452 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5453 # Then adding 10**exp to tmp has the same effect (after rounding)
5454 # as adding any positive quantity smaller than 10**exp; similarly
5455 # for subtraction. So if other is smaller than 10**exp we replace
5456 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00005457 tmp_len = len(str(tmp.int))
5458 other_len = len(str(other.int))
5459 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5460 if other_len + other.exp - 1 < exp:
5461 other.int = 1
5462 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005463
Facundo Batista353750c2007-09-13 18:13:15 +00005464 tmp.int *= 10 ** (tmp.exp - other.exp)
5465 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005466 return op1, op2
5467
Facundo Batista353750c2007-09-13 18:13:15 +00005468##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
5469
5470# This function from Tim Peters was taken from here:
5471# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5472# The correction being in the function definition is for speed, and
5473# the whole function is not resolved with math.log because of avoiding
5474# the use of floats.
5475def _nbits(n, correction = {
5476 '0': 4, '1': 3, '2': 2, '3': 2,
5477 '4': 1, '5': 1, '6': 1, '7': 1,
5478 '8': 0, '9': 0, 'a': 0, 'b': 0,
5479 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5480 """Number of bits in binary representation of the positive integer n,
5481 or 0 if n == 0.
5482 """
5483 if n < 0:
5484 raise ValueError("The argument to _nbits should be nonnegative.")
5485 hex_n = "%x" % n
5486 return 4*len(hex_n) - correction[hex_n[0]]
5487
Mark Dickinsona493ca32011-06-04 18:24:15 +01005488def _decimal_lshift_exact(n, e):
5489 """ Given integers n and e, return n * 10**e if it's an integer, else None.
5490
5491 The computation is designed to avoid computing large powers of 10
5492 unnecessarily.
5493
5494 >>> _decimal_lshift_exact(3, 4)
5495 30000
5496 >>> _decimal_lshift_exact(300, -999999999) # returns None
5497
5498 """
5499 if n == 0:
5500 return 0
5501 elif e >= 0:
5502 return n * 10**e
5503 else:
5504 # val_n = largest power of 10 dividing n.
5505 str_n = str(abs(n))
5506 val_n = len(str_n) - len(str_n.rstrip('0'))
5507 return None if val_n < -e else n // 10**-e
5508
Facundo Batista353750c2007-09-13 18:13:15 +00005509def _sqrt_nearest(n, a):
5510 """Closest integer to the square root of the positive integer n. a is
5511 an initial approximation to the square root. Any positive integer
5512 will do for a, but the closer a is to the square root of n the
5513 faster convergence will be.
5514
5515 """
5516 if n <= 0 or a <= 0:
5517 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5518
5519 b=0
5520 while a != b:
5521 b, a = a, a--n//a>>1
5522 return a
5523
5524def _rshift_nearest(x, shift):
5525 """Given an integer x and a nonnegative integer shift, return closest
5526 integer to x / 2**shift; use round-to-even in case of a tie.
5527
5528 """
5529 b, q = 1L << shift, x >> shift
5530 return q + (2*(x & (b-1)) + (q&1) > b)
5531
5532def _div_nearest(a, b):
5533 """Closest integer to a/b, a and b positive integers; rounds to even
5534 in the case of a tie.
5535
5536 """
5537 q, r = divmod(a, b)
5538 return q + (2*r + (q&1) > b)
5539
5540def _ilog(x, M, L = 8):
5541 """Integer approximation to M*log(x/M), with absolute error boundable
5542 in terms only of x/M.
5543
5544 Given positive integers x and M, return an integer approximation to
5545 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5546 between the approximation and the exact result is at most 22. For
5547 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5548 both cases these are upper bounds on the error; it will usually be
5549 much smaller."""
5550
5551 # The basic algorithm is the following: let log1p be the function
5552 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5553 # the reduction
5554 #
5555 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5556 #
5557 # repeatedly until the argument to log1p is small (< 2**-L in
5558 # absolute value). For small y we can use the Taylor series
5559 # expansion
5560 #
5561 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5562 #
5563 # truncating at T such that y**T is small enough. The whole
5564 # computation is carried out in a form of fixed-point arithmetic,
5565 # with a real number z being represented by an integer
5566 # approximation to z*M. To avoid loss of precision, the y below
5567 # is actually an integer approximation to 2**R*y*M, where R is the
5568 # number of reductions performed so far.
5569
5570 y = x-M
5571 # argument reduction; R = number of reductions performed
5572 R = 0
5573 while (R <= L and long(abs(y)) << L-R >= M or
5574 R > L and abs(y) >> R-L >= M):
5575 y = _div_nearest(long(M*y) << 1,
5576 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5577 R += 1
5578
5579 # Taylor series with T terms
5580 T = -int(-10*len(str(M))//(3*L))
5581 yshift = _rshift_nearest(y, R)
5582 w = _div_nearest(M, T)
5583 for k in xrange(T-1, 0, -1):
5584 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5585
5586 return _div_nearest(w*y, M)
5587
5588def _dlog10(c, e, p):
5589 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5590 approximation to 10**p * log10(c*10**e), with an absolute error of
5591 at most 1. Assumes that c*10**e is not exactly 1."""
5592
5593 # increase precision by 2; compensate for this by dividing
5594 # final result by 100
5595 p += 2
5596
5597 # write c*10**e as d*10**f with either:
5598 # f >= 0 and 1 <= d <= 10, or
5599 # f <= 0 and 0.1 <= d <= 1.
5600 # Thus for c*10**e close to 1, f = 0
5601 l = len(str(c))
5602 f = e+l - (e+l >= 1)
5603
5604 if p > 0:
5605 M = 10**p
5606 k = e+p-f
5607 if k >= 0:
5608 c *= 10**k
5609 else:
5610 c = _div_nearest(c, 10**-k)
5611
5612 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005613 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005614 log_d = _div_nearest(log_d*M, log_10)
5615 log_tenpower = f*M # exact
5616 else:
5617 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005618 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005619
5620 return _div_nearest(log_tenpower+log_d, 100)
5621
5622def _dlog(c, e, p):
5623 """Given integers c, e and p with c > 0, compute an integer
5624 approximation to 10**p * log(c*10**e), with an absolute error of
5625 at most 1. Assumes that c*10**e is not exactly 1."""
5626
5627 # Increase precision by 2. The precision increase is compensated
5628 # for at the end with a division by 100.
5629 p += 2
5630
5631 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5632 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5633 # as 10**p * log(d) + 10**p*f * log(10).
5634 l = len(str(c))
5635 f = e+l - (e+l >= 1)
5636
5637 # compute approximation to 10**p*log(d), with error < 27
5638 if p > 0:
5639 k = e+p-f
5640 if k >= 0:
5641 c *= 10**k
5642 else:
5643 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5644
5645 # _ilog magnifies existing error in c by a factor of at most 10
5646 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5647 else:
5648 # p <= 0: just approximate the whole thing by 0; error < 2.31
5649 log_d = 0
5650
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005651 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005652 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005653 extra = len(str(abs(f)))-1
5654 if p + extra >= 0:
5655 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5656 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5657 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005658 else:
5659 f_log_ten = 0
5660 else:
5661 f_log_ten = 0
5662
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005663 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005664 return _div_nearest(f_log_ten + log_d, 100)
5665
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005666class _Log10Memoize(object):
5667 """Class to compute, store, and allow retrieval of, digits of the
5668 constant log(10) = 2.302585.... This constant is needed by
5669 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5670 def __init__(self):
5671 self.digits = "23025850929940456840179914546843642076011014886"
5672
5673 def getdigits(self, p):
5674 """Given an integer p >= 0, return floor(10**p)*log(10).
5675
5676 For example, self.getdigits(3) returns 2302.
5677 """
5678 # digits are stored as a string, for quick conversion to
5679 # integer in the case that we've already computed enough
5680 # digits; the stored digits should always be correct
5681 # (truncated, not rounded to nearest).
5682 if p < 0:
5683 raise ValueError("p should be nonnegative")
5684
5685 if p >= len(self.digits):
5686 # compute p+3, p+6, p+9, ... digits; continue until at
5687 # least one of the extra digits is nonzero
5688 extra = 3
5689 while True:
5690 # compute p+extra digits, correct to within 1ulp
5691 M = 10**(p+extra+2)
5692 digits = str(_div_nearest(_ilog(10*M, M), 100))
5693 if digits[-extra:] != '0'*extra:
5694 break
5695 extra += 3
5696 # keep all reliable digits so far; remove trailing zeros
5697 # and next nonzero digit
5698 self.digits = digits.rstrip('0')[:-1]
5699 return int(self.digits[:p+1])
5700
5701_log10_digits = _Log10Memoize().getdigits
5702
Facundo Batista353750c2007-09-13 18:13:15 +00005703def _iexp(x, M, L=8):
5704 """Given integers x and M, M > 0, such that x/M is small in absolute
5705 value, compute an integer approximation to M*exp(x/M). For 0 <=
5706 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5707 is usually much smaller)."""
5708
5709 # Algorithm: to compute exp(z) for a real number z, first divide z
5710 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5711 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5712 # series
5713 #
5714 # expm1(x) = x + x**2/2! + x**3/3! + ...
5715 #
5716 # Now use the identity
5717 #
5718 # expm1(2x) = expm1(x)*(expm1(x)+2)
5719 #
5720 # R times to compute the sequence expm1(z/2**R),
5721 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5722
5723 # Find R such that x/2**R/M <= 2**-L
5724 R = _nbits((long(x)<<L)//M)
5725
5726 # Taylor series. (2**L)**T > M
5727 T = -int(-10*len(str(M))//(3*L))
5728 y = _div_nearest(x, T)
5729 Mshift = long(M)<<R
5730 for i in xrange(T-1, 0, -1):
5731 y = _div_nearest(x*(Mshift + y), Mshift * i)
5732
5733 # Expansion
5734 for k in xrange(R-1, -1, -1):
5735 Mshift = long(M)<<(k+2)
5736 y = _div_nearest(y*(y+Mshift), Mshift)
5737
5738 return M+y
5739
5740def _dexp(c, e, p):
5741 """Compute an approximation to exp(c*10**e), with p decimal places of
5742 precision.
5743
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005744 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005745
5746 10**(p-1) <= d <= 10**p, and
5747 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5748
5749 In other words, d*10**f is an approximation to exp(c*10**e) with p
5750 digits of precision, and with an error in d of at most 1. This is
5751 almost, but not quite, the same as the error being < 1ulp: when d
5752 = 10**(p-1) the error could be up to 10 ulp."""
5753
5754 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5755 p += 2
5756
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005757 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005758 extra = max(0, e + len(str(c)) - 1)
5759 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005760
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005761 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005762 # rounding down
5763 shift = e+q
5764 if shift >= 0:
5765 cshift = c*10**shift
5766 else:
5767 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005768 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005769
5770 # reduce remainder back to original precision
5771 rem = _div_nearest(rem, 10**extra)
5772
5773 # error in result of _iexp < 120; error after division < 0.62
5774 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5775
5776def _dpower(xc, xe, yc, ye, p):
5777 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5778 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5779
5780 10**(p-1) <= c <= 10**p, and
5781 (c-1)*10**e < x**y < (c+1)*10**e
5782
5783 in other words, c*10**e is an approximation to x**y with p digits
5784 of precision, and with an error in c of at most 1. (This is
5785 almost, but not quite, the same as the error being < 1ulp: when c
5786 == 10**(p-1) we can only guarantee error < 10ulp.)
5787
5788 We assume that: x is positive and not equal to 1, and y is nonzero.
5789 """
5790
5791 # Find b such that 10**(b-1) <= |y| <= 10**b
5792 b = len(str(abs(yc))) + ye
5793
5794 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5795 lxc = _dlog(xc, xe, p+b+1)
5796
5797 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5798 shift = ye-b
5799 if shift >= 0:
5800 pc = lxc*yc*10**shift
5801 else:
5802 pc = _div_nearest(lxc*yc, 10**-shift)
5803
5804 if pc == 0:
5805 # we prefer a result that isn't exactly 1; this makes it
5806 # easier to compute a correctly rounded result in __pow__
5807 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5808 coeff, exp = 10**(p-1)+1, 1-p
5809 else:
5810 coeff, exp = 10**p-1, -p
5811 else:
5812 coeff, exp = _dexp(pc, -(p+1), p+1)
5813 coeff = _div_nearest(coeff, 10)
5814 exp += 1
5815
5816 return coeff, exp
5817
5818def _log10_lb(c, correction = {
5819 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5820 '6': 23, '7': 16, '8': 10, '9': 5}):
5821 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5822 if c <= 0:
5823 raise ValueError("The argument to _log10_lb should be nonnegative.")
5824 str_c = str(c)
5825 return 100*len(str_c) - correction[str_c[0]]
5826
Facundo Batista59c58842007-04-10 12:58:45 +00005827##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005828
Mark Dickinson99d80962010-04-02 08:53:22 +00005829def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005830 """Convert other to Decimal.
5831
5832 Verifies that it's ok to use in an implicit construction.
Mark Dickinson99d80962010-04-02 08:53:22 +00005833 If allow_float is true, allow conversion from float; this
5834 is used in the comparison methods (__eq__ and friends).
5835
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005836 """
5837 if isinstance(other, Decimal):
5838 return other
5839 if isinstance(other, (int, long)):
5840 return Decimal(other)
Mark Dickinson99d80962010-04-02 08:53:22 +00005841 if allow_float and isinstance(other, float):
5842 return Decimal.from_float(other)
5843
Facundo Batista353750c2007-09-13 18:13:15 +00005844 if raiseit:
5845 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005846 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005847
Facundo Batista59c58842007-04-10 12:58:45 +00005848##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005849
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005850# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005851# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005852
5853DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005854 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005855 traps=[DivisionByZero, Overflow, InvalidOperation],
5856 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005857 Emax=999999999,
5858 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005859 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005860)
5861
5862# Pre-made alternate contexts offered by the specification
5863# Don't change these; the user should be able to select these
5864# contexts and be able to reproduce results from other implementations
5865# of the spec.
5866
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005867BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005868 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005869 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5870 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005871)
5872
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005873ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005874 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005875 traps=[],
5876 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005877)
5878
5879
Facundo Batista72bc54f2007-11-23 17:59:00 +00005880##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005881#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005882# Regular expression used for parsing numeric strings. Additional
5883# comments:
5884#
5885# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5886# whitespace. But note that the specification disallows whitespace in
5887# a numeric string.
5888#
5889# 2. For finite numbers (not infinities and NaNs) the body of the
5890# number between the optional sign and the optional exponent must have
5891# at least one decimal digit, possibly after the decimal point. The
5892# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005893
5894import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005895_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005896# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005897 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005898 (
Mark Dickinson4326ad82009-08-02 10:59:36 +00005899 (?=\d|\.\d) # ...a number (with at least one digit)
5900 (?P<int>\d*) # having a (possibly empty) integer part
5901 (\.(?P<frac>\d*))? # followed by an optional fractional part
5902 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005903 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005904 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005905 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005906 (?P<signal>s)? # ...an (optionally signaling)
5907 NaN # NaN
Mark Dickinson4326ad82009-08-02 10:59:36 +00005908 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005909 )
5910# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005911 \Z
Mark Dickinson4326ad82009-08-02 10:59:36 +00005912""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005913
Facundo Batista2ec74152007-12-03 17:55:00 +00005914_all_zeros = re.compile('0*$').match
5915_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005916
5917##### PEP3101 support functions ##############################################
Mark Dickinson277859d2009-03-17 23:03:46 +00005918# The functions in this section have little to do with the Decimal
5919# class, and could potentially be reused or adapted for other pure
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005920# Python numeric classes that want to implement __format__
5921#
5922# A format specifier for Decimal looks like:
5923#
Mark Dickinson277859d2009-03-17 23:03:46 +00005924# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005925
5926_parse_format_specifier_regex = re.compile(r"""\A
5927(?:
5928 (?P<fill>.)?
5929 (?P<align>[<>=^])
5930)?
5931(?P<sign>[-+ ])?
5932(?P<zeropad>0)?
5933(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson277859d2009-03-17 23:03:46 +00005934(?P<thousands_sep>,)?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005935(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson277859d2009-03-17 23:03:46 +00005936(?P<type>[eEfFgGn%])?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005937\Z
5938""", re.VERBOSE)
5939
Facundo Batista72bc54f2007-11-23 17:59:00 +00005940del re
5941
Mark Dickinson277859d2009-03-17 23:03:46 +00005942# The locale module is only needed for the 'n' format specifier. The
5943# rest of the PEP 3101 code functions quite happily without it, so we
5944# don't care too much if locale isn't present.
5945try:
5946 import locale as _locale
5947except ImportError:
5948 pass
5949
5950def _parse_format_specifier(format_spec, _localeconv=None):
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005951 """Parse and validate a format specifier.
5952
5953 Turns a standard numeric format specifier into a dict, with the
5954 following entries:
5955
5956 fill: fill character to pad field to minimum width
5957 align: alignment type, either '<', '>', '=' or '^'
5958 sign: either '+', '-' or ' '
5959 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson277859d2009-03-17 23:03:46 +00005960 zeropad: boolean, indicating whether to pad with zeros
5961 thousands_sep: string to use as thousands separator, or ''
5962 grouping: grouping for thousands separators, in format
5963 used by localeconv
5964 decimal_point: string to use for decimal point
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005965 precision: nonnegative integer giving precision, or None
5966 type: one of the characters 'eEfFgG%', or None
Mark Dickinson277859d2009-03-17 23:03:46 +00005967 unicode: boolean (always True for Python 3.x)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005968
5969 """
5970 m = _parse_format_specifier_regex.match(format_spec)
5971 if m is None:
5972 raise ValueError("Invalid format specifier: " + format_spec)
5973
5974 # get the dictionary
5975 format_dict = m.groupdict()
5976
Mark Dickinson277859d2009-03-17 23:03:46 +00005977 # zeropad; defaults for fill and alignment. If zero padding
5978 # is requested, the fill and align fields should be absent.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005979 fill = format_dict['fill']
5980 align = format_dict['align']
Mark Dickinson277859d2009-03-17 23:03:46 +00005981 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5982 if format_dict['zeropad']:
5983 if fill is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005984 raise ValueError("Fill character conflicts with '0'"
5985 " in format specifier: " + format_spec)
Mark Dickinson277859d2009-03-17 23:03:46 +00005986 if align is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005987 raise ValueError("Alignment conflicts with '0' in "
5988 "format specifier: " + format_spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005989 format_dict['fill'] = fill or ' '
Mark Dickinson5cfa8042009-09-08 20:20:19 +00005990 # PEP 3101 originally specified that the default alignment should
5991 # be left; it was later agreed that right-aligned makes more sense
5992 # for numeric types. See http://bugs.python.org/issue6857.
5993 format_dict['align'] = align or '>'
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005994
Mark Dickinson277859d2009-03-17 23:03:46 +00005995 # default sign handling: '-' for negative, '' for positive
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005996 if format_dict['sign'] is None:
5997 format_dict['sign'] = '-'
5998
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005999 # minimumwidth defaults to 0; precision remains None if not given
6000 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
6001 if format_dict['precision'] is not None:
6002 format_dict['precision'] = int(format_dict['precision'])
6003
6004 # if format type is 'g' or 'G' then a precision of 0 makes little
6005 # sense; convert it to 1. Same if format type is unspecified.
6006 if format_dict['precision'] == 0:
Mark Dickinson491ea552009-09-07 16:17:41 +00006007 if format_dict['type'] is None or format_dict['type'] in 'gG':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006008 format_dict['precision'] = 1
6009
Mark Dickinson277859d2009-03-17 23:03:46 +00006010 # determine thousands separator, grouping, and decimal separator, and
6011 # add appropriate entries to format_dict
6012 if format_dict['type'] == 'n':
6013 # apart from separators, 'n' behaves just like 'g'
6014 format_dict['type'] = 'g'
6015 if _localeconv is None:
6016 _localeconv = _locale.localeconv()
6017 if format_dict['thousands_sep'] is not None:
6018 raise ValueError("Explicit thousands separator conflicts with "
6019 "'n' type in format specifier: " + format_spec)
6020 format_dict['thousands_sep'] = _localeconv['thousands_sep']
6021 format_dict['grouping'] = _localeconv['grouping']
6022 format_dict['decimal_point'] = _localeconv['decimal_point']
6023 else:
6024 if format_dict['thousands_sep'] is None:
6025 format_dict['thousands_sep'] = ''
6026 format_dict['grouping'] = [3, 0]
6027 format_dict['decimal_point'] = '.'
6028
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006029 # record whether return type should be str or unicode
6030 format_dict['unicode'] = isinstance(format_spec, unicode)
6031
6032 return format_dict
6033
Mark Dickinson277859d2009-03-17 23:03:46 +00006034def _format_align(sign, body, spec):
6035 """Given an unpadded, non-aligned numeric string 'body' and sign
Ezio Melotti24b07bc2011-03-15 18:55:01 +02006036 string 'sign', add padding and alignment conforming to the given
Mark Dickinson277859d2009-03-17 23:03:46 +00006037 format specifier dictionary 'spec' (as produced by
6038 parse_format_specifier).
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006039
Mark Dickinson277859d2009-03-17 23:03:46 +00006040 Also converts result to unicode if necessary.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006041
6042 """
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006043 # how much extra space do we have to play with?
Mark Dickinson277859d2009-03-17 23:03:46 +00006044 minimumwidth = spec['minimumwidth']
6045 fill = spec['fill']
6046 padding = fill*(minimumwidth - len(sign) - len(body))
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006047
Mark Dickinson277859d2009-03-17 23:03:46 +00006048 align = spec['align']
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006049 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006050 result = sign + body + padding
Mark Dickinsonb065e522009-03-17 18:01:03 +00006051 elif align == '>':
6052 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006053 elif align == '=':
6054 result = sign + padding + body
Mark Dickinson277859d2009-03-17 23:03:46 +00006055 elif align == '^':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006056 half = len(padding)//2
6057 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson277859d2009-03-17 23:03:46 +00006058 else:
6059 raise ValueError('Unrecognised alignment field')
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006060
6061 # make sure that result is unicode if necessary
Mark Dickinson277859d2009-03-17 23:03:46 +00006062 if spec['unicode']:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006063 result = unicode(result)
6064
6065 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00006066
Mark Dickinson277859d2009-03-17 23:03:46 +00006067def _group_lengths(grouping):
6068 """Convert a localeconv-style grouping into a (possibly infinite)
6069 iterable of integers representing group lengths.
6070
6071 """
6072 # The result from localeconv()['grouping'], and the input to this
6073 # function, should be a list of integers in one of the
6074 # following three forms:
6075 #
6076 # (1) an empty list, or
6077 # (2) nonempty list of positive integers + [0]
6078 # (3) list of positive integers + [locale.CHAR_MAX], or
6079
6080 from itertools import chain, repeat
6081 if not grouping:
6082 return []
6083 elif grouping[-1] == 0 and len(grouping) >= 2:
6084 return chain(grouping[:-1], repeat(grouping[-2]))
6085 elif grouping[-1] == _locale.CHAR_MAX:
6086 return grouping[:-1]
6087 else:
6088 raise ValueError('unrecognised format for grouping')
6089
6090def _insert_thousands_sep(digits, spec, min_width=1):
6091 """Insert thousands separators into a digit string.
6092
6093 spec is a dictionary whose keys should include 'thousands_sep' and
6094 'grouping'; typically it's the result of parsing the format
6095 specifier using _parse_format_specifier.
6096
6097 The min_width keyword argument gives the minimum length of the
6098 result, which will be padded on the left with zeros if necessary.
6099
6100 If necessary, the zero padding adds an extra '0' on the left to
6101 avoid a leading thousands separator. For example, inserting
6102 commas every three digits in '123456', with min_width=8, gives
6103 '0,123,456', even though that has length 9.
6104
6105 """
6106
6107 sep = spec['thousands_sep']
6108 grouping = spec['grouping']
6109
6110 groups = []
6111 for l in _group_lengths(grouping):
Mark Dickinson277859d2009-03-17 23:03:46 +00006112 if l <= 0:
6113 raise ValueError("group length should be positive")
6114 # max(..., 1) forces at least 1 digit to the left of a separator
6115 l = min(max(len(digits), min_width, 1), l)
6116 groups.append('0'*(l - len(digits)) + digits[-l:])
6117 digits = digits[:-l]
6118 min_width -= l
6119 if not digits and min_width <= 0:
6120 break
Mark Dickinsonb14514a2009-03-18 08:22:51 +00006121 min_width -= len(sep)
Mark Dickinson277859d2009-03-17 23:03:46 +00006122 else:
6123 l = max(len(digits), min_width, 1)
6124 groups.append('0'*(l - len(digits)) + digits[-l:])
6125 return sep.join(reversed(groups))
6126
6127def _format_sign(is_negative, spec):
6128 """Determine sign character."""
6129
6130 if is_negative:
6131 return '-'
6132 elif spec['sign'] in ' +':
6133 return spec['sign']
6134 else:
6135 return ''
6136
6137def _format_number(is_negative, intpart, fracpart, exp, spec):
6138 """Format a number, given the following data:
6139
6140 is_negative: true if the number is negative, else false
6141 intpart: string of digits that must appear before the decimal point
6142 fracpart: string of digits that must come after the point
6143 exp: exponent, as an integer
6144 spec: dictionary resulting from parsing the format specifier
6145
6146 This function uses the information in spec to:
6147 insert separators (decimal separator and thousands separators)
6148 format the sign
6149 format the exponent
6150 add trailing '%' for the '%' type
6151 zero-pad if necessary
6152 fill and align if necessary
6153 """
6154
6155 sign = _format_sign(is_negative, spec)
6156
6157 if fracpart:
6158 fracpart = spec['decimal_point'] + fracpart
6159
6160 if exp != 0 or spec['type'] in 'eE':
6161 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6162 fracpart += "{0}{1:+}".format(echar, exp)
6163 if spec['type'] == '%':
6164 fracpart += '%'
6165
6166 if spec['zeropad']:
6167 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6168 else:
6169 min_width = 0
6170 intpart = _insert_thousands_sep(intpart, spec, min_width)
6171
6172 return _format_align(sign, intpart+fracpart, spec)
6173
6174
Facundo Batista59c58842007-04-10 12:58:45 +00006175##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006176
Facundo Batista59c58842007-04-10 12:58:45 +00006177# Reusable defaults
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006178_Infinity = Decimal('Inf')
6179_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonc5de0962009-01-02 23:07:08 +00006180_NaN = Decimal('NaN')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006181_Zero = Decimal(0)
6182_One = Decimal(1)
6183_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006184
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006185# _SignedInfinity[sign] is infinity w/ that sign
6186_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006187
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006188
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006189
6190if __name__ == '__main__':
6191 import doctest, sys
6192 doctest.testmod(sys.modules[__name__])