blob: a8e4f19999bd6bbdc89b3a8bae687b3737d6faaa [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
1071 if not self:
1072 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001073 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001074 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001075 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001076
1077 if context is None:
1078 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001079 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001080
1081 def __pos__(self, context=None):
1082 """Returns a copy, unless it is a sNaN.
1083
1084 Rounds the number (if more then precision digits)
1085 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001086 if self._is_special:
1087 ans = self._check_nans(context=context)
1088 if ans:
1089 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001090
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001091 if not self:
1092 # + (-0) = 0
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001093 ans = self.copy_abs()
Facundo Batista353750c2007-09-13 18:13:15 +00001094 else:
1095 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001096
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001097 if context is None:
1098 context = getcontext()
Facundo Batistae64acfa2007-12-17 14:18:42 +00001099 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001100
Facundo Batistae64acfa2007-12-17 14:18:42 +00001101 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001102 """Returns the absolute value of self.
1103
Facundo Batistae64acfa2007-12-17 14:18:42 +00001104 If the keyword argument 'round' is false, do not round. The
1105 expression self.__abs__(round=False) is equivalent to
1106 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001107 """
Facundo Batistae64acfa2007-12-17 14:18:42 +00001108 if not round:
1109 return self.copy_abs()
1110
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001111 if self._is_special:
1112 ans = self._check_nans(context=context)
1113 if ans:
1114 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001115
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001116 if self._sign:
1117 ans = self.__neg__(context=context)
1118 else:
1119 ans = self.__pos__(context=context)
1120
1121 return ans
1122
1123 def __add__(self, other, context=None):
1124 """Returns self + other.
1125
1126 -INF + INF (or the reverse) cause InvalidOperation errors.
1127 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001128 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001129 if other is NotImplemented:
1130 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001131
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001132 if context is None:
1133 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001134
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001135 if self._is_special or other._is_special:
1136 ans = self._check_nans(other, context)
1137 if ans:
1138 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001139
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001140 if self._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001141 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001142 if self._sign != other._sign and other._isinfinity():
1143 return context._raise_error(InvalidOperation, '-INF + INF')
1144 return Decimal(self)
1145 if other._isinfinity():
Facundo Batista59c58842007-04-10 12:58:45 +00001146 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001147
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001148 exp = min(self._exp, other._exp)
1149 negativezero = 0
1150 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Facundo Batista59c58842007-04-10 12:58:45 +00001151 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001152 negativezero = 1
1153
1154 if not self and not other:
1155 sign = min(self._sign, other._sign)
1156 if negativezero:
1157 sign = 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00001158 ans = _dec_from_triple(sign, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001159 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001160 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001161 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001162 exp = max(exp, other._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001163 ans = other._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001164 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001165 return ans
1166 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001167 exp = max(exp, self._exp - context.prec-1)
Facundo Batista353750c2007-09-13 18:13:15 +00001168 ans = self._rescale(exp, context.rounding)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001169 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001170 return ans
1171
1172 op1 = _WorkRep(self)
1173 op2 = _WorkRep(other)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001174 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001175
1176 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001177 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001179 if op1.int == op2.int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001180 ans = _dec_from_triple(negativezero, '0', exp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001181 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001182 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001183 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001184 op1, op2 = op2, op1
Facundo Batista59c58842007-04-10 12:58:45 +00001185 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001186 if op1.sign == 1:
1187 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001188 op1.sign, op2.sign = op2.sign, op1.sign
1189 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001190 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001191 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001192 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001193 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001194 op1.sign, op2.sign = (0, 0)
1195 else:
1196 result.sign = 0
Facundo Batista59c58842007-04-10 12:58:45 +00001197 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001198
Raymond Hettinger17931de2004-10-27 06:21:46 +00001199 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001200 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001201 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001202 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001203
1204 result.exp = op1.exp
1205 ans = Decimal(result)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001206 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001207 return ans
1208
1209 __radd__ = __add__
1210
1211 def __sub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001212 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001213 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001214 if other is NotImplemented:
1215 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001216
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001217 if self._is_special or other._is_special:
1218 ans = self._check_nans(other, context=context)
1219 if ans:
1220 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001221
Facundo Batista353750c2007-09-13 18:13:15 +00001222 # self - other is computed as self + other.copy_negate()
1223 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001224
1225 def __rsub__(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00001226 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001227 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001228 if other is NotImplemented:
1229 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001230
Facundo Batista353750c2007-09-13 18:13:15 +00001231 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001232
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233 def __mul__(self, other, context=None):
1234 """Return self * other.
1235
1236 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1237 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001238 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001239 if other is NotImplemented:
1240 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001241
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001242 if context is None:
1243 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001244
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001245 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001246
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001247 if self._is_special or other._is_special:
1248 ans = self._check_nans(other, context)
1249 if ans:
1250 return ans
1251
1252 if self._isinfinity():
1253 if not other:
1254 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001255 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001256
1257 if other._isinfinity():
1258 if not self:
1259 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001260 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001261
1262 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001263
1264 # Special case for multiplying by zero
1265 if not self or not other:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001266 ans = _dec_from_triple(resultsign, '0', resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001267 # Fixing in case the exponent is out of bounds
1268 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001269 return ans
1270
1271 # Special case for multiplying by power of 10
Facundo Batista72bc54f2007-11-23 17:59:00 +00001272 if self._int == '1':
1273 ans = _dec_from_triple(resultsign, other._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001274 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001275 return ans
Facundo Batista72bc54f2007-11-23 17:59:00 +00001276 if other._int == '1':
1277 ans = _dec_from_triple(resultsign, self._int, resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001278 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001279 return ans
1280
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001281 op1 = _WorkRep(self)
1282 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001283
Facundo Batista72bc54f2007-11-23 17:59:00 +00001284 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001285 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001286
1287 return ans
1288 __rmul__ = __mul__
1289
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001290 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001291 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001292 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001293 if other is NotImplemented:
Facundo Batistacce8df22007-09-18 16:53:18 +00001294 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001295
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001296 if context is None:
1297 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001298
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001299 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001300
1301 if self._is_special or other._is_special:
1302 ans = self._check_nans(other, context)
1303 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001304 return ans
1305
1306 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001307 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001308
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001309 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001310 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001311
1312 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001313 context._raise_error(Clamped, 'Division by infinity')
Facundo Batista72bc54f2007-11-23 17:59:00 +00001314 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001315
1316 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001317 if not other:
Facundo Batistacce8df22007-09-18 16:53:18 +00001318 if not self:
1319 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001320 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001321
Facundo Batistacce8df22007-09-18 16:53:18 +00001322 if not self:
1323 exp = self._exp - other._exp
1324 coeff = 0
1325 else:
1326 # OK, so neither = 0, INF or NaN
1327 shift = len(other._int) - len(self._int) + context.prec + 1
1328 exp = self._exp - other._exp - shift
1329 op1 = _WorkRep(self)
1330 op2 = _WorkRep(other)
1331 if shift >= 0:
1332 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1333 else:
1334 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1335 if remainder:
1336 # result is not exact; adjust to ensure correct rounding
1337 if coeff % 5 == 0:
1338 coeff += 1
1339 else:
1340 # result is exact; get as close to ideal exponent as possible
1341 ideal_exp = self._exp - other._exp
1342 while exp < ideal_exp and coeff % 10 == 0:
1343 coeff //= 10
1344 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001345
Facundo Batista72bc54f2007-11-23 17:59:00 +00001346 ans = _dec_from_triple(sign, str(coeff), exp)
Facundo Batistacce8df22007-09-18 16:53:18 +00001347 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001348
Facundo Batistacce8df22007-09-18 16:53:18 +00001349 def _divide(self, other, context):
1350 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001351
Facundo Batistacce8df22007-09-18 16:53:18 +00001352 Assumes that neither self nor other is a NaN, that self is not
1353 infinite and that other is nonzero.
1354 """
1355 sign = self._sign ^ other._sign
1356 if other._isinfinity():
1357 ideal_exp = self._exp
1358 else:
1359 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001360
Facundo Batistacce8df22007-09-18 16:53:18 +00001361 expdiff = self.adjusted() - other.adjusted()
1362 if not self or other._isinfinity() or expdiff <= -2:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001363 return (_dec_from_triple(sign, '0', 0),
Facundo Batistacce8df22007-09-18 16:53:18 +00001364 self._rescale(ideal_exp, context.rounding))
1365 if expdiff <= context.prec:
1366 op1 = _WorkRep(self)
1367 op2 = _WorkRep(other)
1368 if op1.exp >= op2.exp:
1369 op1.int *= 10**(op1.exp - op2.exp)
1370 else:
1371 op2.int *= 10**(op2.exp - op1.exp)
1372 q, r = divmod(op1.int, op2.int)
1373 if q < 10**context.prec:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001374 return (_dec_from_triple(sign, str(q), 0),
1375 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001376
Facundo Batistacce8df22007-09-18 16:53:18 +00001377 # Here the quotient is too large to be representable
1378 ans = context._raise_error(DivisionImpossible,
1379 'quotient too large in //, % or divmod')
1380 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001381
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001382 def __rtruediv__(self, other, context=None):
1383 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001384 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001385 if other is NotImplemented:
1386 return other
Mark Dickinson8aca9d02008-05-04 02:05:06 +00001387 return other.__truediv__(self, context=context)
1388
1389 __div__ = __truediv__
1390 __rdiv__ = __rtruediv__
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001391
1392 def __divmod__(self, other, context=None):
1393 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001394 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001395 """
Facundo Batistacce8df22007-09-18 16:53:18 +00001396 other = _convert_other(other)
1397 if other is NotImplemented:
1398 return other
1399
1400 if context is None:
1401 context = getcontext()
1402
1403 ans = self._check_nans(other, context)
1404 if ans:
1405 return (ans, ans)
1406
1407 sign = self._sign ^ other._sign
1408 if self._isinfinity():
1409 if other._isinfinity():
1410 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1411 return ans, ans
1412 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001413 return (_SignedInfinity[sign],
Facundo Batistacce8df22007-09-18 16:53:18 +00001414 context._raise_error(InvalidOperation, 'INF % x'))
1415
1416 if not other:
1417 if not self:
1418 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1419 return ans, ans
1420 else:
1421 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1422 context._raise_error(InvalidOperation, 'x % 0'))
1423
1424 quotient, remainder = self._divide(other, context)
Facundo Batistae64acfa2007-12-17 14:18:42 +00001425 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001426 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001427
1428 def __rdivmod__(self, other, context=None):
1429 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001430 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001431 if other is NotImplemented:
1432 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001433 return other.__divmod__(self, context=context)
1434
1435 def __mod__(self, other, context=None):
1436 """
1437 self % other
1438 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001439 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001440 if other is NotImplemented:
1441 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001442
Facundo Batistacce8df22007-09-18 16:53:18 +00001443 if context is None:
1444 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001445
Facundo Batistacce8df22007-09-18 16:53:18 +00001446 ans = self._check_nans(other, context)
1447 if ans:
1448 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001449
Facundo Batistacce8df22007-09-18 16:53:18 +00001450 if self._isinfinity():
1451 return context._raise_error(InvalidOperation, 'INF % x')
1452 elif not other:
1453 if self:
1454 return context._raise_error(InvalidOperation, 'x % 0')
1455 else:
1456 return context._raise_error(DivisionUndefined, '0 % 0')
1457
1458 remainder = self._divide(other, context)[1]
Facundo Batistae64acfa2007-12-17 14:18:42 +00001459 remainder = remainder._fix(context)
Facundo Batistacce8df22007-09-18 16:53:18 +00001460 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001461
1462 def __rmod__(self, other, context=None):
1463 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001464 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001465 if other is NotImplemented:
1466 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001467 return other.__mod__(self, context=context)
1468
1469 def remainder_near(self, other, context=None):
1470 """
1471 Remainder nearest to 0- abs(remainder-near) <= other/2
1472 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001473 if context is None:
1474 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001475
Facundo Batista353750c2007-09-13 18:13:15 +00001476 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001477
Facundo Batista353750c2007-09-13 18:13:15 +00001478 ans = self._check_nans(other, context)
1479 if ans:
1480 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001481
Facundo Batista353750c2007-09-13 18:13:15 +00001482 # self == +/-infinity -> InvalidOperation
1483 if self._isinfinity():
1484 return context._raise_error(InvalidOperation,
1485 'remainder_near(infinity, x)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001486
Facundo Batista353750c2007-09-13 18:13:15 +00001487 # other == 0 -> either InvalidOperation or DivisionUndefined
1488 if not other:
1489 if self:
1490 return context._raise_error(InvalidOperation,
1491 'remainder_near(x, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001492 else:
Facundo Batista353750c2007-09-13 18:13:15 +00001493 return context._raise_error(DivisionUndefined,
1494 'remainder_near(0, 0)')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001495
Facundo Batista353750c2007-09-13 18:13:15 +00001496 # other = +/-infinity -> remainder = self
1497 if other._isinfinity():
1498 ans = Decimal(self)
1499 return ans._fix(context)
1500
1501 # self = 0 -> remainder = self, with ideal exponent
1502 ideal_exponent = min(self._exp, other._exp)
1503 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001504 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001505 return ans._fix(context)
1506
1507 # catch most cases of large or small quotient
1508 expdiff = self.adjusted() - other.adjusted()
1509 if expdiff >= context.prec + 1:
1510 # expdiff >= prec+1 => abs(self/other) > 10**prec
Facundo Batistacce8df22007-09-18 16:53:18 +00001511 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001512 if expdiff <= -2:
1513 # expdiff <= -2 => abs(self/other) < 0.1
1514 ans = self._rescale(ideal_exponent, context.rounding)
1515 return ans._fix(context)
1516
1517 # adjust both arguments to have the same exponent, then divide
1518 op1 = _WorkRep(self)
1519 op2 = _WorkRep(other)
1520 if op1.exp >= op2.exp:
1521 op1.int *= 10**(op1.exp - op2.exp)
1522 else:
1523 op2.int *= 10**(op2.exp - op1.exp)
1524 q, r = divmod(op1.int, op2.int)
1525 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1526 # 10**ideal_exponent. Apply correction to ensure that
1527 # abs(remainder) <= abs(other)/2
1528 if 2*r + (q&1) > op2.int:
1529 r -= op2.int
1530 q += 1
1531
1532 if q >= 10**context.prec:
Facundo Batistacce8df22007-09-18 16:53:18 +00001533 return context._raise_error(DivisionImpossible)
Facundo Batista353750c2007-09-13 18:13:15 +00001534
1535 # result has same sign as self unless r is negative
1536 sign = self._sign
1537 if r < 0:
1538 sign = 1-sign
1539 r = -r
1540
Facundo Batista72bc54f2007-11-23 17:59:00 +00001541 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Facundo Batista353750c2007-09-13 18:13:15 +00001542 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001543
1544 def __floordiv__(self, other, context=None):
1545 """self // other"""
Facundo Batistacce8df22007-09-18 16:53:18 +00001546 other = _convert_other(other)
1547 if other is NotImplemented:
1548 return other
1549
1550 if context is None:
1551 context = getcontext()
1552
1553 ans = self._check_nans(other, context)
1554 if ans:
1555 return ans
1556
1557 if self._isinfinity():
1558 if other._isinfinity():
1559 return context._raise_error(InvalidOperation, 'INF // INF')
1560 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001561 return _SignedInfinity[self._sign ^ other._sign]
Facundo Batistacce8df22007-09-18 16:53:18 +00001562
1563 if not other:
1564 if self:
1565 return context._raise_error(DivisionByZero, 'x // 0',
1566 self._sign ^ other._sign)
1567 else:
1568 return context._raise_error(DivisionUndefined, '0 // 0')
1569
1570 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001571
1572 def __rfloordiv__(self, other, context=None):
1573 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001574 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001575 if other is NotImplemented:
1576 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001577 return other.__floordiv__(self, context=context)
1578
1579 def __float__(self):
1580 """Float representation."""
1581 return float(str(self))
1582
1583 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001584 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001585 if self._is_special:
1586 if self._isnan():
Mark Dickinson968f1692009-09-07 18:04:58 +00001587 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001588 elif self._isinfinity():
Mark Dickinson968f1692009-09-07 18:04:58 +00001589 raise OverflowError("Cannot convert infinity to integer")
Facundo Batista353750c2007-09-13 18:13:15 +00001590 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001591 if self._exp >= 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001592 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001593 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001594 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001595
Raymond Hettinger5a053642008-01-24 19:05:29 +00001596 __trunc__ = __int__
1597
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001598 def real(self):
1599 return self
Mark Dickinson65808ff2009-01-04 21:22:02 +00001600 real = property(real)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001601
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001602 def imag(self):
1603 return Decimal(0)
Mark Dickinson65808ff2009-01-04 21:22:02 +00001604 imag = property(imag)
Raymond Hettinger116f72f2008-02-12 01:18:03 +00001605
1606 def conjugate(self):
1607 return self
1608
1609 def __complex__(self):
1610 return complex(float(self))
1611
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001612 def __long__(self):
1613 """Converts to a long.
1614
1615 Equivalent to long(int(self))
1616 """
1617 return long(self.__int__())
1618
Facundo Batista353750c2007-09-13 18:13:15 +00001619 def _fix_nan(self, context):
1620 """Decapitate the payload of a NaN to fit the context"""
1621 payload = self._int
1622
1623 # maximum length of payload is precision if _clamp=0,
1624 # precision-1 if _clamp=1.
1625 max_payload_len = context.prec - context._clamp
1626 if len(payload) > max_payload_len:
Facundo Batista72bc54f2007-11-23 17:59:00 +00001627 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1628 return _dec_from_triple(self._sign, payload, self._exp, True)
Facundo Batista6c398da2007-09-17 17:30:13 +00001629 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001630
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001631 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001632 """Round if it is necessary to keep self within prec precision.
1633
1634 Rounds and fixes the exponent. Does not raise on a sNaN.
1635
1636 Arguments:
1637 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001638 context - context used.
1639 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001640
Facundo Batista353750c2007-09-13 18:13:15 +00001641 if self._is_special:
1642 if self._isnan():
1643 # decapitate payload if necessary
1644 return self._fix_nan(context)
1645 else:
1646 # self is +/-Infinity; return unaltered
Facundo Batista6c398da2007-09-17 17:30:13 +00001647 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001648
Facundo Batista353750c2007-09-13 18:13:15 +00001649 # if self is zero then exponent should be between Etiny and
1650 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1651 Etiny = context.Etiny()
1652 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001653 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00001654 exp_max = [context.Emax, Etop][context._clamp]
1655 new_exp = min(max(self._exp, Etiny), exp_max)
1656 if new_exp != self._exp:
1657 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001658 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001659 else:
Facundo Batista6c398da2007-09-17 17:30:13 +00001660 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00001661
1662 # exp_min is the smallest allowable exponent of the result,
1663 # equal to max(self.adjusted()-context.prec+1, Etiny)
1664 exp_min = len(self._int) + self._exp - context.prec
1665 if exp_min > Etop:
1666 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001667 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00001668 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001669 context._raise_error(Rounded)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001670 return ans
1671
Facundo Batista353750c2007-09-13 18:13:15 +00001672 self_is_subnormal = exp_min < Etiny
1673 if self_is_subnormal:
Facundo Batista353750c2007-09-13 18:13:15 +00001674 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001675
Facundo Batista353750c2007-09-13 18:13:15 +00001676 # round if self has too many digits
1677 if self._exp < exp_min:
Facundo Batista2ec74152007-12-03 17:55:00 +00001678 digits = len(self._int) + self._exp - exp_min
1679 if digits < 0:
1680 self = _dec_from_triple(self._sign, '1', exp_min-1)
1681 digits = 0
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001682 rounding_method = self._pick_rounding_function[context.rounding]
1683 changed = getattr(self, rounding_method)(digits)
Facundo Batista2ec74152007-12-03 17:55:00 +00001684 coeff = self._int[:digits] or '0'
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001685 if changed > 0:
Facundo Batista2ec74152007-12-03 17:55:00 +00001686 coeff = str(int(coeff)+1)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001687 if len(coeff) > context.prec:
1688 coeff = coeff[:-1]
1689 exp_min += 1
Facundo Batista2ec74152007-12-03 17:55:00 +00001690
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001691 # check whether the rounding pushed the exponent out of range
1692 if exp_min > Etop:
1693 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1694 else:
1695 ans = _dec_from_triple(self._sign, coeff, exp_min)
1696
1697 # raise the appropriate signals, taking care to respect
1698 # the precedence described in the specification
1699 if changed and self_is_subnormal:
1700 context._raise_error(Underflow)
1701 if self_is_subnormal:
1702 context._raise_error(Subnormal)
Facundo Batista2ec74152007-12-03 17:55:00 +00001703 if changed:
Facundo Batista353750c2007-09-13 18:13:15 +00001704 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001705 context._raise_error(Rounded)
1706 if not ans:
1707 # raise Clamped on underflow to 0
1708 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001709 return ans
1710
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00001711 if self_is_subnormal:
1712 context._raise_error(Subnormal)
1713
Facundo Batista353750c2007-09-13 18:13:15 +00001714 # fold down if _clamp == 1 and self has too few digits
1715 if context._clamp == 1 and self._exp > Etop:
1716 context._raise_error(Clamped)
Facundo Batista72bc54f2007-11-23 17:59:00 +00001717 self_padded = self._int + '0'*(self._exp - Etop)
1718 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001719
Facundo Batista353750c2007-09-13 18:13:15 +00001720 # here self was representable to begin with; return unchanged
Facundo Batista6c398da2007-09-17 17:30:13 +00001721 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001722
1723 _pick_rounding_function = {}
1724
Facundo Batista353750c2007-09-13 18:13:15 +00001725 # for each of the rounding functions below:
1726 # self is a finite, nonzero Decimal
1727 # prec is an integer satisfying 0 <= prec < len(self._int)
Facundo Batista2ec74152007-12-03 17:55:00 +00001728 #
1729 # each function returns either -1, 0, or 1, as follows:
1730 # 1 indicates that self should be rounded up (away from zero)
1731 # 0 indicates that self should be truncated, and that all the
1732 # digits to be truncated are zeros (so the value is unchanged)
1733 # -1 indicates that there are nonzero digits to be truncated
Facundo Batista353750c2007-09-13 18:13:15 +00001734
1735 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001736 """Also known as round-towards-0, truncate."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001737 if _all_zeros(self._int, prec):
1738 return 0
1739 else:
1740 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001741
Facundo Batista353750c2007-09-13 18:13:15 +00001742 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001743 """Rounds away from 0."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001744 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001745
Facundo Batista353750c2007-09-13 18:13:15 +00001746 def _round_half_up(self, prec):
1747 """Rounds 5 up (away from 0)"""
Facundo Batista72bc54f2007-11-23 17:59:00 +00001748 if self._int[prec] in '56789':
Facundo Batista2ec74152007-12-03 17:55:00 +00001749 return 1
1750 elif _all_zeros(self._int, prec):
1751 return 0
Facundo Batista353750c2007-09-13 18:13:15 +00001752 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001753 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001754
1755 def _round_half_down(self, prec):
1756 """Round 5 down"""
Facundo Batista2ec74152007-12-03 17:55:00 +00001757 if _exact_half(self._int, prec):
1758 return -1
1759 else:
1760 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001761
1762 def _round_half_even(self, prec):
1763 """Round 5 to even, rest to nearest."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001764 if _exact_half(self._int, prec) and \
1765 (prec == 0 or self._int[prec-1] in '02468'):
1766 return -1
Facundo Batista353750c2007-09-13 18:13:15 +00001767 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001768 return self._round_half_up(prec)
Facundo Batista353750c2007-09-13 18:13:15 +00001769
1770 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001771 """Rounds up (not away from 0 if negative.)"""
1772 if self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001773 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001774 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001775 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001776
Facundo Batista353750c2007-09-13 18:13:15 +00001777 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001778 """Rounds down (not towards 0 if negative)"""
1779 if not self._sign:
Facundo Batista353750c2007-09-13 18:13:15 +00001780 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001781 else:
Facundo Batista2ec74152007-12-03 17:55:00 +00001782 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001783
Facundo Batista353750c2007-09-13 18:13:15 +00001784 def _round_05up(self, prec):
1785 """Round down unless digit prec-1 is 0 or 5."""
Facundo Batista2ec74152007-12-03 17:55:00 +00001786 if prec and self._int[prec-1] not in '05':
Facundo Batista353750c2007-09-13 18:13:15 +00001787 return self._round_down(prec)
Facundo Batista2ec74152007-12-03 17:55:00 +00001788 else:
1789 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001790
Facundo Batista353750c2007-09-13 18:13:15 +00001791 def fma(self, other, third, context=None):
1792 """Fused multiply-add.
1793
1794 Returns self*other+third with no rounding of the intermediate
1795 product self*other.
1796
1797 self and other are multiplied together, with no rounding of
1798 the result. The third operand is then added to the result,
1799 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001800 """
Facundo Batista353750c2007-09-13 18:13:15 +00001801
1802 other = _convert_other(other, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001803
1804 # compute product; raise InvalidOperation if either operand is
1805 # a signaling NaN or if the product is zero times infinity.
1806 if self._is_special or other._is_special:
1807 if context is None:
1808 context = getcontext()
1809 if self._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001810 return context._raise_error(InvalidOperation, 'sNaN', self)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001811 if other._exp == 'N':
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001812 return context._raise_error(InvalidOperation, 'sNaN', other)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001813 if self._exp == 'n':
1814 product = self
1815 elif other._exp == 'n':
1816 product = other
1817 elif self._exp == 'F':
1818 if not other:
1819 return context._raise_error(InvalidOperation,
1820 'INF * 0 in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001821 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001822 elif other._exp == 'F':
1823 if not self:
1824 return context._raise_error(InvalidOperation,
1825 '0 * INF in fma')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00001826 product = _SignedInfinity[self._sign ^ other._sign]
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001827 else:
1828 product = _dec_from_triple(self._sign ^ other._sign,
1829 str(int(self._int) * int(other._int)),
1830 self._exp + other._exp)
1831
Facundo Batista353750c2007-09-13 18:13:15 +00001832 third = _convert_other(third, raiseit=True)
Facundo Batista58f6f2e2007-12-04 16:31:53 +00001833 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001834
Facundo Batista353750c2007-09-13 18:13:15 +00001835 def _power_modulo(self, other, modulo, context=None):
1836 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001837
Facundo Batista353750c2007-09-13 18:13:15 +00001838 # if can't convert other and modulo to Decimal, raise
1839 # TypeError; there's no point returning NotImplemented (no
1840 # equivalent of __rpow__ for three argument pow)
1841 other = _convert_other(other, raiseit=True)
1842 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001843
Facundo Batista353750c2007-09-13 18:13:15 +00001844 if context is None:
1845 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001846
Facundo Batista353750c2007-09-13 18:13:15 +00001847 # deal with NaNs: if there are any sNaNs then first one wins,
1848 # (i.e. behaviour for NaNs is identical to that of fma)
1849 self_is_nan = self._isnan()
1850 other_is_nan = other._isnan()
1851 modulo_is_nan = modulo._isnan()
1852 if self_is_nan or other_is_nan or modulo_is_nan:
1853 if self_is_nan == 2:
1854 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001855 self)
Facundo Batista353750c2007-09-13 18:13:15 +00001856 if other_is_nan == 2:
1857 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001858 other)
Facundo Batista353750c2007-09-13 18:13:15 +00001859 if modulo_is_nan == 2:
1860 return context._raise_error(InvalidOperation, 'sNaN',
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00001861 modulo)
Facundo Batista353750c2007-09-13 18:13:15 +00001862 if self_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001863 return self._fix_nan(context)
Facundo Batista353750c2007-09-13 18:13:15 +00001864 if other_is_nan:
Facundo Batista6c398da2007-09-17 17:30:13 +00001865 return other._fix_nan(context)
1866 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001867
Facundo Batista353750c2007-09-13 18:13:15 +00001868 # check inputs: we apply same restrictions as Python's pow()
1869 if not (self._isinteger() and
1870 other._isinteger() and
1871 modulo._isinteger()):
1872 return context._raise_error(InvalidOperation,
1873 'pow() 3rd argument not allowed '
1874 'unless all arguments are integers')
1875 if other < 0:
1876 return context._raise_error(InvalidOperation,
1877 'pow() 2nd argument cannot be '
1878 'negative when 3rd argument specified')
1879 if not modulo:
1880 return context._raise_error(InvalidOperation,
1881 'pow() 3rd argument cannot be 0')
1882
1883 # additional restriction for decimal: the modulus must be less
1884 # than 10**prec in absolute value
1885 if modulo.adjusted() >= context.prec:
1886 return context._raise_error(InvalidOperation,
1887 'insufficient precision: pow() 3rd '
1888 'argument must not have more than '
1889 'precision digits')
1890
1891 # define 0**0 == NaN, for consistency with two-argument pow
1892 # (even though it hurts!)
1893 if not other and not self:
1894 return context._raise_error(InvalidOperation,
1895 'at least one of pow() 1st argument '
1896 'and 2nd argument must be nonzero ;'
1897 '0**0 is not defined')
1898
1899 # compute sign of result
1900 if other._iseven():
1901 sign = 0
1902 else:
1903 sign = self._sign
1904
1905 # convert modulo to a Python integer, and self and other to
1906 # Decimal integers (i.e. force their exponents to be >= 0)
1907 modulo = abs(int(modulo))
1908 base = _WorkRep(self.to_integral_value())
1909 exponent = _WorkRep(other.to_integral_value())
1910
1911 # compute result using integer pow()
1912 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1913 for i in xrange(exponent.exp):
1914 base = pow(base, 10, modulo)
1915 base = pow(base, exponent.int, modulo)
1916
Facundo Batista72bc54f2007-11-23 17:59:00 +00001917 return _dec_from_triple(sign, str(base), 0)
Facundo Batista353750c2007-09-13 18:13:15 +00001918
1919 def _power_exact(self, other, p):
1920 """Attempt to compute self**other exactly.
1921
1922 Given Decimals self and other and an integer p, attempt to
1923 compute an exact result for the power self**other, with p
1924 digits of precision. Return None if self**other is not
1925 exactly representable in p digits.
1926
1927 Assumes that elimination of special cases has already been
1928 performed: self and other must both be nonspecial; self must
1929 be positive and not numerically equal to 1; other must be
1930 nonzero. For efficiency, other._exp should not be too large,
1931 so that 10**abs(other._exp) is a feasible calculation."""
1932
1933 # In the comments below, we write x for the value of self and
1934 # y for the value of other. Write x = xc*10**xe and y =
1935 # yc*10**ye.
1936
1937 # The main purpose of this method is to identify the *failure*
1938 # of x**y to be exactly representable with as little effort as
1939 # possible. So we look for cheap and easy tests that
1940 # eliminate the possibility of x**y being exact. Only if all
1941 # these tests are passed do we go on to actually compute x**y.
1942
1943 # Here's the main idea. First normalize both x and y. We
1944 # express y as a rational m/n, with m and n relatively prime
1945 # and n>0. Then for x**y to be exactly representable (at
1946 # *any* precision), xc must be the nth power of a positive
1947 # integer and xe must be divisible by n. If m is negative
1948 # then additionally xc must be a power of either 2 or 5, hence
1949 # a power of 2**n or 5**n.
1950 #
1951 # There's a limit to how small |y| can be: if y=m/n as above
1952 # then:
1953 #
1954 # (1) if xc != 1 then for the result to be representable we
1955 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
1956 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
1957 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
1958 # representable.
1959 #
1960 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
1961 # |y| < 1/|xe| then the result is not representable.
1962 #
1963 # Note that since x is not equal to 1, at least one of (1) and
1964 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
1965 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
1966 #
1967 # There's also a limit to how large y can be, at least if it's
1968 # positive: the normalized result will have coefficient xc**y,
1969 # so if it's representable then xc**y < 10**p, and y <
1970 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
1971 # not exactly representable.
1972
1973 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
1974 # so |y| < 1/xe and the result is not representable.
1975 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
1976 # < 1/nbits(xc).
1977
1978 x = _WorkRep(self)
1979 xc, xe = x.int, x.exp
1980 while xc % 10 == 0:
1981 xc //= 10
1982 xe += 1
1983
1984 y = _WorkRep(other)
1985 yc, ye = y.int, y.exp
1986 while yc % 10 == 0:
1987 yc //= 10
1988 ye += 1
1989
1990 # case where xc == 1: result is 10**(xe*y), with xe*y
1991 # required to be an integer
1992 if xc == 1:
1993 if ye >= 0:
1994 exponent = xe*yc*10**ye
1995 else:
1996 exponent, remainder = divmod(xe*yc, 10**-ye)
1997 if remainder:
1998 return None
1999 if y.sign == 1:
2000 exponent = -exponent
2001 # if other is a nonnegative integer, use ideal exponent
2002 if other._isinteger() and other._sign == 0:
2003 ideal_exponent = self._exp*int(other)
2004 zeros = min(exponent-ideal_exponent, p-1)
2005 else:
2006 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002007 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002008
2009 # case where y is negative: xc must be either a power
2010 # of 2 or a power of 5.
2011 if y.sign == 1:
2012 last_digit = xc % 10
2013 if last_digit in (2,4,6,8):
2014 # quick test for power of 2
2015 if xc & -xc != xc:
2016 return None
2017 # now xc is a power of 2; e is its exponent
2018 e = _nbits(xc)-1
2019 # find e*y and xe*y; both must be integers
2020 if ye >= 0:
2021 y_as_int = yc*10**ye
2022 e = e*y_as_int
2023 xe = xe*y_as_int
2024 else:
2025 ten_pow = 10**-ye
2026 e, remainder = divmod(e*yc, ten_pow)
2027 if remainder:
2028 return None
2029 xe, remainder = divmod(xe*yc, ten_pow)
2030 if remainder:
2031 return None
2032
2033 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2034 return None
2035 xc = 5**e
2036
2037 elif last_digit == 5:
2038 # e >= log_5(xc) if xc is a power of 5; we have
2039 # equality all the way up to xc=5**2658
2040 e = _nbits(xc)*28//65
2041 xc, remainder = divmod(5**e, xc)
2042 if remainder:
2043 return None
2044 while xc % 5 == 0:
2045 xc //= 5
2046 e -= 1
2047 if ye >= 0:
2048 y_as_integer = yc*10**ye
2049 e = e*y_as_integer
2050 xe = xe*y_as_integer
2051 else:
2052 ten_pow = 10**-ye
2053 e, remainder = divmod(e*yc, ten_pow)
2054 if remainder:
2055 return None
2056 xe, remainder = divmod(xe*yc, ten_pow)
2057 if remainder:
2058 return None
2059 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2060 return None
2061 xc = 2**e
2062 else:
2063 return None
2064
2065 if xc >= 10**p:
2066 return None
2067 xe = -e-xe
Facundo Batista72bc54f2007-11-23 17:59:00 +00002068 return _dec_from_triple(0, str(xc), xe)
Facundo Batista353750c2007-09-13 18:13:15 +00002069
2070 # now y is positive; find m and n such that y = m/n
2071 if ye >= 0:
2072 m, n = yc*10**ye, 1
2073 else:
2074 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2075 return None
2076 xc_bits = _nbits(xc)
2077 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2078 return None
2079 m, n = yc, 10**(-ye)
2080 while m % 2 == n % 2 == 0:
2081 m //= 2
2082 n //= 2
2083 while m % 5 == n % 5 == 0:
2084 m //= 5
2085 n //= 5
2086
2087 # compute nth root of xc*10**xe
2088 if n > 1:
2089 # if 1 < xc < 2**n then xc isn't an nth power
2090 if xc != 1 and xc_bits <= n:
2091 return None
2092
2093 xe, rem = divmod(xe, n)
2094 if rem != 0:
2095 return None
2096
2097 # compute nth root of xc using Newton's method
2098 a = 1L << -(-_nbits(xc)//n) # initial estimate
2099 while True:
2100 q, r = divmod(xc, a**(n-1))
2101 if a <= q:
2102 break
2103 else:
2104 a = (a*(n-1) + q)//n
2105 if not (a == q and r == 0):
2106 return None
2107 xc = a
2108
2109 # now xc*10**xe is the nth root of the original xc*10**xe
2110 # compute mth power of xc*10**xe
2111
2112 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2113 # 10**p and the result is not representable.
2114 if xc > 1 and m > p*100//_log10_lb(xc):
2115 return None
2116 xc = xc**m
2117 xe *= m
2118 if xc > 10**p:
2119 return None
2120
2121 # by this point the result *is* exactly representable
2122 # adjust the exponent to get as close as possible to the ideal
2123 # exponent, if necessary
2124 str_xc = str(xc)
2125 if other._isinteger() and other._sign == 0:
2126 ideal_exponent = self._exp*int(other)
2127 zeros = min(xe-ideal_exponent, p-len(str_xc))
2128 else:
2129 zeros = 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002130 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Facundo Batista353750c2007-09-13 18:13:15 +00002131
2132 def __pow__(self, other, modulo=None, context=None):
2133 """Return self ** other [ % modulo].
2134
2135 With two arguments, compute self**other.
2136
2137 With three arguments, compute (self**other) % modulo. For the
2138 three argument form, the following restrictions on the
2139 arguments hold:
2140
2141 - all three arguments must be integral
2142 - other must be nonnegative
2143 - either self or other (or both) must be nonzero
2144 - modulo must be nonzero and must have at most p digits,
2145 where p is the context precision.
2146
2147 If any of these restrictions is violated the InvalidOperation
2148 flag is raised.
2149
2150 The result of pow(self, other, modulo) is identical to the
2151 result that would be obtained by computing (self**other) %
2152 modulo with unbounded precision, but is computed more
2153 efficiently. It is always exact.
2154 """
2155
2156 if modulo is not None:
2157 return self._power_modulo(other, modulo, context)
2158
2159 other = _convert_other(other)
2160 if other is NotImplemented:
2161 return other
2162
2163 if context is None:
2164 context = getcontext()
2165
2166 # either argument is a NaN => result is NaN
2167 ans = self._check_nans(other, context)
2168 if ans:
2169 return ans
2170
2171 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2172 if not other:
2173 if not self:
2174 return context._raise_error(InvalidOperation, '0 ** 0')
2175 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002176 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002177
2178 # result has sign 1 iff self._sign is 1 and other is an odd integer
2179 result_sign = 0
2180 if self._sign == 1:
2181 if other._isinteger():
2182 if not other._iseven():
2183 result_sign = 1
2184 else:
2185 # -ve**noninteger = NaN
2186 # (-0)**noninteger = 0**noninteger
2187 if self:
2188 return context._raise_error(InvalidOperation,
2189 'x ** y with x negative and y not an integer')
2190 # negate self, without doing any unwanted rounding
Facundo Batista72bc54f2007-11-23 17:59:00 +00002191 self = self.copy_negate()
Facundo Batista353750c2007-09-13 18:13:15 +00002192
2193 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2194 if not self:
2195 if other._sign == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002196 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002197 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002198 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002199
2200 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002201 if self._isinfinity():
Facundo Batista353750c2007-09-13 18:13:15 +00002202 if other._sign == 0:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002203 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002204 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002205 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002206
Facundo Batista353750c2007-09-13 18:13:15 +00002207 # 1**other = 1, but the choice of exponent and the flags
2208 # depend on the exponent of self, and on whether other is a
2209 # positive integer, a negative integer, or neither
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002210 if self == _One:
Facundo Batista353750c2007-09-13 18:13:15 +00002211 if other._isinteger():
2212 # exp = max(self._exp*max(int(other), 0),
2213 # 1-context.prec) but evaluating int(other) directly
2214 # is dangerous until we know other is small (other
2215 # could be 1e999999999)
2216 if other._sign == 1:
2217 multiplier = 0
2218 elif other > context.prec:
2219 multiplier = context.prec
2220 else:
2221 multiplier = int(other)
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002222
Facundo Batista353750c2007-09-13 18:13:15 +00002223 exp = self._exp * multiplier
2224 if exp < 1-context.prec:
2225 exp = 1-context.prec
2226 context._raise_error(Rounded)
2227 else:
2228 context._raise_error(Inexact)
2229 context._raise_error(Rounded)
2230 exp = 1-context.prec
2231
Facundo Batista72bc54f2007-11-23 17:59:00 +00002232 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002233
2234 # compute adjusted exponent of self
2235 self_adj = self.adjusted()
2236
2237 # self ** infinity is infinity if self > 1, 0 if self < 1
2238 # self ** -infinity is infinity if self < 1, 0 if self > 1
2239 if other._isinfinity():
2240 if (other._sign == 0) == (self_adj < 0):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002241 return _dec_from_triple(result_sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002242 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002243 return _SignedInfinity[result_sign]
Facundo Batista353750c2007-09-13 18:13:15 +00002244
2245 # from here on, the result always goes through the call
2246 # to _fix at the end of this function.
2247 ans = None
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002248 exact = False
Facundo Batista353750c2007-09-13 18:13:15 +00002249
2250 # crude test to catch cases of extreme overflow/underflow. If
2251 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2252 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2253 # self**other >= 10**(Emax+1), so overflow occurs. The test
2254 # for underflow is similar.
2255 bound = self._log10_exp_bound() + other.adjusted()
2256 if (self_adj >= 0) == (other._sign == 0):
2257 # self > 1 and other +ve, or self < 1 and other -ve
2258 # possibility of overflow
2259 if bound >= len(str(context.Emax)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002260 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002261 else:
2262 # self > 1 and other -ve, or self < 1 and other +ve
2263 # possibility of underflow to 0
2264 Etiny = context.Etiny()
2265 if bound >= len(str(-Etiny)):
Facundo Batista72bc54f2007-11-23 17:59:00 +00002266 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002267
2268 # try for an exact result with precision +1
2269 if ans is None:
2270 ans = self._power_exact(other, context.prec + 1)
2271 if ans is not None and result_sign == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002272 ans = _dec_from_triple(1, ans._int, ans._exp)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002273 exact = True
Facundo Batista353750c2007-09-13 18:13:15 +00002274
2275 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2276 if ans is None:
2277 p = context.prec
2278 x = _WorkRep(self)
2279 xc, xe = x.int, x.exp
2280 y = _WorkRep(other)
2281 yc, ye = y.int, y.exp
2282 if y.sign == 1:
2283 yc = -yc
2284
2285 # compute correctly rounded result: start with precision +3,
2286 # then increase precision until result is unambiguously roundable
2287 extra = 3
2288 while True:
2289 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2290 if coeff % (5*10**(len(str(coeff))-p-1)):
2291 break
2292 extra += 3
2293
Facundo Batista72bc54f2007-11-23 17:59:00 +00002294 ans = _dec_from_triple(result_sign, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002295
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002296 # unlike exp, ln and log10, the power function respects the
2297 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2298
2299 # There's a difficulty here when 'other' is not an integer and
2300 # the result is exact. In this case, the specification
2301 # requires that the Inexact flag be raised (in spite of
2302 # exactness), but since the result is exact _fix won't do this
2303 # for us. (Correspondingly, the Underflow signal should also
2304 # be raised for subnormal results.) We can't directly raise
2305 # these signals either before or after calling _fix, since
2306 # that would violate the precedence for signals. So we wrap
2307 # the ._fix call in a temporary context, and reraise
2308 # afterwards.
2309 if exact and not other._isinteger():
2310 # pad with zeros up to length context.prec+1 if necessary; this
2311 # ensures that the Rounded signal will be raised.
Facundo Batista353750c2007-09-13 18:13:15 +00002312 if len(ans._int) <= context.prec:
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002313 expdiff = context.prec + 1 - len(ans._int)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002314 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2315 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002316
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002317 # create a copy of the current context, with cleared flags/traps
2318 newcontext = context.copy()
2319 newcontext.clear_flags()
2320 for exception in _signals:
2321 newcontext.traps[exception] = 0
2322
2323 # round in the new context
2324 ans = ans._fix(newcontext)
2325
2326 # raise Inexact, and if necessary, Underflow
2327 newcontext._raise_error(Inexact)
2328 if newcontext.flags[Subnormal]:
2329 newcontext._raise_error(Underflow)
2330
2331 # propagate signals to the original context; _fix could
2332 # have raised any of Overflow, Underflow, Subnormal,
2333 # Inexact, Rounded, Clamped. Overflow needs the correct
2334 # arguments. Note that the order of the exceptions is
2335 # important here.
2336 if newcontext.flags[Overflow]:
2337 context._raise_error(Overflow, 'above Emax', ans._sign)
2338 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2339 if newcontext.flags[exception]:
2340 context._raise_error(exception)
2341
2342 else:
2343 ans = ans._fix(context)
2344
Facundo Batista353750c2007-09-13 18:13:15 +00002345 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002346
2347 def __rpow__(self, other, context=None):
2348 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002349 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002350 if other is NotImplemented:
2351 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002352 return other.__pow__(self, context=context)
2353
2354 def normalize(self, context=None):
2355 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002356
Facundo Batista353750c2007-09-13 18:13:15 +00002357 if context is None:
2358 context = getcontext()
2359
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002360 if self._is_special:
2361 ans = self._check_nans(context=context)
2362 if ans:
2363 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002364
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002365 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002366 if dup._isinfinity():
2367 return dup
2368
2369 if not dup:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002370 return _dec_from_triple(dup._sign, '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00002371 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002372 end = len(dup._int)
2373 exp = dup._exp
Facundo Batista72bc54f2007-11-23 17:59:00 +00002374 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002375 exp += 1
2376 end -= 1
Facundo Batista72bc54f2007-11-23 17:59:00 +00002377 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002378
Facundo Batistabd2fe832007-09-13 18:42:09 +00002379 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002380 """Quantize self so its exponent is the same as that of exp.
2381
2382 Similar to self._rescale(exp._exp) but with error checking.
2383 """
Facundo Batistabd2fe832007-09-13 18:42:09 +00002384 exp = _convert_other(exp, raiseit=True)
2385
Facundo Batista353750c2007-09-13 18:13:15 +00002386 if context is None:
2387 context = getcontext()
2388 if rounding is None:
2389 rounding = context.rounding
2390
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002391 if self._is_special or exp._is_special:
2392 ans = self._check_nans(exp, context)
2393 if ans:
2394 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002395
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002396 if exp._isinfinity() or self._isinfinity():
2397 if exp._isinfinity() and self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00002398 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002399 return context._raise_error(InvalidOperation,
2400 'quantize with one INF')
Facundo Batista353750c2007-09-13 18:13:15 +00002401
Facundo Batistabd2fe832007-09-13 18:42:09 +00002402 # if we're not watching exponents, do a simple rescale
2403 if not watchexp:
2404 ans = self._rescale(exp._exp, rounding)
2405 # raise Inexact and Rounded where appropriate
2406 if ans._exp > self._exp:
2407 context._raise_error(Rounded)
2408 if ans != self:
2409 context._raise_error(Inexact)
2410 return ans
2411
Facundo Batista353750c2007-09-13 18:13:15 +00002412 # exp._exp should be between Etiny and Emax
2413 if not (context.Etiny() <= exp._exp <= context.Emax):
2414 return context._raise_error(InvalidOperation,
2415 'target exponent out of bounds in quantize')
2416
2417 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002418 ans = _dec_from_triple(self._sign, '0', exp._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002419 return ans._fix(context)
2420
2421 self_adjusted = self.adjusted()
2422 if self_adjusted > context.Emax:
2423 return context._raise_error(InvalidOperation,
2424 'exponent of quantize result too large for current context')
2425 if self_adjusted - exp._exp + 1 > context.prec:
2426 return context._raise_error(InvalidOperation,
2427 'quantize result has too many digits for current context')
2428
2429 ans = self._rescale(exp._exp, rounding)
2430 if ans.adjusted() > context.Emax:
2431 return context._raise_error(InvalidOperation,
2432 'exponent of quantize result too large for current context')
2433 if len(ans._int) > context.prec:
2434 return context._raise_error(InvalidOperation,
2435 'quantize result has too many digits for current context')
2436
2437 # raise appropriate flags
Facundo Batista353750c2007-09-13 18:13:15 +00002438 if ans and ans.adjusted() < context.Emin:
2439 context._raise_error(Subnormal)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002440 if ans._exp > self._exp:
2441 if ans != self:
2442 context._raise_error(Inexact)
2443 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00002444
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002445 # call to fix takes care of any necessary folddown, and
2446 # signals Clamped if necessary
Facundo Batista353750c2007-09-13 18:13:15 +00002447 ans = ans._fix(context)
2448 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002449
2450 def same_quantum(self, other):
Facundo Batista1a191df2007-10-02 17:01:24 +00002451 """Return True if self and other have the same exponent; otherwise
2452 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002453
Facundo Batista1a191df2007-10-02 17:01:24 +00002454 If either operand is a special value, the following rules are used:
2455 * return True if both operands are infinities
2456 * return True if both operands are NaNs
2457 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002458 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002459 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002460 if self._is_special or other._is_special:
Facundo Batista1a191df2007-10-02 17:01:24 +00002461 return (self.is_nan() and other.is_nan() or
2462 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002463 return self._exp == other._exp
2464
Facundo Batista353750c2007-09-13 18:13:15 +00002465 def _rescale(self, exp, rounding):
2466 """Rescale self so that the exponent is exp, either by padding with zeros
2467 or by truncating digits, using the given rounding mode.
2468
2469 Specials are returned without change. This operation is
2470 quiet: it raises no flags, and uses no information from the
2471 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002472
2473 exp = exp to scale to (an integer)
Facundo Batista353750c2007-09-13 18:13:15 +00002474 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002475 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002476 if self._is_special:
Facundo Batista6c398da2007-09-17 17:30:13 +00002477 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002478 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002479 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002480
Facundo Batista353750c2007-09-13 18:13:15 +00002481 if self._exp >= exp:
2482 # pad answer with zeros if necessary
Facundo Batista72bc54f2007-11-23 17:59:00 +00002483 return _dec_from_triple(self._sign,
2484 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002485
Facundo Batista353750c2007-09-13 18:13:15 +00002486 # too many digits; round and lose data. If self.adjusted() <
2487 # exp-1, replace self by 10**(exp-1) before rounding
2488 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002489 if digits < 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002490 self = _dec_from_triple(self._sign, '1', exp-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002491 digits = 0
2492 this_function = getattr(self, self._pick_rounding_function[rounding])
Facundo Batista2ec74152007-12-03 17:55:00 +00002493 changed = this_function(digits)
2494 coeff = self._int[:digits] or '0'
2495 if changed == 1:
2496 coeff = str(int(coeff)+1)
2497 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002498
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00002499 def _round(self, places, rounding):
2500 """Round a nonzero, nonspecial Decimal to a fixed number of
2501 significant figures, using the given rounding mode.
2502
2503 Infinities, NaNs and zeros are returned unaltered.
2504
2505 This operation is quiet: it raises no flags, and uses no
2506 information from the context.
2507
2508 """
2509 if places <= 0:
2510 raise ValueError("argument should be at least 1 in _round")
2511 if self._is_special or not self:
2512 return Decimal(self)
2513 ans = self._rescale(self.adjusted()+1-places, rounding)
2514 # it can happen that the rescale alters the adjusted exponent;
2515 # for example when rounding 99.97 to 3 significant figures.
2516 # When this happens we end up with an extra 0 at the end of
2517 # the number; a second rescale fixes this.
2518 if ans.adjusted() != self.adjusted():
2519 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2520 return ans
2521
Facundo Batista353750c2007-09-13 18:13:15 +00002522 def to_integral_exact(self, rounding=None, context=None):
2523 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002524
Facundo Batista353750c2007-09-13 18:13:15 +00002525 If no rounding mode is specified, take the rounding mode from
2526 the context. This method raises the Rounded and Inexact flags
2527 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002528
Facundo Batista353750c2007-09-13 18:13:15 +00002529 See also: to_integral_value, which does exactly the same as
2530 this method except that it doesn't raise Inexact or Rounded.
2531 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002532 if self._is_special:
2533 ans = self._check_nans(context=context)
2534 if ans:
2535 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002536 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002537 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002538 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002539 if not self:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002540 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002541 if context is None:
2542 context = getcontext()
Facundo Batista353750c2007-09-13 18:13:15 +00002543 if rounding is None:
2544 rounding = context.rounding
Facundo Batista353750c2007-09-13 18:13:15 +00002545 ans = self._rescale(0, rounding)
2546 if ans != self:
2547 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00002548 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002549 return ans
2550
Facundo Batista353750c2007-09-13 18:13:15 +00002551 def to_integral_value(self, rounding=None, context=None):
2552 """Rounds to the nearest integer, without raising inexact, rounded."""
2553 if context is None:
2554 context = getcontext()
2555 if rounding is None:
2556 rounding = context.rounding
2557 if self._is_special:
2558 ans = self._check_nans(context=context)
2559 if ans:
2560 return ans
Facundo Batista6c398da2007-09-17 17:30:13 +00002561 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002562 if self._exp >= 0:
Facundo Batista6c398da2007-09-17 17:30:13 +00002563 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00002564 else:
2565 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002566
Facundo Batista353750c2007-09-13 18:13:15 +00002567 # the method name changed, but we provide also the old one, for compatibility
2568 to_integral = to_integral_value
2569
2570 def sqrt(self, context=None):
2571 """Return the square root of self."""
Mark Dickinson3b24ccb2008-03-25 14:33:23 +00002572 if context is None:
2573 context = getcontext()
2574
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002575 if self._is_special:
2576 ans = self._check_nans(context=context)
2577 if ans:
2578 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002579
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002580 if self._isinfinity() and self._sign == 0:
2581 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002582
2583 if not self:
Facundo Batista353750c2007-09-13 18:13:15 +00002584 # exponent = self._exp // 2. sqrt(-0) = -0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002585 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Facundo Batista353750c2007-09-13 18:13:15 +00002586 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002587
2588 if self._sign == 1:
2589 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2590
Facundo Batista353750c2007-09-13 18:13:15 +00002591 # At this point self represents a positive number. Let p be
2592 # the desired precision and express self in the form c*100**e
2593 # with c a positive real number and e an integer, c and e
2594 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2595 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2596 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2597 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2598 # the closest integer to sqrt(c) with the even integer chosen
2599 # in the case of a tie.
2600 #
2601 # To ensure correct rounding in all cases, we use the
2602 # following trick: we compute the square root to an extra
2603 # place (precision p+1 instead of precision p), rounding down.
2604 # Then, if the result is inexact and its last digit is 0 or 5,
2605 # we increase the last digit to 1 or 6 respectively; if it's
2606 # exact we leave the last digit alone. Now the final round to
2607 # p places (or fewer in the case of underflow) will round
2608 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002609
Facundo Batista353750c2007-09-13 18:13:15 +00002610 # use an extra digit of precision
2611 prec = context.prec+1
2612
2613 # write argument in the form c*100**e where e = self._exp//2
2614 # is the 'ideal' exponent, to be used if the square root is
2615 # exactly representable. l is the number of 'digits' of c in
2616 # base 100, so that 100**(l-1) <= c < 100**l.
2617 op = _WorkRep(self)
2618 e = op.exp >> 1
2619 if op.exp & 1:
2620 c = op.int * 10
2621 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002622 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002623 c = op.int
2624 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002625
Facundo Batista353750c2007-09-13 18:13:15 +00002626 # rescale so that c has exactly prec base 100 'digits'
2627 shift = prec-l
2628 if shift >= 0:
2629 c *= 100**shift
2630 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002631 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002632 c, remainder = divmod(c, 100**-shift)
2633 exact = not remainder
2634 e -= shift
Martin v. Löwiscfe31282006-07-19 17:18:32 +00002635
Facundo Batista353750c2007-09-13 18:13:15 +00002636 # find n = floor(sqrt(c)) using Newton's method
2637 n = 10**prec
2638 while True:
2639 q = c//n
2640 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002641 break
Facundo Batista353750c2007-09-13 18:13:15 +00002642 else:
2643 n = n + q >> 1
2644 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002645
Facundo Batista353750c2007-09-13 18:13:15 +00002646 if exact:
2647 # result is exact; rescale to use ideal exponent e
2648 if shift >= 0:
2649 # assert n % 10**shift == 0
2650 n //= 10**shift
2651 else:
2652 n *= 10**-shift
2653 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002654 else:
Facundo Batista353750c2007-09-13 18:13:15 +00002655 # result is not exact; fix last digit as described above
2656 if n % 5 == 0:
2657 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002658
Facundo Batista72bc54f2007-11-23 17:59:00 +00002659 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002660
Facundo Batista353750c2007-09-13 18:13:15 +00002661 # round, and fit to current context
2662 context = context._shallow_copy()
2663 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002664 ans = ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00002665 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002666
Facundo Batista353750c2007-09-13 18:13:15 +00002667 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002668
2669 def max(self, other, context=None):
2670 """Returns the larger value.
2671
Facundo Batista353750c2007-09-13 18:13:15 +00002672 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002673 NaN (and signals if one is sNaN). Also rounds.
2674 """
Facundo Batista353750c2007-09-13 18:13:15 +00002675 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002676
Facundo Batista6c398da2007-09-17 17:30:13 +00002677 if context is None:
2678 context = getcontext()
2679
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002680 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002681 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002682 # number is always returned
2683 sn = self._isnan()
2684 on = other._isnan()
2685 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002686 if on == 1 and sn == 0:
2687 return self._fix(context)
2688 if sn == 1 and on == 0:
2689 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002690 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002691
Mark Dickinson2fc92632008-02-06 22:10:50 +00002692 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002693 if c == 0:
Facundo Batista59c58842007-04-10 12:58:45 +00002694 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002695 # then an ordering is applied:
2696 #
Facundo Batista59c58842007-04-10 12:58:45 +00002697 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002698 # positive sign and min returns the operand with the negative sign
2699 #
Facundo Batista59c58842007-04-10 12:58:45 +00002700 # If the signs are the same then the exponent is used to select
Facundo Batista353750c2007-09-13 18:13:15 +00002701 # the result. This is exactly the ordering used in compare_total.
2702 c = self.compare_total(other)
2703
2704 if c == -1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002705 ans = other
Facundo Batista353750c2007-09-13 18:13:15 +00002706 else:
2707 ans = self
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002708
Facundo Batistae64acfa2007-12-17 14:18:42 +00002709 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002710
2711 def min(self, other, context=None):
2712 """Returns the smaller value.
2713
Facundo Batista59c58842007-04-10 12:58:45 +00002714 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002715 NaN (and signals if one is sNaN). Also rounds.
2716 """
Facundo Batista353750c2007-09-13 18:13:15 +00002717 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002718
Facundo Batista6c398da2007-09-17 17:30:13 +00002719 if context is None:
2720 context = getcontext()
2721
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002722 if self._is_special or other._is_special:
Facundo Batista59c58842007-04-10 12:58:45 +00002723 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002724 # number is always returned
2725 sn = self._isnan()
2726 on = other._isnan()
2727 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00002728 if on == 1 and sn == 0:
2729 return self._fix(context)
2730 if sn == 1 and on == 0:
2731 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002732 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002733
Mark Dickinson2fc92632008-02-06 22:10:50 +00002734 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002735 if c == 0:
Facundo Batista353750c2007-09-13 18:13:15 +00002736 c = self.compare_total(other)
2737
2738 if c == -1:
2739 ans = self
2740 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002741 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002742
Facundo Batistae64acfa2007-12-17 14:18:42 +00002743 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002744
2745 def _isinteger(self):
2746 """Returns whether self is an integer"""
Facundo Batista353750c2007-09-13 18:13:15 +00002747 if self._is_special:
2748 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002749 if self._exp >= 0:
2750 return True
2751 rest = self._int[self._exp:]
Facundo Batista72bc54f2007-11-23 17:59:00 +00002752 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002753
2754 def _iseven(self):
Facundo Batista353750c2007-09-13 18:13:15 +00002755 """Returns True if self is even. Assumes self is an integer."""
2756 if not self or self._exp > 0:
2757 return True
Facundo Batista72bc54f2007-11-23 17:59:00 +00002758 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002759
2760 def adjusted(self):
2761 """Return the adjusted exponent of self"""
2762 try:
2763 return self._exp + len(self._int) - 1
Facundo Batista59c58842007-04-10 12:58:45 +00002764 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002765 except TypeError:
2766 return 0
2767
Facundo Batista353750c2007-09-13 18:13:15 +00002768 def canonical(self, context=None):
2769 """Returns the same Decimal object.
2770
2771 As we do not have different encodings for the same number, the
2772 received object already is in its canonical form.
2773 """
2774 return self
2775
2776 def compare_signal(self, other, context=None):
2777 """Compares self to the other operand numerically.
2778
2779 It's pretty much like compare(), but all NaNs signal, with signaling
2780 NaNs taking precedence over quiet NaNs.
2781 """
Mark Dickinson2fc92632008-02-06 22:10:50 +00002782 other = _convert_other(other, raiseit = True)
2783 ans = self._compare_check_nans(other, context)
2784 if ans:
2785 return ans
Facundo Batista353750c2007-09-13 18:13:15 +00002786 return self.compare(other, context=context)
2787
2788 def compare_total(self, other):
2789 """Compares self to other using the abstract representations.
2790
2791 This is not like the standard compare, which use their numerical
2792 value. Note that a total ordering is defined for all possible abstract
2793 representations.
2794 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002795 other = _convert_other(other, raiseit=True)
2796
Facundo Batista353750c2007-09-13 18:13:15 +00002797 # if one is negative and the other is positive, it's easy
2798 if self._sign and not other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002799 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002800 if not self._sign and other._sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002801 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002802 sign = self._sign
2803
2804 # let's handle both NaN types
2805 self_nan = self._isnan()
2806 other_nan = other._isnan()
2807 if self_nan or other_nan:
2808 if self_nan == other_nan:
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002809 # compare payloads as though they're integers
2810 self_key = len(self._int), self._int
2811 other_key = len(other._int), other._int
2812 if self_key < other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002813 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002814 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002815 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002816 return _NegativeOne
Mark Dickinson7a7739d2009-08-28 13:25:02 +00002817 if self_key > other_key:
Facundo Batista353750c2007-09-13 18:13:15 +00002818 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002819 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002820 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002821 return _One
2822 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002823
2824 if sign:
2825 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002826 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002827 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002828 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002829 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002830 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002831 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002832 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002833 else:
2834 if self_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002835 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002836 if other_nan == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002837 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002838 if self_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002839 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002840 if other_nan == 2:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002841 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002842
2843 if self < other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002844 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002845 if self > other:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002846 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002847
2848 if self._exp < other._exp:
2849 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002850 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002851 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002852 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002853 if self._exp > other._exp:
2854 if sign:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002855 return _NegativeOne
Facundo Batista353750c2007-09-13 18:13:15 +00002856 else:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002857 return _One
2858 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002859
2860
2861 def compare_total_mag(self, other):
2862 """Compares self to other using abstract repr., ignoring sign.
2863
2864 Like compare_total, but with operand's sign ignored and assumed to be 0.
2865 """
Mark Dickinson0c673122009-10-29 12:04:00 +00002866 other = _convert_other(other, raiseit=True)
2867
Facundo Batista353750c2007-09-13 18:13:15 +00002868 s = self.copy_abs()
2869 o = other.copy_abs()
2870 return s.compare_total(o)
2871
2872 def copy_abs(self):
2873 """Returns a copy with the sign set to 0. """
Facundo Batista72bc54f2007-11-23 17:59:00 +00002874 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002875
2876 def copy_negate(self):
2877 """Returns a copy with the sign inverted."""
2878 if self._sign:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002879 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002880 else:
Facundo Batista72bc54f2007-11-23 17:59:00 +00002881 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002882
2883 def copy_sign(self, other):
2884 """Returns self with the sign of other."""
Mark Dickinson6d8effb2010-02-18 14:27:02 +00002885 other = _convert_other(other, raiseit=True)
Facundo Batista72bc54f2007-11-23 17:59:00 +00002886 return _dec_from_triple(other._sign, self._int,
2887 self._exp, self._is_special)
Facundo Batista353750c2007-09-13 18:13:15 +00002888
2889 def exp(self, context=None):
2890 """Returns e ** self."""
2891
2892 if context is None:
2893 context = getcontext()
2894
2895 # exp(NaN) = NaN
2896 ans = self._check_nans(context=context)
2897 if ans:
2898 return ans
2899
2900 # exp(-Infinity) = 0
2901 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002902 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00002903
2904 # exp(0) = 1
2905 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00002906 return _One
Facundo Batista353750c2007-09-13 18:13:15 +00002907
2908 # exp(Infinity) = Infinity
2909 if self._isinfinity() == 1:
2910 return Decimal(self)
2911
2912 # the result is now guaranteed to be inexact (the true
2913 # mathematical result is transcendental). There's no need to
2914 # raise Rounded and Inexact here---they'll always be raised as
2915 # a result of the call to _fix.
2916 p = context.prec
2917 adj = self.adjusted()
2918
2919 # we only need to do any computation for quite a small range
2920 # of adjusted exponents---for example, -29 <= adj <= 10 for
2921 # the default context. For smaller exponent the result is
2922 # indistinguishable from 1 at the given precision, while for
2923 # larger exponent the result either overflows or underflows.
2924 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2925 # overflow
Facundo Batista72bc54f2007-11-23 17:59:00 +00002926 ans = _dec_from_triple(0, '1', context.Emax+1)
Facundo Batista353750c2007-09-13 18:13:15 +00002927 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2928 # underflow to 0
Facundo Batista72bc54f2007-11-23 17:59:00 +00002929 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002930 elif self._sign == 0 and adj < -p:
2931 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002932 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Facundo Batista353750c2007-09-13 18:13:15 +00002933 elif self._sign == 1 and adj < -p-1:
2934 # p+1 digits; final round will raise correct flags
Facundo Batista72bc54f2007-11-23 17:59:00 +00002935 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Facundo Batista353750c2007-09-13 18:13:15 +00002936 # general case
2937 else:
2938 op = _WorkRep(self)
2939 c, e = op.int, op.exp
2940 if op.sign == 1:
2941 c = -c
2942
2943 # compute correctly rounded result: increase precision by
2944 # 3 digits at a time until we get an unambiguously
2945 # roundable result
2946 extra = 3
2947 while True:
2948 coeff, exp = _dexp(c, e, p+extra)
2949 if coeff % (5*10**(len(str(coeff))-p-1)):
2950 break
2951 extra += 3
2952
Facundo Batista72bc54f2007-11-23 17:59:00 +00002953 ans = _dec_from_triple(0, str(coeff), exp)
Facundo Batista353750c2007-09-13 18:13:15 +00002954
2955 # at this stage, ans should round correctly with *any*
2956 # rounding mode, not just with ROUND_HALF_EVEN
2957 context = context._shallow_copy()
2958 rounding = context._set_rounding(ROUND_HALF_EVEN)
2959 ans = ans._fix(context)
2960 context.rounding = rounding
2961
2962 return ans
2963
2964 def is_canonical(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002965 """Return True if self is canonical; otherwise return False.
2966
2967 Currently, the encoding of a Decimal instance is always
2968 canonical, so this method returns True for any Decimal.
2969 """
2970 return True
Facundo Batista353750c2007-09-13 18:13:15 +00002971
2972 def is_finite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002973 """Return True if self is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00002974
Facundo Batista1a191df2007-10-02 17:01:24 +00002975 A Decimal instance is considered finite if it is neither
2976 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00002977 """
Facundo Batista1a191df2007-10-02 17:01:24 +00002978 return not self._is_special
Facundo Batista353750c2007-09-13 18:13:15 +00002979
2980 def is_infinite(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002981 """Return True if self is infinite; otherwise return False."""
2982 return self._exp == 'F'
Facundo Batista353750c2007-09-13 18:13:15 +00002983
2984 def is_nan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002985 """Return True if self is a qNaN or sNaN; otherwise return False."""
2986 return self._exp in ('n', 'N')
Facundo Batista353750c2007-09-13 18:13:15 +00002987
2988 def is_normal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00002989 """Return True if self is a normal number; otherwise return False."""
2990 if self._is_special or not self:
2991 return False
Facundo Batista353750c2007-09-13 18:13:15 +00002992 if context is None:
2993 context = getcontext()
Mark Dickinsona7a52ab2009-10-20 13:33:03 +00002994 return context.Emin <= self.adjusted()
Facundo Batista353750c2007-09-13 18:13:15 +00002995
2996 def is_qnan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00002997 """Return True if self is a quiet NaN; otherwise return False."""
2998 return self._exp == 'n'
Facundo Batista353750c2007-09-13 18:13:15 +00002999
3000 def is_signed(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003001 """Return True if self is negative; otherwise return False."""
3002 return self._sign == 1
Facundo Batista353750c2007-09-13 18:13:15 +00003003
3004 def is_snan(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003005 """Return True if self is a signaling NaN; otherwise return False."""
3006 return self._exp == 'N'
Facundo Batista353750c2007-09-13 18:13:15 +00003007
3008 def is_subnormal(self, context=None):
Facundo Batista1a191df2007-10-02 17:01:24 +00003009 """Return True if self is subnormal; otherwise return False."""
3010 if self._is_special or not self:
3011 return False
Facundo Batista353750c2007-09-13 18:13:15 +00003012 if context is None:
3013 context = getcontext()
Facundo Batista1a191df2007-10-02 17:01:24 +00003014 return self.adjusted() < context.Emin
Facundo Batista353750c2007-09-13 18:13:15 +00003015
3016 def is_zero(self):
Facundo Batista1a191df2007-10-02 17:01:24 +00003017 """Return True if self is a zero; otherwise return False."""
Facundo Batista72bc54f2007-11-23 17:59:00 +00003018 return not self._is_special and self._int == '0'
Facundo Batista353750c2007-09-13 18:13:15 +00003019
3020 def _ln_exp_bound(self):
3021 """Compute a lower bound for the adjusted exponent of self.ln().
3022 In other words, compute r such that self.ln() >= 10**r. Assumes
3023 that self is finite and positive and that self != 1.
3024 """
3025
3026 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3027 adj = self._exp + len(self._int) - 1
3028 if adj >= 1:
3029 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3030 return len(str(adj*23//10)) - 1
3031 if adj <= -2:
3032 # argument <= 0.1
3033 return len(str((-1-adj)*23//10)) - 1
3034 op = _WorkRep(self)
3035 c, e = op.int, op.exp
3036 if adj == 0:
3037 # 1 < self < 10
3038 num = str(c-10**-e)
3039 den = str(c)
3040 return len(num) - len(den) - (num < den)
3041 # adj == -1, 0.1 <= self < 1
3042 return e + len(str(10**-e - c)) - 1
3043
3044
3045 def ln(self, context=None):
3046 """Returns the natural (base e) logarithm of self."""
3047
3048 if context is None:
3049 context = getcontext()
3050
3051 # ln(NaN) = NaN
3052 ans = self._check_nans(context=context)
3053 if ans:
3054 return ans
3055
3056 # ln(0.0) == -Infinity
3057 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003058 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003059
3060 # ln(Infinity) = Infinity
3061 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003062 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003063
3064 # ln(1.0) == 0.0
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003065 if self == _One:
3066 return _Zero
Facundo Batista353750c2007-09-13 18:13:15 +00003067
3068 # ln(negative) raises InvalidOperation
3069 if self._sign == 1:
3070 return context._raise_error(InvalidOperation,
3071 'ln of a negative value')
3072
3073 # result is irrational, so necessarily inexact
3074 op = _WorkRep(self)
3075 c, e = op.int, op.exp
3076 p = context.prec
3077
3078 # correctly rounded result: repeatedly increase precision by 3
3079 # until we get an unambiguously roundable result
3080 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3081 while True:
3082 coeff = _dlog(c, e, places)
3083 # assert len(str(abs(coeff)))-p >= 1
3084 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3085 break
3086 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003087 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003088
3089 context = context._shallow_copy()
3090 rounding = context._set_rounding(ROUND_HALF_EVEN)
3091 ans = ans._fix(context)
3092 context.rounding = rounding
3093 return ans
3094
3095 def _log10_exp_bound(self):
3096 """Compute a lower bound for the adjusted exponent of self.log10().
3097 In other words, find r such that self.log10() >= 10**r.
3098 Assumes that self is finite and positive and that self != 1.
3099 """
3100
3101 # For x >= 10 or x < 0.1 we only need a bound on the integer
3102 # part of log10(self), and this comes directly from the
3103 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3104 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3105 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3106
3107 adj = self._exp + len(self._int) - 1
3108 if adj >= 1:
3109 # self >= 10
3110 return len(str(adj))-1
3111 if adj <= -2:
3112 # self < 0.1
3113 return len(str(-1-adj))-1
3114 op = _WorkRep(self)
3115 c, e = op.int, op.exp
3116 if adj == 0:
3117 # 1 < self < 10
3118 num = str(c-10**-e)
3119 den = str(231*c)
3120 return len(num) - len(den) - (num < den) + 2
3121 # adj == -1, 0.1 <= self < 1
3122 num = str(10**-e-c)
3123 return len(num) + e - (num < "231") - 1
3124
3125 def log10(self, context=None):
3126 """Returns the base 10 logarithm of self."""
3127
3128 if context is None:
3129 context = getcontext()
3130
3131 # log10(NaN) = NaN
3132 ans = self._check_nans(context=context)
3133 if ans:
3134 return ans
3135
3136 # log10(0.0) == -Infinity
3137 if not self:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003138 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003139
3140 # log10(Infinity) = Infinity
3141 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003142 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003143
3144 # log10(negative or -Infinity) raises InvalidOperation
3145 if self._sign == 1:
3146 return context._raise_error(InvalidOperation,
3147 'log10 of a negative value')
3148
3149 # log10(10**n) = n
Facundo Batista72bc54f2007-11-23 17:59:00 +00003150 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Facundo Batista353750c2007-09-13 18:13:15 +00003151 # answer may need rounding
3152 ans = Decimal(self._exp + len(self._int) - 1)
3153 else:
3154 # result is irrational, so necessarily inexact
3155 op = _WorkRep(self)
3156 c, e = op.int, op.exp
3157 p = context.prec
3158
3159 # correctly rounded result: repeatedly increase precision
3160 # until result is unambiguously roundable
3161 places = p-self._log10_exp_bound()+2
3162 while True:
3163 coeff = _dlog10(c, e, places)
3164 # assert len(str(abs(coeff)))-p >= 1
3165 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3166 break
3167 places += 3
Facundo Batista72bc54f2007-11-23 17:59:00 +00003168 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Facundo Batista353750c2007-09-13 18:13:15 +00003169
3170 context = context._shallow_copy()
3171 rounding = context._set_rounding(ROUND_HALF_EVEN)
3172 ans = ans._fix(context)
3173 context.rounding = rounding
3174 return ans
3175
3176 def logb(self, context=None):
3177 """ Returns the exponent of the magnitude of self's MSD.
3178
3179 The result is the integer which is the exponent of the magnitude
3180 of the most significant digit of self (as though it were truncated
3181 to a single digit while maintaining the value of that digit and
3182 without limiting the resulting exponent).
3183 """
3184 # logb(NaN) = NaN
3185 ans = self._check_nans(context=context)
3186 if ans:
3187 return ans
3188
3189 if context is None:
3190 context = getcontext()
3191
3192 # logb(+/-Inf) = +Inf
3193 if self._isinfinity():
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003194 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003195
3196 # logb(0) = -Inf, DivisionByZero
3197 if not self:
Facundo Batistacce8df22007-09-18 16:53:18 +00003198 return context._raise_error(DivisionByZero, 'logb(0)', 1)
Facundo Batista353750c2007-09-13 18:13:15 +00003199
3200 # otherwise, simply return the adjusted exponent of self, as a
3201 # Decimal. Note that no attempt is made to fit the result
3202 # into the current context.
Mark Dickinson15ae41c2009-10-07 19:22:05 +00003203 ans = Decimal(self.adjusted())
3204 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003205
3206 def _islogical(self):
3207 """Return True if self is a logical operand.
3208
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00003209 For being logical, it must be a finite number with a sign of 0,
Facundo Batista353750c2007-09-13 18:13:15 +00003210 an exponent of 0, and a coefficient whose digits must all be
3211 either 0 or 1.
3212 """
3213 if self._sign != 0 or self._exp != 0:
3214 return False
3215 for dig in self._int:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003216 if dig not in '01':
Facundo Batista353750c2007-09-13 18:13:15 +00003217 return False
3218 return True
3219
3220 def _fill_logical(self, context, opa, opb):
3221 dif = context.prec - len(opa)
3222 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003223 opa = '0'*dif + opa
Facundo Batista353750c2007-09-13 18:13:15 +00003224 elif dif < 0:
3225 opa = opa[-context.prec:]
3226 dif = context.prec - len(opb)
3227 if dif > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003228 opb = '0'*dif + opb
Facundo Batista353750c2007-09-13 18:13:15 +00003229 elif dif < 0:
3230 opb = opb[-context.prec:]
3231 return opa, opb
3232
3233 def logical_and(self, other, context=None):
3234 """Applies an 'and' operation between self and other's digits."""
3235 if context is None:
3236 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003237
3238 other = _convert_other(other, raiseit=True)
3239
Facundo Batista353750c2007-09-13 18:13:15 +00003240 if not self._islogical() or not other._islogical():
3241 return context._raise_error(InvalidOperation)
3242
3243 # fill to context.prec
3244 (opa, opb) = self._fill_logical(context, self._int, other._int)
3245
3246 # make the operation, and clean starting zeroes
Facundo Batista72bc54f2007-11-23 17:59:00 +00003247 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3248 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003249
3250 def logical_invert(self, context=None):
3251 """Invert all its digits."""
3252 if context is None:
3253 context = getcontext()
Facundo Batista72bc54f2007-11-23 17:59:00 +00003254 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3255 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003256
3257 def logical_or(self, other, context=None):
3258 """Applies an 'or' operation between self and other's digits."""
3259 if context is None:
3260 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003261
3262 other = _convert_other(other, raiseit=True)
3263
Facundo Batista353750c2007-09-13 18:13:15 +00003264 if not self._islogical() or not other._islogical():
3265 return context._raise_error(InvalidOperation)
3266
3267 # fill to context.prec
3268 (opa, opb) = self._fill_logical(context, self._int, other._int)
3269
3270 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003271 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003272 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003273
3274 def logical_xor(self, other, context=None):
3275 """Applies an 'xor' operation between self and other's digits."""
3276 if context is None:
3277 context = getcontext()
Mark Dickinson0c673122009-10-29 12:04:00 +00003278
3279 other = _convert_other(other, raiseit=True)
3280
Facundo Batista353750c2007-09-13 18:13:15 +00003281 if not self._islogical() or not other._islogical():
3282 return context._raise_error(InvalidOperation)
3283
3284 # fill to context.prec
3285 (opa, opb) = self._fill_logical(context, self._int, other._int)
3286
3287 # make the operation, and clean starting zeroes
Mark Dickinson65808ff2009-01-04 21:22:02 +00003288 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Facundo Batista72bc54f2007-11-23 17:59:00 +00003289 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Facundo Batista353750c2007-09-13 18:13:15 +00003290
3291 def max_mag(self, other, context=None):
3292 """Compares the values numerically with their sign ignored."""
3293 other = _convert_other(other, raiseit=True)
3294
Facundo Batista6c398da2007-09-17 17:30:13 +00003295 if context is None:
3296 context = getcontext()
3297
Facundo Batista353750c2007-09-13 18:13:15 +00003298 if self._is_special or other._is_special:
3299 # If one operand is a quiet NaN and the other is number, then the
3300 # number is always returned
3301 sn = self._isnan()
3302 on = other._isnan()
3303 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003304 if on == 1 and sn == 0:
3305 return self._fix(context)
3306 if sn == 1 and on == 0:
3307 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003308 return self._check_nans(other, context)
3309
Mark Dickinson2fc92632008-02-06 22:10:50 +00003310 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003311 if c == 0:
3312 c = self.compare_total(other)
3313
3314 if c == -1:
3315 ans = other
3316 else:
3317 ans = self
3318
Facundo Batistae64acfa2007-12-17 14:18:42 +00003319 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003320
3321 def min_mag(self, other, context=None):
3322 """Compares the values numerically with their sign ignored."""
3323 other = _convert_other(other, raiseit=True)
3324
Facundo Batista6c398da2007-09-17 17:30:13 +00003325 if context is None:
3326 context = getcontext()
3327
Facundo Batista353750c2007-09-13 18:13:15 +00003328 if self._is_special or other._is_special:
3329 # If one operand is a quiet NaN and the other is number, then the
3330 # number is always returned
3331 sn = self._isnan()
3332 on = other._isnan()
3333 if sn or on:
Facundo Batistae29d4352008-12-11 04:19:46 +00003334 if on == 1 and sn == 0:
3335 return self._fix(context)
3336 if sn == 1 and on == 0:
3337 return other._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003338 return self._check_nans(other, context)
3339
Mark Dickinson2fc92632008-02-06 22:10:50 +00003340 c = self.copy_abs()._cmp(other.copy_abs())
Facundo Batista353750c2007-09-13 18:13:15 +00003341 if c == 0:
3342 c = self.compare_total(other)
3343
3344 if c == -1:
3345 ans = self
3346 else:
3347 ans = other
3348
Facundo Batistae64acfa2007-12-17 14:18:42 +00003349 return ans._fix(context)
Facundo Batista353750c2007-09-13 18:13:15 +00003350
3351 def next_minus(self, context=None):
3352 """Returns the largest representable number smaller than itself."""
3353 if context is None:
3354 context = getcontext()
3355
3356 ans = self._check_nans(context=context)
3357 if ans:
3358 return ans
3359
3360 if self._isinfinity() == -1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003361 return _NegativeInfinity
Facundo Batista353750c2007-09-13 18:13:15 +00003362 if self._isinfinity() == 1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003363 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003364
3365 context = context.copy()
3366 context._set_rounding(ROUND_FLOOR)
3367 context._ignore_all_flags()
3368 new_self = self._fix(context)
3369 if new_self != self:
3370 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003371 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3372 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003373
3374 def next_plus(self, context=None):
3375 """Returns the smallest representable number larger than itself."""
3376 if context is None:
3377 context = getcontext()
3378
3379 ans = self._check_nans(context=context)
3380 if ans:
3381 return ans
3382
3383 if self._isinfinity() == 1:
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00003384 return _Infinity
Facundo Batista353750c2007-09-13 18:13:15 +00003385 if self._isinfinity() == -1:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003386 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Facundo Batista353750c2007-09-13 18:13:15 +00003387
3388 context = context.copy()
3389 context._set_rounding(ROUND_CEILING)
3390 context._ignore_all_flags()
3391 new_self = self._fix(context)
3392 if new_self != self:
3393 return new_self
Facundo Batista72bc54f2007-11-23 17:59:00 +00003394 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3395 context)
Facundo Batista353750c2007-09-13 18:13:15 +00003396
3397 def next_toward(self, other, context=None):
3398 """Returns the number closest to self, in the direction towards other.
3399
3400 The result is the closest representable number to self
3401 (excluding self) that is in the direction towards other,
3402 unless both have the same value. If the two operands are
3403 numerically equal, then the result is a copy of self with the
3404 sign set to be the same as the sign of other.
3405 """
3406 other = _convert_other(other, raiseit=True)
3407
3408 if context is None:
3409 context = getcontext()
3410
3411 ans = self._check_nans(other, context)
3412 if ans:
3413 return ans
3414
Mark Dickinson2fc92632008-02-06 22:10:50 +00003415 comparison = self._cmp(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003416 if comparison == 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003417 return self.copy_sign(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003418
3419 if comparison == -1:
3420 ans = self.next_plus(context)
3421 else: # comparison == 1
3422 ans = self.next_minus(context)
3423
3424 # decide which flags to raise using value of ans
3425 if ans._isinfinity():
3426 context._raise_error(Overflow,
3427 'Infinite result from next_toward',
3428 ans._sign)
Facundo Batista353750c2007-09-13 18:13:15 +00003429 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00003430 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003431 elif ans.adjusted() < context.Emin:
3432 context._raise_error(Underflow)
3433 context._raise_error(Subnormal)
Facundo Batista353750c2007-09-13 18:13:15 +00003434 context._raise_error(Inexact)
Mark Dickinson4f96f5f2010-05-04 14:25:50 +00003435 context._raise_error(Rounded)
Facundo Batista353750c2007-09-13 18:13:15 +00003436 # if precision == 1 then we don't raise Clamped for a
3437 # result 0E-Etiny.
3438 if not ans:
3439 context._raise_error(Clamped)
3440
3441 return ans
3442
3443 def number_class(self, context=None):
3444 """Returns an indication of the class of self.
3445
3446 The class is one of the following strings:
Facundo Batista0f5e7bf2007-12-19 12:53:01 +00003447 sNaN
3448 NaN
Facundo Batista353750c2007-09-13 18:13:15 +00003449 -Infinity
3450 -Normal
3451 -Subnormal
3452 -Zero
3453 +Zero
3454 +Subnormal
3455 +Normal
3456 +Infinity
3457 """
3458 if self.is_snan():
3459 return "sNaN"
3460 if self.is_qnan():
3461 return "NaN"
3462 inf = self._isinfinity()
3463 if inf == 1:
3464 return "+Infinity"
3465 if inf == -1:
3466 return "-Infinity"
3467 if self.is_zero():
3468 if self._sign:
3469 return "-Zero"
3470 else:
3471 return "+Zero"
3472 if context is None:
3473 context = getcontext()
3474 if self.is_subnormal(context=context):
3475 if self._sign:
3476 return "-Subnormal"
3477 else:
3478 return "+Subnormal"
3479 # just a normal, regular, boring number, :)
3480 if self._sign:
3481 return "-Normal"
3482 else:
3483 return "+Normal"
3484
3485 def radix(self):
3486 """Just returns 10, as this is Decimal, :)"""
3487 return Decimal(10)
3488
3489 def rotate(self, other, context=None):
3490 """Returns a rotated copy of self, value-of-other times."""
3491 if context is None:
3492 context = getcontext()
3493
Mark Dickinson0c673122009-10-29 12:04:00 +00003494 other = _convert_other(other, raiseit=True)
3495
Facundo Batista353750c2007-09-13 18:13:15 +00003496 ans = self._check_nans(other, context)
3497 if ans:
3498 return ans
3499
3500 if other._exp != 0:
3501 return context._raise_error(InvalidOperation)
3502 if not (-context.prec <= int(other) <= context.prec):
3503 return context._raise_error(InvalidOperation)
3504
3505 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003506 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003507
3508 # get values, pad if necessary
3509 torot = int(other)
3510 rotdig = self._int
3511 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003512 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003513 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003514 elif topad < 0:
3515 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003516
3517 # let's rotate!
3518 rotated = rotdig[torot:] + rotdig[:torot]
Facundo Batista72bc54f2007-11-23 17:59:00 +00003519 return _dec_from_triple(self._sign,
3520 rotated.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003521
Mark Dickinson0c673122009-10-29 12:04:00 +00003522 def scaleb(self, other, context=None):
Facundo Batista353750c2007-09-13 18:13:15 +00003523 """Returns self operand after adding the second value to its exp."""
3524 if context is None:
3525 context = getcontext()
3526
Mark Dickinson0c673122009-10-29 12:04:00 +00003527 other = _convert_other(other, raiseit=True)
3528
Facundo Batista353750c2007-09-13 18:13:15 +00003529 ans = self._check_nans(other, context)
3530 if ans:
3531 return ans
3532
3533 if other._exp != 0:
3534 return context._raise_error(InvalidOperation)
3535 liminf = -2 * (context.Emax + context.prec)
3536 limsup = 2 * (context.Emax + context.prec)
3537 if not (liminf <= int(other) <= limsup):
3538 return context._raise_error(InvalidOperation)
3539
3540 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003541 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003542
Facundo Batista72bc54f2007-11-23 17:59:00 +00003543 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Facundo Batista353750c2007-09-13 18:13:15 +00003544 d = d._fix(context)
3545 return d
3546
3547 def shift(self, other, context=None):
3548 """Returns a shifted copy of self, value-of-other times."""
3549 if context is None:
3550 context = getcontext()
3551
Mark Dickinson0c673122009-10-29 12:04:00 +00003552 other = _convert_other(other, raiseit=True)
3553
Facundo Batista353750c2007-09-13 18:13:15 +00003554 ans = self._check_nans(other, context)
3555 if ans:
3556 return ans
3557
3558 if other._exp != 0:
3559 return context._raise_error(InvalidOperation)
3560 if not (-context.prec <= int(other) <= context.prec):
3561 return context._raise_error(InvalidOperation)
3562
3563 if self._isinfinity():
Facundo Batista6c398da2007-09-17 17:30:13 +00003564 return Decimal(self)
Facundo Batista353750c2007-09-13 18:13:15 +00003565
3566 # get values, pad if necessary
3567 torot = int(other)
Facundo Batista353750c2007-09-13 18:13:15 +00003568 rotdig = self._int
3569 topad = context.prec - len(rotdig)
Mark Dickinson6f390012009-10-29 12:11:18 +00003570 if topad > 0:
Facundo Batista72bc54f2007-11-23 17:59:00 +00003571 rotdig = '0'*topad + rotdig
Mark Dickinson6f390012009-10-29 12:11:18 +00003572 elif topad < 0:
3573 rotdig = rotdig[-topad:]
Facundo Batista353750c2007-09-13 18:13:15 +00003574
3575 # let's shift!
3576 if torot < 0:
Mark Dickinson6f390012009-10-29 12:11:18 +00003577 shifted = rotdig[:torot]
Facundo Batista353750c2007-09-13 18:13:15 +00003578 else:
Mark Dickinson6f390012009-10-29 12:11:18 +00003579 shifted = rotdig + '0'*torot
3580 shifted = shifted[-context.prec:]
Facundo Batista353750c2007-09-13 18:13:15 +00003581
Facundo Batista72bc54f2007-11-23 17:59:00 +00003582 return _dec_from_triple(self._sign,
Mark Dickinson6f390012009-10-29 12:11:18 +00003583 shifted.lstrip('0') or '0', self._exp)
Facundo Batista353750c2007-09-13 18:13:15 +00003584
Facundo Batista59c58842007-04-10 12:58:45 +00003585 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003586 def __reduce__(self):
3587 return (self.__class__, (str(self),))
3588
3589 def __copy__(self):
Benjamin Peterson28e369a2010-01-25 03:58:21 +00003590 if type(self) is Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003591 return self # I'm immutable; therefore I am my own clone
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003592 return self.__class__(str(self))
3593
3594 def __deepcopy__(self, memo):
Benjamin Peterson28e369a2010-01-25 03:58:21 +00003595 if type(self) is Decimal:
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003596 return self # My components are also immutable
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003597 return self.__class__(str(self))
3598
Mark Dickinson277859d2009-03-17 23:03:46 +00003599 # PEP 3101 support. the _localeconv keyword argument should be
3600 # considered private: it's provided for ease of testing only.
3601 def __format__(self, specifier, context=None, _localeconv=None):
Mark Dickinsonf4da7772008-02-29 03:29:17 +00003602 """Format a Decimal instance according to the given specifier.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003603
3604 The specifier should be a standard format specifier, with the
3605 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson277859d2009-03-17 23:03:46 +00003606 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3607 type is omitted it defaults to 'g' or 'G', depending on the
3608 value of context.capitals.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003609 """
3610
3611 # Note: PEP 3101 says that if the type is not present then
3612 # there should be at least one digit after the decimal point.
3613 # We take the liberty of ignoring this requirement for
3614 # Decimal---it's presumably there to make sure that
3615 # format(float, '') behaves similarly to str(float).
3616 if context is None:
3617 context = getcontext()
3618
Mark Dickinson277859d2009-03-17 23:03:46 +00003619 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003620
Mark Dickinson277859d2009-03-17 23:03:46 +00003621 # special values don't care about the type or precision
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003622 if self._is_special:
Mark Dickinson277859d2009-03-17 23:03:46 +00003623 sign = _format_sign(self._sign, spec)
3624 body = str(self.copy_abs())
3625 return _format_align(sign, body, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003626
3627 # a type of None defaults to 'g' or 'G', depending on context
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003628 if spec['type'] is None:
3629 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson277859d2009-03-17 23:03:46 +00003630
3631 # if type is '%', adjust exponent of self accordingly
3632 if spec['type'] == '%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003633 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3634
3635 # round if necessary, taking rounding mode from the context
3636 rounding = context.rounding
3637 precision = spec['precision']
3638 if precision is not None:
3639 if spec['type'] in 'eE':
3640 self = self._round(precision+1, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003641 elif spec['type'] in 'fF%':
3642 self = self._rescale(-precision, rounding)
Mark Dickinson277859d2009-03-17 23:03:46 +00003643 elif spec['type'] in 'gG' and len(self._int) > precision:
3644 self = self._round(precision, rounding)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003645 # special case: zeros with a positive exponent can't be
3646 # represented in fixed point; rescale them to 0e0.
Mark Dickinson277859d2009-03-17 23:03:46 +00003647 if not self and self._exp > 0 and spec['type'] in 'fF%':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003648 self = self._rescale(0, rounding)
3649
3650 # figure out placement of the decimal point
3651 leftdigits = self._exp + len(self._int)
Mark Dickinson277859d2009-03-17 23:03:46 +00003652 if spec['type'] in 'eE':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003653 if not self and precision is not None:
3654 dotplace = 1 - precision
3655 else:
3656 dotplace = 1
Mark Dickinson277859d2009-03-17 23:03:46 +00003657 elif spec['type'] in 'fF%':
3658 dotplace = leftdigits
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003659 elif spec['type'] in 'gG':
3660 if self._exp <= 0 and leftdigits > -6:
3661 dotplace = leftdigits
3662 else:
3663 dotplace = 1
3664
Mark Dickinson277859d2009-03-17 23:03:46 +00003665 # find digits before and after decimal point, and get exponent
3666 if dotplace < 0:
3667 intpart = '0'
3668 fracpart = '0'*(-dotplace) + self._int
3669 elif dotplace > len(self._int):
3670 intpart = self._int + '0'*(dotplace-len(self._int))
3671 fracpart = ''
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003672 else:
Mark Dickinson277859d2009-03-17 23:03:46 +00003673 intpart = self._int[:dotplace] or '0'
3674 fracpart = self._int[dotplace:]
3675 exp = leftdigits-dotplace
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003676
Mark Dickinson277859d2009-03-17 23:03:46 +00003677 # done with the decimal-specific stuff; hand over the rest
3678 # of the formatting to the _format_number function
3679 return _format_number(self._sign, intpart, fracpart, exp, spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00003680
Facundo Batista72bc54f2007-11-23 17:59:00 +00003681def _dec_from_triple(sign, coefficient, exponent, special=False):
3682 """Create a decimal instance directly, without any validation,
3683 normalization (e.g. removal of leading zeros) or argument
3684 conversion.
3685
3686 This function is for *internal use only*.
3687 """
3688
3689 self = object.__new__(Decimal)
3690 self._sign = sign
3691 self._int = coefficient
3692 self._exp = exponent
3693 self._is_special = special
3694
3695 return self
3696
Raymond Hettinger2c8585b2009-02-03 03:37:03 +00003697# Register Decimal as a kind of Number (an abstract base class).
3698# However, do not register it as Real (because Decimals are not
3699# interoperable with floats).
3700_numbers.Number.register(Decimal)
3701
3702
Facundo Batista59c58842007-04-10 12:58:45 +00003703##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003704
Martin v. Löwiscfe31282006-07-19 17:18:32 +00003705
3706# get rounding method function:
Facundo Batista59c58842007-04-10 12:58:45 +00003707rounding_functions = [name for name in Decimal.__dict__.keys()
3708 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003709for name in rounding_functions:
Facundo Batista59c58842007-04-10 12:58:45 +00003710 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003711 globalname = name[1:].upper()
3712 val = globals()[globalname]
3713 Decimal._pick_rounding_function[val] = name
3714
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003715del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003716
Nick Coghlanced12182006-09-02 03:54:17 +00003717class _ContextManager(object):
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003718 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003719
Nick Coghlanced12182006-09-02 03:54:17 +00003720 Sets a copy of the supplied context in __enter__() and restores
Nick Coghlan8b6999b2006-08-31 12:00:43 +00003721 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003722 """
3723 def __init__(self, new_context):
Nick Coghlanced12182006-09-02 03:54:17 +00003724 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003725 def __enter__(self):
3726 self.saved_context = getcontext()
3727 setcontext(self.new_context)
3728 return self.new_context
3729 def __exit__(self, t, v, tb):
3730 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003731
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003732class Context(object):
3733 """Contains the context for a Decimal instance.
3734
3735 Contains:
3736 prec - precision (for use in rounding, division, square roots..)
Facundo Batista59c58842007-04-10 12:58:45 +00003737 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003738 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003739 raised when it is caused. Otherwise, a value is
3740 substituted in.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003741 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003742 (Whether or not the trap_enabler is set)
3743 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003744 Emin - Minimum exponent
3745 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003746 capitals - If 1, 1*10^1 is printed as 1E+1.
3747 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003748 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003749 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003750
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003751 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003752 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003753 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003754 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003755 _ignored_flags=None):
3756 if flags is None:
3757 flags = []
3758 if _ignored_flags is None:
3759 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003760 if not isinstance(flags, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003761 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003762 del s
Raymond Hettingerbf440692004-07-10 14:14:37 +00003763 if traps is not None and not isinstance(traps, dict):
Mark Dickinson71f3b852008-05-04 02:25:46 +00003764 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettingerb91af522004-07-14 16:35:30 +00003765 del s
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003766 for name, val in locals().items():
3767 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003768 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003769 else:
3770 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003771 del self.self
3772
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003773 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003774 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003775 s = []
Facundo Batista59c58842007-04-10 12:58:45 +00003776 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3777 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3778 % vars(self))
3779 names = [f.__name__ for f, v in self.flags.items() if v]
3780 s.append('flags=[' + ', '.join(names) + ']')
3781 names = [t.__name__ for t, v in self.traps.items() if v]
3782 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003783 return ', '.join(s) + ')'
3784
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003785 def clear_flags(self):
3786 """Reset all flags to zero"""
3787 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003788 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003789
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003790 def _shallow_copy(self):
3791 """Returns a shallow copy from self."""
Facundo Batistae64acfa2007-12-17 14:18:42 +00003792 nc = Context(self.prec, self.rounding, self.traps,
3793 self.flags, self.Emin, self.Emax,
3794 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003795 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003796
3797 def copy(self):
3798 """Returns a deep copy from self."""
Facundo Batista59c58842007-04-10 12:58:45 +00003799 nc = Context(self.prec, self.rounding, self.traps.copy(),
Facundo Batistae64acfa2007-12-17 14:18:42 +00003800 self.flags.copy(), self.Emin, self.Emax,
3801 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003802 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003803 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003804
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003805 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003806 """Handles an error
3807
3808 If the flag is in _ignored_flags, returns the default response.
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003809 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah8a6f3fe2010-05-19 15:46:39 +00003810 trap_enabler is set, it reraises the exception. Otherwise, it returns
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003811 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003812 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003813 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003814 if error in self._ignored_flags:
Facundo Batista59c58842007-04-10 12:58:45 +00003815 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003816 return error().handle(self, *args)
3817
Mark Dickinson1840c1a2008-05-03 18:23:14 +00003818 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003819 if not self.traps[error]:
Facundo Batista59c58842007-04-10 12:58:45 +00003820 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003821 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003822
3823 # Errors should only be risked on copies of the context
Facundo Batista59c58842007-04-10 12:58:45 +00003824 # self._ignored_flags = []
Mark Dickinson8aca9d02008-05-04 02:05:06 +00003825 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003826
3827 def _ignore_all_flags(self):
3828 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003829 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003830
3831 def _ignore_flags(self, *flags):
3832 """Ignore the flags, if they are raised"""
3833 # Do not mutate-- This way, copies of a context leave the original
3834 # alone.
3835 self._ignored_flags = (self._ignored_flags + list(flags))
3836 return list(flags)
3837
3838 def _regard_flags(self, *flags):
3839 """Stop ignoring the flags, if they are raised"""
3840 if flags and isinstance(flags[0], (tuple,list)):
3841 flags = flags[0]
3842 for flag in flags:
3843 self._ignored_flags.remove(flag)
3844
Nick Coghlan53663a62008-07-15 14:27:37 +00003845 # We inherit object.__hash__, so we must deny this explicitly
3846 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003847
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003848 def Etiny(self):
3849 """Returns Etiny (= Emin - prec + 1)"""
3850 return int(self.Emin - self.prec + 1)
3851
3852 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003853 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003854 return int(self.Emax - self.prec + 1)
3855
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003856 def _set_rounding(self, type):
3857 """Sets the rounding type.
3858
3859 Sets the rounding type, and returns the current (previous)
3860 rounding type. Often used like:
3861
3862 context = context.copy()
3863 # so you don't change the calling context
3864 # if an error occurs in the middle.
3865 rounding = context._set_rounding(ROUND_UP)
3866 val = self.__sub__(other, context=context)
3867 context._set_rounding(rounding)
3868
3869 This will make it round up for that operation.
3870 """
3871 rounding = self.rounding
3872 self.rounding= type
3873 return rounding
3874
Raymond Hettingerfed52962004-07-14 15:41:57 +00003875 def create_decimal(self, num='0'):
Mark Dickinson59bc20b2008-01-12 01:56:00 +00003876 """Creates a new Decimal instance but using self as context.
3877
3878 This method implements the to-number operation of the
3879 IBM Decimal specification."""
3880
3881 if isinstance(num, basestring) and num != num.strip():
3882 return self._raise_error(ConversionSyntax,
3883 "no trailing or leading whitespace is "
3884 "permitted.")
3885
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003886 d = Decimal(num, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00003887 if d._isnan() and len(d._int) > self.prec - self._clamp:
3888 return self._raise_error(ConversionSyntax,
3889 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003890 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003891
Raymond Hettingerf4d85972009-01-03 19:02:23 +00003892 def create_decimal_from_float(self, f):
3893 """Creates a new Decimal instance from a float but rounding using self
3894 as the context.
3895
3896 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3897 >>> context.create_decimal_from_float(3.1415926535897932)
3898 Decimal('3.1415')
3899 >>> context = Context(prec=5, traps=[Inexact])
3900 >>> context.create_decimal_from_float(3.1415926535897932)
3901 Traceback (most recent call last):
3902 ...
3903 Inexact: None
3904
3905 """
3906 d = Decimal.from_float(f) # An exact conversion
3907 return d._fix(self) # Apply the context rounding
3908
Facundo Batista59c58842007-04-10 12:58:45 +00003909 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003910 def abs(self, a):
3911 """Returns the absolute value of the operand.
3912
3913 If the operand is negative, the result is the same as using the minus
Facundo Batista59c58842007-04-10 12:58:45 +00003914 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003915 the plus operation on the operand.
3916
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003917 >>> ExtendedContext.abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003918 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003919 >>> ExtendedContext.abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003920 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003921 >>> ExtendedContext.abs(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003922 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003923 >>> ExtendedContext.abs(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003924 Decimal('101.5')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003925 >>> ExtendedContext.abs(-1)
3926 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003927 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003928 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003929 return a.__abs__(context=self)
3930
3931 def add(self, a, b):
3932 """Return the sum of the two operands.
3933
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003934 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003935 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003936 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003937 Decimal('1.02E+4')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003938 >>> ExtendedContext.add(1, Decimal(2))
3939 Decimal('3')
3940 >>> ExtendedContext.add(Decimal(8), 5)
3941 Decimal('13')
3942 >>> ExtendedContext.add(5, 5)
3943 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003944 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003945 a = _convert_other(a, raiseit=True)
3946 r = a.__add__(b, context=self)
3947 if r is NotImplemented:
3948 raise TypeError("Unable to convert %s to Decimal" % b)
3949 else:
3950 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003951
3952 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003953 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003954
Facundo Batista353750c2007-09-13 18:13:15 +00003955 def canonical(self, a):
3956 """Returns the same Decimal object.
3957
3958 As we do not have different encodings for the same number, the
3959 received object already is in its canonical form.
3960
3961 >>> ExtendedContext.canonical(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003962 Decimal('2.50')
Facundo Batista353750c2007-09-13 18:13:15 +00003963 """
3964 return a.canonical(context=self)
3965
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003966 def compare(self, a, b):
3967 """Compares values numerically.
3968
3969 If the signs of the operands differ, a value representing each operand
3970 ('-1' if the operand is less than zero, '0' if the operand is zero or
3971 negative zero, or '1' if the operand is greater than zero) is used in
3972 place of that operand for the comparison instead of the actual
3973 operand.
3974
3975 The comparison is then effected by subtracting the second operand from
3976 the first and then returning a value according to the result of the
3977 subtraction: '-1' if the result is less than zero, '0' if the result is
3978 zero or negative zero, or '1' if the result is greater than zero.
3979
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003980 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003981 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003982 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003983 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003984 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003985 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003986 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003987 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003988 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003989 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003990 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00003991 Decimal('-1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003992 >>> ExtendedContext.compare(1, 2)
3993 Decimal('-1')
3994 >>> ExtendedContext.compare(Decimal(1), 2)
3995 Decimal('-1')
3996 >>> ExtendedContext.compare(1, Decimal(2))
3997 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003998 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00003999 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004000 return a.compare(b, context=self)
4001
Facundo Batista353750c2007-09-13 18:13:15 +00004002 def compare_signal(self, a, b):
4003 """Compares the values of the two operands numerically.
4004
4005 It's pretty much like compare(), but all NaNs signal, with signaling
4006 NaNs taking precedence over quiet NaNs.
4007
4008 >>> c = ExtendedContext
4009 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004010 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004011 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004012 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004013 >>> c.flags[InvalidOperation] = 0
4014 >>> print c.flags[InvalidOperation]
4015 0
4016 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004017 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004018 >>> print c.flags[InvalidOperation]
4019 1
4020 >>> c.flags[InvalidOperation] = 0
4021 >>> print c.flags[InvalidOperation]
4022 0
4023 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004024 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004025 >>> print c.flags[InvalidOperation]
4026 1
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004027 >>> c.compare_signal(-1, 2)
4028 Decimal('-1')
4029 >>> c.compare_signal(Decimal(-1), 2)
4030 Decimal('-1')
4031 >>> c.compare_signal(-1, Decimal(2))
4032 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004033 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004034 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004035 return a.compare_signal(b, context=self)
4036
4037 def compare_total(self, a, b):
4038 """Compares two operands using their abstract representation.
4039
4040 This is not like the standard compare, which use their numerical
4041 value. Note that a total ordering is defined for all possible abstract
4042 representations.
4043
4044 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004045 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004046 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004047 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004048 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004049 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004050 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004051 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004052 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004053 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004054 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004055 Decimal('-1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004056 >>> ExtendedContext.compare_total(1, 2)
4057 Decimal('-1')
4058 >>> ExtendedContext.compare_total(Decimal(1), 2)
4059 Decimal('-1')
4060 >>> ExtendedContext.compare_total(1, Decimal(2))
4061 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004062 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004063 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004064 return a.compare_total(b)
4065
4066 def compare_total_mag(self, a, b):
4067 """Compares two operands using their abstract representation ignoring sign.
4068
4069 Like compare_total, but with operand's sign ignored and assumed to be 0.
4070 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004071 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004072 return a.compare_total_mag(b)
4073
4074 def copy_abs(self, a):
4075 """Returns a copy of the operand with the sign set to 0.
4076
4077 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004078 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00004079 >>> ExtendedContext.copy_abs(Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004080 Decimal('100')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004081 >>> ExtendedContext.copy_abs(-1)
4082 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004083 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004084 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004085 return a.copy_abs()
4086
4087 def copy_decimal(self, a):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004088 """Returns a copy of the decimal object.
Facundo Batista353750c2007-09-13 18:13:15 +00004089
4090 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004091 Decimal('2.1')
Facundo Batista353750c2007-09-13 18:13:15 +00004092 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004093 Decimal('-1.00')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004094 >>> ExtendedContext.copy_decimal(1)
4095 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004096 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004097 a = _convert_other(a, raiseit=True)
Facundo Batista6c398da2007-09-17 17:30:13 +00004098 return Decimal(a)
Facundo Batista353750c2007-09-13 18:13:15 +00004099
4100 def copy_negate(self, a):
4101 """Returns a copy of the operand with the sign inverted.
4102
4103 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004104 Decimal('-101.5')
Facundo Batista353750c2007-09-13 18:13:15 +00004105 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004106 Decimal('101.5')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004107 >>> ExtendedContext.copy_negate(1)
4108 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004109 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004110 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004111 return a.copy_negate()
4112
4113 def copy_sign(self, a, b):
4114 """Copies the second operand's sign to the first one.
4115
4116 In detail, it returns a copy of the first operand with the sign
4117 equal to the sign of the second operand.
4118
4119 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004120 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004121 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004122 Decimal('1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004123 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004124 Decimal('-1.50')
Facundo Batista353750c2007-09-13 18:13:15 +00004125 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004126 Decimal('-1.50')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004127 >>> ExtendedContext.copy_sign(1, -2)
4128 Decimal('-1')
4129 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4130 Decimal('-1')
4131 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4132 Decimal('-1')
Facundo Batista353750c2007-09-13 18:13:15 +00004133 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004134 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004135 return a.copy_sign(b)
4136
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004137 def divide(self, a, b):
4138 """Decimal division in a specified context.
4139
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004140 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004141 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004142 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004143 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004144 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004145 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004146 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004147 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004148 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004149 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004150 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004151 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004152 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004153 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004154 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004155 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004156 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004157 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004158 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004159 Decimal('1.20E+6')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004160 >>> ExtendedContext.divide(5, 5)
4161 Decimal('1')
4162 >>> ExtendedContext.divide(Decimal(5), 5)
4163 Decimal('1')
4164 >>> ExtendedContext.divide(5, Decimal(5))
4165 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004166 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004167 a = _convert_other(a, raiseit=True)
4168 r = a.__div__(b, context=self)
4169 if r is NotImplemented:
4170 raise TypeError("Unable to convert %s to Decimal" % b)
4171 else:
4172 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004173
4174 def divide_int(self, a, b):
4175 """Divides two numbers and returns the integer part of the result.
4176
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004177 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004178 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004179 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004180 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004181 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004182 Decimal('3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004183 >>> ExtendedContext.divide_int(10, 3)
4184 Decimal('3')
4185 >>> ExtendedContext.divide_int(Decimal(10), 3)
4186 Decimal('3')
4187 >>> ExtendedContext.divide_int(10, Decimal(3))
4188 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004189 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004190 a = _convert_other(a, raiseit=True)
4191 r = a.__floordiv__(b, context=self)
4192 if r is NotImplemented:
4193 raise TypeError("Unable to convert %s to Decimal" % b)
4194 else:
4195 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004196
4197 def divmod(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004198 """Return (a // b, a % b).
Mark Dickinson202eb902010-01-06 16:20:22 +00004199
4200 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4201 (Decimal('2'), Decimal('2'))
4202 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4203 (Decimal('2'), Decimal('0'))
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004204 >>> ExtendedContext.divmod(8, 4)
4205 (Decimal('2'), Decimal('0'))
4206 >>> ExtendedContext.divmod(Decimal(8), 4)
4207 (Decimal('2'), Decimal('0'))
4208 >>> ExtendedContext.divmod(8, Decimal(4))
4209 (Decimal('2'), Decimal('0'))
Mark Dickinson202eb902010-01-06 16:20:22 +00004210 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004211 a = _convert_other(a, raiseit=True)
4212 r = a.__divmod__(b, context=self)
4213 if r is NotImplemented:
4214 raise TypeError("Unable to convert %s to Decimal" % b)
4215 else:
4216 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004217
Facundo Batista353750c2007-09-13 18:13:15 +00004218 def exp(self, a):
4219 """Returns e ** a.
4220
4221 >>> c = ExtendedContext.copy()
4222 >>> c.Emin = -999
4223 >>> c.Emax = 999
4224 >>> c.exp(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004225 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004226 >>> c.exp(Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004227 Decimal('0.367879441')
Facundo Batista353750c2007-09-13 18:13:15 +00004228 >>> c.exp(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004229 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004230 >>> c.exp(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004231 Decimal('2.71828183')
Facundo Batista353750c2007-09-13 18:13:15 +00004232 >>> c.exp(Decimal('0.693147181'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004233 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004234 >>> c.exp(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004235 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004236 >>> c.exp(10)
4237 Decimal('22026.4658')
Facundo Batista353750c2007-09-13 18:13:15 +00004238 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004239 a =_convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004240 return a.exp(context=self)
4241
4242 def fma(self, a, b, c):
4243 """Returns a multiplied by b, plus c.
4244
4245 The first two operands are multiplied together, using multiply,
4246 the third operand is then added to the result of that
4247 multiplication, using add, all with only one final rounding.
4248
4249 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004250 Decimal('22')
Facundo Batista353750c2007-09-13 18:13:15 +00004251 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004252 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004253 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004254 Decimal('1.38435736E+12')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004255 >>> ExtendedContext.fma(1, 3, 4)
4256 Decimal('7')
4257 >>> ExtendedContext.fma(1, Decimal(3), 4)
4258 Decimal('7')
4259 >>> ExtendedContext.fma(1, 3, Decimal(4))
4260 Decimal('7')
Facundo Batista353750c2007-09-13 18:13:15 +00004261 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004262 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004263 return a.fma(b, c, context=self)
4264
4265 def is_canonical(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004266 """Return True if the operand is canonical; otherwise return False.
4267
4268 Currently, the encoding of a Decimal instance is always
4269 canonical, so this method returns True for any Decimal.
Facundo Batista353750c2007-09-13 18:13:15 +00004270
4271 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004272 True
Facundo Batista353750c2007-09-13 18:13:15 +00004273 """
Facundo Batista1a191df2007-10-02 17:01:24 +00004274 return a.is_canonical()
Facundo Batista353750c2007-09-13 18:13:15 +00004275
4276 def is_finite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004277 """Return True if the operand is finite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004278
Facundo Batista1a191df2007-10-02 17:01:24 +00004279 A Decimal instance is considered finite if it is neither
4280 infinite nor a NaN.
Facundo Batista353750c2007-09-13 18:13:15 +00004281
4282 >>> ExtendedContext.is_finite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004283 True
Facundo Batista353750c2007-09-13 18:13:15 +00004284 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004285 True
Facundo Batista353750c2007-09-13 18:13:15 +00004286 >>> ExtendedContext.is_finite(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004287 True
Facundo Batista353750c2007-09-13 18:13:15 +00004288 >>> ExtendedContext.is_finite(Decimal('Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004289 False
Facundo Batista353750c2007-09-13 18:13:15 +00004290 >>> ExtendedContext.is_finite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004291 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004292 >>> ExtendedContext.is_finite(1)
4293 True
Facundo Batista353750c2007-09-13 18:13:15 +00004294 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004295 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004296 return a.is_finite()
4297
4298 def is_infinite(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004299 """Return True if the operand is infinite; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004300
4301 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004302 False
Facundo Batista353750c2007-09-13 18:13:15 +00004303 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004304 True
Facundo Batista353750c2007-09-13 18:13:15 +00004305 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004306 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004307 >>> ExtendedContext.is_infinite(1)
4308 False
Facundo Batista353750c2007-09-13 18:13:15 +00004309 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004310 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004311 return a.is_infinite()
4312
4313 def is_nan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004314 """Return True if the operand is a qNaN or sNaN;
4315 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004316
4317 >>> ExtendedContext.is_nan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004318 False
Facundo Batista353750c2007-09-13 18:13:15 +00004319 >>> ExtendedContext.is_nan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004320 True
Facundo Batista353750c2007-09-13 18:13:15 +00004321 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004322 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004323 >>> ExtendedContext.is_nan(1)
4324 False
Facundo Batista353750c2007-09-13 18:13:15 +00004325 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004326 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004327 return a.is_nan()
4328
4329 def is_normal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004330 """Return True if the operand is a normal number;
4331 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004332
4333 >>> c = ExtendedContext.copy()
4334 >>> c.Emin = -999
4335 >>> c.Emax = 999
4336 >>> c.is_normal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004337 True
Facundo Batista353750c2007-09-13 18:13:15 +00004338 >>> c.is_normal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004339 False
Facundo Batista353750c2007-09-13 18:13:15 +00004340 >>> c.is_normal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004341 False
Facundo Batista353750c2007-09-13 18:13:15 +00004342 >>> c.is_normal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004343 False
Facundo Batista353750c2007-09-13 18:13:15 +00004344 >>> c.is_normal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004345 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004346 >>> c.is_normal(1)
4347 True
Facundo Batista353750c2007-09-13 18:13:15 +00004348 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004349 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004350 return a.is_normal(context=self)
4351
4352 def is_qnan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004353 """Return True if the operand is a quiet NaN; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004354
4355 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004356 False
Facundo Batista353750c2007-09-13 18:13:15 +00004357 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004358 True
Facundo Batista353750c2007-09-13 18:13:15 +00004359 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004360 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004361 >>> ExtendedContext.is_qnan(1)
4362 False
Facundo Batista353750c2007-09-13 18:13:15 +00004363 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004364 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004365 return a.is_qnan()
4366
4367 def is_signed(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004368 """Return True if the operand is negative; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004369
4370 >>> ExtendedContext.is_signed(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004371 False
Facundo Batista353750c2007-09-13 18:13:15 +00004372 >>> ExtendedContext.is_signed(Decimal('-12'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004373 True
Facundo Batista353750c2007-09-13 18:13:15 +00004374 >>> ExtendedContext.is_signed(Decimal('-0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004375 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004376 >>> ExtendedContext.is_signed(8)
4377 False
4378 >>> ExtendedContext.is_signed(-8)
4379 True
Facundo Batista353750c2007-09-13 18:13:15 +00004380 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004381 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004382 return a.is_signed()
4383
4384 def is_snan(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004385 """Return True if the operand is a signaling NaN;
4386 otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004387
4388 >>> ExtendedContext.is_snan(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004389 False
Facundo Batista353750c2007-09-13 18:13:15 +00004390 >>> ExtendedContext.is_snan(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004391 False
Facundo Batista353750c2007-09-13 18:13:15 +00004392 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004393 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004394 >>> ExtendedContext.is_snan(1)
4395 False
Facundo Batista353750c2007-09-13 18:13:15 +00004396 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004397 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004398 return a.is_snan()
4399
4400 def is_subnormal(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004401 """Return True if the operand is subnormal; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004402
4403 >>> c = ExtendedContext.copy()
4404 >>> c.Emin = -999
4405 >>> c.Emax = 999
4406 >>> c.is_subnormal(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004407 False
Facundo Batista353750c2007-09-13 18:13:15 +00004408 >>> c.is_subnormal(Decimal('0.1E-999'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004409 True
Facundo Batista353750c2007-09-13 18:13:15 +00004410 >>> c.is_subnormal(Decimal('0.00'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004411 False
Facundo Batista353750c2007-09-13 18:13:15 +00004412 >>> c.is_subnormal(Decimal('-Inf'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004413 False
Facundo Batista353750c2007-09-13 18:13:15 +00004414 >>> c.is_subnormal(Decimal('NaN'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004415 False
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004416 >>> c.is_subnormal(1)
4417 False
Facundo Batista353750c2007-09-13 18:13:15 +00004418 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004419 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004420 return a.is_subnormal(context=self)
4421
4422 def is_zero(self, a):
Facundo Batista1a191df2007-10-02 17:01:24 +00004423 """Return True if the operand is a zero; otherwise return False.
Facundo Batista353750c2007-09-13 18:13:15 +00004424
4425 >>> ExtendedContext.is_zero(Decimal('0'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004426 True
Facundo Batista353750c2007-09-13 18:13:15 +00004427 >>> ExtendedContext.is_zero(Decimal('2.50'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004428 False
Facundo Batista353750c2007-09-13 18:13:15 +00004429 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Facundo Batista1a191df2007-10-02 17:01:24 +00004430 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004431 >>> ExtendedContext.is_zero(1)
4432 False
4433 >>> ExtendedContext.is_zero(0)
4434 True
Facundo Batista353750c2007-09-13 18:13:15 +00004435 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004436 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004437 return a.is_zero()
4438
4439 def ln(self, a):
4440 """Returns the natural (base e) logarithm of the operand.
4441
4442 >>> c = ExtendedContext.copy()
4443 >>> c.Emin = -999
4444 >>> c.Emax = 999
4445 >>> c.ln(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004446 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004447 >>> c.ln(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004448 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004449 >>> c.ln(Decimal('2.71828183'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004450 Decimal('1.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004451 >>> c.ln(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004452 Decimal('2.30258509')
Facundo Batista353750c2007-09-13 18:13:15 +00004453 >>> c.ln(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004454 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004455 >>> c.ln(1)
4456 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004457 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004458 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004459 return a.ln(context=self)
4460
4461 def log10(self, a):
4462 """Returns the base 10 logarithm of the operand.
4463
4464 >>> c = ExtendedContext.copy()
4465 >>> c.Emin = -999
4466 >>> c.Emax = 999
4467 >>> c.log10(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004468 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004469 >>> c.log10(Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004470 Decimal('-3')
Facundo Batista353750c2007-09-13 18:13:15 +00004471 >>> c.log10(Decimal('1.000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004472 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004473 >>> c.log10(Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004474 Decimal('0.301029996')
Facundo Batista353750c2007-09-13 18:13:15 +00004475 >>> c.log10(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004476 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004477 >>> c.log10(Decimal('70'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004478 Decimal('1.84509804')
Facundo Batista353750c2007-09-13 18:13:15 +00004479 >>> c.log10(Decimal('+Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004480 Decimal('Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004481 >>> c.log10(0)
4482 Decimal('-Infinity')
4483 >>> c.log10(1)
4484 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004485 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004486 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004487 return a.log10(context=self)
4488
4489 def logb(self, a):
4490 """ Returns the exponent of the magnitude of the operand's MSD.
4491
4492 The result is the integer which is the exponent of the magnitude
4493 of the most significant digit of the operand (as though the
4494 operand were truncated to a single digit while maintaining the
4495 value of that digit and without limiting the resulting exponent).
4496
4497 >>> ExtendedContext.logb(Decimal('250'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004498 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004499 >>> ExtendedContext.logb(Decimal('2.50'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004500 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004501 >>> ExtendedContext.logb(Decimal('0.03'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004502 Decimal('-2')
Facundo Batista353750c2007-09-13 18:13:15 +00004503 >>> ExtendedContext.logb(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004504 Decimal('-Infinity')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004505 >>> ExtendedContext.logb(1)
4506 Decimal('0')
4507 >>> ExtendedContext.logb(10)
4508 Decimal('1')
4509 >>> ExtendedContext.logb(100)
4510 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00004511 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004512 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004513 return a.logb(context=self)
4514
4515 def logical_and(self, a, b):
4516 """Applies the logical operation 'and' between each operand's digits.
4517
4518 The operands must be both logical numbers.
4519
4520 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004521 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004522 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004523 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004524 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004525 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004526 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004527 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004528 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004529 Decimal('1000')
Facundo Batista353750c2007-09-13 18:13:15 +00004530 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004531 Decimal('10')
Mark Dickinson456e1652010-02-18 14:45:33 +00004532 >>> ExtendedContext.logical_and(110, 1101)
4533 Decimal('100')
4534 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4535 Decimal('100')
4536 >>> ExtendedContext.logical_and(110, Decimal(1101))
4537 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00004538 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004539 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004540 return a.logical_and(b, context=self)
4541
4542 def logical_invert(self, a):
4543 """Invert all the digits in the operand.
4544
4545 The operand must be a logical number.
4546
4547 >>> ExtendedContext.logical_invert(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004548 Decimal('111111111')
Facundo Batista353750c2007-09-13 18:13:15 +00004549 >>> ExtendedContext.logical_invert(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004550 Decimal('111111110')
Facundo Batista353750c2007-09-13 18:13:15 +00004551 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004552 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004553 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004554 Decimal('10101010')
Mark Dickinson456e1652010-02-18 14:45:33 +00004555 >>> ExtendedContext.logical_invert(1101)
4556 Decimal('111110010')
Facundo Batista353750c2007-09-13 18:13:15 +00004557 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004558 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004559 return a.logical_invert(context=self)
4560
4561 def logical_or(self, a, b):
4562 """Applies the logical operation 'or' between each operand's digits.
4563
4564 The operands must be both logical numbers.
4565
4566 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004567 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004568 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004569 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004570 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004571 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004572 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004573 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004574 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004575 Decimal('1110')
Facundo Batista353750c2007-09-13 18:13:15 +00004576 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004577 Decimal('1110')
Mark Dickinson456e1652010-02-18 14:45:33 +00004578 >>> ExtendedContext.logical_or(110, 1101)
4579 Decimal('1111')
4580 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4581 Decimal('1111')
4582 >>> ExtendedContext.logical_or(110, Decimal(1101))
4583 Decimal('1111')
Facundo Batista353750c2007-09-13 18:13:15 +00004584 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004585 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004586 return a.logical_or(b, context=self)
4587
4588 def logical_xor(self, a, b):
4589 """Applies the logical operation 'xor' between each operand's digits.
4590
4591 The operands must be both logical numbers.
4592
4593 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004594 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004595 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004596 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004597 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004598 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004599 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004600 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004601 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004602 Decimal('110')
Facundo Batista353750c2007-09-13 18:13:15 +00004603 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004604 Decimal('1101')
Mark Dickinson456e1652010-02-18 14:45:33 +00004605 >>> ExtendedContext.logical_xor(110, 1101)
4606 Decimal('1011')
4607 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4608 Decimal('1011')
4609 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4610 Decimal('1011')
Facundo Batista353750c2007-09-13 18:13:15 +00004611 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004612 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004613 return a.logical_xor(b, context=self)
4614
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004615 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004616 """max compares two values numerically and returns the maximum.
4617
4618 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004619 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004620 operation. If they are numerically equal then the left-hand operand
4621 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004622 infinity) of the two operands is chosen as the result.
4623
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004624 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004625 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004626 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004627 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004628 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004629 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004630 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004631 Decimal('7')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004632 >>> ExtendedContext.max(1, 2)
4633 Decimal('2')
4634 >>> ExtendedContext.max(Decimal(1), 2)
4635 Decimal('2')
4636 >>> ExtendedContext.max(1, Decimal(2))
4637 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004638 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004639 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004640 return a.max(b, context=self)
4641
Facundo Batista353750c2007-09-13 18:13:15 +00004642 def max_mag(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004643 """Compares the values numerically with their sign ignored.
4644
4645 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4646 Decimal('7')
4647 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4648 Decimal('-10')
4649 >>> ExtendedContext.max_mag(1, -2)
4650 Decimal('-2')
4651 >>> ExtendedContext.max_mag(Decimal(1), -2)
4652 Decimal('-2')
4653 >>> ExtendedContext.max_mag(1, Decimal(-2))
4654 Decimal('-2')
4655 """
4656 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004657 return a.max_mag(b, context=self)
4658
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004659 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004660 """min compares two values numerically and returns the minimum.
4661
4662 If either operand is a NaN then the general rules apply.
Andrew M. Kuchlingc8acc882008-01-16 00:32:03 +00004663 Otherwise, the operands are compared as though by the compare
Facundo Batista59c58842007-04-10 12:58:45 +00004664 operation. If they are numerically equal then the left-hand operand
4665 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004666 infinity) of the two operands is chosen as the result.
4667
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004668 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004669 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004670 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004671 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004672 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004673 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004674 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004675 Decimal('7')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004676 >>> ExtendedContext.min(1, 2)
4677 Decimal('1')
4678 >>> ExtendedContext.min(Decimal(1), 2)
4679 Decimal('1')
4680 >>> ExtendedContext.min(1, Decimal(29))
4681 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004682 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004683 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004684 return a.min(b, context=self)
4685
Facundo Batista353750c2007-09-13 18:13:15 +00004686 def min_mag(self, a, b):
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004687 """Compares the values numerically with their sign ignored.
4688
4689 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4690 Decimal('-2')
4691 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4692 Decimal('-3')
4693 >>> ExtendedContext.min_mag(1, -2)
4694 Decimal('1')
4695 >>> ExtendedContext.min_mag(Decimal(1), -2)
4696 Decimal('1')
4697 >>> ExtendedContext.min_mag(1, Decimal(-2))
4698 Decimal('1')
4699 """
4700 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004701 return a.min_mag(b, context=self)
4702
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004703 def minus(self, a):
4704 """Minus corresponds to unary prefix minus in Python.
4705
4706 The operation is evaluated using the same rules as subtract; the
4707 operation minus(a) is calculated as subtract('0', a) where the '0'
4708 has the same exponent as the operand.
4709
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004710 >>> ExtendedContext.minus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004711 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004712 >>> ExtendedContext.minus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004713 Decimal('1.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004714 >>> ExtendedContext.minus(1)
4715 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004716 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004717 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004718 return a.__neg__(context=self)
4719
4720 def multiply(self, a, b):
4721 """multiply multiplies two operands.
4722
Martin v. Löwiscfe31282006-07-19 17:18:32 +00004723 If either operand is a special value then the general rules apply.
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004724 Otherwise, the operands are multiplied together
4725 ('long multiplication'), resulting in a number which may be as long as
4726 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004727
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004728 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004729 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004730 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004731 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004732 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004733 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004734 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004735 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004736 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004737 Decimal('4.28135971E+11')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004738 >>> ExtendedContext.multiply(7, 7)
4739 Decimal('49')
4740 >>> ExtendedContext.multiply(Decimal(7), 7)
4741 Decimal('49')
4742 >>> ExtendedContext.multiply(7, Decimal(7))
4743 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004744 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004745 a = _convert_other(a, raiseit=True)
4746 r = a.__mul__(b, context=self)
4747 if r is NotImplemented:
4748 raise TypeError("Unable to convert %s to Decimal" % b)
4749 else:
4750 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004751
Facundo Batista353750c2007-09-13 18:13:15 +00004752 def next_minus(self, a):
4753 """Returns the largest representable number smaller than a.
4754
4755 >>> c = ExtendedContext.copy()
4756 >>> c.Emin = -999
4757 >>> c.Emax = 999
4758 >>> ExtendedContext.next_minus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004759 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004760 >>> c.next_minus(Decimal('1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004761 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004762 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004763 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004764 >>> c.next_minus(Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004765 Decimal('9.99999999E+999')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004766 >>> c.next_minus(1)
4767 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004768 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004769 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004770 return a.next_minus(context=self)
4771
4772 def next_plus(self, a):
4773 """Returns the smallest representable number larger than a.
4774
4775 >>> c = ExtendedContext.copy()
4776 >>> c.Emin = -999
4777 >>> c.Emax = 999
4778 >>> ExtendedContext.next_plus(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004779 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004780 >>> c.next_plus(Decimal('-1E-1007'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004781 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004782 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004783 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004784 >>> c.next_plus(Decimal('-Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004785 Decimal('-9.99999999E+999')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004786 >>> c.next_plus(1)
4787 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004788 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004789 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004790 return a.next_plus(context=self)
4791
4792 def next_toward(self, a, b):
4793 """Returns the number closest to a, in direction towards b.
4794
4795 The result is the closest representable number from the first
4796 operand (but not the first operand) that is in the direction
4797 towards the second operand, unless the operands have the same
4798 value.
4799
4800 >>> c = ExtendedContext.copy()
4801 >>> c.Emin = -999
4802 >>> c.Emax = 999
4803 >>> c.next_toward(Decimal('1'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004804 Decimal('1.00000001')
Facundo Batista353750c2007-09-13 18:13:15 +00004805 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004806 Decimal('-0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004807 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004808 Decimal('-1.00000002')
Facundo Batista353750c2007-09-13 18:13:15 +00004809 >>> c.next_toward(Decimal('1'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004810 Decimal('0.999999999')
Facundo Batista353750c2007-09-13 18:13:15 +00004811 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004812 Decimal('0E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004813 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004814 Decimal('-1.00000004')
Facundo Batista353750c2007-09-13 18:13:15 +00004815 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004816 Decimal('-0.00')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004817 >>> c.next_toward(0, 1)
4818 Decimal('1E-1007')
4819 >>> c.next_toward(Decimal(0), 1)
4820 Decimal('1E-1007')
4821 >>> c.next_toward(0, Decimal(1))
4822 Decimal('1E-1007')
Facundo Batista353750c2007-09-13 18:13:15 +00004823 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004824 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004825 return a.next_toward(b, context=self)
4826
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004827 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004828 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004829
4830 Essentially a plus operation with all trailing zeros removed from the
4831 result.
4832
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004833 >>> ExtendedContext.normalize(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004834 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004835 >>> ExtendedContext.normalize(Decimal('-2.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004836 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004837 >>> ExtendedContext.normalize(Decimal('1.200'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004838 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004839 >>> ExtendedContext.normalize(Decimal('-120'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004840 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004841 >>> ExtendedContext.normalize(Decimal('120.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004842 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004843 >>> ExtendedContext.normalize(Decimal('0.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004844 Decimal('0')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004845 >>> ExtendedContext.normalize(6)
4846 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004847 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004848 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004849 return a.normalize(context=self)
4850
Facundo Batista353750c2007-09-13 18:13:15 +00004851 def number_class(self, a):
4852 """Returns an indication of the class of the operand.
4853
4854 The class is one of the following strings:
4855 -sNaN
4856 -NaN
4857 -Infinity
4858 -Normal
4859 -Subnormal
4860 -Zero
4861 +Zero
4862 +Subnormal
4863 +Normal
4864 +Infinity
4865
4866 >>> c = Context(ExtendedContext)
4867 >>> c.Emin = -999
4868 >>> c.Emax = 999
4869 >>> c.number_class(Decimal('Infinity'))
4870 '+Infinity'
4871 >>> c.number_class(Decimal('1E-10'))
4872 '+Normal'
4873 >>> c.number_class(Decimal('2.50'))
4874 '+Normal'
4875 >>> c.number_class(Decimal('0.1E-999'))
4876 '+Subnormal'
4877 >>> c.number_class(Decimal('0'))
4878 '+Zero'
4879 >>> c.number_class(Decimal('-0'))
4880 '-Zero'
4881 >>> c.number_class(Decimal('-0.1E-999'))
4882 '-Subnormal'
4883 >>> c.number_class(Decimal('-1E-10'))
4884 '-Normal'
4885 >>> c.number_class(Decimal('-2.50'))
4886 '-Normal'
4887 >>> c.number_class(Decimal('-Infinity'))
4888 '-Infinity'
4889 >>> c.number_class(Decimal('NaN'))
4890 'NaN'
4891 >>> c.number_class(Decimal('-NaN'))
4892 'NaN'
4893 >>> c.number_class(Decimal('sNaN'))
4894 'sNaN'
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004895 >>> c.number_class(123)
4896 '+Normal'
Facundo Batista353750c2007-09-13 18:13:15 +00004897 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004898 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00004899 return a.number_class(context=self)
4900
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004901 def plus(self, a):
4902 """Plus corresponds to unary prefix plus in Python.
4903
4904 The operation is evaluated using the same rules as add; the
4905 operation plus(a) is calculated as add('0', a) where the '0'
4906 has the same exponent as the operand.
4907
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004908 >>> ExtendedContext.plus(Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004909 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004910 >>> ExtendedContext.plus(Decimal('-1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004911 Decimal('-1.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004912 >>> ExtendedContext.plus(-1)
4913 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004914 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004915 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004916 return a.__pos__(context=self)
4917
4918 def power(self, a, b, modulo=None):
4919 """Raises a to the power of b, to modulo if given.
4920
Facundo Batista353750c2007-09-13 18:13:15 +00004921 With two arguments, compute a**b. If a is negative then b
4922 must be integral. The result will be inexact unless b is
4923 integral and the result is finite and can be expressed exactly
4924 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004925
Facundo Batista353750c2007-09-13 18:13:15 +00004926 With three arguments, compute (a**b) % modulo. For the
4927 three argument form, the following restrictions on the
4928 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004929
Facundo Batista353750c2007-09-13 18:13:15 +00004930 - all three arguments must be integral
4931 - b must be nonnegative
4932 - at least one of a or b must be nonzero
4933 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004934
Facundo Batista353750c2007-09-13 18:13:15 +00004935 The result of pow(a, b, modulo) is identical to the result
4936 that would be obtained by computing (a**b) % modulo with
4937 unbounded precision, but is computed more efficiently. It is
4938 always exact.
4939
4940 >>> c = ExtendedContext.copy()
4941 >>> c.Emin = -999
4942 >>> c.Emax = 999
4943 >>> c.power(Decimal('2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004944 Decimal('8')
Facundo Batista353750c2007-09-13 18:13:15 +00004945 >>> c.power(Decimal('-2'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004946 Decimal('-8')
Facundo Batista353750c2007-09-13 18:13:15 +00004947 >>> c.power(Decimal('2'), Decimal('-3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004948 Decimal('0.125')
Facundo Batista353750c2007-09-13 18:13:15 +00004949 >>> c.power(Decimal('1.7'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004950 Decimal('69.7575744')
Facundo Batista353750c2007-09-13 18:13:15 +00004951 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004952 Decimal('2.00000000')
Facundo Batista353750c2007-09-13 18:13:15 +00004953 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004954 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00004955 >>> c.power(Decimal('Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004956 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004957 >>> c.power(Decimal('Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004958 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004959 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004960 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004961 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004962 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004963 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004964 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004965 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004966 Decimal('Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00004967 >>> c.power(Decimal('0'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004968 Decimal('NaN')
Facundo Batista353750c2007-09-13 18:13:15 +00004969
4970 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004971 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004972 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004973 Decimal('-11')
Facundo Batista353750c2007-09-13 18:13:15 +00004974 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004975 Decimal('1')
Facundo Batista353750c2007-09-13 18:13:15 +00004976 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004977 Decimal('11')
Facundo Batista353750c2007-09-13 18:13:15 +00004978 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004979 Decimal('11729830')
Facundo Batista353750c2007-09-13 18:13:15 +00004980 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004981 Decimal('-0')
Facundo Batista353750c2007-09-13 18:13:15 +00004982 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00004983 Decimal('1')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004984 >>> ExtendedContext.power(7, 7)
4985 Decimal('823543')
4986 >>> ExtendedContext.power(Decimal(7), 7)
4987 Decimal('823543')
4988 >>> ExtendedContext.power(7, Decimal(7), 2)
4989 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004990 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00004991 a = _convert_other(a, raiseit=True)
4992 r = a.__pow__(b, modulo, context=self)
4993 if r is NotImplemented:
4994 raise TypeError("Unable to convert %s to Decimal" % b)
4995 else:
4996 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004997
4998 def quantize(self, a, b):
Facundo Batista59c58842007-04-10 12:58:45 +00004999 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005000
5001 The coefficient of the result is derived from that of the left-hand
Facundo Batista59c58842007-04-10 12:58:45 +00005002 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005003 exponent is being increased), multiplied by a positive power of ten (if
5004 the exponent is being decreased), or is unchanged (if the exponent is
5005 already equal to that of the right-hand operand).
5006
5007 Unlike other operations, if the length of the coefficient after the
5008 quantize operation would be greater than precision then an Invalid
Facundo Batista59c58842007-04-10 12:58:45 +00005009 operation condition is raised. This guarantees that, unless there is
5010 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005011 equal to that of the right-hand operand.
5012
5013 Also unlike other operations, quantize will never raise Underflow, even
5014 if the result is subnormal and inexact.
5015
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005016 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005017 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005018 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005019 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005020 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005021 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005022 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005023 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005024 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005025 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005026 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005027 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005028 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005029 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005030 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005031 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005032 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005033 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005034 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005035 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005036 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005037 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005038 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005039 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005040 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005041 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005042 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005043 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005044 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005045 Decimal('2E+2')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005046 >>> ExtendedContext.quantize(1, 2)
5047 Decimal('1')
5048 >>> ExtendedContext.quantize(Decimal(1), 2)
5049 Decimal('1')
5050 >>> ExtendedContext.quantize(1, Decimal(2))
5051 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005052 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005053 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005054 return a.quantize(b, context=self)
5055
Facundo Batista353750c2007-09-13 18:13:15 +00005056 def radix(self):
5057 """Just returns 10, as this is Decimal, :)
5058
5059 >>> ExtendedContext.radix()
Raymond Hettingerabe32372008-02-14 02:41:22 +00005060 Decimal('10')
Facundo Batista353750c2007-09-13 18:13:15 +00005061 """
5062 return Decimal(10)
5063
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005064 def remainder(self, a, b):
5065 """Returns the remainder from integer division.
5066
5067 The result is the residue of the dividend after the operation of
Facundo Batista59c58842007-04-10 12:58:45 +00005068 calculating integer division as described for divide-integer, rounded
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00005069 to precision digits if necessary. The sign of the result, if
Facundo Batista59c58842007-04-10 12:58:45 +00005070 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005071
5072 This operation will fail under the same conditions as integer division
5073 (that is, if integer division on the same two operands would fail, the
5074 remainder cannot be calculated).
5075
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005076 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005077 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005078 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005079 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005080 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005081 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005082 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005083 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005084 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005085 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005086 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005087 Decimal('1.0')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005088 >>> ExtendedContext.remainder(22, 6)
5089 Decimal('4')
5090 >>> ExtendedContext.remainder(Decimal(22), 6)
5091 Decimal('4')
5092 >>> ExtendedContext.remainder(22, Decimal(6))
5093 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005094 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005095 a = _convert_other(a, raiseit=True)
5096 r = a.__mod__(b, context=self)
5097 if r is NotImplemented:
5098 raise TypeError("Unable to convert %s to Decimal" % b)
5099 else:
5100 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005101
5102 def remainder_near(self, a, b):
5103 """Returns to be "a - b * n", where n is the integer nearest the exact
5104 value of "x / b" (if two integers are equally near then the even one
Facundo Batista59c58842007-04-10 12:58:45 +00005105 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005106 sign of a.
5107
5108 This operation will fail under the same conditions as integer division
5109 (that is, if integer division on the same two operands would fail, the
5110 remainder cannot be calculated).
5111
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005112 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005113 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005114 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005115 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005116 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005117 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005118 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005119 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005120 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005121 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005122 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005123 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005124 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005125 Decimal('-0.3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005126 >>> ExtendedContext.remainder_near(3, 11)
5127 Decimal('3')
5128 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5129 Decimal('3')
5130 >>> ExtendedContext.remainder_near(3, Decimal(11))
5131 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005132 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005133 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005134 return a.remainder_near(b, context=self)
5135
Facundo Batista353750c2007-09-13 18:13:15 +00005136 def rotate(self, a, b):
5137 """Returns a rotated copy of a, b times.
5138
5139 The coefficient of the result is a rotated copy of the digits in
5140 the coefficient of the first operand. The number of places of
5141 rotation is taken from the absolute value of the second operand,
5142 with the rotation being to the left if the second operand is
5143 positive or to the right otherwise.
5144
5145 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005146 Decimal('400000003')
Facundo Batista353750c2007-09-13 18:13:15 +00005147 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005148 Decimal('12')
Facundo Batista353750c2007-09-13 18:13:15 +00005149 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005150 Decimal('891234567')
Facundo Batista353750c2007-09-13 18:13:15 +00005151 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005152 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00005153 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005154 Decimal('345678912')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005155 >>> ExtendedContext.rotate(1333333, 1)
5156 Decimal('13333330')
5157 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5158 Decimal('13333330')
5159 >>> ExtendedContext.rotate(1333333, Decimal(1))
5160 Decimal('13333330')
Facundo Batista353750c2007-09-13 18:13:15 +00005161 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005162 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005163 return a.rotate(b, context=self)
5164
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005165 def same_quantum(self, a, b):
5166 """Returns True if the two operands have the same exponent.
5167
5168 The result is never affected by either the sign or the coefficient of
5169 either operand.
5170
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005171 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005172 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005173 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005174 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005175 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005176 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005177 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005178 True
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005179 >>> ExtendedContext.same_quantum(10000, -1)
5180 True
5181 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5182 True
5183 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5184 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005185 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005186 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005187 return a.same_quantum(b)
5188
Facundo Batista353750c2007-09-13 18:13:15 +00005189 def scaleb (self, a, b):
5190 """Returns the first operand after adding the second value its exp.
5191
5192 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005193 Decimal('0.0750')
Facundo Batista353750c2007-09-13 18:13:15 +00005194 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005195 Decimal('7.50')
Facundo Batista353750c2007-09-13 18:13:15 +00005196 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005197 Decimal('7.50E+3')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005198 >>> ExtendedContext.scaleb(1, 4)
5199 Decimal('1E+4')
5200 >>> ExtendedContext.scaleb(Decimal(1), 4)
5201 Decimal('1E+4')
5202 >>> ExtendedContext.scaleb(1, Decimal(4))
5203 Decimal('1E+4')
Facundo Batista353750c2007-09-13 18:13:15 +00005204 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005205 a = _convert_other(a, raiseit=True)
5206 return a.scaleb(b, context=self)
Facundo Batista353750c2007-09-13 18:13:15 +00005207
5208 def shift(self, a, b):
5209 """Returns a shifted copy of a, b times.
5210
5211 The coefficient of the result is a shifted copy of the digits
5212 in the coefficient of the first operand. The number of places
5213 to shift is taken from the absolute value of the second operand,
5214 with the shift being to the left if the second operand is
5215 positive or to the right otherwise. Digits shifted into the
5216 coefficient are zeros.
5217
5218 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005219 Decimal('400000000')
Facundo Batista353750c2007-09-13 18:13:15 +00005220 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005221 Decimal('0')
Facundo Batista353750c2007-09-13 18:13:15 +00005222 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005223 Decimal('1234567')
Facundo Batista353750c2007-09-13 18:13:15 +00005224 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005225 Decimal('123456789')
Facundo Batista353750c2007-09-13 18:13:15 +00005226 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005227 Decimal('345678900')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005228 >>> ExtendedContext.shift(88888888, 2)
5229 Decimal('888888800')
5230 >>> ExtendedContext.shift(Decimal(88888888), 2)
5231 Decimal('888888800')
5232 >>> ExtendedContext.shift(88888888, Decimal(2))
5233 Decimal('888888800')
Facundo Batista353750c2007-09-13 18:13:15 +00005234 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005235 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005236 return a.shift(b, context=self)
5237
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005238 def sqrt(self, a):
Facundo Batista59c58842007-04-10 12:58:45 +00005239 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005240
5241 If the result must be inexact, it is rounded using the round-half-even
5242 algorithm.
5243
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005244 >>> ExtendedContext.sqrt(Decimal('0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005245 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005246 >>> ExtendedContext.sqrt(Decimal('-0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005247 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005248 >>> ExtendedContext.sqrt(Decimal('0.39'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005249 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005250 >>> ExtendedContext.sqrt(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005251 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005252 >>> ExtendedContext.sqrt(Decimal('1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005253 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005254 >>> ExtendedContext.sqrt(Decimal('1.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005255 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005256 >>> ExtendedContext.sqrt(Decimal('1.00'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005257 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005258 >>> ExtendedContext.sqrt(Decimal('7'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005259 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005260 >>> ExtendedContext.sqrt(Decimal('10'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005261 Decimal('3.16227766')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005262 >>> ExtendedContext.sqrt(2)
5263 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005264 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005265 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005266 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005267 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005268 return a.sqrt(context=self)
5269
5270 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005271 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005272
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005273 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005274 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005275 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005276 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005277 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005278 Decimal('-0.77')
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005279 >>> ExtendedContext.subtract(8, 5)
5280 Decimal('3')
5281 >>> ExtendedContext.subtract(Decimal(8), 5)
5282 Decimal('3')
5283 >>> ExtendedContext.subtract(8, Decimal(5))
5284 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005285 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005286 a = _convert_other(a, raiseit=True)
5287 r = a.__sub__(b, context=self)
5288 if r is NotImplemented:
5289 raise TypeError("Unable to convert %s to Decimal" % b)
5290 else:
5291 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005292
5293 def to_eng_string(self, a):
5294 """Converts a number to a string, using scientific notation.
5295
5296 The operation is not affected by the context.
5297 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005298 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005299 return a.to_eng_string(context=self)
5300
5301 def to_sci_string(self, a):
5302 """Converts a number to a string, using scientific notation.
5303
5304 The operation is not affected by the context.
5305 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005306 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005307 return a.__str__(context=self)
5308
Facundo Batista353750c2007-09-13 18:13:15 +00005309 def to_integral_exact(self, a):
5310 """Rounds to an integer.
5311
5312 When the operand has a negative exponent, the result is the same
5313 as using the quantize() operation using the given operand as the
5314 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5315 of the operand as the precision setting; Inexact and Rounded flags
5316 are allowed in this operation. The rounding mode is taken from the
5317 context.
5318
5319 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005320 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00005321 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005322 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005323 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005324 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005325 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005326 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00005327 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005328 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00005329 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005330 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00005331 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005332 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00005333 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005334 Decimal('-Infinity')
Facundo Batista353750c2007-09-13 18:13:15 +00005335 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005336 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005337 return a.to_integral_exact(context=self)
5338
5339 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005340 """Rounds to an integer.
5341
5342 When the operand has a negative exponent, the result is the same
5343 as using the quantize() operation using the given operand as the
5344 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5345 of the operand as the precision setting, except that no flags will
Facundo Batista59c58842007-04-10 12:58:45 +00005346 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005347
Facundo Batista353750c2007-09-13 18:13:15 +00005348 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005349 Decimal('2')
Facundo Batista353750c2007-09-13 18:13:15 +00005350 >>> ExtendedContext.to_integral_value(Decimal('100'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005351 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005352 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005353 Decimal('100')
Facundo Batista353750c2007-09-13 18:13:15 +00005354 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005355 Decimal('102')
Facundo Batista353750c2007-09-13 18:13:15 +00005356 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005357 Decimal('-102')
Facundo Batista353750c2007-09-13 18:13:15 +00005358 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005359 Decimal('1.0E+6')
Facundo Batista353750c2007-09-13 18:13:15 +00005360 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005361 Decimal('7.89E+77')
Facundo Batista353750c2007-09-13 18:13:15 +00005362 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Raymond Hettingerabe32372008-02-14 02:41:22 +00005363 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005364 """
Mark Dickinson6d8effb2010-02-18 14:27:02 +00005365 a = _convert_other(a, raiseit=True)
Facundo Batista353750c2007-09-13 18:13:15 +00005366 return a.to_integral_value(context=self)
5367
5368 # the method name changed, but we provide also the old one, for compatibility
5369 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005370
5371class _WorkRep(object):
5372 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005373 # sign: 0 or 1
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005374 # int: int or long
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005375 # exp: None, int, or string
5376
5377 def __init__(self, value=None):
5378 if value is None:
5379 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005380 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005381 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005382 elif isinstance(value, Decimal):
5383 self.sign = value._sign
Facundo Batista72bc54f2007-11-23 17:59:00 +00005384 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005385 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005386 else:
5387 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005388 self.sign = value[0]
5389 self.int = value[1]
5390 self.exp = value[2]
5391
5392 def __repr__(self):
5393 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5394
5395 __str__ = __repr__
5396
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005397
5398
Facundo Batistae64acfa2007-12-17 14:18:42 +00005399def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005400 """Normalizes op1, op2 to have the same exp and length of coefficient.
5401
5402 Done during addition.
5403 """
Facundo Batista353750c2007-09-13 18:13:15 +00005404 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005405 tmp = op2
5406 other = op1
5407 else:
5408 tmp = op1
5409 other = op2
5410
Facundo Batista353750c2007-09-13 18:13:15 +00005411 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5412 # Then adding 10**exp to tmp has the same effect (after rounding)
5413 # as adding any positive quantity smaller than 10**exp; similarly
5414 # for subtraction. So if other is smaller than 10**exp we replace
5415 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Facundo Batistae64acfa2007-12-17 14:18:42 +00005416 tmp_len = len(str(tmp.int))
5417 other_len = len(str(other.int))
5418 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5419 if other_len + other.exp - 1 < exp:
5420 other.int = 1
5421 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005422
Facundo Batista353750c2007-09-13 18:13:15 +00005423 tmp.int *= 10 ** (tmp.exp - other.exp)
5424 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005425 return op1, op2
5426
Facundo Batista353750c2007-09-13 18:13:15 +00005427##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
5428
5429# This function from Tim Peters was taken from here:
5430# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5431# The correction being in the function definition is for speed, and
5432# the whole function is not resolved with math.log because of avoiding
5433# the use of floats.
5434def _nbits(n, correction = {
5435 '0': 4, '1': 3, '2': 2, '3': 2,
5436 '4': 1, '5': 1, '6': 1, '7': 1,
5437 '8': 0, '9': 0, 'a': 0, 'b': 0,
5438 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5439 """Number of bits in binary representation of the positive integer n,
5440 or 0 if n == 0.
5441 """
5442 if n < 0:
5443 raise ValueError("The argument to _nbits should be nonnegative.")
5444 hex_n = "%x" % n
5445 return 4*len(hex_n) - correction[hex_n[0]]
5446
5447def _sqrt_nearest(n, a):
5448 """Closest integer to the square root of the positive integer n. a is
5449 an initial approximation to the square root. Any positive integer
5450 will do for a, but the closer a is to the square root of n the
5451 faster convergence will be.
5452
5453 """
5454 if n <= 0 or a <= 0:
5455 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5456
5457 b=0
5458 while a != b:
5459 b, a = a, a--n//a>>1
5460 return a
5461
5462def _rshift_nearest(x, shift):
5463 """Given an integer x and a nonnegative integer shift, return closest
5464 integer to x / 2**shift; use round-to-even in case of a tie.
5465
5466 """
5467 b, q = 1L << shift, x >> shift
5468 return q + (2*(x & (b-1)) + (q&1) > b)
5469
5470def _div_nearest(a, b):
5471 """Closest integer to a/b, a and b positive integers; rounds to even
5472 in the case of a tie.
5473
5474 """
5475 q, r = divmod(a, b)
5476 return q + (2*r + (q&1) > b)
5477
5478def _ilog(x, M, L = 8):
5479 """Integer approximation to M*log(x/M), with absolute error boundable
5480 in terms only of x/M.
5481
5482 Given positive integers x and M, return an integer approximation to
5483 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5484 between the approximation and the exact result is at most 22. For
5485 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5486 both cases these are upper bounds on the error; it will usually be
5487 much smaller."""
5488
5489 # The basic algorithm is the following: let log1p be the function
5490 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5491 # the reduction
5492 #
5493 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5494 #
5495 # repeatedly until the argument to log1p is small (< 2**-L in
5496 # absolute value). For small y we can use the Taylor series
5497 # expansion
5498 #
5499 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5500 #
5501 # truncating at T such that y**T is small enough. The whole
5502 # computation is carried out in a form of fixed-point arithmetic,
5503 # with a real number z being represented by an integer
5504 # approximation to z*M. To avoid loss of precision, the y below
5505 # is actually an integer approximation to 2**R*y*M, where R is the
5506 # number of reductions performed so far.
5507
5508 y = x-M
5509 # argument reduction; R = number of reductions performed
5510 R = 0
5511 while (R <= L and long(abs(y)) << L-R >= M or
5512 R > L and abs(y) >> R-L >= M):
5513 y = _div_nearest(long(M*y) << 1,
5514 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5515 R += 1
5516
5517 # Taylor series with T terms
5518 T = -int(-10*len(str(M))//(3*L))
5519 yshift = _rshift_nearest(y, R)
5520 w = _div_nearest(M, T)
5521 for k in xrange(T-1, 0, -1):
5522 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5523
5524 return _div_nearest(w*y, M)
5525
5526def _dlog10(c, e, p):
5527 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5528 approximation to 10**p * log10(c*10**e), with an absolute error of
5529 at most 1. Assumes that c*10**e is not exactly 1."""
5530
5531 # increase precision by 2; compensate for this by dividing
5532 # final result by 100
5533 p += 2
5534
5535 # write c*10**e as d*10**f with either:
5536 # f >= 0 and 1 <= d <= 10, or
5537 # f <= 0 and 0.1 <= d <= 1.
5538 # Thus for c*10**e close to 1, f = 0
5539 l = len(str(c))
5540 f = e+l - (e+l >= 1)
5541
5542 if p > 0:
5543 M = 10**p
5544 k = e+p-f
5545 if k >= 0:
5546 c *= 10**k
5547 else:
5548 c = _div_nearest(c, 10**-k)
5549
5550 log_d = _ilog(c, M) # error < 5 + 22 = 27
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005551 log_10 = _log10_digits(p) # error < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005552 log_d = _div_nearest(log_d*M, log_10)
5553 log_tenpower = f*M # exact
5554 else:
5555 log_d = 0 # error < 2.31
Neal Norwitz18aa3882008-08-24 05:04:52 +00005556 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Facundo Batista353750c2007-09-13 18:13:15 +00005557
5558 return _div_nearest(log_tenpower+log_d, 100)
5559
5560def _dlog(c, e, p):
5561 """Given integers c, e and p with c > 0, compute an integer
5562 approximation to 10**p * log(c*10**e), with an absolute error of
5563 at most 1. Assumes that c*10**e is not exactly 1."""
5564
5565 # Increase precision by 2. The precision increase is compensated
5566 # for at the end with a division by 100.
5567 p += 2
5568
5569 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5570 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5571 # as 10**p * log(d) + 10**p*f * log(10).
5572 l = len(str(c))
5573 f = e+l - (e+l >= 1)
5574
5575 # compute approximation to 10**p*log(d), with error < 27
5576 if p > 0:
5577 k = e+p-f
5578 if k >= 0:
5579 c *= 10**k
5580 else:
5581 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5582
5583 # _ilog magnifies existing error in c by a factor of at most 10
5584 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5585 else:
5586 # p <= 0: just approximate the whole thing by 0; error < 2.31
5587 log_d = 0
5588
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005589 # compute approximation to f*10**p*log(10), with error < 11.
Facundo Batista353750c2007-09-13 18:13:15 +00005590 if f:
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005591 extra = len(str(abs(f)))-1
5592 if p + extra >= 0:
5593 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5594 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5595 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Facundo Batista353750c2007-09-13 18:13:15 +00005596 else:
5597 f_log_ten = 0
5598 else:
5599 f_log_ten = 0
5600
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005601 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Facundo Batista353750c2007-09-13 18:13:15 +00005602 return _div_nearest(f_log_ten + log_d, 100)
5603
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005604class _Log10Memoize(object):
5605 """Class to compute, store, and allow retrieval of, digits of the
5606 constant log(10) = 2.302585.... This constant is needed by
5607 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5608 def __init__(self):
5609 self.digits = "23025850929940456840179914546843642076011014886"
5610
5611 def getdigits(self, p):
5612 """Given an integer p >= 0, return floor(10**p)*log(10).
5613
5614 For example, self.getdigits(3) returns 2302.
5615 """
5616 # digits are stored as a string, for quick conversion to
5617 # integer in the case that we've already computed enough
5618 # digits; the stored digits should always be correct
5619 # (truncated, not rounded to nearest).
5620 if p < 0:
5621 raise ValueError("p should be nonnegative")
5622
5623 if p >= len(self.digits):
5624 # compute p+3, p+6, p+9, ... digits; continue until at
5625 # least one of the extra digits is nonzero
5626 extra = 3
5627 while True:
5628 # compute p+extra digits, correct to within 1ulp
5629 M = 10**(p+extra+2)
5630 digits = str(_div_nearest(_ilog(10*M, M), 100))
5631 if digits[-extra:] != '0'*extra:
5632 break
5633 extra += 3
5634 # keep all reliable digits so far; remove trailing zeros
5635 # and next nonzero digit
5636 self.digits = digits.rstrip('0')[:-1]
5637 return int(self.digits[:p+1])
5638
5639_log10_digits = _Log10Memoize().getdigits
5640
Facundo Batista353750c2007-09-13 18:13:15 +00005641def _iexp(x, M, L=8):
5642 """Given integers x and M, M > 0, such that x/M is small in absolute
5643 value, compute an integer approximation to M*exp(x/M). For 0 <=
5644 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5645 is usually much smaller)."""
5646
5647 # Algorithm: to compute exp(z) for a real number z, first divide z
5648 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5649 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5650 # series
5651 #
5652 # expm1(x) = x + x**2/2! + x**3/3! + ...
5653 #
5654 # Now use the identity
5655 #
5656 # expm1(2x) = expm1(x)*(expm1(x)+2)
5657 #
5658 # R times to compute the sequence expm1(z/2**R),
5659 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5660
5661 # Find R such that x/2**R/M <= 2**-L
5662 R = _nbits((long(x)<<L)//M)
5663
5664 # Taylor series. (2**L)**T > M
5665 T = -int(-10*len(str(M))//(3*L))
5666 y = _div_nearest(x, T)
5667 Mshift = long(M)<<R
5668 for i in xrange(T-1, 0, -1):
5669 y = _div_nearest(x*(Mshift + y), Mshift * i)
5670
5671 # Expansion
5672 for k in xrange(R-1, -1, -1):
5673 Mshift = long(M)<<(k+2)
5674 y = _div_nearest(y*(y+Mshift), Mshift)
5675
5676 return M+y
5677
5678def _dexp(c, e, p):
5679 """Compute an approximation to exp(c*10**e), with p decimal places of
5680 precision.
5681
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005682 Returns integers d, f such that:
Facundo Batista353750c2007-09-13 18:13:15 +00005683
5684 10**(p-1) <= d <= 10**p, and
5685 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5686
5687 In other words, d*10**f is an approximation to exp(c*10**e) with p
5688 digits of precision, and with an error in d of at most 1. This is
5689 almost, but not quite, the same as the error being < 1ulp: when d
5690 = 10**(p-1) the error could be up to 10 ulp."""
5691
5692 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5693 p += 2
5694
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005695 # compute log(10) with extra precision = adjusted exponent of c*10**e
Facundo Batista353750c2007-09-13 18:13:15 +00005696 extra = max(0, e + len(str(c)) - 1)
5697 q = p + extra
Facundo Batista353750c2007-09-13 18:13:15 +00005698
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005699 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Facundo Batista353750c2007-09-13 18:13:15 +00005700 # rounding down
5701 shift = e+q
5702 if shift >= 0:
5703 cshift = c*10**shift
5704 else:
5705 cshift = c//10**-shift
Facundo Batistabe6c7ba2007-10-02 18:21:18 +00005706 quot, rem = divmod(cshift, _log10_digits(q))
Facundo Batista353750c2007-09-13 18:13:15 +00005707
5708 # reduce remainder back to original precision
5709 rem = _div_nearest(rem, 10**extra)
5710
5711 # error in result of _iexp < 120; error after division < 0.62
5712 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5713
5714def _dpower(xc, xe, yc, ye, p):
5715 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5716 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5717
5718 10**(p-1) <= c <= 10**p, and
5719 (c-1)*10**e < x**y < (c+1)*10**e
5720
5721 in other words, c*10**e is an approximation to x**y with p digits
5722 of precision, and with an error in c of at most 1. (This is
5723 almost, but not quite, the same as the error being < 1ulp: when c
5724 == 10**(p-1) we can only guarantee error < 10ulp.)
5725
5726 We assume that: x is positive and not equal to 1, and y is nonzero.
5727 """
5728
5729 # Find b such that 10**(b-1) <= |y| <= 10**b
5730 b = len(str(abs(yc))) + ye
5731
5732 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5733 lxc = _dlog(xc, xe, p+b+1)
5734
5735 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5736 shift = ye-b
5737 if shift >= 0:
5738 pc = lxc*yc*10**shift
5739 else:
5740 pc = _div_nearest(lxc*yc, 10**-shift)
5741
5742 if pc == 0:
5743 # we prefer a result that isn't exactly 1; this makes it
5744 # easier to compute a correctly rounded result in __pow__
5745 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5746 coeff, exp = 10**(p-1)+1, 1-p
5747 else:
5748 coeff, exp = 10**p-1, -p
5749 else:
5750 coeff, exp = _dexp(pc, -(p+1), p+1)
5751 coeff = _div_nearest(coeff, 10)
5752 exp += 1
5753
5754 return coeff, exp
5755
5756def _log10_lb(c, correction = {
5757 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5758 '6': 23, '7': 16, '8': 10, '9': 5}):
5759 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5760 if c <= 0:
5761 raise ValueError("The argument to _log10_lb should be nonnegative.")
5762 str_c = str(c)
5763 return 100*len(str_c) - correction[str_c[0]]
5764
Facundo Batista59c58842007-04-10 12:58:45 +00005765##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005766
Mark Dickinson99d80962010-04-02 08:53:22 +00005767def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005768 """Convert other to Decimal.
5769
5770 Verifies that it's ok to use in an implicit construction.
Mark Dickinson99d80962010-04-02 08:53:22 +00005771 If allow_float is true, allow conversion from float; this
5772 is used in the comparison methods (__eq__ and friends).
5773
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005774 """
5775 if isinstance(other, Decimal):
5776 return other
5777 if isinstance(other, (int, long)):
5778 return Decimal(other)
Mark Dickinson99d80962010-04-02 08:53:22 +00005779 if allow_float and isinstance(other, float):
5780 return Decimal.from_float(other)
5781
Facundo Batista353750c2007-09-13 18:13:15 +00005782 if raiseit:
5783 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005784 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005785
Facundo Batista59c58842007-04-10 12:58:45 +00005786##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005787
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005788# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005789# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005790
5791DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005792 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005793 traps=[DivisionByZero, Overflow, InvalidOperation],
5794 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005795 Emax=999999999,
5796 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005797 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005798)
5799
5800# Pre-made alternate contexts offered by the specification
5801# Don't change these; the user should be able to select these
5802# contexts and be able to reproduce results from other implementations
5803# of the spec.
5804
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005805BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005806 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005807 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5808 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005809)
5810
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005811ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005812 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005813 traps=[],
5814 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005815)
5816
5817
Facundo Batista72bc54f2007-11-23 17:59:00 +00005818##### crud for parsing strings #############################################
Mark Dickinson6a123cb2008-02-24 18:12:36 +00005819#
Facundo Batista72bc54f2007-11-23 17:59:00 +00005820# Regular expression used for parsing numeric strings. Additional
5821# comments:
5822#
5823# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5824# whitespace. But note that the specification disallows whitespace in
5825# a numeric string.
5826#
5827# 2. For finite numbers (not infinities and NaNs) the body of the
5828# number between the optional sign and the optional exponent must have
5829# at least one decimal digit, possibly after the decimal point. The
5830# lookahead expression '(?=\d|\.\d)' checks this.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005831
5832import re
Mark Dickinson70c32892008-07-02 09:37:01 +00005833_parser = re.compile(r""" # A numeric string consists of:
Facundo Batista72bc54f2007-11-23 17:59:00 +00005834# \s*
Mark Dickinson70c32892008-07-02 09:37:01 +00005835 (?P<sign>[-+])? # an optional sign, followed by either...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005836 (
Mark Dickinson4326ad82009-08-02 10:59:36 +00005837 (?=\d|\.\d) # ...a number (with at least one digit)
5838 (?P<int>\d*) # having a (possibly empty) integer part
5839 (\.(?P<frac>\d*))? # followed by an optional fractional part
5840 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005841 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005842 Inf(inity)? # ...an infinity, or...
Facundo Batista72bc54f2007-11-23 17:59:00 +00005843 |
Mark Dickinson70c32892008-07-02 09:37:01 +00005844 (?P<signal>s)? # ...an (optionally signaling)
5845 NaN # NaN
Mark Dickinson4326ad82009-08-02 10:59:36 +00005846 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Facundo Batista72bc54f2007-11-23 17:59:00 +00005847 )
5848# \s*
Mark Dickinson59bc20b2008-01-12 01:56:00 +00005849 \Z
Mark Dickinson4326ad82009-08-02 10:59:36 +00005850""", re.VERBOSE | re.IGNORECASE | re.UNICODE).match
Facundo Batista72bc54f2007-11-23 17:59:00 +00005851
Facundo Batista2ec74152007-12-03 17:55:00 +00005852_all_zeros = re.compile('0*$').match
5853_exact_half = re.compile('50*$').match
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005854
5855##### PEP3101 support functions ##############################################
Mark Dickinson277859d2009-03-17 23:03:46 +00005856# The functions in this section have little to do with the Decimal
5857# class, and could potentially be reused or adapted for other pure
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005858# Python numeric classes that want to implement __format__
5859#
5860# A format specifier for Decimal looks like:
5861#
Mark Dickinson277859d2009-03-17 23:03:46 +00005862# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005863
5864_parse_format_specifier_regex = re.compile(r"""\A
5865(?:
5866 (?P<fill>.)?
5867 (?P<align>[<>=^])
5868)?
5869(?P<sign>[-+ ])?
5870(?P<zeropad>0)?
5871(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson277859d2009-03-17 23:03:46 +00005872(?P<thousands_sep>,)?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005873(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson277859d2009-03-17 23:03:46 +00005874(?P<type>[eEfFgGn%])?
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005875\Z
5876""", re.VERBOSE)
5877
Facundo Batista72bc54f2007-11-23 17:59:00 +00005878del re
5879
Mark Dickinson277859d2009-03-17 23:03:46 +00005880# The locale module is only needed for the 'n' format specifier. The
5881# rest of the PEP 3101 code functions quite happily without it, so we
5882# don't care too much if locale isn't present.
5883try:
5884 import locale as _locale
5885except ImportError:
5886 pass
5887
5888def _parse_format_specifier(format_spec, _localeconv=None):
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005889 """Parse and validate a format specifier.
5890
5891 Turns a standard numeric format specifier into a dict, with the
5892 following entries:
5893
5894 fill: fill character to pad field to minimum width
5895 align: alignment type, either '<', '>', '=' or '^'
5896 sign: either '+', '-' or ' '
5897 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson277859d2009-03-17 23:03:46 +00005898 zeropad: boolean, indicating whether to pad with zeros
5899 thousands_sep: string to use as thousands separator, or ''
5900 grouping: grouping for thousands separators, in format
5901 used by localeconv
5902 decimal_point: string to use for decimal point
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005903 precision: nonnegative integer giving precision, or None
5904 type: one of the characters 'eEfFgG%', or None
Mark Dickinson277859d2009-03-17 23:03:46 +00005905 unicode: boolean (always True for Python 3.x)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005906
5907 """
5908 m = _parse_format_specifier_regex.match(format_spec)
5909 if m is None:
5910 raise ValueError("Invalid format specifier: " + format_spec)
5911
5912 # get the dictionary
5913 format_dict = m.groupdict()
5914
Mark Dickinson277859d2009-03-17 23:03:46 +00005915 # zeropad; defaults for fill and alignment. If zero padding
5916 # is requested, the fill and align fields should be absent.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005917 fill = format_dict['fill']
5918 align = format_dict['align']
Mark Dickinson277859d2009-03-17 23:03:46 +00005919 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5920 if format_dict['zeropad']:
5921 if fill is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005922 raise ValueError("Fill character conflicts with '0'"
5923 " in format specifier: " + format_spec)
Mark Dickinson277859d2009-03-17 23:03:46 +00005924 if align is not None:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005925 raise ValueError("Alignment conflicts with '0' in "
5926 "format specifier: " + format_spec)
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005927 format_dict['fill'] = fill or ' '
Mark Dickinson5cfa8042009-09-08 20:20:19 +00005928 # PEP 3101 originally specified that the default alignment should
5929 # be left; it was later agreed that right-aligned makes more sense
5930 # for numeric types. See http://bugs.python.org/issue6857.
5931 format_dict['align'] = align or '>'
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005932
Mark Dickinson277859d2009-03-17 23:03:46 +00005933 # default sign handling: '-' for negative, '' for positive
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005934 if format_dict['sign'] is None:
5935 format_dict['sign'] = '-'
5936
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005937 # minimumwidth defaults to 0; precision remains None if not given
5938 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5939 if format_dict['precision'] is not None:
5940 format_dict['precision'] = int(format_dict['precision'])
5941
5942 # if format type is 'g' or 'G' then a precision of 0 makes little
5943 # sense; convert it to 1. Same if format type is unspecified.
5944 if format_dict['precision'] == 0:
Mark Dickinson491ea552009-09-07 16:17:41 +00005945 if format_dict['type'] is None or format_dict['type'] in 'gG':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005946 format_dict['precision'] = 1
5947
Mark Dickinson277859d2009-03-17 23:03:46 +00005948 # determine thousands separator, grouping, and decimal separator, and
5949 # add appropriate entries to format_dict
5950 if format_dict['type'] == 'n':
5951 # apart from separators, 'n' behaves just like 'g'
5952 format_dict['type'] = 'g'
5953 if _localeconv is None:
5954 _localeconv = _locale.localeconv()
5955 if format_dict['thousands_sep'] is not None:
5956 raise ValueError("Explicit thousands separator conflicts with "
5957 "'n' type in format specifier: " + format_spec)
5958 format_dict['thousands_sep'] = _localeconv['thousands_sep']
5959 format_dict['grouping'] = _localeconv['grouping']
5960 format_dict['decimal_point'] = _localeconv['decimal_point']
5961 else:
5962 if format_dict['thousands_sep'] is None:
5963 format_dict['thousands_sep'] = ''
5964 format_dict['grouping'] = [3, 0]
5965 format_dict['decimal_point'] = '.'
5966
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005967 # record whether return type should be str or unicode
5968 format_dict['unicode'] = isinstance(format_spec, unicode)
5969
5970 return format_dict
5971
Mark Dickinson277859d2009-03-17 23:03:46 +00005972def _format_align(sign, body, spec):
5973 """Given an unpadded, non-aligned numeric string 'body' and sign
5974 string 'sign', add padding and aligment conforming to the given
5975 format specifier dictionary 'spec' (as produced by
5976 parse_format_specifier).
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005977
Mark Dickinson277859d2009-03-17 23:03:46 +00005978 Also converts result to unicode if necessary.
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005979
5980 """
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005981 # how much extra space do we have to play with?
Mark Dickinson277859d2009-03-17 23:03:46 +00005982 minimumwidth = spec['minimumwidth']
5983 fill = spec['fill']
5984 padding = fill*(minimumwidth - len(sign) - len(body))
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005985
Mark Dickinson277859d2009-03-17 23:03:46 +00005986 align = spec['align']
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005987 if align == '<':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005988 result = sign + body + padding
Mark Dickinsonb065e522009-03-17 18:01:03 +00005989 elif align == '>':
5990 result = padding + sign + body
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005991 elif align == '=':
5992 result = sign + padding + body
Mark Dickinson277859d2009-03-17 23:03:46 +00005993 elif align == '^':
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005994 half = len(padding)//2
5995 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson277859d2009-03-17 23:03:46 +00005996 else:
5997 raise ValueError('Unrecognised alignment field')
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00005998
5999 # make sure that result is unicode if necessary
Mark Dickinson277859d2009-03-17 23:03:46 +00006000 if spec['unicode']:
Mark Dickinson1ddf1d82008-02-29 02:16:37 +00006001 result = unicode(result)
6002
6003 return result
Facundo Batista72bc54f2007-11-23 17:59:00 +00006004
Mark Dickinson277859d2009-03-17 23:03:46 +00006005def _group_lengths(grouping):
6006 """Convert a localeconv-style grouping into a (possibly infinite)
6007 iterable of integers representing group lengths.
6008
6009 """
6010 # The result from localeconv()['grouping'], and the input to this
6011 # function, should be a list of integers in one of the
6012 # following three forms:
6013 #
6014 # (1) an empty list, or
6015 # (2) nonempty list of positive integers + [0]
6016 # (3) list of positive integers + [locale.CHAR_MAX], or
6017
6018 from itertools import chain, repeat
6019 if not grouping:
6020 return []
6021 elif grouping[-1] == 0 and len(grouping) >= 2:
6022 return chain(grouping[:-1], repeat(grouping[-2]))
6023 elif grouping[-1] == _locale.CHAR_MAX:
6024 return grouping[:-1]
6025 else:
6026 raise ValueError('unrecognised format for grouping')
6027
6028def _insert_thousands_sep(digits, spec, min_width=1):
6029 """Insert thousands separators into a digit string.
6030
6031 spec is a dictionary whose keys should include 'thousands_sep' and
6032 'grouping'; typically it's the result of parsing the format
6033 specifier using _parse_format_specifier.
6034
6035 The min_width keyword argument gives the minimum length of the
6036 result, which will be padded on the left with zeros if necessary.
6037
6038 If necessary, the zero padding adds an extra '0' on the left to
6039 avoid a leading thousands separator. For example, inserting
6040 commas every three digits in '123456', with min_width=8, gives
6041 '0,123,456', even though that has length 9.
6042
6043 """
6044
6045 sep = spec['thousands_sep']
6046 grouping = spec['grouping']
6047
6048 groups = []
6049 for l in _group_lengths(grouping):
Mark Dickinson277859d2009-03-17 23:03:46 +00006050 if l <= 0:
6051 raise ValueError("group length should be positive")
6052 # max(..., 1) forces at least 1 digit to the left of a separator
6053 l = min(max(len(digits), min_width, 1), l)
6054 groups.append('0'*(l - len(digits)) + digits[-l:])
6055 digits = digits[:-l]
6056 min_width -= l
6057 if not digits and min_width <= 0:
6058 break
Mark Dickinsonb14514a2009-03-18 08:22:51 +00006059 min_width -= len(sep)
Mark Dickinson277859d2009-03-17 23:03:46 +00006060 else:
6061 l = max(len(digits), min_width, 1)
6062 groups.append('0'*(l - len(digits)) + digits[-l:])
6063 return sep.join(reversed(groups))
6064
6065def _format_sign(is_negative, spec):
6066 """Determine sign character."""
6067
6068 if is_negative:
6069 return '-'
6070 elif spec['sign'] in ' +':
6071 return spec['sign']
6072 else:
6073 return ''
6074
6075def _format_number(is_negative, intpart, fracpart, exp, spec):
6076 """Format a number, given the following data:
6077
6078 is_negative: true if the number is negative, else false
6079 intpart: string of digits that must appear before the decimal point
6080 fracpart: string of digits that must come after the point
6081 exp: exponent, as an integer
6082 spec: dictionary resulting from parsing the format specifier
6083
6084 This function uses the information in spec to:
6085 insert separators (decimal separator and thousands separators)
6086 format the sign
6087 format the exponent
6088 add trailing '%' for the '%' type
6089 zero-pad if necessary
6090 fill and align if necessary
6091 """
6092
6093 sign = _format_sign(is_negative, spec)
6094
6095 if fracpart:
6096 fracpart = spec['decimal_point'] + fracpart
6097
6098 if exp != 0 or spec['type'] in 'eE':
6099 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6100 fracpart += "{0}{1:+}".format(echar, exp)
6101 if spec['type'] == '%':
6102 fracpart += '%'
6103
6104 if spec['zeropad']:
6105 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6106 else:
6107 min_width = 0
6108 intpart = _insert_thousands_sep(intpart, spec, min_width)
6109
6110 return _format_align(sign, intpart+fracpart, spec)
6111
6112
Facundo Batista59c58842007-04-10 12:58:45 +00006113##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006114
Facundo Batista59c58842007-04-10 12:58:45 +00006115# Reusable defaults
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006116_Infinity = Decimal('Inf')
6117_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonc5de0962009-01-02 23:07:08 +00006118_NaN = Decimal('NaN')
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006119_Zero = Decimal(0)
6120_One = Decimal(1)
6121_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006122
Raymond Hettingerb7e835b2009-01-03 19:08:10 +00006123# _SignedInfinity[sign] is infinity w/ that sign
6124_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006125
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006126
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006127
6128if __name__ == '__main__':
6129 import doctest, sys
6130 doctest.testmod(sys.modules[__name__])