blob: 370eb821ba8cefe09cb3fca88b5e788ffbb2c7aa [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
Facundo Batista6ab24792009-02-16 15:41:37 +000010# This module should be kept in sync with the latest updates of the
11# IBM specification as it evolves. Those updates will be treated
Raymond Hettinger27dbcf22004-08-19 22:39:55 +000012# as bug fixes (deviation from the spec is a compatibility, usability
13# bug) and will be backported. At this point the spec is stabilizing
14# and the updates are becoming fewer, smaller, and less significant.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000015
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000016"""
Facundo Batista6ab24792009-02-16 15:41:37 +000017This is an implementation of decimal floating point arithmetic based on
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000018the General Decimal Arithmetic Specification:
19
Raymond Hettinger960dc362009-04-21 03:43:15 +000020 http://speleotrove.com/decimal/decarith.html
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000021
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000022and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000023
24 www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html
25
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000026Decimal floating point has finite precision with arbitrarily large bounds.
27
Guido van Rossumd8faa362007-04-27 19:54:29 +000028The purpose of this module is to support arithmetic using familiar
29"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030issues associated with binary floating point. The package is especially
31useful for financial applications or for contexts where users have
32expectations that are at odds with binary floating point (for instance,
33in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Christian Heimes68f5fbe2008-02-14 08:27:37 +000034of the expected Decimal('0.00') returned by decimal floating point).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000035
36Here are some examples of using the decimal module:
37
38>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000039>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000040>>> Decimal(0)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000041Decimal('0')
42>>> Decimal('1')
43Decimal('1')
44>>> Decimal('-.0123')
45Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000046>>> Decimal(123456)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000047Decimal('123456')
48>>> Decimal('123.45e12345678901234567890')
49Decimal('1.2345E+12345678901234567892')
50>>> Decimal('1.33') + Decimal('1.27')
51Decimal('2.60')
52>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
53Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000054>>> dig = Decimal(1)
Guido van Rossum7131f842007-02-09 20:13:25 +000055>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000560.333333333
57>>> getcontext().prec = 18
Guido van Rossum7131f842007-02-09 20:13:25 +000058>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000590.333333333333333333
Guido van Rossum7131f842007-02-09 20:13:25 +000060>>> print(dig.sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000611
Guido van Rossum7131f842007-02-09 20:13:25 +000062>>> print(Decimal(3).sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000631.73205080756887729
Guido van Rossum7131f842007-02-09 20:13:25 +000064>>> print(Decimal(3) ** 123)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000654.85192780976896427E+58
66>>> inf = Decimal(1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000067>>> print(inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000068Infinity
69>>> neginf = Decimal(-1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000070>>> print(neginf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000071-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000072>>> print(neginf + inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000073NaN
Guido van Rossum7131f842007-02-09 20:13:25 +000074>>> print(neginf * inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000075-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000076>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000077Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000078>>> getcontext().traps[DivisionByZero] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000079>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000080Traceback (most recent call last):
81 ...
82 ...
83 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +000084decimal.DivisionByZero: x / 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000085>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000086>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000087>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000880
89>>> c.divide(Decimal(0), Decimal(0))
Christian Heimes68f5fbe2008-02-14 08:27:37 +000090Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000091>>> c.traps[InvalidOperation] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000092>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000931
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000094>>> c.flags[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000095>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000960
Guido van Rossum7131f842007-02-09 20:13:25 +000097>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000098Traceback (most recent call last):
99 ...
100 ...
101 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +0000102decimal.InvalidOperation: 0 / 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000103>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001041
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000105>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000106>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000107>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000108NaN
Guido van Rossum7131f842007-02-09 20:13:25 +0000109>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001101
111>>>
112"""
113
114__all__ = [
115 # Two major classes
116 'Decimal', 'Context',
117
118 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000119 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000120
121 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000122 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
123 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000124
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000125 # Constants for use in setting up contexts
126 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000127 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000128
129 # Functions for manipulating contexts
Thomas Wouters89f507f2006-12-13 04:49:30 +0000130 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000131]
132
Raymond Hettinger960dc362009-04-21 03:43:15 +0000133__version__ = '1.70' # Highest version of the spec this complies with
134
Raymond Hettingereb260842005-06-07 18:52:34 +0000135import copy as _copy
Raymond Hettinger771ed762009-01-03 19:20:32 +0000136import math as _math
Raymond Hettinger82417ca2009-02-03 03:54:28 +0000137import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000138
Christian Heimes25bb7832008-01-11 16:17:00 +0000139try:
140 from collections import namedtuple as _namedtuple
141 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
142except ImportError:
143 DecimalTuple = lambda *args: args
144
Guido van Rossumd8faa362007-04-27 19:54:29 +0000145# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000146ROUND_DOWN = 'ROUND_DOWN'
147ROUND_HALF_UP = 'ROUND_HALF_UP'
148ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
149ROUND_CEILING = 'ROUND_CEILING'
150ROUND_FLOOR = 'ROUND_FLOOR'
151ROUND_UP = 'ROUND_UP'
152ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000153ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000154
Guido van Rossumd8faa362007-04-27 19:54:29 +0000155# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000156
157class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000158 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000159
160 Used exceptions derive from this.
161 If an exception derives from another exception besides this (such as
162 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
163 called if the others are present. This isn't actually used for
164 anything, though.
165
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000166 handle -- Called when context._raise_error is called and the
167 trap_enabler is set. First argument is self, second is the
168 context. More arguments can be given, those being after
169 the explanation in _raise_error (For example,
170 context._raise_error(NewError, '(-x)!', self._sign) would
171 call NewError().handle(context, self._sign).)
172
173 To define a new exception, it should be sufficient to have it derive
174 from DecimalException.
175 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000176 def handle(self, context, *args):
177 pass
178
179
180class Clamped(DecimalException):
181 """Exponent of a 0 changed to fit bounds.
182
183 This occurs and signals clamped if the exponent of a result has been
184 altered in order to fit the constraints of a specific concrete
Guido van Rossumd8faa362007-04-27 19:54:29 +0000185 representation. This may occur when the exponent of a zero result would
186 be outside the bounds of a representation, or when a large normal
187 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000188 this latter case, the exponent is reduced to fit and the corresponding
189 number of zero digits are appended to the coefficient ("fold-down").
190 """
191
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000192class InvalidOperation(DecimalException):
193 """An invalid operation was performed.
194
195 Various bad things cause this:
196
197 Something creates a signaling NaN
198 -INF + INF
Guido van Rossumd8faa362007-04-27 19:54:29 +0000199 0 * (+-)INF
200 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000201 x % 0
202 (+-)INF % x
203 x._rescale( non-integer )
204 sqrt(-x) , x > 0
205 0 ** 0
206 x ** (non-integer)
207 x ** (+-)INF
208 An operand is invalid
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000209
210 The result of the operation after these is a quiet positive NaN,
211 except when the cause is a signaling NaN, in which case the result is
212 also a quiet NaN, but with the original sign, and an optional
213 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000214 """
215 def handle(self, context, *args):
216 if args:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000217 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
218 return ans._fix_nan(context)
Mark Dickinsonf9236412009-01-02 23:23:21 +0000219 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000220
221class ConversionSyntax(InvalidOperation):
222 """Trying to convert badly formed string.
223
224 This occurs and signals invalid-operation if an string is being
225 converted to a number and it does not conform to the numeric string
Guido van Rossumd8faa362007-04-27 19:54:29 +0000226 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000227 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000228 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000229 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000230
231class DivisionByZero(DecimalException, ZeroDivisionError):
232 """Division by 0.
233
234 This occurs and signals division-by-zero if division of a finite number
235 by zero was attempted (during a divide-integer or divide operation, or a
236 power operation with negative right-hand operand), and the dividend was
237 not zero.
238
239 The result of the operation is [sign,inf], where sign is the exclusive
240 or of the signs of the operands for divide, or is 1 for an odd power of
241 -0, for power.
242 """
243
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000244 def handle(self, context, sign, *args):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000245 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000246
247class DivisionImpossible(InvalidOperation):
248 """Cannot perform the division adequately.
249
250 This occurs and signals invalid-operation if the integer result of a
251 divide-integer or remainder operation had too many digits (would be
Guido van Rossumd8faa362007-04-27 19:54:29 +0000252 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000253 """
254
255 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000256 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000257
258class DivisionUndefined(InvalidOperation, ZeroDivisionError):
259 """Undefined result of division.
260
261 This occurs and signals invalid-operation if division by zero was
262 attempted (during a divide-integer, divide, or remainder operation), and
Guido van Rossumd8faa362007-04-27 19:54:29 +0000263 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000264 """
265
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000266 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000267 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000268
269class Inexact(DecimalException):
270 """Had to round, losing information.
271
272 This occurs and signals inexact whenever the result of an operation is
273 not exact (that is, it needed to be rounded and any discarded digits
Guido van Rossumd8faa362007-04-27 19:54:29 +0000274 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000275 result in all cases is unchanged.
276
277 The inexact signal may be tested (or trapped) to determine if a given
278 operation (or sequence of operations) was inexact.
279 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000280
281class InvalidContext(InvalidOperation):
282 """Invalid context. Unknown rounding, for example.
283
284 This occurs and signals invalid-operation if an invalid context was
Guido van Rossumd8faa362007-04-27 19:54:29 +0000285 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000286 on creation and either the precision exceeds the capability of the
287 underlying concrete representation or an unknown or unsupported rounding
Guido van Rossumd8faa362007-04-27 19:54:29 +0000288 was specified. These aspects of the context need only be checked when
289 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000290 """
291
292 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000293 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000294
295class Rounded(DecimalException):
296 """Number got rounded (not necessarily changed during rounding).
297
298 This occurs and signals rounded whenever the result of an operation is
299 rounded (that is, some zero or non-zero digits were discarded from the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000300 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000301 result in all cases is unchanged.
302
303 The rounded signal may be tested (or trapped) to determine if a given
304 operation (or sequence of operations) caused a loss of precision.
305 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000306
307class Subnormal(DecimalException):
308 """Exponent < Emin before rounding.
309
310 This occurs and signals subnormal whenever the result of a conversion or
311 operation is subnormal (that is, its adjusted exponent is less than
Guido van Rossumd8faa362007-04-27 19:54:29 +0000312 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000313
314 The subnormal signal may be tested (or trapped) to determine if a given
315 or operation (or sequence of operations) yielded a subnormal result.
316 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000317
318class Overflow(Inexact, Rounded):
319 """Numerical overflow.
320
321 This occurs and signals overflow if the adjusted exponent of a result
322 (from a conversion or from an operation that is not an attempt to divide
323 by zero), after rounding, would be greater than the largest value that
324 can be handled by the implementation (the value Emax).
325
326 The result depends on the rounding mode:
327
328 For round-half-up and round-half-even (and for round-half-down and
329 round-up, if implemented), the result of the operation is [sign,inf],
Guido van Rossumd8faa362007-04-27 19:54:29 +0000330 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000331 result is the largest finite number that can be represented in the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000332 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000333 round-ceiling, the result is the same as for round-down if the sign of
Guido van Rossumd8faa362007-04-27 19:54:29 +0000334 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000335 the result is the same as for round-down if the sign of the intermediate
Guido van Rossumd8faa362007-04-27 19:54:29 +0000336 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000337 will also be raised.
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000338 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000339
340 def handle(self, context, sign, *args):
341 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000342 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000343 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000344 if sign == 0:
345 if context.rounding == ROUND_CEILING:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000346 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000347 return _dec_from_triple(sign, '9'*context.prec,
348 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000349 if sign == 1:
350 if context.rounding == ROUND_FLOOR:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000351 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000352 return _dec_from_triple(sign, '9'*context.prec,
353 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000354
355
356class Underflow(Inexact, Rounded, Subnormal):
357 """Numerical underflow with result rounded to 0.
358
359 This occurs and signals underflow if a result is inexact and the
360 adjusted exponent of the result would be smaller (more negative) than
361 the smallest value that can be handled by the implementation (the value
Guido van Rossumd8faa362007-04-27 19:54:29 +0000362 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000363
364 The result after an underflow will be a subnormal number rounded, if
Guido van Rossumd8faa362007-04-27 19:54:29 +0000365 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000366 in 0 with the sign of the intermediate result and an exponent of Etiny.
367
368 In all cases, Inexact, Rounded, and Subnormal will also be raised.
369 """
370
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000371# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000372_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000373 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000374
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000375# Map conditions (per the spec) to signals
376_condition_map = {ConversionSyntax:InvalidOperation,
377 DivisionImpossible:InvalidOperation,
378 DivisionUndefined:InvalidOperation,
379 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000380
Guido van Rossumd8faa362007-04-27 19:54:29 +0000381##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000382
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000383# The getcontext() and setcontext() function manage access to a thread-local
384# current context. Py2.4 offers direct support for thread locals. If that
Georg Brandlf9926402008-06-13 06:32:25 +0000385# is not available, use threading.current_thread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000386# work for older Pythons. If threads are not part of the build, create a
387# mock threading object with threading.local() returning the module namespace.
388
389try:
390 import threading
391except ImportError:
392 # Python was compiled without threads; create a mock object instead
393 import sys
Guido van Rossumd8faa362007-04-27 19:54:29 +0000394 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000395 def local(self, sys=sys):
396 return sys.modules[__name__]
397 threading = MockThreading()
398 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000399
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000400try:
401 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000402
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000403except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000404
Guido van Rossumd8faa362007-04-27 19:54:29 +0000405 # To fix reloading, force it to create a new context
406 # Old contexts have different exceptions in their dicts, making problems.
Georg Brandlf9926402008-06-13 06:32:25 +0000407 if hasattr(threading.current_thread(), '__decimal_context__'):
408 del threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000409
410 def setcontext(context):
411 """Set this thread's context to context."""
412 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000413 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000414 context.clear_flags()
Georg Brandlf9926402008-06-13 06:32:25 +0000415 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000416
417 def getcontext():
418 """Returns this thread's context.
419
420 If this thread does not yet have a context, returns
421 a new context and sets this thread's context.
422 New contexts are copies of DefaultContext.
423 """
424 try:
Georg Brandlf9926402008-06-13 06:32:25 +0000425 return threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000426 except AttributeError:
427 context = Context()
Georg Brandlf9926402008-06-13 06:32:25 +0000428 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000429 return context
430
431else:
432
433 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000434 if hasattr(local, '__decimal_context__'):
435 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000436
437 def getcontext(_local=local):
438 """Returns this thread's context.
439
440 If this thread does not yet have a context, returns
441 a new context and sets this thread's context.
442 New contexts are copies of DefaultContext.
443 """
444 try:
445 return _local.__decimal_context__
446 except AttributeError:
447 context = Context()
448 _local.__decimal_context__ = context
449 return context
450
451 def setcontext(context, _local=local):
452 """Set this thread's context to context."""
453 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000454 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000455 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000456 _local.__decimal_context__ = context
457
458 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000459
Thomas Wouters89f507f2006-12-13 04:49:30 +0000460def localcontext(ctx=None):
461 """Return a context manager for a copy of the supplied context
462
463 Uses a copy of the current context if no context is specified
464 The returned context manager creates a local decimal context
465 in a with statement:
466 def sin(x):
467 with localcontext() as ctx:
468 ctx.prec += 2
469 # Rest of sin calculation algorithm
470 # uses a precision 2 greater than normal
Guido van Rossumd8faa362007-04-27 19:54:29 +0000471 return +s # Convert result to normal precision
Thomas Wouters89f507f2006-12-13 04:49:30 +0000472
473 def sin(x):
474 with localcontext(ExtendedContext):
475 # Rest of sin calculation algorithm
476 # uses the Extended Context from the
477 # General Decimal Arithmetic Specification
Guido van Rossumd8faa362007-04-27 19:54:29 +0000478 return +s # Convert result to normal context
Thomas Wouters89f507f2006-12-13 04:49:30 +0000479
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000480 >>> setcontext(DefaultContext)
Guido van Rossum7131f842007-02-09 20:13:25 +0000481 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000482 28
483 >>> with localcontext():
484 ... ctx = getcontext()
Thomas Wouterscf297e42007-02-23 15:07:44 +0000485 ... ctx.prec += 2
Guido van Rossum7131f842007-02-09 20:13:25 +0000486 ... print(ctx.prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000487 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000488 30
489 >>> with localcontext(ExtendedContext):
Guido van Rossum7131f842007-02-09 20:13:25 +0000490 ... print(getcontext().prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000491 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000492 9
Guido van Rossum7131f842007-02-09 20:13:25 +0000493 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000494 28
495 """
496 if ctx is None: ctx = getcontext()
497 return _ContextManager(ctx)
498
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000499
Guido van Rossumd8faa362007-04-27 19:54:29 +0000500##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000501
Raymond Hettingera0fd8882009-01-20 07:24:44 +0000502# Do not subclass Decimal from numbers.Real and do not register it as such
503# (because Decimals are not interoperable with floats). See the notes in
504# numbers.py for more detail.
505
506class Decimal(object):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000507 """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
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000519 Decimal('3.14')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000520 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000521 Decimal('3.14')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000522 >>> Decimal(314) # int
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000523 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000524 >>> Decimal(Decimal(314)) # another decimal instance
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000525 Decimal('314')
Christian Heimesa62da1d2008-01-12 19:39:10 +0000526 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000527 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000528 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000529
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +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
Christian Heimesd59c64c2007-11-30 19:27:20 +0000540 # From a string
541 # REs insist on real strings, so we can too.
542 if isinstance(value, str):
Christian Heimesa62da1d2008-01-12 19:39:10 +0000543 m = _parser(value.strip())
Christian Heimesd59c64c2007-11-30 19:27:20 +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
Christian Heimesd59c64c2007-11-30 19:27:20 +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 Dickinson345adc42009-08-02 10:14:23 +0000557 fracpart = m.group('frac') or ''
Christian Heimesd59c64c2007-11-30 19:27:20 +0000558 exp = int(m.group('exp') or '0')
Mark Dickinson345adc42009-08-02 10:14:23 +0000559 self._int = str(int(intpart+fracpart))
560 self._exp = exp - len(fracpart)
Christian Heimesd59c64c2007-11-30 19:27:20 +0000561 self._is_special = False
562 else:
563 diag = m.group('diag')
564 if diag is not None:
565 # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +0000566 self._int = str(int(diag or '0')).lstrip('0')
Christian Heimesd59c64c2007-11-30 19:27:20 +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
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000579 if isinstance(value, int):
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
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000585 self._int = str(abs(value))
Christian Heimesd59c64c2007-11-30 19:27:20 +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:
Guido van Rossum8ce8a782007-11-01 19:42:39 +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) 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]
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000617 if value[2] == 'F':
618 # infinity: value[1] is ignored
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +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:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000623 # process and validate the digits in value[1]
624 digits = []
625 for digit in value[1]:
626 if isinstance(digit, int) 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
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000636 self._int = ''.join(map(str, digits))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000637 self._exp = value[2]
638 self._is_special = True
639 elif isinstance(value[2], int):
640 # finite number: digits give the coefficient
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000641 self._int = ''.join(map(str, digits or [0]))
Guido van Rossum8ce8a782007-11-01 19:42:39 +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):
Benjamin Peterson5e55b3e2010-02-03 02:35:45 +0000651 raise TypeError("Cannot convert float in Decimal constructor. "
652 "Use from_float class method.")
Raymond Hettingerbf440692004-07-10 14:14:37 +0000653
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000654 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000655
Mark Dickinsonba298e42009-01-04 21:17:43 +0000656 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
657 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000658 def from_float(cls, f):
659 """Converts a float to a decimal number, exactly.
660
661 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
662 Since 0.1 is not exactly representable in binary floating point, the
663 value is stored as the nearest representable value which is
664 0x1.999999999999ap-4. The exact equivalent of the value in decimal
665 is 0.1000000000000000055511151231257827021181583404541015625.
666
667 >>> Decimal.from_float(0.1)
668 Decimal('0.1000000000000000055511151231257827021181583404541015625')
669 >>> Decimal.from_float(float('nan'))
670 Decimal('NaN')
671 >>> Decimal.from_float(float('inf'))
672 Decimal('Infinity')
673 >>> Decimal.from_float(-float('inf'))
674 Decimal('-Infinity')
675 >>> Decimal.from_float(-0.0)
676 Decimal('-0')
677
678 """
679 if isinstance(f, int): # handle integer inputs
680 return cls(f)
681 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
682 return cls(repr(f))
Mark Dickinsonba298e42009-01-04 21:17:43 +0000683 if _math.copysign(1.0, f) == 1.0:
684 sign = 0
685 else:
686 sign = 1
Raymond Hettinger771ed762009-01-03 19:20:32 +0000687 n, d = abs(f).as_integer_ratio()
688 k = d.bit_length() - 1
689 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinsonba298e42009-01-04 21:17:43 +0000690 if cls is Decimal:
691 return result
692 else:
693 return cls(result)
694 from_float = classmethod(from_float)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000695
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000696 def _isnan(self):
697 """Returns whether the number is not actually one.
698
699 0 if a number
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000700 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000701 2 if sNaN
702 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000703 if self._is_special:
704 exp = self._exp
705 if exp == 'n':
706 return 1
707 elif exp == 'N':
708 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000709 return 0
710
711 def _isinfinity(self):
712 """Returns whether the number is infinite
713
714 0 if finite or not a number
715 1 if +INF
716 -1 if -INF
717 """
718 if self._exp == 'F':
719 if self._sign:
720 return -1
721 return 1
722 return 0
723
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000724 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000725 """Returns whether the number is not actually one.
726
727 if self, other are sNaN, signal
728 if self, other are NaN return nan
729 return 0
730
731 Done before operations.
732 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000733
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000734 self_is_nan = self._isnan()
735 if other is None:
736 other_is_nan = False
737 else:
738 other_is_nan = other._isnan()
739
740 if self_is_nan or other_is_nan:
741 if context is None:
742 context = getcontext()
743
744 if self_is_nan == 2:
745 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000746 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000747 if other_is_nan == 2:
748 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000749 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000750 if self_is_nan:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000751 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000752
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000753 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000754 return 0
755
Christian Heimes77c02eb2008-02-09 02:18:51 +0000756 def _compare_check_nans(self, other, context):
757 """Version of _check_nans used for the signaling comparisons
758 compare_signal, __le__, __lt__, __ge__, __gt__.
759
760 Signal InvalidOperation if either self or other is a (quiet
761 or signaling) NaN. Signaling NaNs take precedence over quiet
762 NaNs.
763
764 Return 0 if neither operand is a NaN.
765
766 """
767 if context is None:
768 context = getcontext()
769
770 if self._is_special or other._is_special:
771 if self.is_snan():
772 return context._raise_error(InvalidOperation,
773 'comparison involving sNaN',
774 self)
775 elif other.is_snan():
776 return context._raise_error(InvalidOperation,
777 'comparison involving sNaN',
778 other)
779 elif self.is_qnan():
780 return context._raise_error(InvalidOperation,
781 'comparison involving NaN',
782 self)
783 elif other.is_qnan():
784 return context._raise_error(InvalidOperation,
785 'comparison involving NaN',
786 other)
787 return 0
788
Jack Diederich4dafcc42006-11-28 19:15:13 +0000789 def __bool__(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000790 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000791
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000792 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000793 """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000794 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000795
Christian Heimes77c02eb2008-02-09 02:18:51 +0000796 def _cmp(self, other):
797 """Compare the two non-NaN decimal instances self and other.
798
799 Returns -1 if self < other, 0 if self == other and 1
800 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000801
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000802 if self._is_special or other._is_special:
Mark Dickinsone6aad752009-01-25 10:48:51 +0000803 self_inf = self._isinfinity()
804 other_inf = other._isinfinity()
805 if self_inf == other_inf:
806 return 0
807 elif self_inf < other_inf:
808 return -1
809 else:
810 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000811
Mark Dickinsone6aad752009-01-25 10:48:51 +0000812 # check for zeros; Decimal('0') == Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000813 if not self:
814 if not other:
815 return 0
816 else:
817 return -((-1)**other._sign)
818 if not other:
819 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000820
Guido van Rossumd8faa362007-04-27 19:54:29 +0000821 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000822 if other._sign < self._sign:
823 return -1
824 if self._sign < other._sign:
825 return 1
826
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000827 self_adjusted = self.adjusted()
828 other_adjusted = other.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000829 if self_adjusted == other_adjusted:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000830 self_padded = self._int + '0'*(self._exp - other._exp)
831 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone6aad752009-01-25 10:48:51 +0000832 if self_padded == other_padded:
833 return 0
834 elif self_padded < other_padded:
835 return -(-1)**self._sign
836 else:
837 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000838 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000839 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000840 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000841 return -((-1)**self._sign)
842
Christian Heimes77c02eb2008-02-09 02:18:51 +0000843 # Note: The Decimal standard doesn't cover rich comparisons for
844 # Decimals. In particular, the specification is silent on the
845 # subject of what should happen for a comparison involving a NaN.
846 # We take the following approach:
847 #
848 # == comparisons involving a NaN always return False
849 # != comparisons involving a NaN always return True
850 # <, >, <= and >= comparisons involving a (quiet or signaling)
851 # NaN signal InvalidOperation, and return False if the
Christian Heimes3feef612008-02-11 06:19:17 +0000852 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000853 #
854 # This behavior is designed to conform as closely as possible to
855 # that specified by IEEE 754.
856
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000857 def __eq__(self, other):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000858 other = _convert_other(other)
859 if other is NotImplemented:
860 return other
861 if self.is_nan() or other.is_nan():
862 return False
863 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000864
865 def __ne__(self, other):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000866 other = _convert_other(other)
867 if other is NotImplemented:
868 return other
869 if self.is_nan() or other.is_nan():
870 return True
871 return self._cmp(other) != 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000872
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000873
Christian Heimes77c02eb2008-02-09 02:18:51 +0000874 def __lt__(self, other, context=None):
875 other = _convert_other(other)
876 if other is NotImplemented:
877 return other
878 ans = self._compare_check_nans(other, context)
879 if ans:
880 return False
881 return self._cmp(other) < 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000882
Christian Heimes77c02eb2008-02-09 02:18:51 +0000883 def __le__(self, other, context=None):
884 other = _convert_other(other)
885 if other is NotImplemented:
886 return other
887 ans = self._compare_check_nans(other, context)
888 if ans:
889 return False
890 return self._cmp(other) <= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000891
Christian Heimes77c02eb2008-02-09 02:18:51 +0000892 def __gt__(self, other, context=None):
893 other = _convert_other(other)
894 if other is NotImplemented:
895 return other
896 ans = self._compare_check_nans(other, context)
897 if ans:
898 return False
899 return self._cmp(other) > 0
900
901 def __ge__(self, other, context=None):
902 other = _convert_other(other)
903 if other is NotImplemented:
904 return other
905 ans = self._compare_check_nans(other, context)
906 if ans:
907 return False
908 return self._cmp(other) >= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000909
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000910 def compare(self, other, context=None):
911 """Compares one to another.
912
913 -1 => a < b
914 0 => a = b
915 1 => a > b
916 NaN => one is NaN
917 Like __cmp__, but returns Decimal instances.
918 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000919 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
Guido van Rossumd8faa362007-04-27 19:54:29 +0000921 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000922 if (self._is_special or other and other._is_special):
923 ans = self._check_nans(other, context)
924 if ans:
925 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000926
Christian Heimes77c02eb2008-02-09 02:18:51 +0000927 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000928
929 def __hash__(self):
930 """x.__hash__() <==> hash(x)"""
931 # Decimal integers must hash the same as the ints
Christian Heimes2380ac72008-01-09 00:17:24 +0000932 #
933 # The hash of a nonspecial noninteger Decimal must depend only
934 # on the value of that Decimal, and not on its representation.
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000935 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000936 if self._is_special:
937 if self._isnan():
938 raise TypeError('Cannot hash a NaN value.')
939 return hash(str(self))
Thomas Wouters8ce81f72007-09-20 18:22:40 +0000940 if not self:
941 return 0
942 if self._isinteger():
943 op = _WorkRep(self.to_integral_value())
944 # to make computation feasible for Decimals with large
945 # exponent, we use the fact that hash(n) == hash(m) for
946 # any two nonzero integers n and m such that (i) n and m
947 # have the same sign, and (ii) n is congruent to m modulo
948 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
949 # hash((-1)**s*c*pow(10, e, 2**64-1).
950 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Christian Heimes2380ac72008-01-09 00:17:24 +0000951 # The value of a nonzero nonspecial Decimal instance is
952 # faithfully represented by the triple consisting of its sign,
953 # its adjusted exponent, and its coefficient with trailing
954 # zeros removed.
955 return hash((self._sign,
956 self._exp+len(self._int),
957 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000958
959 def as_tuple(self):
960 """Represents the number as a triple tuple.
961
962 To show the internals exactly as they are.
963 """
Christian Heimes25bb7832008-01-11 16:17:00 +0000964 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000965
966 def __repr__(self):
967 """Represents the number as an instance of Decimal."""
968 # Invariant: eval(repr(d)) == d
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000969 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000970
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000971 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000972 """Return string representation of the number in scientific notation.
973
974 Captures all of the information in the underlying representation.
975 """
976
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000977 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000978 if self._is_special:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000979 if self._exp == 'F':
980 return sign + 'Infinity'
981 elif self._exp == 'n':
982 return sign + 'NaN' + self._int
983 else: # self._exp == 'N'
984 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000985
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000986 # number of digits of self._int to left of decimal point
987 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000988
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000989 # dotplace is number of digits of self._int to the left of the
990 # decimal point in the mantissa of the output string (that is,
991 # after adjusting the exponent)
992 if self._exp <= 0 and leftdigits > -6:
993 # no exponent required
994 dotplace = leftdigits
995 elif not eng:
996 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000997 dotplace = 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000998 elif self._int == '0':
999 # engineering notation, zero
1000 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001001 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001002 # engineering notation, nonzero
1003 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001004
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001005 if dotplace <= 0:
1006 intpart = '0'
1007 fracpart = '.' + '0'*(-dotplace) + self._int
1008 elif dotplace >= len(self._int):
1009 intpart = self._int+'0'*(dotplace-len(self._int))
1010 fracpart = ''
1011 else:
1012 intpart = self._int[:dotplace]
1013 fracpart = '.' + self._int[dotplace:]
1014 if leftdigits == dotplace:
1015 exp = ''
1016 else:
1017 if context is None:
1018 context = getcontext()
1019 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1020
1021 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001022
1023 def to_eng_string(self, context=None):
1024 """Convert to engineering-type string.
1025
1026 Engineering notation has an exponent which is a multiple of 3, so there
1027 are up to 3 digits left of the decimal place.
1028
1029 Same rules for when in exponential and when as a value as in __str__.
1030 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001031 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001032
1033 def __neg__(self, context=None):
1034 """Returns a copy with the sign switched.
1035
1036 Rounds, if it has reason.
1037 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001038 if self._is_special:
1039 ans = self._check_nans(context=context)
1040 if ans:
1041 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001042
1043 if not self:
1044 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001045 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001046 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001047 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001048
1049 if context is None:
1050 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001051 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001052
1053 def __pos__(self, context=None):
1054 """Returns a copy, unless it is a sNaN.
1055
1056 Rounds the number (if more then precision digits)
1057 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001058 if self._is_special:
1059 ans = self._check_nans(context=context)
1060 if ans:
1061 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001062
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001063 if not self:
1064 # + (-0) = 0
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001065 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001066 else:
1067 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001068
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001069 if context is None:
1070 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001071 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001072
Christian Heimes2c181612007-12-17 20:04:13 +00001073 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001074 """Returns the absolute value of self.
1075
Christian Heimes2c181612007-12-17 20:04:13 +00001076 If the keyword argument 'round' is false, do not round. The
1077 expression self.__abs__(round=False) is equivalent to
1078 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001079 """
Christian Heimes2c181612007-12-17 20:04:13 +00001080 if not round:
1081 return self.copy_abs()
1082
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001083 if self._is_special:
1084 ans = self._check_nans(context=context)
1085 if ans:
1086 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001087
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001088 if self._sign:
1089 ans = self.__neg__(context=context)
1090 else:
1091 ans = self.__pos__(context=context)
1092
1093 return ans
1094
1095 def __add__(self, other, context=None):
1096 """Returns self + other.
1097
1098 -INF + INF (or the reverse) cause InvalidOperation errors.
1099 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001100 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001101 if other is NotImplemented:
1102 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001103
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001104 if context is None:
1105 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001106
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001107 if self._is_special or other._is_special:
1108 ans = self._check_nans(other, context)
1109 if ans:
1110 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001111
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001112 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001113 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001114 if self._sign != other._sign and other._isinfinity():
1115 return context._raise_error(InvalidOperation, '-INF + INF')
1116 return Decimal(self)
1117 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001118 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001119
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001120 exp = min(self._exp, other._exp)
1121 negativezero = 0
1122 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001123 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001124 negativezero = 1
1125
1126 if not self and not other:
1127 sign = min(self._sign, other._sign)
1128 if negativezero:
1129 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001130 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001131 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001132 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001133 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001134 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001135 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001136 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001137 return ans
1138 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001139 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001140 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001141 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001142 return ans
1143
1144 op1 = _WorkRep(self)
1145 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001146 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001147
1148 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001150 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001151 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001152 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001153 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001154 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001155 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001156 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001157 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001158 if op1.sign == 1:
1159 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001160 op1.sign, op2.sign = op2.sign, op1.sign
1161 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001162 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001163 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001164 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001165 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001166 op1.sign, op2.sign = (0, 0)
1167 else:
1168 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001169 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001170
Raymond Hettinger17931de2004-10-27 06:21:46 +00001171 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001172 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001173 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001174 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001175
1176 result.exp = op1.exp
1177 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001178 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001179 return ans
1180
1181 __radd__ = __add__
1182
1183 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001184 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001185 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001186 if other is NotImplemented:
1187 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001188
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001189 if self._is_special or other._is_special:
1190 ans = self._check_nans(other, context=context)
1191 if ans:
1192 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001193
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001194 # self - other is computed as self + other.copy_negate()
1195 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001196
1197 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001198 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001199 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001200 if other is NotImplemented:
1201 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001202
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001203 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001205 def __mul__(self, other, context=None):
1206 """Return self * other.
1207
1208 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1209 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001210 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001211 if other is NotImplemented:
1212 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001213
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001214 if context is None:
1215 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001216
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001217 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001218
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001219 if self._is_special or other._is_special:
1220 ans = self._check_nans(other, context)
1221 if ans:
1222 return ans
1223
1224 if self._isinfinity():
1225 if not other:
1226 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001227 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001228
1229 if other._isinfinity():
1230 if not self:
1231 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001232 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233
1234 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235
1236 # Special case for multiplying by zero
1237 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001238 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001239 # Fixing in case the exponent is out of bounds
1240 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001241 return ans
1242
1243 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001244 if self._int == '1':
1245 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001246 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001247 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001248 if other._int == '1':
1249 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001250 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001251 return ans
1252
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001253 op1 = _WorkRep(self)
1254 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001255
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001256 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001257 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001258
1259 return ans
1260 __rmul__ = __mul__
1261
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001262 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001263 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001264 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001265 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001266 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001267
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001268 if context is None:
1269 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001270
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001271 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001272
1273 if self._is_special or other._is_special:
1274 ans = self._check_nans(other, context)
1275 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001276 return ans
1277
1278 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001279 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001280
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001281 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001282 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001283
1284 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001285 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001286 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001287
1288 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001289 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001290 if not self:
1291 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001292 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001293
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001294 if not self:
1295 exp = self._exp - other._exp
1296 coeff = 0
1297 else:
1298 # OK, so neither = 0, INF or NaN
1299 shift = len(other._int) - len(self._int) + context.prec + 1
1300 exp = self._exp - other._exp - shift
1301 op1 = _WorkRep(self)
1302 op2 = _WorkRep(other)
1303 if shift >= 0:
1304 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1305 else:
1306 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1307 if remainder:
1308 # result is not exact; adjust to ensure correct rounding
1309 if coeff % 5 == 0:
1310 coeff += 1
1311 else:
1312 # result is exact; get as close to ideal exponent as possible
1313 ideal_exp = self._exp - other._exp
1314 while exp < ideal_exp and coeff % 10 == 0:
1315 coeff //= 10
1316 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001317
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001318 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001319 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001320
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001321 def _divide(self, other, context):
1322 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001323
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001324 Assumes that neither self nor other is a NaN, that self is not
1325 infinite and that other is nonzero.
1326 """
1327 sign = self._sign ^ other._sign
1328 if other._isinfinity():
1329 ideal_exp = self._exp
1330 else:
1331 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001332
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001333 expdiff = self.adjusted() - other.adjusted()
1334 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001335 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001336 self._rescale(ideal_exp, context.rounding))
1337 if expdiff <= context.prec:
1338 op1 = _WorkRep(self)
1339 op2 = _WorkRep(other)
1340 if op1.exp >= op2.exp:
1341 op1.int *= 10**(op1.exp - op2.exp)
1342 else:
1343 op2.int *= 10**(op2.exp - op1.exp)
1344 q, r = divmod(op1.int, op2.int)
1345 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001346 return (_dec_from_triple(sign, str(q), 0),
1347 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001348
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001349 # Here the quotient is too large to be representable
1350 ans = context._raise_error(DivisionImpossible,
1351 'quotient too large in //, % or divmod')
1352 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001353
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001354 def __rtruediv__(self, other, context=None):
1355 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001356 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001357 if other is NotImplemented:
1358 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001359 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001360
1361 def __divmod__(self, other, context=None):
1362 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001363 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001364 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001365 other = _convert_other(other)
1366 if other is NotImplemented:
1367 return other
1368
1369 if context is None:
1370 context = getcontext()
1371
1372 ans = self._check_nans(other, context)
1373 if ans:
1374 return (ans, ans)
1375
1376 sign = self._sign ^ other._sign
1377 if self._isinfinity():
1378 if other._isinfinity():
1379 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1380 return ans, ans
1381 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001382 return (_SignedInfinity[sign],
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001383 context._raise_error(InvalidOperation, 'INF % x'))
1384
1385 if not other:
1386 if not self:
1387 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1388 return ans, ans
1389 else:
1390 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1391 context._raise_error(InvalidOperation, 'x % 0'))
1392
1393 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001394 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001395 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001396
1397 def __rdivmod__(self, other, context=None):
1398 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001399 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001400 if other is NotImplemented:
1401 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001402 return other.__divmod__(self, context=context)
1403
1404 def __mod__(self, other, context=None):
1405 """
1406 self % other
1407 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001408 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001409 if other is NotImplemented:
1410 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001411
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001412 if context is None:
1413 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001414
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001415 ans = self._check_nans(other, context)
1416 if ans:
1417 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001418
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001419 if self._isinfinity():
1420 return context._raise_error(InvalidOperation, 'INF % x')
1421 elif not other:
1422 if self:
1423 return context._raise_error(InvalidOperation, 'x % 0')
1424 else:
1425 return context._raise_error(DivisionUndefined, '0 % 0')
1426
1427 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001428 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001429 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001430
1431 def __rmod__(self, other, context=None):
1432 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001433 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001434 if other is NotImplemented:
1435 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001436 return other.__mod__(self, context=context)
1437
1438 def remainder_near(self, other, context=None):
1439 """
1440 Remainder nearest to 0- abs(remainder-near) <= other/2
1441 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001442 if context is None:
1443 context = getcontext()
1444
1445 other = _convert_other(other, raiseit=True)
1446
1447 ans = self._check_nans(other, context)
1448 if ans:
1449 return ans
1450
1451 # self == +/-infinity -> InvalidOperation
1452 if self._isinfinity():
1453 return context._raise_error(InvalidOperation,
1454 'remainder_near(infinity, x)')
1455
1456 # other == 0 -> either InvalidOperation or DivisionUndefined
1457 if not other:
1458 if self:
1459 return context._raise_error(InvalidOperation,
1460 'remainder_near(x, 0)')
1461 else:
1462 return context._raise_error(DivisionUndefined,
1463 'remainder_near(0, 0)')
1464
1465 # other = +/-infinity -> remainder = self
1466 if other._isinfinity():
1467 ans = Decimal(self)
1468 return ans._fix(context)
1469
1470 # self = 0 -> remainder = self, with ideal exponent
1471 ideal_exponent = min(self._exp, other._exp)
1472 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001473 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001474 return ans._fix(context)
1475
1476 # catch most cases of large or small quotient
1477 expdiff = self.adjusted() - other.adjusted()
1478 if expdiff >= context.prec + 1:
1479 # expdiff >= prec+1 => abs(self/other) > 10**prec
1480 return context._raise_error(DivisionImpossible)
1481 if expdiff <= -2:
1482 # expdiff <= -2 => abs(self/other) < 0.1
1483 ans = self._rescale(ideal_exponent, context.rounding)
1484 return ans._fix(context)
1485
1486 # adjust both arguments to have the same exponent, then divide
1487 op1 = _WorkRep(self)
1488 op2 = _WorkRep(other)
1489 if op1.exp >= op2.exp:
1490 op1.int *= 10**(op1.exp - op2.exp)
1491 else:
1492 op2.int *= 10**(op2.exp - op1.exp)
1493 q, r = divmod(op1.int, op2.int)
1494 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1495 # 10**ideal_exponent. Apply correction to ensure that
1496 # abs(remainder) <= abs(other)/2
1497 if 2*r + (q&1) > op2.int:
1498 r -= op2.int
1499 q += 1
1500
1501 if q >= 10**context.prec:
1502 return context._raise_error(DivisionImpossible)
1503
1504 # result has same sign as self unless r is negative
1505 sign = self._sign
1506 if r < 0:
1507 sign = 1-sign
1508 r = -r
1509
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001510 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001511 return ans._fix(context)
1512
1513 def __floordiv__(self, other, context=None):
1514 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001515 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001516 if other is NotImplemented:
1517 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001518
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001519 if context is None:
1520 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001521
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001522 ans = self._check_nans(other, context)
1523 if ans:
1524 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001525
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001526 if self._isinfinity():
1527 if other._isinfinity():
1528 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001529 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001530 return _SignedInfinity[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001531
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001532 if not other:
1533 if self:
1534 return context._raise_error(DivisionByZero, 'x // 0',
1535 self._sign ^ other._sign)
1536 else:
1537 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001538
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001539 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001540
1541 def __rfloordiv__(self, other, context=None):
1542 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001543 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001544 if other is NotImplemented:
1545 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001546 return other.__floordiv__(self, context=context)
1547
1548 def __float__(self):
1549 """Float representation."""
1550 return float(str(self))
1551
1552 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001553 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001554 if self._is_special:
1555 if self._isnan():
Mark Dickinson825fce32009-09-07 18:08:12 +00001556 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001557 elif self._isinfinity():
Mark Dickinson825fce32009-09-07 18:08:12 +00001558 raise OverflowError("Cannot convert infinity to integer")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001559 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001560 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001561 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001562 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001563 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001564
Christian Heimes969fe572008-01-25 11:23:10 +00001565 __trunc__ = __int__
1566
Christian Heimes0bd4e112008-02-12 22:59:25 +00001567 def real(self):
1568 return self
Mark Dickinson315a20a2009-01-04 21:34:18 +00001569 real = property(real)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001570
Christian Heimes0bd4e112008-02-12 22:59:25 +00001571 def imag(self):
1572 return Decimal(0)
Mark Dickinson315a20a2009-01-04 21:34:18 +00001573 imag = property(imag)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001574
1575 def conjugate(self):
1576 return self
1577
1578 def __complex__(self):
1579 return complex(float(self))
1580
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001581 def _fix_nan(self, context):
1582 """Decapitate the payload of a NaN to fit the context"""
1583 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001584
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001585 # maximum length of payload is precision if _clamp=0,
1586 # precision-1 if _clamp=1.
1587 max_payload_len = context.prec - context._clamp
1588 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001589 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1590 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001591 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001592
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001593 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001594 """Round if it is necessary to keep self within prec precision.
1595
1596 Rounds and fixes the exponent. Does not raise on a sNaN.
1597
1598 Arguments:
1599 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001600 context - context used.
1601 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001602
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001603 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001604 if self._isnan():
1605 # decapitate payload if necessary
1606 return self._fix_nan(context)
1607 else:
1608 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001609 return Decimal(self)
1610
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001611 # if self is zero then exponent should be between Etiny and
1612 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1613 Etiny = context.Etiny()
1614 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001615 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001616 exp_max = [context.Emax, Etop][context._clamp]
1617 new_exp = min(max(self._exp, Etiny), exp_max)
1618 if new_exp != self._exp:
1619 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001620 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001621 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001622 return Decimal(self)
1623
1624 # exp_min is the smallest allowable exponent of the result,
1625 # equal to max(self.adjusted()-context.prec+1, Etiny)
1626 exp_min = len(self._int) + self._exp - context.prec
1627 if exp_min > Etop:
1628 # overflow: exp_min > Etop iff self.adjusted() > Emax
1629 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001630 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001631 return context._raise_error(Overflow, 'above Emax', self._sign)
1632 self_is_subnormal = exp_min < Etiny
1633 if self_is_subnormal:
1634 context._raise_error(Subnormal)
1635 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001636
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001637 # round if self has too many digits
1638 if self._exp < exp_min:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001639 context._raise_error(Rounded)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001640 digits = len(self._int) + self._exp - exp_min
1641 if digits < 0:
1642 self = _dec_from_triple(self._sign, '1', exp_min-1)
1643 digits = 0
1644 this_function = getattr(self, self._pick_rounding_function[context.rounding])
1645 changed = this_function(digits)
1646 coeff = self._int[:digits] or '0'
1647 if changed == 1:
1648 coeff = str(int(coeff)+1)
1649 ans = _dec_from_triple(self._sign, coeff, exp_min)
1650
1651 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001652 context._raise_error(Inexact)
1653 if self_is_subnormal:
1654 context._raise_error(Underflow)
1655 if not ans:
1656 # raise Clamped on underflow to 0
1657 context._raise_error(Clamped)
1658 elif len(ans._int) == context.prec+1:
1659 # we get here only if rescaling rounds the
1660 # cofficient up to exactly 10**context.prec
1661 if ans._exp < Etop:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001662 ans = _dec_from_triple(ans._sign,
1663 ans._int[:-1], ans._exp+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001664 else:
1665 # Inexact and Rounded have already been raised
1666 ans = context._raise_error(Overflow, 'above Emax',
1667 self._sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001668 return ans
1669
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001670 # fold down if _clamp == 1 and self has too few digits
1671 if context._clamp == 1 and self._exp > Etop:
1672 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001673 self_padded = self._int + '0'*(self._exp - Etop)
1674 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001675
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001676 # here self was representable to begin with; return unchanged
1677 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001678
1679 _pick_rounding_function = {}
1680
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001681 # for each of the rounding functions below:
1682 # self is a finite, nonzero Decimal
1683 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001684 #
1685 # each function returns either -1, 0, or 1, as follows:
1686 # 1 indicates that self should be rounded up (away from zero)
1687 # 0 indicates that self should be truncated, and that all the
1688 # digits to be truncated are zeros (so the value is unchanged)
1689 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001690
1691 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001692 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001693 if _all_zeros(self._int, prec):
1694 return 0
1695 else:
1696 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001697
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001698 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001699 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001700 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001701
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001702 def _round_half_up(self, prec):
1703 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001704 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001705 return 1
1706 elif _all_zeros(self._int, prec):
1707 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001708 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001709 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001710
1711 def _round_half_down(self, prec):
1712 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001713 if _exact_half(self._int, prec):
1714 return -1
1715 else:
1716 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001717
1718 def _round_half_even(self, prec):
1719 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001720 if _exact_half(self._int, prec) and \
1721 (prec == 0 or self._int[prec-1] in '02468'):
1722 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001723 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001724 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001725
1726 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001727 """Rounds up (not away from 0 if negative.)"""
1728 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001729 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001730 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001731 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001732
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001733 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001734 """Rounds down (not towards 0 if negative)"""
1735 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001736 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001737 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001738 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001739
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001740 def _round_05up(self, prec):
1741 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001742 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001743 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001744 else:
1745 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001746
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001747 def __round__(self, n=None):
1748 """Round self to the nearest integer, or to a given precision.
1749
1750 If only one argument is supplied, round a finite Decimal
1751 instance self to the nearest integer. If self is infinite or
1752 a NaN then a Python exception is raised. If self is finite
1753 and lies exactly halfway between two integers then it is
1754 rounded to the integer with even last digit.
1755
1756 >>> round(Decimal('123.456'))
1757 123
1758 >>> round(Decimal('-456.789'))
1759 -457
1760 >>> round(Decimal('-3.0'))
1761 -3
1762 >>> round(Decimal('2.5'))
1763 2
1764 >>> round(Decimal('3.5'))
1765 4
1766 >>> round(Decimal('Inf'))
1767 Traceback (most recent call last):
1768 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001769 OverflowError: cannot round an infinity
1770 >>> round(Decimal('NaN'))
1771 Traceback (most recent call last):
1772 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001773 ValueError: cannot round a NaN
1774
1775 If a second argument n is supplied, self is rounded to n
1776 decimal places using the rounding mode for the current
1777 context.
1778
1779 For an integer n, round(self, -n) is exactly equivalent to
1780 self.quantize(Decimal('1En')).
1781
1782 >>> round(Decimal('123.456'), 0)
1783 Decimal('123')
1784 >>> round(Decimal('123.456'), 2)
1785 Decimal('123.46')
1786 >>> round(Decimal('123.456'), -2)
1787 Decimal('1E+2')
1788 >>> round(Decimal('-Infinity'), 37)
1789 Decimal('NaN')
1790 >>> round(Decimal('sNaN123'), 0)
1791 Decimal('NaN123')
1792
1793 """
1794 if n is not None:
1795 # two-argument form: use the equivalent quantize call
1796 if not isinstance(n, int):
1797 raise TypeError('Second argument to round should be integral')
1798 exp = _dec_from_triple(0, '1', -n)
1799 return self.quantize(exp)
1800
1801 # one-argument form
1802 if self._is_special:
1803 if self.is_nan():
1804 raise ValueError("cannot round a NaN")
1805 else:
1806 raise OverflowError("cannot round an infinity")
1807 return int(self._rescale(0, ROUND_HALF_EVEN))
1808
1809 def __floor__(self):
1810 """Return the floor of self, as an integer.
1811
1812 For a finite Decimal instance self, return the greatest
1813 integer n such that n <= self. If self is infinite or a NaN
1814 then a Python exception is raised.
1815
1816 """
1817 if self._is_special:
1818 if self.is_nan():
1819 raise ValueError("cannot round a NaN")
1820 else:
1821 raise OverflowError("cannot round an infinity")
1822 return int(self._rescale(0, ROUND_FLOOR))
1823
1824 def __ceil__(self):
1825 """Return the ceiling of self, as an integer.
1826
1827 For a finite Decimal instance self, return the least integer n
1828 such that n >= self. If self is infinite or a NaN then a
1829 Python exception is raised.
1830
1831 """
1832 if self._is_special:
1833 if self.is_nan():
1834 raise ValueError("cannot round a NaN")
1835 else:
1836 raise OverflowError("cannot round an infinity")
1837 return int(self._rescale(0, ROUND_CEILING))
1838
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001839 def fma(self, other, third, context=None):
1840 """Fused multiply-add.
1841
1842 Returns self*other+third with no rounding of the intermediate
1843 product self*other.
1844
1845 self and other are multiplied together, with no rounding of
1846 the result. The third operand is then added to the result,
1847 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001848 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001849
1850 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001851
1852 # compute product; raise InvalidOperation if either operand is
1853 # a signaling NaN or if the product is zero times infinity.
1854 if self._is_special or other._is_special:
1855 if context is None:
1856 context = getcontext()
1857 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001858 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001859 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001860 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001861 if self._exp == 'n':
1862 product = self
1863 elif other._exp == 'n':
1864 product = other
1865 elif self._exp == 'F':
1866 if not other:
1867 return context._raise_error(InvalidOperation,
1868 'INF * 0 in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001869 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001870 elif other._exp == 'F':
1871 if not self:
1872 return context._raise_error(InvalidOperation,
1873 '0 * INF in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001874 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001875 else:
1876 product = _dec_from_triple(self._sign ^ other._sign,
1877 str(int(self._int) * int(other._int)),
1878 self._exp + other._exp)
1879
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001880 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001881 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001882
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001883 def _power_modulo(self, other, modulo, context=None):
1884 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001885
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001886 # if can't convert other and modulo to Decimal, raise
1887 # TypeError; there's no point returning NotImplemented (no
1888 # equivalent of __rpow__ for three argument pow)
1889 other = _convert_other(other, raiseit=True)
1890 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001891
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001892 if context is None:
1893 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001894
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001895 # deal with NaNs: if there are any sNaNs then first one wins,
1896 # (i.e. behaviour for NaNs is identical to that of fma)
1897 self_is_nan = self._isnan()
1898 other_is_nan = other._isnan()
1899 modulo_is_nan = modulo._isnan()
1900 if self_is_nan or other_is_nan or modulo_is_nan:
1901 if self_is_nan == 2:
1902 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001903 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001904 if other_is_nan == 2:
1905 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001906 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001907 if modulo_is_nan == 2:
1908 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001909 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001910 if self_is_nan:
1911 return self._fix_nan(context)
1912 if other_is_nan:
1913 return other._fix_nan(context)
1914 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001915
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001916 # check inputs: we apply same restrictions as Python's pow()
1917 if not (self._isinteger() and
1918 other._isinteger() and
1919 modulo._isinteger()):
1920 return context._raise_error(InvalidOperation,
1921 'pow() 3rd argument not allowed '
1922 'unless all arguments are integers')
1923 if other < 0:
1924 return context._raise_error(InvalidOperation,
1925 'pow() 2nd argument cannot be '
1926 'negative when 3rd argument specified')
1927 if not modulo:
1928 return context._raise_error(InvalidOperation,
1929 'pow() 3rd argument cannot be 0')
1930
1931 # additional restriction for decimal: the modulus must be less
1932 # than 10**prec in absolute value
1933 if modulo.adjusted() >= context.prec:
1934 return context._raise_error(InvalidOperation,
1935 'insufficient precision: pow() 3rd '
1936 'argument must not have more than '
1937 'precision digits')
1938
1939 # define 0**0 == NaN, for consistency with two-argument pow
1940 # (even though it hurts!)
1941 if not other and not self:
1942 return context._raise_error(InvalidOperation,
1943 'at least one of pow() 1st argument '
1944 'and 2nd argument must be nonzero ;'
1945 '0**0 is not defined')
1946
1947 # compute sign of result
1948 if other._iseven():
1949 sign = 0
1950 else:
1951 sign = self._sign
1952
1953 # convert modulo to a Python integer, and self and other to
1954 # Decimal integers (i.e. force their exponents to be >= 0)
1955 modulo = abs(int(modulo))
1956 base = _WorkRep(self.to_integral_value())
1957 exponent = _WorkRep(other.to_integral_value())
1958
1959 # compute result using integer pow()
1960 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1961 for i in range(exponent.exp):
1962 base = pow(base, 10, modulo)
1963 base = pow(base, exponent.int, modulo)
1964
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001965 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001966
1967 def _power_exact(self, other, p):
1968 """Attempt to compute self**other exactly.
1969
1970 Given Decimals self and other and an integer p, attempt to
1971 compute an exact result for the power self**other, with p
1972 digits of precision. Return None if self**other is not
1973 exactly representable in p digits.
1974
1975 Assumes that elimination of special cases has already been
1976 performed: self and other must both be nonspecial; self must
1977 be positive and not numerically equal to 1; other must be
1978 nonzero. For efficiency, other._exp should not be too large,
1979 so that 10**abs(other._exp) is a feasible calculation."""
1980
1981 # In the comments below, we write x for the value of self and
1982 # y for the value of other. Write x = xc*10**xe and y =
1983 # yc*10**ye.
1984
1985 # The main purpose of this method is to identify the *failure*
1986 # of x**y to be exactly representable with as little effort as
1987 # possible. So we look for cheap and easy tests that
1988 # eliminate the possibility of x**y being exact. Only if all
1989 # these tests are passed do we go on to actually compute x**y.
1990
1991 # Here's the main idea. First normalize both x and y. We
1992 # express y as a rational m/n, with m and n relatively prime
1993 # and n>0. Then for x**y to be exactly representable (at
1994 # *any* precision), xc must be the nth power of a positive
1995 # integer and xe must be divisible by n. If m is negative
1996 # then additionally xc must be a power of either 2 or 5, hence
1997 # a power of 2**n or 5**n.
1998 #
1999 # There's a limit to how small |y| can be: if y=m/n as above
2000 # then:
2001 #
2002 # (1) if xc != 1 then for the result to be representable we
2003 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
2004 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
2005 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
2006 # representable.
2007 #
2008 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
2009 # |y| < 1/|xe| then the result is not representable.
2010 #
2011 # Note that since x is not equal to 1, at least one of (1) and
2012 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
2013 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
2014 #
2015 # There's also a limit to how large y can be, at least if it's
2016 # positive: the normalized result will have coefficient xc**y,
2017 # so if it's representable then xc**y < 10**p, and y <
2018 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
2019 # not exactly representable.
2020
2021 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
2022 # so |y| < 1/xe and the result is not representable.
2023 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
2024 # < 1/nbits(xc).
2025
2026 x = _WorkRep(self)
2027 xc, xe = x.int, x.exp
2028 while xc % 10 == 0:
2029 xc //= 10
2030 xe += 1
2031
2032 y = _WorkRep(other)
2033 yc, ye = y.int, y.exp
2034 while yc % 10 == 0:
2035 yc //= 10
2036 ye += 1
2037
2038 # case where xc == 1: result is 10**(xe*y), with xe*y
2039 # required to be an integer
2040 if xc == 1:
2041 if ye >= 0:
2042 exponent = xe*yc*10**ye
2043 else:
2044 exponent, remainder = divmod(xe*yc, 10**-ye)
2045 if remainder:
2046 return None
2047 if y.sign == 1:
2048 exponent = -exponent
2049 # if other is a nonnegative integer, use ideal exponent
2050 if other._isinteger() and other._sign == 0:
2051 ideal_exponent = self._exp*int(other)
2052 zeros = min(exponent-ideal_exponent, p-1)
2053 else:
2054 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002055 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002056
2057 # case where y is negative: xc must be either a power
2058 # of 2 or a power of 5.
2059 if y.sign == 1:
2060 last_digit = xc % 10
2061 if last_digit in (2,4,6,8):
2062 # quick test for power of 2
2063 if xc & -xc != xc:
2064 return None
2065 # now xc is a power of 2; e is its exponent
2066 e = _nbits(xc)-1
2067 # find e*y and xe*y; both must be integers
2068 if ye >= 0:
2069 y_as_int = yc*10**ye
2070 e = e*y_as_int
2071 xe = xe*y_as_int
2072 else:
2073 ten_pow = 10**-ye
2074 e, remainder = divmod(e*yc, ten_pow)
2075 if remainder:
2076 return None
2077 xe, remainder = divmod(xe*yc, ten_pow)
2078 if remainder:
2079 return None
2080
2081 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2082 return None
2083 xc = 5**e
2084
2085 elif last_digit == 5:
2086 # e >= log_5(xc) if xc is a power of 5; we have
2087 # equality all the way up to xc=5**2658
2088 e = _nbits(xc)*28//65
2089 xc, remainder = divmod(5**e, xc)
2090 if remainder:
2091 return None
2092 while xc % 5 == 0:
2093 xc //= 5
2094 e -= 1
2095 if ye >= 0:
2096 y_as_integer = yc*10**ye
2097 e = e*y_as_integer
2098 xe = xe*y_as_integer
2099 else:
2100 ten_pow = 10**-ye
2101 e, remainder = divmod(e*yc, ten_pow)
2102 if remainder:
2103 return None
2104 xe, remainder = divmod(xe*yc, ten_pow)
2105 if remainder:
2106 return None
2107 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2108 return None
2109 xc = 2**e
2110 else:
2111 return None
2112
2113 if xc >= 10**p:
2114 return None
2115 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002116 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002117
2118 # now y is positive; find m and n such that y = m/n
2119 if ye >= 0:
2120 m, n = yc*10**ye, 1
2121 else:
2122 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2123 return None
2124 xc_bits = _nbits(xc)
2125 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2126 return None
2127 m, n = yc, 10**(-ye)
2128 while m % 2 == n % 2 == 0:
2129 m //= 2
2130 n //= 2
2131 while m % 5 == n % 5 == 0:
2132 m //= 5
2133 n //= 5
2134
2135 # compute nth root of xc*10**xe
2136 if n > 1:
2137 # if 1 < xc < 2**n then xc isn't an nth power
2138 if xc != 1 and xc_bits <= n:
2139 return None
2140
2141 xe, rem = divmod(xe, n)
2142 if rem != 0:
2143 return None
2144
2145 # compute nth root of xc using Newton's method
2146 a = 1 << -(-_nbits(xc)//n) # initial estimate
2147 while True:
2148 q, r = divmod(xc, a**(n-1))
2149 if a <= q:
2150 break
2151 else:
2152 a = (a*(n-1) + q)//n
2153 if not (a == q and r == 0):
2154 return None
2155 xc = a
2156
2157 # now xc*10**xe is the nth root of the original xc*10**xe
2158 # compute mth power of xc*10**xe
2159
2160 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2161 # 10**p and the result is not representable.
2162 if xc > 1 and m > p*100//_log10_lb(xc):
2163 return None
2164 xc = xc**m
2165 xe *= m
2166 if xc > 10**p:
2167 return None
2168
2169 # by this point the result *is* exactly representable
2170 # adjust the exponent to get as close as possible to the ideal
2171 # exponent, if necessary
2172 str_xc = str(xc)
2173 if other._isinteger() and other._sign == 0:
2174 ideal_exponent = self._exp*int(other)
2175 zeros = min(xe-ideal_exponent, p-len(str_xc))
2176 else:
2177 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002178 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002179
2180 def __pow__(self, other, modulo=None, context=None):
2181 """Return self ** other [ % modulo].
2182
2183 With two arguments, compute self**other.
2184
2185 With three arguments, compute (self**other) % modulo. For the
2186 three argument form, the following restrictions on the
2187 arguments hold:
2188
2189 - all three arguments must be integral
2190 - other must be nonnegative
2191 - either self or other (or both) must be nonzero
2192 - modulo must be nonzero and must have at most p digits,
2193 where p is the context precision.
2194
2195 If any of these restrictions is violated the InvalidOperation
2196 flag is raised.
2197
2198 The result of pow(self, other, modulo) is identical to the
2199 result that would be obtained by computing (self**other) %
2200 modulo with unbounded precision, but is computed more
2201 efficiently. It is always exact.
2202 """
2203
2204 if modulo is not None:
2205 return self._power_modulo(other, modulo, context)
2206
2207 other = _convert_other(other)
2208 if other is NotImplemented:
2209 return other
2210
2211 if context is None:
2212 context = getcontext()
2213
2214 # either argument is a NaN => result is NaN
2215 ans = self._check_nans(other, context)
2216 if ans:
2217 return ans
2218
2219 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2220 if not other:
2221 if not self:
2222 return context._raise_error(InvalidOperation, '0 ** 0')
2223 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002224 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002225
2226 # result has sign 1 iff self._sign is 1 and other is an odd integer
2227 result_sign = 0
2228 if self._sign == 1:
2229 if other._isinteger():
2230 if not other._iseven():
2231 result_sign = 1
2232 else:
2233 # -ve**noninteger = NaN
2234 # (-0)**noninteger = 0**noninteger
2235 if self:
2236 return context._raise_error(InvalidOperation,
2237 'x ** y with x negative and y not an integer')
2238 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002239 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002240
2241 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2242 if not self:
2243 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002244 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002245 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002246 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002247
2248 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002249 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002250 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002251 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002252 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002253 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002254
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002255 # 1**other = 1, but the choice of exponent and the flags
2256 # depend on the exponent of self, and on whether other is a
2257 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002258 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002259 if other._isinteger():
2260 # exp = max(self._exp*max(int(other), 0),
2261 # 1-context.prec) but evaluating int(other) directly
2262 # is dangerous until we know other is small (other
2263 # could be 1e999999999)
2264 if other._sign == 1:
2265 multiplier = 0
2266 elif other > context.prec:
2267 multiplier = context.prec
2268 else:
2269 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002270
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002271 exp = self._exp * multiplier
2272 if exp < 1-context.prec:
2273 exp = 1-context.prec
2274 context._raise_error(Rounded)
2275 else:
2276 context._raise_error(Inexact)
2277 context._raise_error(Rounded)
2278 exp = 1-context.prec
2279
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002280 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002281
2282 # compute adjusted exponent of self
2283 self_adj = self.adjusted()
2284
2285 # self ** infinity is infinity if self > 1, 0 if self < 1
2286 # self ** -infinity is infinity if self < 1, 0 if self > 1
2287 if other._isinfinity():
2288 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002289 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002290 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002291 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002292
2293 # from here on, the result always goes through the call
2294 # to _fix at the end of this function.
2295 ans = None
2296
2297 # crude test to catch cases of extreme overflow/underflow. If
2298 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2299 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2300 # self**other >= 10**(Emax+1), so overflow occurs. The test
2301 # for underflow is similar.
2302 bound = self._log10_exp_bound() + other.adjusted()
2303 if (self_adj >= 0) == (other._sign == 0):
2304 # self > 1 and other +ve, or self < 1 and other -ve
2305 # possibility of overflow
2306 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002307 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002308 else:
2309 # self > 1 and other -ve, or self < 1 and other +ve
2310 # possibility of underflow to 0
2311 Etiny = context.Etiny()
2312 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002313 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002314
2315 # try for an exact result with precision +1
2316 if ans is None:
2317 ans = self._power_exact(other, context.prec + 1)
2318 if ans is not None and result_sign == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002319 ans = _dec_from_triple(1, ans._int, ans._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002320
2321 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2322 if ans is None:
2323 p = context.prec
2324 x = _WorkRep(self)
2325 xc, xe = x.int, x.exp
2326 y = _WorkRep(other)
2327 yc, ye = y.int, y.exp
2328 if y.sign == 1:
2329 yc = -yc
2330
2331 # compute correctly rounded result: start with precision +3,
2332 # then increase precision until result is unambiguously roundable
2333 extra = 3
2334 while True:
2335 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2336 if coeff % (5*10**(len(str(coeff))-p-1)):
2337 break
2338 extra += 3
2339
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002340 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002341
2342 # the specification says that for non-integer other we need to
2343 # raise Inexact, even when the result is actually exact. In
2344 # the same way, we need to raise Underflow here if the result
2345 # is subnormal. (The call to _fix will take care of raising
2346 # Rounded and Subnormal, as usual.)
2347 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002348 context._raise_error(Inexact)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002349 # pad with zeros up to length context.prec+1 if necessary
2350 if len(ans._int) <= context.prec:
2351 expdiff = context.prec+1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002352 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2353 ans._exp-expdiff)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002354 if ans.adjusted() < context.Emin:
2355 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002356
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002357 # unlike exp, ln and log10, the power function respects the
2358 # rounding mode; no need to use ROUND_HALF_EVEN here
2359 ans = ans._fix(context)
2360 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002361
2362 def __rpow__(self, other, context=None):
2363 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002364 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002365 if other is NotImplemented:
2366 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002367 return other.__pow__(self, context=context)
2368
2369 def normalize(self, context=None):
2370 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002371
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002372 if context is None:
2373 context = getcontext()
2374
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002375 if self._is_special:
2376 ans = self._check_nans(context=context)
2377 if ans:
2378 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002379
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002380 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002381 if dup._isinfinity():
2382 return dup
2383
2384 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002385 return _dec_from_triple(dup._sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002386 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002387 end = len(dup._int)
2388 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002389 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002390 exp += 1
2391 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002392 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002393
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002394 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002395 """Quantize self so its exponent is the same as that of exp.
2396
2397 Similar to self._rescale(exp._exp) but with error checking.
2398 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002399 exp = _convert_other(exp, raiseit=True)
2400
2401 if context is None:
2402 context = getcontext()
2403 if rounding is None:
2404 rounding = context.rounding
2405
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002406 if self._is_special or exp._is_special:
2407 ans = self._check_nans(exp, context)
2408 if ans:
2409 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002410
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002411 if exp._isinfinity() or self._isinfinity():
2412 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002413 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002414 return context._raise_error(InvalidOperation,
2415 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002416
2417 # if we're not watching exponents, do a simple rescale
2418 if not watchexp:
2419 ans = self._rescale(exp._exp, rounding)
2420 # raise Inexact and Rounded where appropriate
2421 if ans._exp > self._exp:
2422 context._raise_error(Rounded)
2423 if ans != self:
2424 context._raise_error(Inexact)
2425 return ans
2426
2427 # exp._exp should be between Etiny and Emax
2428 if not (context.Etiny() <= exp._exp <= context.Emax):
2429 return context._raise_error(InvalidOperation,
2430 'target exponent out of bounds in quantize')
2431
2432 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002433 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002434 return ans._fix(context)
2435
2436 self_adjusted = self.adjusted()
2437 if self_adjusted > context.Emax:
2438 return context._raise_error(InvalidOperation,
2439 'exponent of quantize result too large for current context')
2440 if self_adjusted - exp._exp + 1 > context.prec:
2441 return context._raise_error(InvalidOperation,
2442 'quantize result has too many digits for current context')
2443
2444 ans = self._rescale(exp._exp, rounding)
2445 if ans.adjusted() > context.Emax:
2446 return context._raise_error(InvalidOperation,
2447 'exponent of quantize result too large for current context')
2448 if len(ans._int) > context.prec:
2449 return context._raise_error(InvalidOperation,
2450 'quantize result has too many digits for current context')
2451
2452 # raise appropriate flags
2453 if ans._exp > self._exp:
2454 context._raise_error(Rounded)
2455 if ans != self:
2456 context._raise_error(Inexact)
2457 if ans and ans.adjusted() < context.Emin:
2458 context._raise_error(Subnormal)
2459
2460 # call to fix takes care of any necessary folddown
2461 ans = ans._fix(context)
2462 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002463
2464 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002465 """Return True if self and other have the same exponent; otherwise
2466 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002467
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002468 If either operand is a special value, the following rules are used:
2469 * return True if both operands are infinities
2470 * return True if both operands are NaNs
2471 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002472 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002473 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002474 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002475 return (self.is_nan() and other.is_nan() or
2476 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002477 return self._exp == other._exp
2478
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002479 def _rescale(self, exp, rounding):
2480 """Rescale self so that the exponent is exp, either by padding with zeros
2481 or by truncating digits, using the given rounding mode.
2482
2483 Specials are returned without change. This operation is
2484 quiet: it raises no flags, and uses no information from the
2485 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002486
2487 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002488 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002489 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002490 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002491 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002492 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002493 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002494
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002495 if self._exp >= exp:
2496 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002497 return _dec_from_triple(self._sign,
2498 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002499
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002500 # too many digits; round and lose data. If self.adjusted() <
2501 # exp-1, replace self by 10**(exp-1) before rounding
2502 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002503 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002504 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002505 digits = 0
2506 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002507 changed = this_function(digits)
2508 coeff = self._int[:digits] or '0'
2509 if changed == 1:
2510 coeff = str(int(coeff)+1)
2511 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002512
Christian Heimesf16baeb2008-02-29 14:57:44 +00002513 def _round(self, places, rounding):
2514 """Round a nonzero, nonspecial Decimal to a fixed number of
2515 significant figures, using the given rounding mode.
2516
2517 Infinities, NaNs and zeros are returned unaltered.
2518
2519 This operation is quiet: it raises no flags, and uses no
2520 information from the context.
2521
2522 """
2523 if places <= 0:
2524 raise ValueError("argument should be at least 1 in _round")
2525 if self._is_special or not self:
2526 return Decimal(self)
2527 ans = self._rescale(self.adjusted()+1-places, rounding)
2528 # it can happen that the rescale alters the adjusted exponent;
2529 # for example when rounding 99.97 to 3 significant figures.
2530 # When this happens we end up with an extra 0 at the end of
2531 # the number; a second rescale fixes this.
2532 if ans.adjusted() != self.adjusted():
2533 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2534 return ans
2535
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002536 def to_integral_exact(self, rounding=None, context=None):
2537 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002538
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002539 If no rounding mode is specified, take the rounding mode from
2540 the context. This method raises the Rounded and Inexact flags
2541 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002542
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002543 See also: to_integral_value, which does exactly the same as
2544 this method except that it doesn't raise Inexact or Rounded.
2545 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002546 if self._is_special:
2547 ans = self._check_nans(context=context)
2548 if ans:
2549 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002550 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002551 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002552 return Decimal(self)
2553 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002554 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002555 if context is None:
2556 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002557 if rounding is None:
2558 rounding = context.rounding
2559 context._raise_error(Rounded)
2560 ans = self._rescale(0, rounding)
2561 if ans != self:
2562 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002563 return ans
2564
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002565 def to_integral_value(self, rounding=None, context=None):
2566 """Rounds to the nearest integer, without raising inexact, rounded."""
2567 if context is None:
2568 context = getcontext()
2569 if rounding is None:
2570 rounding = context.rounding
2571 if self._is_special:
2572 ans = self._check_nans(context=context)
2573 if ans:
2574 return ans
2575 return Decimal(self)
2576 if self._exp >= 0:
2577 return Decimal(self)
2578 else:
2579 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002580
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002581 # the method name changed, but we provide also the old one, for compatibility
2582 to_integral = to_integral_value
2583
2584 def sqrt(self, context=None):
2585 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002586 if context is None:
2587 context = getcontext()
2588
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002589 if self._is_special:
2590 ans = self._check_nans(context=context)
2591 if ans:
2592 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002593
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002594 if self._isinfinity() and self._sign == 0:
2595 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002596
2597 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002598 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002599 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002600 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002601
2602 if self._sign == 1:
2603 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2604
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002605 # At this point self represents a positive number. Let p be
2606 # the desired precision and express self in the form c*100**e
2607 # with c a positive real number and e an integer, c and e
2608 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2609 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2610 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2611 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2612 # the closest integer to sqrt(c) with the even integer chosen
2613 # in the case of a tie.
2614 #
2615 # To ensure correct rounding in all cases, we use the
2616 # following trick: we compute the square root to an extra
2617 # place (precision p+1 instead of precision p), rounding down.
2618 # Then, if the result is inexact and its last digit is 0 or 5,
2619 # we increase the last digit to 1 or 6 respectively; if it's
2620 # exact we leave the last digit alone. Now the final round to
2621 # p places (or fewer in the case of underflow) will round
2622 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002623
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002624 # use an extra digit of precision
2625 prec = context.prec+1
2626
2627 # write argument in the form c*100**e where e = self._exp//2
2628 # is the 'ideal' exponent, to be used if the square root is
2629 # exactly representable. l is the number of 'digits' of c in
2630 # base 100, so that 100**(l-1) <= c < 100**l.
2631 op = _WorkRep(self)
2632 e = op.exp >> 1
2633 if op.exp & 1:
2634 c = op.int * 10
2635 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002636 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002637 c = op.int
2638 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002639
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002640 # rescale so that c has exactly prec base 100 'digits'
2641 shift = prec-l
2642 if shift >= 0:
2643 c *= 100**shift
2644 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002645 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002646 c, remainder = divmod(c, 100**-shift)
2647 exact = not remainder
2648 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002649
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002650 # find n = floor(sqrt(c)) using Newton's method
2651 n = 10**prec
2652 while True:
2653 q = c//n
2654 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002655 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002656 else:
2657 n = n + q >> 1
2658 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002659
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002660 if exact:
2661 # result is exact; rescale to use ideal exponent e
2662 if shift >= 0:
2663 # assert n % 10**shift == 0
2664 n //= 10**shift
2665 else:
2666 n *= 10**-shift
2667 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002668 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002669 # result is not exact; fix last digit as described above
2670 if n % 5 == 0:
2671 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002672
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002673 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002674
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002675 # round, and fit to current context
2676 context = context._shallow_copy()
2677 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002678 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002679 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002680
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002681 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002682
2683 def max(self, other, context=None):
2684 """Returns the larger value.
2685
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002686 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002687 NaN (and signals if one is sNaN). Also rounds.
2688 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002689 other = _convert_other(other, raiseit=True)
2690
2691 if context is None:
2692 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002693
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002694 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002695 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002696 # number is always returned
2697 sn = self._isnan()
2698 on = other._isnan()
2699 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002700 if on == 1 and sn == 0:
2701 return self._fix(context)
2702 if sn == 1 and on == 0:
2703 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002704 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002705
Christian Heimes77c02eb2008-02-09 02:18:51 +00002706 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002707 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002708 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002709 # then an ordering is applied:
2710 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002711 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002712 # positive sign and min returns the operand with the negative sign
2713 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002714 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002715 # the result. This is exactly the ordering used in compare_total.
2716 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002717
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002718 if c == -1:
2719 ans = other
2720 else:
2721 ans = self
2722
Christian Heimes2c181612007-12-17 20:04:13 +00002723 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002724
2725 def min(self, other, context=None):
2726 """Returns the smaller value.
2727
Guido van Rossumd8faa362007-04-27 19:54:29 +00002728 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002729 NaN (and signals if one is sNaN). Also rounds.
2730 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002731 other = _convert_other(other, raiseit=True)
2732
2733 if context is None:
2734 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002735
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002736 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002737 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002738 # number is always returned
2739 sn = self._isnan()
2740 on = other._isnan()
2741 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002742 if on == 1 and sn == 0:
2743 return self._fix(context)
2744 if sn == 1 and on == 0:
2745 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002746 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002747
Christian Heimes77c02eb2008-02-09 02:18:51 +00002748 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002749 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002750 c = self.compare_total(other)
2751
2752 if c == -1:
2753 ans = self
2754 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002755 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002756
Christian Heimes2c181612007-12-17 20:04:13 +00002757 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002758
2759 def _isinteger(self):
2760 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002761 if self._is_special:
2762 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002763 if self._exp >= 0:
2764 return True
2765 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002766 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002767
2768 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002769 """Returns True if self is even. Assumes self is an integer."""
2770 if not self or self._exp > 0:
2771 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002772 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002773
2774 def adjusted(self):
2775 """Return the adjusted exponent of self"""
2776 try:
2777 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002778 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002779 except TypeError:
2780 return 0
2781
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002782 def canonical(self, context=None):
2783 """Returns the same Decimal object.
2784
2785 As we do not have different encodings for the same number, the
2786 received object already is in its canonical form.
2787 """
2788 return self
2789
2790 def compare_signal(self, other, context=None):
2791 """Compares self to the other operand numerically.
2792
2793 It's pretty much like compare(), but all NaNs signal, with signaling
2794 NaNs taking precedence over quiet NaNs.
2795 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002796 other = _convert_other(other, raiseit = True)
2797 ans = self._compare_check_nans(other, context)
2798 if ans:
2799 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002800 return self.compare(other, context=context)
2801
2802 def compare_total(self, other):
2803 """Compares self to other using the abstract representations.
2804
2805 This is not like the standard compare, which use their numerical
2806 value. Note that a total ordering is defined for all possible abstract
2807 representations.
2808 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002809 other = _convert_other(other, raiseit=True)
2810
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002811 # if one is negative and the other is positive, it's easy
2812 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002813 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002814 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002815 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002816 sign = self._sign
2817
2818 # let's handle both NaN types
2819 self_nan = self._isnan()
2820 other_nan = other._isnan()
2821 if self_nan or other_nan:
2822 if self_nan == other_nan:
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002823 # compare payloads as though they're integers
2824 self_key = len(self._int), self._int
2825 other_key = len(other._int), other._int
2826 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002827 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002828 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002829 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002830 return _NegativeOne
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002831 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002832 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002833 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002834 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002835 return _One
2836 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002837
2838 if sign:
2839 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002840 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002841 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002842 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002843 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002844 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002845 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002846 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002847 else:
2848 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002849 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002850 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002851 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002852 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002853 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002854 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002855 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002856
2857 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002858 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002859 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002860 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002861
2862 if self._exp < other._exp:
2863 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002864 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002865 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002866 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002867 if self._exp > other._exp:
2868 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002869 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002870 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002871 return _One
2872 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002873
2874
2875 def compare_total_mag(self, other):
2876 """Compares self to other using abstract repr., ignoring sign.
2877
2878 Like compare_total, but with operand's sign ignored and assumed to be 0.
2879 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002880 other = _convert_other(other, raiseit=True)
2881
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002882 s = self.copy_abs()
2883 o = other.copy_abs()
2884 return s.compare_total(o)
2885
2886 def copy_abs(self):
2887 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002888 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002889
2890 def copy_negate(self):
2891 """Returns a copy with the sign inverted."""
2892 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002893 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002894 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002895 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002896
2897 def copy_sign(self, other):
2898 """Returns self with the sign of other."""
Mark Dickinson84230a12010-02-18 14:49:50 +00002899 other = _convert_other(other, raiseit=True)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002900 return _dec_from_triple(other._sign, self._int,
2901 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002902
2903 def exp(self, context=None):
2904 """Returns e ** self."""
2905
2906 if context is None:
2907 context = getcontext()
2908
2909 # exp(NaN) = NaN
2910 ans = self._check_nans(context=context)
2911 if ans:
2912 return ans
2913
2914 # exp(-Infinity) = 0
2915 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002916 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002917
2918 # exp(0) = 1
2919 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002920 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002921
2922 # exp(Infinity) = Infinity
2923 if self._isinfinity() == 1:
2924 return Decimal(self)
2925
2926 # the result is now guaranteed to be inexact (the true
2927 # mathematical result is transcendental). There's no need to
2928 # raise Rounded and Inexact here---they'll always be raised as
2929 # a result of the call to _fix.
2930 p = context.prec
2931 adj = self.adjusted()
2932
2933 # we only need to do any computation for quite a small range
2934 # of adjusted exponents---for example, -29 <= adj <= 10 for
2935 # the default context. For smaller exponent the result is
2936 # indistinguishable from 1 at the given precision, while for
2937 # larger exponent the result either overflows or underflows.
2938 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2939 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002940 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002941 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2942 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002943 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002944 elif self._sign == 0 and adj < -p:
2945 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002946 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002947 elif self._sign == 1 and adj < -p-1:
2948 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002949 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002950 # general case
2951 else:
2952 op = _WorkRep(self)
2953 c, e = op.int, op.exp
2954 if op.sign == 1:
2955 c = -c
2956
2957 # compute correctly rounded result: increase precision by
2958 # 3 digits at a time until we get an unambiguously
2959 # roundable result
2960 extra = 3
2961 while True:
2962 coeff, exp = _dexp(c, e, p+extra)
2963 if coeff % (5*10**(len(str(coeff))-p-1)):
2964 break
2965 extra += 3
2966
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002967 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002968
2969 # at this stage, ans should round correctly with *any*
2970 # rounding mode, not just with ROUND_HALF_EVEN
2971 context = context._shallow_copy()
2972 rounding = context._set_rounding(ROUND_HALF_EVEN)
2973 ans = ans._fix(context)
2974 context.rounding = rounding
2975
2976 return ans
2977
2978 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002979 """Return True if self is canonical; otherwise return False.
2980
2981 Currently, the encoding of a Decimal instance is always
2982 canonical, so this method returns True for any Decimal.
2983 """
2984 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002985
2986 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002987 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002988
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002989 A Decimal instance is considered finite if it is neither
2990 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002991 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002992 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002993
2994 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002995 """Return True if self is infinite; otherwise return False."""
2996 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002997
2998 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002999 """Return True if self is a qNaN or sNaN; otherwise return False."""
3000 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003001
3002 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003003 """Return True if self is a normal number; otherwise return False."""
3004 if self._is_special or not self:
3005 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003006 if context is None:
3007 context = getcontext()
Mark Dickinson06bb6742009-10-20 13:38:04 +00003008 return context.Emin <= self.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003009
3010 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003011 """Return True if self is a quiet NaN; otherwise return False."""
3012 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003013
3014 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003015 """Return True if self is negative; otherwise return False."""
3016 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003017
3018 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003019 """Return True if self is a signaling NaN; otherwise return False."""
3020 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003021
3022 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003023 """Return True if self is subnormal; otherwise return False."""
3024 if self._is_special or not self:
3025 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003026 if context is None:
3027 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003028 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003029
3030 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003031 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003032 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003033
3034 def _ln_exp_bound(self):
3035 """Compute a lower bound for the adjusted exponent of self.ln().
3036 In other words, compute r such that self.ln() >= 10**r. Assumes
3037 that self is finite and positive and that self != 1.
3038 """
3039
3040 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3041 adj = self._exp + len(self._int) - 1
3042 if adj >= 1:
3043 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3044 return len(str(adj*23//10)) - 1
3045 if adj <= -2:
3046 # argument <= 0.1
3047 return len(str((-1-adj)*23//10)) - 1
3048 op = _WorkRep(self)
3049 c, e = op.int, op.exp
3050 if adj == 0:
3051 # 1 < self < 10
3052 num = str(c-10**-e)
3053 den = str(c)
3054 return len(num) - len(den) - (num < den)
3055 # adj == -1, 0.1 <= self < 1
3056 return e + len(str(10**-e - c)) - 1
3057
3058
3059 def ln(self, context=None):
3060 """Returns the natural (base e) logarithm of self."""
3061
3062 if context is None:
3063 context = getcontext()
3064
3065 # ln(NaN) = NaN
3066 ans = self._check_nans(context=context)
3067 if ans:
3068 return ans
3069
3070 # ln(0.0) == -Infinity
3071 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003072 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003073
3074 # ln(Infinity) = Infinity
3075 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003076 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003077
3078 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003079 if self == _One:
3080 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003081
3082 # ln(negative) raises InvalidOperation
3083 if self._sign == 1:
3084 return context._raise_error(InvalidOperation,
3085 'ln of a negative value')
3086
3087 # result is irrational, so necessarily inexact
3088 op = _WorkRep(self)
3089 c, e = op.int, op.exp
3090 p = context.prec
3091
3092 # correctly rounded result: repeatedly increase precision by 3
3093 # until we get an unambiguously roundable result
3094 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3095 while True:
3096 coeff = _dlog(c, e, places)
3097 # assert len(str(abs(coeff)))-p >= 1
3098 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3099 break
3100 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003101 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003102
3103 context = context._shallow_copy()
3104 rounding = context._set_rounding(ROUND_HALF_EVEN)
3105 ans = ans._fix(context)
3106 context.rounding = rounding
3107 return ans
3108
3109 def _log10_exp_bound(self):
3110 """Compute a lower bound for the adjusted exponent of self.log10().
3111 In other words, find r such that self.log10() >= 10**r.
3112 Assumes that self is finite and positive and that self != 1.
3113 """
3114
3115 # For x >= 10 or x < 0.1 we only need a bound on the integer
3116 # part of log10(self), and this comes directly from the
3117 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3118 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3119 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3120
3121 adj = self._exp + len(self._int) - 1
3122 if adj >= 1:
3123 # self >= 10
3124 return len(str(adj))-1
3125 if adj <= -2:
3126 # self < 0.1
3127 return len(str(-1-adj))-1
3128 op = _WorkRep(self)
3129 c, e = op.int, op.exp
3130 if adj == 0:
3131 # 1 < self < 10
3132 num = str(c-10**-e)
3133 den = str(231*c)
3134 return len(num) - len(den) - (num < den) + 2
3135 # adj == -1, 0.1 <= self < 1
3136 num = str(10**-e-c)
3137 return len(num) + e - (num < "231") - 1
3138
3139 def log10(self, context=None):
3140 """Returns the base 10 logarithm of self."""
3141
3142 if context is None:
3143 context = getcontext()
3144
3145 # log10(NaN) = NaN
3146 ans = self._check_nans(context=context)
3147 if ans:
3148 return ans
3149
3150 # log10(0.0) == -Infinity
3151 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003152 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003153
3154 # log10(Infinity) = Infinity
3155 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003156 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003157
3158 # log10(negative or -Infinity) raises InvalidOperation
3159 if self._sign == 1:
3160 return context._raise_error(InvalidOperation,
3161 'log10 of a negative value')
3162
3163 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003164 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003165 # answer may need rounding
3166 ans = Decimal(self._exp + len(self._int) - 1)
3167 else:
3168 # result is irrational, so necessarily inexact
3169 op = _WorkRep(self)
3170 c, e = op.int, op.exp
3171 p = context.prec
3172
3173 # correctly rounded result: repeatedly increase precision
3174 # until result is unambiguously roundable
3175 places = p-self._log10_exp_bound()+2
3176 while True:
3177 coeff = _dlog10(c, e, places)
3178 # assert len(str(abs(coeff)))-p >= 1
3179 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3180 break
3181 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003182 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003183
3184 context = context._shallow_copy()
3185 rounding = context._set_rounding(ROUND_HALF_EVEN)
3186 ans = ans._fix(context)
3187 context.rounding = rounding
3188 return ans
3189
3190 def logb(self, context=None):
3191 """ Returns the exponent of the magnitude of self's MSD.
3192
3193 The result is the integer which is the exponent of the magnitude
3194 of the most significant digit of self (as though it were truncated
3195 to a single digit while maintaining the value of that digit and
3196 without limiting the resulting exponent).
3197 """
3198 # logb(NaN) = NaN
3199 ans = self._check_nans(context=context)
3200 if ans:
3201 return ans
3202
3203 if context is None:
3204 context = getcontext()
3205
3206 # logb(+/-Inf) = +Inf
3207 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003208 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003209
3210 # logb(0) = -Inf, DivisionByZero
3211 if not self:
3212 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3213
3214 # otherwise, simply return the adjusted exponent of self, as a
3215 # Decimal. Note that no attempt is made to fit the result
3216 # into the current context.
Mark Dickinson56df8872009-10-07 19:23:50 +00003217 ans = Decimal(self.adjusted())
3218 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003219
3220 def _islogical(self):
3221 """Return True if self is a logical operand.
3222
Christian Heimes679db4a2008-01-18 09:56:22 +00003223 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003224 an exponent of 0, and a coefficient whose digits must all be
3225 either 0 or 1.
3226 """
3227 if self._sign != 0 or self._exp != 0:
3228 return False
3229 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003230 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003231 return False
3232 return True
3233
3234 def _fill_logical(self, context, opa, opb):
3235 dif = context.prec - len(opa)
3236 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003237 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003238 elif dif < 0:
3239 opa = opa[-context.prec:]
3240 dif = context.prec - len(opb)
3241 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003242 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003243 elif dif < 0:
3244 opb = opb[-context.prec:]
3245 return opa, opb
3246
3247 def logical_and(self, other, context=None):
3248 """Applies an 'and' operation between self and other's digits."""
3249 if context is None:
3250 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003251
3252 other = _convert_other(other, raiseit=True)
3253
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003254 if not self._islogical() or not other._islogical():
3255 return context._raise_error(InvalidOperation)
3256
3257 # fill to context.prec
3258 (opa, opb) = self._fill_logical(context, self._int, other._int)
3259
3260 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003261 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3262 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003263
3264 def logical_invert(self, context=None):
3265 """Invert all its digits."""
3266 if context is None:
3267 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003268 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3269 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003270
3271 def logical_or(self, other, context=None):
3272 """Applies an 'or' operation between self and other's digits."""
3273 if context is None:
3274 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003275
3276 other = _convert_other(other, raiseit=True)
3277
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003278 if not self._islogical() or not other._islogical():
3279 return context._raise_error(InvalidOperation)
3280
3281 # fill to context.prec
3282 (opa, opb) = self._fill_logical(context, self._int, other._int)
3283
3284 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003285 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003286 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003287
3288 def logical_xor(self, other, context=None):
3289 """Applies an 'xor' operation between self and other's digits."""
3290 if context is None:
3291 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003292
3293 other = _convert_other(other, raiseit=True)
3294
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003295 if not self._islogical() or not other._islogical():
3296 return context._raise_error(InvalidOperation)
3297
3298 # fill to context.prec
3299 (opa, opb) = self._fill_logical(context, self._int, other._int)
3300
3301 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003302 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003303 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003304
3305 def max_mag(self, other, context=None):
3306 """Compares the values numerically with their sign ignored."""
3307 other = _convert_other(other, raiseit=True)
3308
3309 if context is None:
3310 context = getcontext()
3311
3312 if self._is_special or other._is_special:
3313 # If one operand is a quiet NaN and the other is number, then the
3314 # number is always returned
3315 sn = self._isnan()
3316 on = other._isnan()
3317 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003318 if on == 1 and sn == 0:
3319 return self._fix(context)
3320 if sn == 1 and on == 0:
3321 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003322 return self._check_nans(other, context)
3323
Christian Heimes77c02eb2008-02-09 02:18:51 +00003324 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003325 if c == 0:
3326 c = self.compare_total(other)
3327
3328 if c == -1:
3329 ans = other
3330 else:
3331 ans = self
3332
Christian Heimes2c181612007-12-17 20:04:13 +00003333 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003334
3335 def min_mag(self, other, context=None):
3336 """Compares the values numerically with their sign ignored."""
3337 other = _convert_other(other, raiseit=True)
3338
3339 if context is None:
3340 context = getcontext()
3341
3342 if self._is_special or other._is_special:
3343 # If one operand is a quiet NaN and the other is number, then the
3344 # number is always returned
3345 sn = self._isnan()
3346 on = other._isnan()
3347 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003348 if on == 1 and sn == 0:
3349 return self._fix(context)
3350 if sn == 1 and on == 0:
3351 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003352 return self._check_nans(other, context)
3353
Christian Heimes77c02eb2008-02-09 02:18:51 +00003354 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003355 if c == 0:
3356 c = self.compare_total(other)
3357
3358 if c == -1:
3359 ans = self
3360 else:
3361 ans = other
3362
Christian Heimes2c181612007-12-17 20:04:13 +00003363 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003364
3365 def next_minus(self, context=None):
3366 """Returns the largest representable number smaller than itself."""
3367 if context is None:
3368 context = getcontext()
3369
3370 ans = self._check_nans(context=context)
3371 if ans:
3372 return ans
3373
3374 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003375 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003376 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003377 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003378
3379 context = context.copy()
3380 context._set_rounding(ROUND_FLOOR)
3381 context._ignore_all_flags()
3382 new_self = self._fix(context)
3383 if new_self != self:
3384 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003385 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3386 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003387
3388 def next_plus(self, context=None):
3389 """Returns the smallest representable number larger than itself."""
3390 if context is None:
3391 context = getcontext()
3392
3393 ans = self._check_nans(context=context)
3394 if ans:
3395 return ans
3396
3397 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003398 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003399 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003400 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003401
3402 context = context.copy()
3403 context._set_rounding(ROUND_CEILING)
3404 context._ignore_all_flags()
3405 new_self = self._fix(context)
3406 if new_self != self:
3407 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003408 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3409 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003410
3411 def next_toward(self, other, context=None):
3412 """Returns the number closest to self, in the direction towards other.
3413
3414 The result is the closest representable number to self
3415 (excluding self) that is in the direction towards other,
3416 unless both have the same value. If the two operands are
3417 numerically equal, then the result is a copy of self with the
3418 sign set to be the same as the sign of other.
3419 """
3420 other = _convert_other(other, raiseit=True)
3421
3422 if context is None:
3423 context = getcontext()
3424
3425 ans = self._check_nans(other, context)
3426 if ans:
3427 return ans
3428
Christian Heimes77c02eb2008-02-09 02:18:51 +00003429 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003430 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003431 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003432
3433 if comparison == -1:
3434 ans = self.next_plus(context)
3435 else: # comparison == 1
3436 ans = self.next_minus(context)
3437
3438 # decide which flags to raise using value of ans
3439 if ans._isinfinity():
3440 context._raise_error(Overflow,
3441 'Infinite result from next_toward',
3442 ans._sign)
3443 context._raise_error(Rounded)
3444 context._raise_error(Inexact)
3445 elif ans.adjusted() < context.Emin:
3446 context._raise_error(Underflow)
3447 context._raise_error(Subnormal)
3448 context._raise_error(Rounded)
3449 context._raise_error(Inexact)
3450 # if precision == 1 then we don't raise Clamped for a
3451 # result 0E-Etiny.
3452 if not ans:
3453 context._raise_error(Clamped)
3454
3455 return ans
3456
3457 def number_class(self, context=None):
3458 """Returns an indication of the class of self.
3459
3460 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003461 sNaN
3462 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003463 -Infinity
3464 -Normal
3465 -Subnormal
3466 -Zero
3467 +Zero
3468 +Subnormal
3469 +Normal
3470 +Infinity
3471 """
3472 if self.is_snan():
3473 return "sNaN"
3474 if self.is_qnan():
3475 return "NaN"
3476 inf = self._isinfinity()
3477 if inf == 1:
3478 return "+Infinity"
3479 if inf == -1:
3480 return "-Infinity"
3481 if self.is_zero():
3482 if self._sign:
3483 return "-Zero"
3484 else:
3485 return "+Zero"
3486 if context is None:
3487 context = getcontext()
3488 if self.is_subnormal(context=context):
3489 if self._sign:
3490 return "-Subnormal"
3491 else:
3492 return "+Subnormal"
3493 # just a normal, regular, boring number, :)
3494 if self._sign:
3495 return "-Normal"
3496 else:
3497 return "+Normal"
3498
3499 def radix(self):
3500 """Just returns 10, as this is Decimal, :)"""
3501 return Decimal(10)
3502
3503 def rotate(self, other, context=None):
3504 """Returns a rotated copy of self, value-of-other times."""
3505 if context is None:
3506 context = getcontext()
3507
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003508 other = _convert_other(other, raiseit=True)
3509
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003510 ans = self._check_nans(other, context)
3511 if ans:
3512 return ans
3513
3514 if other._exp != 0:
3515 return context._raise_error(InvalidOperation)
3516 if not (-context.prec <= int(other) <= context.prec):
3517 return context._raise_error(InvalidOperation)
3518
3519 if self._isinfinity():
3520 return Decimal(self)
3521
3522 # get values, pad if necessary
3523 torot = int(other)
3524 rotdig = self._int
3525 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003526 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003527 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003528 elif topad < 0:
3529 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003530
3531 # let's rotate!
3532 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003533 return _dec_from_triple(self._sign,
3534 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003535
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003536 def scaleb(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003537 """Returns self operand after adding the second value to its exp."""
3538 if context is None:
3539 context = getcontext()
3540
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003541 other = _convert_other(other, raiseit=True)
3542
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003543 ans = self._check_nans(other, context)
3544 if ans:
3545 return ans
3546
3547 if other._exp != 0:
3548 return context._raise_error(InvalidOperation)
3549 liminf = -2 * (context.Emax + context.prec)
3550 limsup = 2 * (context.Emax + context.prec)
3551 if not (liminf <= int(other) <= limsup):
3552 return context._raise_error(InvalidOperation)
3553
3554 if self._isinfinity():
3555 return Decimal(self)
3556
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003557 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003558 d = d._fix(context)
3559 return d
3560
3561 def shift(self, other, context=None):
3562 """Returns a shifted copy of self, value-of-other times."""
3563 if context is None:
3564 context = getcontext()
3565
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003566 other = _convert_other(other, raiseit=True)
3567
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003568 ans = self._check_nans(other, context)
3569 if ans:
3570 return ans
3571
3572 if other._exp != 0:
3573 return context._raise_error(InvalidOperation)
3574 if not (-context.prec <= int(other) <= context.prec):
3575 return context._raise_error(InvalidOperation)
3576
3577 if self._isinfinity():
3578 return Decimal(self)
3579
3580 # get values, pad if necessary
3581 torot = int(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003582 rotdig = self._int
3583 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003584 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003585 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003586 elif topad < 0:
3587 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003588
3589 # let's shift!
3590 if torot < 0:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003591 shifted = rotdig[:torot]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003592 else:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003593 shifted = rotdig + '0'*torot
3594 shifted = shifted[-context.prec:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003595
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003596 return _dec_from_triple(self._sign,
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003597 shifted.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003598
Guido van Rossumd8faa362007-04-27 19:54:29 +00003599 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003600 def __reduce__(self):
3601 return (self.__class__, (str(self),))
3602
3603 def __copy__(self):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003604 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003605 return self # I'm immutable; therefore I am my own clone
3606 return self.__class__(str(self))
3607
3608 def __deepcopy__(self, memo):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003609 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003610 return self # My components are also immutable
3611 return self.__class__(str(self))
3612
Mark Dickinson79f52032009-03-17 23:12:51 +00003613 # PEP 3101 support. the _localeconv keyword argument should be
3614 # considered private: it's provided for ease of testing only.
3615 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003616 """Format a Decimal instance according to the given specifier.
3617
3618 The specifier should be a standard format specifier, with the
3619 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003620 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3621 type is omitted it defaults to 'g' or 'G', depending on the
3622 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003623 """
3624
3625 # Note: PEP 3101 says that if the type is not present then
3626 # there should be at least one digit after the decimal point.
3627 # We take the liberty of ignoring this requirement for
3628 # Decimal---it's presumably there to make sure that
3629 # format(float, '') behaves similarly to str(float).
3630 if context is None:
3631 context = getcontext()
3632
Mark Dickinson79f52032009-03-17 23:12:51 +00003633 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003634
Mark Dickinson79f52032009-03-17 23:12:51 +00003635 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003636 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003637 sign = _format_sign(self._sign, spec)
3638 body = str(self.copy_abs())
3639 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003640
3641 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003642 if spec['type'] is None:
3643 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003644
3645 # if type is '%', adjust exponent of self accordingly
3646 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003647 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3648
3649 # round if necessary, taking rounding mode from the context
3650 rounding = context.rounding
3651 precision = spec['precision']
3652 if precision is not None:
3653 if spec['type'] in 'eE':
3654 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003655 elif spec['type'] in 'fF%':
3656 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003657 elif spec['type'] in 'gG' and len(self._int) > precision:
3658 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003659 # special case: zeros with a positive exponent can't be
3660 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003661 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003662 self = self._rescale(0, rounding)
3663
3664 # figure out placement of the decimal point
3665 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003666 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003667 if not self and precision is not None:
3668 dotplace = 1 - precision
3669 else:
3670 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003671 elif spec['type'] in 'fF%':
3672 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003673 elif spec['type'] in 'gG':
3674 if self._exp <= 0 and leftdigits > -6:
3675 dotplace = leftdigits
3676 else:
3677 dotplace = 1
3678
Mark Dickinson79f52032009-03-17 23:12:51 +00003679 # find digits before and after decimal point, and get exponent
3680 if dotplace < 0:
3681 intpart = '0'
3682 fracpart = '0'*(-dotplace) + self._int
3683 elif dotplace > len(self._int):
3684 intpart = self._int + '0'*(dotplace-len(self._int))
3685 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003686 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003687 intpart = self._int[:dotplace] or '0'
3688 fracpart = self._int[dotplace:]
3689 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003690
Mark Dickinson79f52032009-03-17 23:12:51 +00003691 # done with the decimal-specific stuff; hand over the rest
3692 # of the formatting to the _format_number function
3693 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003694
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003695def _dec_from_triple(sign, coefficient, exponent, special=False):
3696 """Create a decimal instance directly, without any validation,
3697 normalization (e.g. removal of leading zeros) or argument
3698 conversion.
3699
3700 This function is for *internal use only*.
3701 """
3702
3703 self = object.__new__(Decimal)
3704 self._sign = sign
3705 self._int = coefficient
3706 self._exp = exponent
3707 self._is_special = special
3708
3709 return self
3710
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003711# Register Decimal as a kind of Number (an abstract base class).
3712# However, do not register it as Real (because Decimals are not
3713# interoperable with floats).
3714_numbers.Number.register(Decimal)
3715
3716
Guido van Rossumd8faa362007-04-27 19:54:29 +00003717##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003718
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003719
3720# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003721rounding_functions = [name for name in Decimal.__dict__.keys()
3722 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003723for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003724 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003725 globalname = name[1:].upper()
3726 val = globals()[globalname]
3727 Decimal._pick_rounding_function[val] = name
3728
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003729del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003730
Thomas Wouters89f507f2006-12-13 04:49:30 +00003731class _ContextManager(object):
3732 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003733
Thomas Wouters89f507f2006-12-13 04:49:30 +00003734 Sets a copy of the supplied context in __enter__() and restores
3735 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003736 """
3737 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003738 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003739 def __enter__(self):
3740 self.saved_context = getcontext()
3741 setcontext(self.new_context)
3742 return self.new_context
3743 def __exit__(self, t, v, tb):
3744 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003745
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003746class Context(object):
3747 """Contains the context for a Decimal instance.
3748
3749 Contains:
3750 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003751 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003752 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003753 raised when it is caused. Otherwise, a value is
3754 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003755 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003756 (Whether or not the trap_enabler is set)
3757 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003758 Emin - Minimum exponent
3759 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003760 capitals - If 1, 1*10^1 is printed as 1E+1.
3761 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003762 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003763 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003764
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003765 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003766 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003767 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003768 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003769 _ignored_flags=None):
3770 if flags is None:
3771 flags = []
3772 if _ignored_flags is None:
3773 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003774 if not isinstance(flags, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003775 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerbf440692004-07-10 14:14:37 +00003776 if traps is not None and not isinstance(traps, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003777 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003778 for name, val in locals().items():
3779 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003780 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003781 else:
3782 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003783 del self.self
3784
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003785 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003786 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003787 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003788 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3789 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3790 % vars(self))
3791 names = [f.__name__ for f, v in self.flags.items() if v]
3792 s.append('flags=[' + ', '.join(names) + ']')
3793 names = [t.__name__ for t, v in self.traps.items() if v]
3794 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003795 return ', '.join(s) + ')'
3796
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003797 def clear_flags(self):
3798 """Reset all flags to zero"""
3799 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003800 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003801
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003802 def _shallow_copy(self):
3803 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003804 nc = Context(self.prec, self.rounding, self.traps,
3805 self.flags, self.Emin, self.Emax,
3806 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003807 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003808
3809 def copy(self):
3810 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003811 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003812 self.flags.copy(), self.Emin, self.Emax,
3813 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003814 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003815 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003816
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003817 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003818 """Handles an error
3819
3820 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003821 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003822 trap_enabler is set, it reaises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003823 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003824 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003825 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003826 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003827 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003828 return error().handle(self, *args)
3829
Raymond Hettinger86173da2008-02-01 20:38:12 +00003830 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003831 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003832 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003833 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003834
3835 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003836 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003837 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003838
3839 def _ignore_all_flags(self):
3840 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003841 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003842
3843 def _ignore_flags(self, *flags):
3844 """Ignore the flags, if they are raised"""
3845 # Do not mutate-- This way, copies of a context leave the original
3846 # alone.
3847 self._ignored_flags = (self._ignored_flags + list(flags))
3848 return list(flags)
3849
3850 def _regard_flags(self, *flags):
3851 """Stop ignoring the flags, if they are raised"""
3852 if flags and isinstance(flags[0], (tuple,list)):
3853 flags = flags[0]
3854 for flag in flags:
3855 self._ignored_flags.remove(flag)
3856
Nick Coghland1abd252008-07-15 15:46:38 +00003857 # We inherit object.__hash__, so we must deny this explicitly
3858 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003859
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003860 def Etiny(self):
3861 """Returns Etiny (= Emin - prec + 1)"""
3862 return int(self.Emin - self.prec + 1)
3863
3864 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003865 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003866 return int(self.Emax - self.prec + 1)
3867
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003868 def _set_rounding(self, type):
3869 """Sets the rounding type.
3870
3871 Sets the rounding type, and returns the current (previous)
3872 rounding type. Often used like:
3873
3874 context = context.copy()
3875 # so you don't change the calling context
3876 # if an error occurs in the middle.
3877 rounding = context._set_rounding(ROUND_UP)
3878 val = self.__sub__(other, context=context)
3879 context._set_rounding(rounding)
3880
3881 This will make it round up for that operation.
3882 """
3883 rounding = self.rounding
3884 self.rounding= type
3885 return rounding
3886
Raymond Hettingerfed52962004-07-14 15:41:57 +00003887 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003888 """Creates a new Decimal instance but using self as context.
3889
3890 This method implements the to-number operation of the
3891 IBM Decimal specification."""
3892
3893 if isinstance(num, str) and num != num.strip():
3894 return self._raise_error(ConversionSyntax,
3895 "no trailing or leading whitespace is "
3896 "permitted.")
3897
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003898 d = Decimal(num, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003899 if d._isnan() and len(d._int) > self.prec - self._clamp:
3900 return self._raise_error(ConversionSyntax,
3901 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003902 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003903
Raymond Hettinger771ed762009-01-03 19:20:32 +00003904 def create_decimal_from_float(self, f):
3905 """Creates a new Decimal instance from a float but rounding using self
3906 as the context.
3907
3908 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3909 >>> context.create_decimal_from_float(3.1415926535897932)
3910 Decimal('3.1415')
3911 >>> context = Context(prec=5, traps=[Inexact])
3912 >>> context.create_decimal_from_float(3.1415926535897932)
3913 Traceback (most recent call last):
3914 ...
3915 decimal.Inexact: None
3916
3917 """
3918 d = Decimal.from_float(f) # An exact conversion
3919 return d._fix(self) # Apply the context rounding
3920
Guido van Rossumd8faa362007-04-27 19:54:29 +00003921 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003922 def abs(self, a):
3923 """Returns the absolute value of the operand.
3924
3925 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00003926 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003927 the plus operation on the operand.
3928
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003929 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003930 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003931 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003932 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003933 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003934 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003935 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003936 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00003937 >>> ExtendedContext.abs(-1)
3938 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003939 """
Mark Dickinson84230a12010-02-18 14:49:50 +00003940 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003941 return a.__abs__(context=self)
3942
3943 def add(self, a, b):
3944 """Return the sum of the two operands.
3945
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003946 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003947 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003948 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003949 Decimal('1.02E+4')
Mark Dickinson84230a12010-02-18 14:49:50 +00003950 >>> ExtendedContext.add(1, Decimal(2))
3951 Decimal('3')
3952 >>> ExtendedContext.add(Decimal(8), 5)
3953 Decimal('13')
3954 >>> ExtendedContext.add(5, 5)
3955 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003956 """
Mark Dickinson84230a12010-02-18 14:49:50 +00003957 a = _convert_other(a, raiseit=True)
3958 r = a.__add__(b, context=self)
3959 if r is NotImplemented:
3960 raise TypeError("Unable to convert %s to Decimal" % b)
3961 else:
3962 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003963
3964 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003965 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003966
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003967 def canonical(self, a):
3968 """Returns the same Decimal object.
3969
3970 As we do not have different encodings for the same number, the
3971 received object already is in its canonical form.
3972
3973 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003974 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003975 """
3976 return a.canonical(context=self)
3977
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003978 def compare(self, a, b):
3979 """Compares values numerically.
3980
3981 If the signs of the operands differ, a value representing each operand
3982 ('-1' if the operand is less than zero, '0' if the operand is zero or
3983 negative zero, or '1' if the operand is greater than zero) is used in
3984 place of that operand for the comparison instead of the actual
3985 operand.
3986
3987 The comparison is then effected by subtracting the second operand from
3988 the first and then returning a value according to the result of the
3989 subtraction: '-1' if the result is less than zero, '0' if the result is
3990 zero or negative zero, or '1' if the result is greater than zero.
3991
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003992 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003993 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003994 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003995 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003996 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003997 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003998 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003999 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004000 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004001 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004002 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004003 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004004 >>> ExtendedContext.compare(1, 2)
4005 Decimal('-1')
4006 >>> ExtendedContext.compare(Decimal(1), 2)
4007 Decimal('-1')
4008 >>> ExtendedContext.compare(1, Decimal(2))
4009 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004010 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004011 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004012 return a.compare(b, context=self)
4013
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004014 def compare_signal(self, a, b):
4015 """Compares the values of the two operands numerically.
4016
4017 It's pretty much like compare(), but all NaNs signal, with signaling
4018 NaNs taking precedence over quiet NaNs.
4019
4020 >>> c = ExtendedContext
4021 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004022 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004023 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004024 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004025 >>> c.flags[InvalidOperation] = 0
4026 >>> print(c.flags[InvalidOperation])
4027 0
4028 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004029 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004030 >>> print(c.flags[InvalidOperation])
4031 1
4032 >>> c.flags[InvalidOperation] = 0
4033 >>> print(c.flags[InvalidOperation])
4034 0
4035 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004036 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004037 >>> print(c.flags[InvalidOperation])
4038 1
Mark Dickinson84230a12010-02-18 14:49:50 +00004039 >>> c.compare_signal(-1, 2)
4040 Decimal('-1')
4041 >>> c.compare_signal(Decimal(-1), 2)
4042 Decimal('-1')
4043 >>> c.compare_signal(-1, Decimal(2))
4044 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004045 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004046 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004047 return a.compare_signal(b, context=self)
4048
4049 def compare_total(self, a, b):
4050 """Compares two operands using their abstract representation.
4051
4052 This is not like the standard compare, which use their numerical
4053 value. Note that a total ordering is defined for all possible abstract
4054 representations.
4055
4056 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004057 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004058 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004059 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004060 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004061 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004062 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004063 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004064 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004065 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004066 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004067 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004068 >>> ExtendedContext.compare_total(1, 2)
4069 Decimal('-1')
4070 >>> ExtendedContext.compare_total(Decimal(1), 2)
4071 Decimal('-1')
4072 >>> ExtendedContext.compare_total(1, Decimal(2))
4073 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004074 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004075 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004076 return a.compare_total(b)
4077
4078 def compare_total_mag(self, a, b):
4079 """Compares two operands using their abstract representation ignoring sign.
4080
4081 Like compare_total, but with operand's sign ignored and assumed to be 0.
4082 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004083 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004084 return a.compare_total_mag(b)
4085
4086 def copy_abs(self, a):
4087 """Returns a copy of the operand with the sign set to 0.
4088
4089 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004090 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004091 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004092 Decimal('100')
Mark Dickinson84230a12010-02-18 14:49:50 +00004093 >>> ExtendedContext.copy_abs(-1)
4094 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004095 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004096 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004097 return a.copy_abs()
4098
4099 def copy_decimal(self, a):
Mark Dickinson84230a12010-02-18 14:49:50 +00004100 """Returns a copy of the decimal object.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004101
4102 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004103 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004104 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004105 Decimal('-1.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004106 >>> ExtendedContext.copy_decimal(1)
4107 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004108 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004109 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004110 return Decimal(a)
4111
4112 def copy_negate(self, a):
4113 """Returns a copy of the operand with the sign inverted.
4114
4115 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004116 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004117 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004118 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004119 >>> ExtendedContext.copy_negate(1)
4120 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004121 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004122 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004123 return a.copy_negate()
4124
4125 def copy_sign(self, a, b):
4126 """Copies the second operand's sign to the first one.
4127
4128 In detail, it returns a copy of the first operand with the sign
4129 equal to the sign of the second operand.
4130
4131 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004132 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004133 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004134 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004135 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004136 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004137 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004138 Decimal('-1.50')
Mark Dickinson84230a12010-02-18 14:49:50 +00004139 >>> ExtendedContext.copy_sign(1, -2)
4140 Decimal('-1')
4141 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4142 Decimal('-1')
4143 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4144 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004145 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004146 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004147 return a.copy_sign(b)
4148
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004149 def divide(self, a, b):
4150 """Decimal division in a specified context.
4151
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004152 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004153 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004154 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004155 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004156 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004157 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004158 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004159 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004160 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004161 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004162 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004163 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004164 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004165 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004166 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004167 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004168 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004169 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004170 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004171 Decimal('1.20E+6')
Mark Dickinson84230a12010-02-18 14:49:50 +00004172 >>> ExtendedContext.divide(5, 5)
4173 Decimal('1')
4174 >>> ExtendedContext.divide(Decimal(5), 5)
4175 Decimal('1')
4176 >>> ExtendedContext.divide(5, Decimal(5))
4177 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004178 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004179 a = _convert_other(a, raiseit=True)
4180 r = a.__truediv__(b, context=self)
4181 if r is NotImplemented:
4182 raise TypeError("Unable to convert %s to Decimal" % b)
4183 else:
4184 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004185
4186 def divide_int(self, a, b):
4187 """Divides two numbers and returns the integer part of the result.
4188
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004189 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004190 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004191 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004192 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004193 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004194 Decimal('3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004195 >>> ExtendedContext.divide_int(10, 3)
4196 Decimal('3')
4197 >>> ExtendedContext.divide_int(Decimal(10), 3)
4198 Decimal('3')
4199 >>> ExtendedContext.divide_int(10, Decimal(3))
4200 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004201 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004202 a = _convert_other(a, raiseit=True)
4203 r = a.__floordiv__(b, context=self)
4204 if r is NotImplemented:
4205 raise TypeError("Unable to convert %s to Decimal" % b)
4206 else:
4207 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004208
4209 def divmod(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004210 """Return (a // b, a % b).
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004211
4212 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4213 (Decimal('2'), Decimal('2'))
4214 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4215 (Decimal('2'), Decimal('0'))
Mark Dickinson84230a12010-02-18 14:49:50 +00004216 >>> ExtendedContext.divmod(8, 4)
4217 (Decimal('2'), Decimal('0'))
4218 >>> ExtendedContext.divmod(Decimal(8), 4)
4219 (Decimal('2'), Decimal('0'))
4220 >>> ExtendedContext.divmod(8, Decimal(4))
4221 (Decimal('2'), Decimal('0'))
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004222 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004223 a = _convert_other(a, raiseit=True)
4224 r = a.__divmod__(b, context=self)
4225 if r is NotImplemented:
4226 raise TypeError("Unable to convert %s to Decimal" % b)
4227 else:
4228 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004229
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004230 def exp(self, a):
4231 """Returns e ** a.
4232
4233 >>> c = ExtendedContext.copy()
4234 >>> c.Emin = -999
4235 >>> c.Emax = 999
4236 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004237 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004238 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004239 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004240 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004241 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004242 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004243 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004244 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004245 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004246 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004247 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004248 >>> c.exp(10)
4249 Decimal('22026.4658')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004250 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004251 a =_convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004252 return a.exp(context=self)
4253
4254 def fma(self, a, b, c):
4255 """Returns a multiplied by b, plus c.
4256
4257 The first two operands are multiplied together, using multiply,
4258 the third operand is then added to the result of that
4259 multiplication, using add, all with only one final rounding.
4260
4261 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004262 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004263 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004264 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004265 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004266 Decimal('1.38435736E+12')
Mark Dickinson84230a12010-02-18 14:49:50 +00004267 >>> ExtendedContext.fma(1, 3, 4)
4268 Decimal('7')
4269 >>> ExtendedContext.fma(1, Decimal(3), 4)
4270 Decimal('7')
4271 >>> ExtendedContext.fma(1, 3, Decimal(4))
4272 Decimal('7')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004273 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004274 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004275 return a.fma(b, c, context=self)
4276
4277 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004278 """Return True if the operand is canonical; otherwise return False.
4279
4280 Currently, the encoding of a Decimal instance is always
4281 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004282
4283 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004284 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004285 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004286 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004287
4288 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004289 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004290
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004291 A Decimal instance is considered finite if it is neither
4292 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004293
4294 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004295 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004296 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004297 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004298 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004299 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004300 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004301 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004302 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004303 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004304 >>> ExtendedContext.is_finite(1)
4305 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004306 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004307 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004308 return a.is_finite()
4309
4310 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004311 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004312
4313 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004314 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004315 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004316 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004317 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004318 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004319 >>> ExtendedContext.is_infinite(1)
4320 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004321 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004322 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004323 return a.is_infinite()
4324
4325 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004326 """Return True if the operand is a qNaN or sNaN;
4327 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004328
4329 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004330 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004331 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004332 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004333 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004334 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004335 >>> ExtendedContext.is_nan(1)
4336 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004337 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004338 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004339 return a.is_nan()
4340
4341 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004342 """Return True if the operand is a normal number;
4343 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004344
4345 >>> c = ExtendedContext.copy()
4346 >>> c.Emin = -999
4347 >>> c.Emax = 999
4348 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004349 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004350 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004351 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004352 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004353 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004354 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004355 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004356 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004357 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004358 >>> c.is_normal(1)
4359 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004360 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004361 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004362 return a.is_normal(context=self)
4363
4364 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004365 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004366
4367 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004368 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004369 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004370 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004371 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004372 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004373 >>> ExtendedContext.is_qnan(1)
4374 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004375 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004376 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004377 return a.is_qnan()
4378
4379 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004380 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004381
4382 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004383 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004384 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004385 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004386 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004387 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004388 >>> ExtendedContext.is_signed(8)
4389 False
4390 >>> ExtendedContext.is_signed(-8)
4391 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004392 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004393 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004394 return a.is_signed()
4395
4396 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004397 """Return True if the operand is a signaling NaN;
4398 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004399
4400 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004401 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004402 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004403 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004404 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004405 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004406 >>> ExtendedContext.is_snan(1)
4407 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004408 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004409 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004410 return a.is_snan()
4411
4412 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004413 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004414
4415 >>> c = ExtendedContext.copy()
4416 >>> c.Emin = -999
4417 >>> c.Emax = 999
4418 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004419 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004420 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004421 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004422 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004423 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004424 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004425 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004426 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004427 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004428 >>> c.is_subnormal(1)
4429 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004430 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004431 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004432 return a.is_subnormal(context=self)
4433
4434 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004435 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004436
4437 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004438 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004439 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004440 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004441 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004442 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004443 >>> ExtendedContext.is_zero(1)
4444 False
4445 >>> ExtendedContext.is_zero(0)
4446 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004447 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004448 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004449 return a.is_zero()
4450
4451 def ln(self, a):
4452 """Returns the natural (base e) logarithm of the operand.
4453
4454 >>> c = ExtendedContext.copy()
4455 >>> c.Emin = -999
4456 >>> c.Emax = 999
4457 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004458 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004459 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004460 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004461 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004462 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004463 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004464 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004465 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004466 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004467 >>> c.ln(1)
4468 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004469 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004470 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004471 return a.ln(context=self)
4472
4473 def log10(self, a):
4474 """Returns the base 10 logarithm of the operand.
4475
4476 >>> c = ExtendedContext.copy()
4477 >>> c.Emin = -999
4478 >>> c.Emax = 999
4479 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004480 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004481 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004482 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004483 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004484 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004485 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004486 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004487 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004488 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004489 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004490 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004491 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004492 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004493 >>> c.log10(0)
4494 Decimal('-Infinity')
4495 >>> c.log10(1)
4496 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004497 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004498 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004499 return a.log10(context=self)
4500
4501 def logb(self, a):
4502 """ Returns the exponent of the magnitude of the operand's MSD.
4503
4504 The result is the integer which is the exponent of the magnitude
4505 of the most significant digit of the operand (as though the
4506 operand were truncated to a single digit while maintaining the
4507 value of that digit and without limiting the resulting exponent).
4508
4509 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004510 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004511 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004512 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004513 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004514 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004515 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004516 Decimal('-Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004517 >>> ExtendedContext.logb(1)
4518 Decimal('0')
4519 >>> ExtendedContext.logb(10)
4520 Decimal('1')
4521 >>> ExtendedContext.logb(100)
4522 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004523 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004524 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004525 return a.logb(context=self)
4526
4527 def logical_and(self, a, b):
4528 """Applies the logical operation 'and' between each operand's digits.
4529
4530 The operands must be both logical numbers.
4531
4532 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004533 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004534 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004535 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004536 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004537 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004538 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004539 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004540 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004541 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004542 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004543 Decimal('10')
Mark Dickinson84230a12010-02-18 14:49:50 +00004544 >>> ExtendedContext.logical_and(110, 1101)
4545 Decimal('100')
4546 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4547 Decimal('100')
4548 >>> ExtendedContext.logical_and(110, Decimal(1101))
4549 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004550 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004551 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004552 return a.logical_and(b, context=self)
4553
4554 def logical_invert(self, a):
4555 """Invert all the digits in the operand.
4556
4557 The operand must be a logical number.
4558
4559 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004560 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004561 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004562 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004563 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004564 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004565 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004566 Decimal('10101010')
Mark Dickinson84230a12010-02-18 14:49:50 +00004567 >>> ExtendedContext.logical_invert(1101)
4568 Decimal('111110010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004569 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004570 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004571 return a.logical_invert(context=self)
4572
4573 def logical_or(self, a, b):
4574 """Applies the logical operation 'or' between each operand's digits.
4575
4576 The operands must be both logical numbers.
4577
4578 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004579 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004580 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004581 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004582 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004583 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004584 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004585 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004586 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004587 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004588 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004589 Decimal('1110')
Mark Dickinson84230a12010-02-18 14:49:50 +00004590 >>> ExtendedContext.logical_or(110, 1101)
4591 Decimal('1111')
4592 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4593 Decimal('1111')
4594 >>> ExtendedContext.logical_or(110, Decimal(1101))
4595 Decimal('1111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004596 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004597 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004598 return a.logical_or(b, context=self)
4599
4600 def logical_xor(self, a, b):
4601 """Applies the logical operation 'xor' between each operand's digits.
4602
4603 The operands must be both logical numbers.
4604
4605 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004606 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004607 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004608 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004609 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004610 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004611 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004612 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004613 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004614 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004615 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004616 Decimal('1101')
Mark Dickinson84230a12010-02-18 14:49:50 +00004617 >>> ExtendedContext.logical_xor(110, 1101)
4618 Decimal('1011')
4619 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4620 Decimal('1011')
4621 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4622 Decimal('1011')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004623 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004624 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004625 return a.logical_xor(b, context=self)
4626
Mark Dickinson84230a12010-02-18 14:49:50 +00004627 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004628 """max compares two values numerically and returns the maximum.
4629
4630 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004631 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004632 operation. If they are numerically equal then the left-hand operand
4633 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004634 infinity) of the two operands is chosen as the result.
4635
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004636 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004637 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004638 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004639 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004640 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004641 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004642 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004643 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004644 >>> ExtendedContext.max(1, 2)
4645 Decimal('2')
4646 >>> ExtendedContext.max(Decimal(1), 2)
4647 Decimal('2')
4648 >>> ExtendedContext.max(1, Decimal(2))
4649 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004650 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004651 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004652 return a.max(b, context=self)
4653
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004654 def max_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004655 """Compares the values numerically with their sign ignored.
4656
4657 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4658 Decimal('7')
4659 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4660 Decimal('-10')
4661 >>> ExtendedContext.max_mag(1, -2)
4662 Decimal('-2')
4663 >>> ExtendedContext.max_mag(Decimal(1), -2)
4664 Decimal('-2')
4665 >>> ExtendedContext.max_mag(1, Decimal(-2))
4666 Decimal('-2')
4667 """
4668 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004669 return a.max_mag(b, context=self)
4670
Mark Dickinson84230a12010-02-18 14:49:50 +00004671 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004672 """min compares two values numerically and returns the minimum.
4673
4674 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004675 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004676 operation. If they are numerically equal then the left-hand operand
4677 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004678 infinity) of the two operands is chosen as the result.
4679
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004680 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004681 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004682 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004683 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004684 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004685 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004686 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004687 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004688 >>> ExtendedContext.min(1, 2)
4689 Decimal('1')
4690 >>> ExtendedContext.min(Decimal(1), 2)
4691 Decimal('1')
4692 >>> ExtendedContext.min(1, Decimal(29))
4693 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004694 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004695 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004696 return a.min(b, context=self)
4697
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004698 def min_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004699 """Compares the values numerically with their sign ignored.
4700
4701 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4702 Decimal('-2')
4703 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4704 Decimal('-3')
4705 >>> ExtendedContext.min_mag(1, -2)
4706 Decimal('1')
4707 >>> ExtendedContext.min_mag(Decimal(1), -2)
4708 Decimal('1')
4709 >>> ExtendedContext.min_mag(1, Decimal(-2))
4710 Decimal('1')
4711 """
4712 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004713 return a.min_mag(b, context=self)
4714
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004715 def minus(self, a):
4716 """Minus corresponds to unary prefix minus in Python.
4717
4718 The operation is evaluated using the same rules as subtract; the
4719 operation minus(a) is calculated as subtract('0', a) where the '0'
4720 has the same exponent as the operand.
4721
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004722 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004723 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004724 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004725 Decimal('1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004726 >>> ExtendedContext.minus(1)
4727 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004728 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004729 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004730 return a.__neg__(context=self)
4731
4732 def multiply(self, a, b):
4733 """multiply multiplies two operands.
4734
4735 If either operand is a special value then the general rules apply.
Mark Dickinson84230a12010-02-18 14:49:50 +00004736 Otherwise, the operands are multiplied together
4737 ('long multiplication'), resulting in a number which may be as long as
4738 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004739
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004740 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004741 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004742 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004743 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004744 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004745 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004746 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004747 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004748 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004749 Decimal('4.28135971E+11')
Mark Dickinson84230a12010-02-18 14:49:50 +00004750 >>> ExtendedContext.multiply(7, 7)
4751 Decimal('49')
4752 >>> ExtendedContext.multiply(Decimal(7), 7)
4753 Decimal('49')
4754 >>> ExtendedContext.multiply(7, Decimal(7))
4755 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004756 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004757 a = _convert_other(a, raiseit=True)
4758 r = a.__mul__(b, context=self)
4759 if r is NotImplemented:
4760 raise TypeError("Unable to convert %s to Decimal" % b)
4761 else:
4762 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004763
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004764 def next_minus(self, a):
4765 """Returns the largest representable number smaller than a.
4766
4767 >>> c = ExtendedContext.copy()
4768 >>> c.Emin = -999
4769 >>> c.Emax = 999
4770 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004771 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004772 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004773 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004774 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004775 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004776 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004777 Decimal('9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004778 >>> c.next_minus(1)
4779 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004780 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004781 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004782 return a.next_minus(context=self)
4783
4784 def next_plus(self, a):
4785 """Returns the smallest representable number larger than a.
4786
4787 >>> c = ExtendedContext.copy()
4788 >>> c.Emin = -999
4789 >>> c.Emax = 999
4790 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004791 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004792 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004793 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004794 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004795 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004796 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004797 Decimal('-9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004798 >>> c.next_plus(1)
4799 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004800 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004801 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004802 return a.next_plus(context=self)
4803
4804 def next_toward(self, a, b):
4805 """Returns the number closest to a, in direction towards b.
4806
4807 The result is the closest representable number from the first
4808 operand (but not the first operand) that is in the direction
4809 towards the second operand, unless the operands have the same
4810 value.
4811
4812 >>> c = ExtendedContext.copy()
4813 >>> c.Emin = -999
4814 >>> c.Emax = 999
4815 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004816 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004817 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004818 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004819 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004820 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004821 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004822 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004823 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004824 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004825 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004826 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004827 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004828 Decimal('-0.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004829 >>> c.next_toward(0, 1)
4830 Decimal('1E-1007')
4831 >>> c.next_toward(Decimal(0), 1)
4832 Decimal('1E-1007')
4833 >>> c.next_toward(0, Decimal(1))
4834 Decimal('1E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004835 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004836 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004837 return a.next_toward(b, context=self)
4838
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004839 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004840 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004841
4842 Essentially a plus operation with all trailing zeros removed from the
4843 result.
4844
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004845 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004846 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004847 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004848 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004849 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004850 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004851 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004852 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004853 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004854 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004855 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004856 Decimal('0')
Mark Dickinson84230a12010-02-18 14:49:50 +00004857 >>> ExtendedContext.normalize(6)
4858 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004859 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004860 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004861 return a.normalize(context=self)
4862
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004863 def number_class(self, a):
4864 """Returns an indication of the class of the operand.
4865
4866 The class is one of the following strings:
4867 -sNaN
4868 -NaN
4869 -Infinity
4870 -Normal
4871 -Subnormal
4872 -Zero
4873 +Zero
4874 +Subnormal
4875 +Normal
4876 +Infinity
4877
4878 >>> c = Context(ExtendedContext)
4879 >>> c.Emin = -999
4880 >>> c.Emax = 999
4881 >>> c.number_class(Decimal('Infinity'))
4882 '+Infinity'
4883 >>> c.number_class(Decimal('1E-10'))
4884 '+Normal'
4885 >>> c.number_class(Decimal('2.50'))
4886 '+Normal'
4887 >>> c.number_class(Decimal('0.1E-999'))
4888 '+Subnormal'
4889 >>> c.number_class(Decimal('0'))
4890 '+Zero'
4891 >>> c.number_class(Decimal('-0'))
4892 '-Zero'
4893 >>> c.number_class(Decimal('-0.1E-999'))
4894 '-Subnormal'
4895 >>> c.number_class(Decimal('-1E-10'))
4896 '-Normal'
4897 >>> c.number_class(Decimal('-2.50'))
4898 '-Normal'
4899 >>> c.number_class(Decimal('-Infinity'))
4900 '-Infinity'
4901 >>> c.number_class(Decimal('NaN'))
4902 'NaN'
4903 >>> c.number_class(Decimal('-NaN'))
4904 'NaN'
4905 >>> c.number_class(Decimal('sNaN'))
4906 'sNaN'
Mark Dickinson84230a12010-02-18 14:49:50 +00004907 >>> c.number_class(123)
4908 '+Normal'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004909 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004910 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004911 return a.number_class(context=self)
4912
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004913 def plus(self, a):
4914 """Plus corresponds to unary prefix plus in Python.
4915
4916 The operation is evaluated using the same rules as add; the
4917 operation plus(a) is calculated as add('0', a) where the '0'
4918 has the same exponent as the operand.
4919
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004920 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004921 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004922 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004923 Decimal('-1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004924 >>> ExtendedContext.plus(-1)
4925 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004926 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004927 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004928 return a.__pos__(context=self)
4929
4930 def power(self, a, b, modulo=None):
4931 """Raises a to the power of b, to modulo if given.
4932
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004933 With two arguments, compute a**b. If a is negative then b
4934 must be integral. The result will be inexact unless b is
4935 integral and the result is finite and can be expressed exactly
4936 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004937
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004938 With three arguments, compute (a**b) % modulo. For the
4939 three argument form, the following restrictions on the
4940 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004941
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004942 - all three arguments must be integral
4943 - b must be nonnegative
4944 - at least one of a or b must be nonzero
4945 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004946
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004947 The result of pow(a, b, modulo) is identical to the result
4948 that would be obtained by computing (a**b) % modulo with
4949 unbounded precision, but is computed more efficiently. It is
4950 always exact.
4951
4952 >>> c = ExtendedContext.copy()
4953 >>> c.Emin = -999
4954 >>> c.Emax = 999
4955 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004956 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004957 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004958 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004959 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004960 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004961 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004962 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004963 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004964 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004965 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004966 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004967 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004968 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004969 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004970 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004971 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004972 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004973 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004974 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004975 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004976 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004977 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004978 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004979 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004980 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004981
4982 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004983 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004984 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004985 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004986 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004987 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004988 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004989 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004990 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004991 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004992 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004993 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004994 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004995 Decimal('1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004996 >>> ExtendedContext.power(7, 7)
4997 Decimal('823543')
4998 >>> ExtendedContext.power(Decimal(7), 7)
4999 Decimal('823543')
5000 >>> ExtendedContext.power(7, Decimal(7), 2)
5001 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005002 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005003 a = _convert_other(a, raiseit=True)
5004 r = a.__pow__(b, modulo, context=self)
5005 if r is NotImplemented:
5006 raise TypeError("Unable to convert %s to Decimal" % b)
5007 else:
5008 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005009
5010 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005011 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005012
5013 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00005014 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005015 exponent is being increased), multiplied by a positive power of ten (if
5016 the exponent is being decreased), or is unchanged (if the exponent is
5017 already equal to that of the right-hand operand).
5018
5019 Unlike other operations, if the length of the coefficient after the
5020 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00005021 operation condition is raised. This guarantees that, unless there is
5022 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005023 equal to that of the right-hand operand.
5024
5025 Also unlike other operations, quantize will never raise Underflow, even
5026 if the result is subnormal and inexact.
5027
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005028 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005029 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005030 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005031 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005032 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005033 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005034 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005035 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005036 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005037 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005038 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005039 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005040 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005041 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005042 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005043 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005044 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005045 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005046 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005047 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005048 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005049 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005050 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005051 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005052 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005053 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005054 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005055 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005056 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005057 Decimal('2E+2')
Mark Dickinson84230a12010-02-18 14:49:50 +00005058 >>> ExtendedContext.quantize(1, 2)
5059 Decimal('1')
5060 >>> ExtendedContext.quantize(Decimal(1), 2)
5061 Decimal('1')
5062 >>> ExtendedContext.quantize(1, Decimal(2))
5063 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005064 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005065 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005066 return a.quantize(b, context=self)
5067
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005068 def radix(self):
5069 """Just returns 10, as this is Decimal, :)
5070
5071 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005072 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005073 """
5074 return Decimal(10)
5075
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005076 def remainder(self, a, b):
5077 """Returns the remainder from integer division.
5078
5079 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00005080 calculating integer division as described for divide-integer, rounded
5081 to precision digits if necessary. The sign of the result, if
5082 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005083
5084 This operation will fail under the same conditions as integer division
5085 (that is, if integer division on the same two operands would fail, the
5086 remainder cannot be calculated).
5087
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005088 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005089 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005090 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005091 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005092 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005093 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005094 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005095 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005096 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005097 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005098 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005099 Decimal('1.0')
Mark Dickinson84230a12010-02-18 14:49:50 +00005100 >>> ExtendedContext.remainder(22, 6)
5101 Decimal('4')
5102 >>> ExtendedContext.remainder(Decimal(22), 6)
5103 Decimal('4')
5104 >>> ExtendedContext.remainder(22, Decimal(6))
5105 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005106 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005107 a = _convert_other(a, raiseit=True)
5108 r = a.__mod__(b, context=self)
5109 if r is NotImplemented:
5110 raise TypeError("Unable to convert %s to Decimal" % b)
5111 else:
5112 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005113
5114 def remainder_near(self, a, b):
5115 """Returns to be "a - b * n", where n is the integer nearest the exact
5116 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00005117 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005118 sign of a.
5119
5120 This operation will fail under the same conditions as integer division
5121 (that is, if integer division on the same two operands would fail, the
5122 remainder cannot be calculated).
5123
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005124 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005125 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005126 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005127 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005128 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005129 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005130 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005131 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005132 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005133 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005134 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005135 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005136 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005137 Decimal('-0.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005138 >>> ExtendedContext.remainder_near(3, 11)
5139 Decimal('3')
5140 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5141 Decimal('3')
5142 >>> ExtendedContext.remainder_near(3, Decimal(11))
5143 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005144 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005145 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005146 return a.remainder_near(b, context=self)
5147
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005148 def rotate(self, a, b):
5149 """Returns a rotated copy of a, b times.
5150
5151 The coefficient of the result is a rotated copy of the digits in
5152 the coefficient of the first operand. The number of places of
5153 rotation is taken from the absolute value of the second operand,
5154 with the rotation being to the left if the second operand is
5155 positive or to the right otherwise.
5156
5157 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005158 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005159 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005160 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005161 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005162 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005163 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005164 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005165 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005166 Decimal('345678912')
Mark Dickinson84230a12010-02-18 14:49:50 +00005167 >>> ExtendedContext.rotate(1333333, 1)
5168 Decimal('13333330')
5169 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5170 Decimal('13333330')
5171 >>> ExtendedContext.rotate(1333333, Decimal(1))
5172 Decimal('13333330')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005173 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005174 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005175 return a.rotate(b, context=self)
5176
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005177 def same_quantum(self, a, b):
5178 """Returns True if the two operands have the same exponent.
5179
5180 The result is never affected by either the sign or the coefficient of
5181 either operand.
5182
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005183 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005184 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005185 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005186 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005187 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005188 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005189 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005190 True
Mark Dickinson84230a12010-02-18 14:49:50 +00005191 >>> ExtendedContext.same_quantum(10000, -1)
5192 True
5193 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5194 True
5195 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5196 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005197 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005198 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005199 return a.same_quantum(b)
5200
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005201 def scaleb (self, a, b):
5202 """Returns the first operand after adding the second value its exp.
5203
5204 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005205 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005206 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005207 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005208 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005209 Decimal('7.50E+3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005210 >>> ExtendedContext.scaleb(1, 4)
5211 Decimal('1E+4')
5212 >>> ExtendedContext.scaleb(Decimal(1), 4)
5213 Decimal('1E+4')
5214 >>> ExtendedContext.scaleb(1, Decimal(4))
5215 Decimal('1E+4')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005216 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005217 a = _convert_other(a, raiseit=True)
5218 return a.scaleb(b, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005219
5220 def shift(self, a, b):
5221 """Returns a shifted copy of a, b times.
5222
5223 The coefficient of the result is a shifted copy of the digits
5224 in the coefficient of the first operand. The number of places
5225 to shift is taken from the absolute value of the second operand,
5226 with the shift being to the left if the second operand is
5227 positive or to the right otherwise. Digits shifted into the
5228 coefficient are zeros.
5229
5230 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005231 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005232 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005233 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005234 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005235 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005236 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005237 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005238 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005239 Decimal('345678900')
Mark Dickinson84230a12010-02-18 14:49:50 +00005240 >>> ExtendedContext.shift(88888888, 2)
5241 Decimal('888888800')
5242 >>> ExtendedContext.shift(Decimal(88888888), 2)
5243 Decimal('888888800')
5244 >>> ExtendedContext.shift(88888888, Decimal(2))
5245 Decimal('888888800')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005246 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005247 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005248 return a.shift(b, context=self)
5249
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005250 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005251 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005252
5253 If the result must be inexact, it is rounded using the round-half-even
5254 algorithm.
5255
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005256 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005257 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005258 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005259 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005260 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005261 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005262 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005263 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005264 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005265 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005266 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005267 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005268 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005269 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005270 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005271 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005272 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005273 Decimal('3.16227766')
Mark Dickinson84230a12010-02-18 14:49:50 +00005274 >>> ExtendedContext.sqrt(2)
5275 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005276 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005277 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005278 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005279 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005280 return a.sqrt(context=self)
5281
5282 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005283 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005284
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005285 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005286 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005287 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005288 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005289 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005290 Decimal('-0.77')
Mark Dickinson84230a12010-02-18 14:49:50 +00005291 >>> ExtendedContext.subtract(8, 5)
5292 Decimal('3')
5293 >>> ExtendedContext.subtract(Decimal(8), 5)
5294 Decimal('3')
5295 >>> ExtendedContext.subtract(8, Decimal(5))
5296 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005297 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005298 a = _convert_other(a, raiseit=True)
5299 r = a.__sub__(b, context=self)
5300 if r is NotImplemented:
5301 raise TypeError("Unable to convert %s to Decimal" % b)
5302 else:
5303 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005304
5305 def to_eng_string(self, a):
5306 """Converts a number to a string, using scientific notation.
5307
5308 The operation is not affected by the context.
5309 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005310 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005311 return a.to_eng_string(context=self)
5312
5313 def to_sci_string(self, a):
5314 """Converts a number to a string, using scientific notation.
5315
5316 The operation is not affected by the context.
5317 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005318 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005319 return a.__str__(context=self)
5320
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005321 def to_integral_exact(self, a):
5322 """Rounds to an integer.
5323
5324 When the operand has a negative exponent, the result is the same
5325 as using the quantize() operation using the given operand as the
5326 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5327 of the operand as the precision setting; Inexact and Rounded flags
5328 are allowed in this operation. The rounding mode is taken from the
5329 context.
5330
5331 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005332 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005333 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005334 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005335 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005336 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005337 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005338 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005339 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005340 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005341 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005342 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005343 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005344 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005345 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005346 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005347 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005348 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005349 return a.to_integral_exact(context=self)
5350
5351 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005352 """Rounds to an integer.
5353
5354 When the operand has a negative exponent, the result is the same
5355 as using the quantize() operation using the given operand as the
5356 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5357 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00005358 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005359
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005360 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005361 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005362 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005363 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005364 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005365 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005366 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005367 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005368 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005369 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005370 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005371 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005372 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005373 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005374 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005375 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005376 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005377 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005378 return a.to_integral_value(context=self)
5379
5380 # the method name changed, but we provide also the old one, for compatibility
5381 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005382
5383class _WorkRep(object):
5384 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005385 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005386 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005387 # exp: None, int, or string
5388
5389 def __init__(self, value=None):
5390 if value is None:
5391 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005392 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005393 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005394 elif isinstance(value, Decimal):
5395 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005396 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005397 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005398 else:
5399 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005400 self.sign = value[0]
5401 self.int = value[1]
5402 self.exp = value[2]
5403
5404 def __repr__(self):
5405 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5406
5407 __str__ = __repr__
5408
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005409
5410
Christian Heimes2c181612007-12-17 20:04:13 +00005411def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005412 """Normalizes op1, op2 to have the same exp and length of coefficient.
5413
5414 Done during addition.
5415 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005416 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005417 tmp = op2
5418 other = op1
5419 else:
5420 tmp = op1
5421 other = op2
5422
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005423 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5424 # Then adding 10**exp to tmp has the same effect (after rounding)
5425 # as adding any positive quantity smaller than 10**exp; similarly
5426 # for subtraction. So if other is smaller than 10**exp we replace
5427 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00005428 tmp_len = len(str(tmp.int))
5429 other_len = len(str(other.int))
5430 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5431 if other_len + other.exp - 1 < exp:
5432 other.int = 1
5433 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005434
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005435 tmp.int *= 10 ** (tmp.exp - other.exp)
5436 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005437 return op1, op2
5438
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005439##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005440
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005441# This function from Tim Peters was taken from here:
5442# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5443# The correction being in the function definition is for speed, and
5444# the whole function is not resolved with math.log because of avoiding
5445# the use of floats.
5446def _nbits(n, correction = {
5447 '0': 4, '1': 3, '2': 2, '3': 2,
5448 '4': 1, '5': 1, '6': 1, '7': 1,
5449 '8': 0, '9': 0, 'a': 0, 'b': 0,
5450 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5451 """Number of bits in binary representation of the positive integer n,
5452 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005453 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005454 if n < 0:
5455 raise ValueError("The argument to _nbits should be nonnegative.")
5456 hex_n = "%x" % n
5457 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005458
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005459def _sqrt_nearest(n, a):
5460 """Closest integer to the square root of the positive integer n. a is
5461 an initial approximation to the square root. Any positive integer
5462 will do for a, but the closer a is to the square root of n the
5463 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005464
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005465 """
5466 if n <= 0 or a <= 0:
5467 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5468
5469 b=0
5470 while a != b:
5471 b, a = a, a--n//a>>1
5472 return a
5473
5474def _rshift_nearest(x, shift):
5475 """Given an integer x and a nonnegative integer shift, return closest
5476 integer to x / 2**shift; use round-to-even in case of a tie.
5477
5478 """
5479 b, q = 1 << shift, x >> shift
5480 return q + (2*(x & (b-1)) + (q&1) > b)
5481
5482def _div_nearest(a, b):
5483 """Closest integer to a/b, a and b positive integers; rounds to even
5484 in the case of a tie.
5485
5486 """
5487 q, r = divmod(a, b)
5488 return q + (2*r + (q&1) > b)
5489
5490def _ilog(x, M, L = 8):
5491 """Integer approximation to M*log(x/M), with absolute error boundable
5492 in terms only of x/M.
5493
5494 Given positive integers x and M, return an integer approximation to
5495 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5496 between the approximation and the exact result is at most 22. For
5497 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5498 both cases these are upper bounds on the error; it will usually be
5499 much smaller."""
5500
5501 # The basic algorithm is the following: let log1p be the function
5502 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5503 # the reduction
5504 #
5505 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5506 #
5507 # repeatedly until the argument to log1p is small (< 2**-L in
5508 # absolute value). For small y we can use the Taylor series
5509 # expansion
5510 #
5511 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5512 #
5513 # truncating at T such that y**T is small enough. The whole
5514 # computation is carried out in a form of fixed-point arithmetic,
5515 # with a real number z being represented by an integer
5516 # approximation to z*M. To avoid loss of precision, the y below
5517 # is actually an integer approximation to 2**R*y*M, where R is the
5518 # number of reductions performed so far.
5519
5520 y = x-M
5521 # argument reduction; R = number of reductions performed
5522 R = 0
5523 while (R <= L and abs(y) << L-R >= M or
5524 R > L and abs(y) >> R-L >= M):
5525 y = _div_nearest((M*y) << 1,
5526 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5527 R += 1
5528
5529 # Taylor series with T terms
5530 T = -int(-10*len(str(M))//(3*L))
5531 yshift = _rshift_nearest(y, R)
5532 w = _div_nearest(M, T)
5533 for k in range(T-1, 0, -1):
5534 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5535
5536 return _div_nearest(w*y, M)
5537
5538def _dlog10(c, e, p):
5539 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5540 approximation to 10**p * log10(c*10**e), with an absolute error of
5541 at most 1. Assumes that c*10**e is not exactly 1."""
5542
5543 # increase precision by 2; compensate for this by dividing
5544 # final result by 100
5545 p += 2
5546
5547 # write c*10**e as d*10**f with either:
5548 # f >= 0 and 1 <= d <= 10, or
5549 # f <= 0 and 0.1 <= d <= 1.
5550 # Thus for c*10**e close to 1, f = 0
5551 l = len(str(c))
5552 f = e+l - (e+l >= 1)
5553
5554 if p > 0:
5555 M = 10**p
5556 k = e+p-f
5557 if k >= 0:
5558 c *= 10**k
5559 else:
5560 c = _div_nearest(c, 10**-k)
5561
5562 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005563 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005564 log_d = _div_nearest(log_d*M, log_10)
5565 log_tenpower = f*M # exact
5566 else:
5567 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005568 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005569
5570 return _div_nearest(log_tenpower+log_d, 100)
5571
5572def _dlog(c, e, p):
5573 """Given integers c, e and p with c > 0, compute an integer
5574 approximation to 10**p * log(c*10**e), with an absolute error of
5575 at most 1. Assumes that c*10**e is not exactly 1."""
5576
5577 # Increase precision by 2. The precision increase is compensated
5578 # for at the end with a division by 100.
5579 p += 2
5580
5581 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5582 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5583 # as 10**p * log(d) + 10**p*f * log(10).
5584 l = len(str(c))
5585 f = e+l - (e+l >= 1)
5586
5587 # compute approximation to 10**p*log(d), with error < 27
5588 if p > 0:
5589 k = e+p-f
5590 if k >= 0:
5591 c *= 10**k
5592 else:
5593 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5594
5595 # _ilog magnifies existing error in c by a factor of at most 10
5596 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5597 else:
5598 # p <= 0: just approximate the whole thing by 0; error < 2.31
5599 log_d = 0
5600
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005601 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005602 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005603 extra = len(str(abs(f)))-1
5604 if p + extra >= 0:
5605 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5606 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5607 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005608 else:
5609 f_log_ten = 0
5610 else:
5611 f_log_ten = 0
5612
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005613 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005614 return _div_nearest(f_log_ten + log_d, 100)
5615
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005616class _Log10Memoize(object):
5617 """Class to compute, store, and allow retrieval of, digits of the
5618 constant log(10) = 2.302585.... This constant is needed by
5619 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5620 def __init__(self):
5621 self.digits = "23025850929940456840179914546843642076011014886"
5622
5623 def getdigits(self, p):
5624 """Given an integer p >= 0, return floor(10**p)*log(10).
5625
5626 For example, self.getdigits(3) returns 2302.
5627 """
5628 # digits are stored as a string, for quick conversion to
5629 # integer in the case that we've already computed enough
5630 # digits; the stored digits should always be correct
5631 # (truncated, not rounded to nearest).
5632 if p < 0:
5633 raise ValueError("p should be nonnegative")
5634
5635 if p >= len(self.digits):
5636 # compute p+3, p+6, p+9, ... digits; continue until at
5637 # least one of the extra digits is nonzero
5638 extra = 3
5639 while True:
5640 # compute p+extra digits, correct to within 1ulp
5641 M = 10**(p+extra+2)
5642 digits = str(_div_nearest(_ilog(10*M, M), 100))
5643 if digits[-extra:] != '0'*extra:
5644 break
5645 extra += 3
5646 # keep all reliable digits so far; remove trailing zeros
5647 # and next nonzero digit
5648 self.digits = digits.rstrip('0')[:-1]
5649 return int(self.digits[:p+1])
5650
5651_log10_digits = _Log10Memoize().getdigits
5652
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005653def _iexp(x, M, L=8):
5654 """Given integers x and M, M > 0, such that x/M is small in absolute
5655 value, compute an integer approximation to M*exp(x/M). For 0 <=
5656 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5657 is usually much smaller)."""
5658
5659 # Algorithm: to compute exp(z) for a real number z, first divide z
5660 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5661 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5662 # series
5663 #
5664 # expm1(x) = x + x**2/2! + x**3/3! + ...
5665 #
5666 # Now use the identity
5667 #
5668 # expm1(2x) = expm1(x)*(expm1(x)+2)
5669 #
5670 # R times to compute the sequence expm1(z/2**R),
5671 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5672
5673 # Find R such that x/2**R/M <= 2**-L
5674 R = _nbits((x<<L)//M)
5675
5676 # Taylor series. (2**L)**T > M
5677 T = -int(-10*len(str(M))//(3*L))
5678 y = _div_nearest(x, T)
5679 Mshift = M<<R
5680 for i in range(T-1, 0, -1):
5681 y = _div_nearest(x*(Mshift + y), Mshift * i)
5682
5683 # Expansion
5684 for k in range(R-1, -1, -1):
5685 Mshift = M<<(k+2)
5686 y = _div_nearest(y*(y+Mshift), Mshift)
5687
5688 return M+y
5689
5690def _dexp(c, e, p):
5691 """Compute an approximation to exp(c*10**e), with p decimal places of
5692 precision.
5693
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005694 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005695
5696 10**(p-1) <= d <= 10**p, and
5697 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5698
5699 In other words, d*10**f is an approximation to exp(c*10**e) with p
5700 digits of precision, and with an error in d of at most 1. This is
5701 almost, but not quite, the same as the error being < 1ulp: when d
5702 = 10**(p-1) the error could be up to 10 ulp."""
5703
5704 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5705 p += 2
5706
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005707 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005708 extra = max(0, e + len(str(c)) - 1)
5709 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005710
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005711 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005712 # rounding down
5713 shift = e+q
5714 if shift >= 0:
5715 cshift = c*10**shift
5716 else:
5717 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005718 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005719
5720 # reduce remainder back to original precision
5721 rem = _div_nearest(rem, 10**extra)
5722
5723 # error in result of _iexp < 120; error after division < 0.62
5724 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5725
5726def _dpower(xc, xe, yc, ye, p):
5727 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5728 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5729
5730 10**(p-1) <= c <= 10**p, and
5731 (c-1)*10**e < x**y < (c+1)*10**e
5732
5733 in other words, c*10**e is an approximation to x**y with p digits
5734 of precision, and with an error in c of at most 1. (This is
5735 almost, but not quite, the same as the error being < 1ulp: when c
5736 == 10**(p-1) we can only guarantee error < 10ulp.)
5737
5738 We assume that: x is positive and not equal to 1, and y is nonzero.
5739 """
5740
5741 # Find b such that 10**(b-1) <= |y| <= 10**b
5742 b = len(str(abs(yc))) + ye
5743
5744 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5745 lxc = _dlog(xc, xe, p+b+1)
5746
5747 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5748 shift = ye-b
5749 if shift >= 0:
5750 pc = lxc*yc*10**shift
5751 else:
5752 pc = _div_nearest(lxc*yc, 10**-shift)
5753
5754 if pc == 0:
5755 # we prefer a result that isn't exactly 1; this makes it
5756 # easier to compute a correctly rounded result in __pow__
5757 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5758 coeff, exp = 10**(p-1)+1, 1-p
5759 else:
5760 coeff, exp = 10**p-1, -p
5761 else:
5762 coeff, exp = _dexp(pc, -(p+1), p+1)
5763 coeff = _div_nearest(coeff, 10)
5764 exp += 1
5765
5766 return coeff, exp
5767
5768def _log10_lb(c, correction = {
5769 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5770 '6': 23, '7': 16, '8': 10, '9': 5}):
5771 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5772 if c <= 0:
5773 raise ValueError("The argument to _log10_lb should be nonnegative.")
5774 str_c = str(c)
5775 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005776
Guido van Rossumd8faa362007-04-27 19:54:29 +00005777##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005778
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005779def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005780 """Convert other to Decimal.
5781
5782 Verifies that it's ok to use in an implicit construction.
5783 """
5784 if isinstance(other, Decimal):
5785 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005786 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005787 return Decimal(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005788 if raiseit:
5789 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005790 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005791
Guido van Rossumd8faa362007-04-27 19:54:29 +00005792##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005793
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005794# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005795# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005796
5797DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005798 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005799 traps=[DivisionByZero, Overflow, InvalidOperation],
5800 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005801 Emax=999999999,
5802 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005803 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005804)
5805
5806# Pre-made alternate contexts offered by the specification
5807# Don't change these; the user should be able to select these
5808# contexts and be able to reproduce results from other implementations
5809# of the spec.
5810
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005811BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005812 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005813 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5814 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005815)
5816
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005817ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005818 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005819 traps=[],
5820 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005821)
5822
5823
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005824##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005825#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005826# Regular expression used for parsing numeric strings. Additional
5827# comments:
5828#
5829# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5830# whitespace. But note that the specification disallows whitespace in
5831# a numeric string.
5832#
5833# 2. For finite numbers (not infinities and NaNs) the body of the
5834# number between the optional sign and the optional exponent must have
5835# at least one decimal digit, possibly after the decimal point. The
Mark Dickinson345adc42009-08-02 10:14:23 +00005836# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005837
5838import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005839_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005840# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005841 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005842 (
Mark Dickinson345adc42009-08-02 10:14:23 +00005843 (?=\d|\.\d) # ...a number (with at least one digit)
5844 (?P<int>\d*) # having a (possibly empty) integer part
5845 (\.(?P<frac>\d*))? # followed by an optional fractional part
5846 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005847 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005848 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005849 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005850 (?P<signal>s)? # ...an (optionally signaling)
5851 NaN # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +00005852 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005853 )
5854# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005855 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005856""", re.VERBOSE | re.IGNORECASE).match
5857
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005858_all_zeros = re.compile('0*$').match
5859_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005860
5861##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005862# The functions in this section have little to do with the Decimal
5863# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005864# Python numeric classes that want to implement __format__
5865#
5866# A format specifier for Decimal looks like:
5867#
Mark Dickinson79f52032009-03-17 23:12:51 +00005868# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005869
5870_parse_format_specifier_regex = re.compile(r"""\A
5871(?:
5872 (?P<fill>.)?
5873 (?P<align>[<>=^])
5874)?
5875(?P<sign>[-+ ])?
5876(?P<zeropad>0)?
5877(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00005878(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005879(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00005880(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005881\Z
5882""", re.VERBOSE)
5883
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005884del re
5885
Mark Dickinson79f52032009-03-17 23:12:51 +00005886# The locale module is only needed for the 'n' format specifier. The
5887# rest of the PEP 3101 code functions quite happily without it, so we
5888# don't care too much if locale isn't present.
5889try:
5890 import locale as _locale
5891except ImportError:
5892 pass
5893
5894def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00005895 """Parse and validate a format specifier.
5896
5897 Turns a standard numeric format specifier into a dict, with the
5898 following entries:
5899
5900 fill: fill character to pad field to minimum width
5901 align: alignment type, either '<', '>', '=' or '^'
5902 sign: either '+', '-' or ' '
5903 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00005904 zeropad: boolean, indicating whether to pad with zeros
5905 thousands_sep: string to use as thousands separator, or ''
5906 grouping: grouping for thousands separators, in format
5907 used by localeconv
5908 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00005909 precision: nonnegative integer giving precision, or None
5910 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00005911
5912 """
5913 m = _parse_format_specifier_regex.match(format_spec)
5914 if m is None:
5915 raise ValueError("Invalid format specifier: " + format_spec)
5916
5917 # get the dictionary
5918 format_dict = m.groupdict()
5919
Mark Dickinson79f52032009-03-17 23:12:51 +00005920 # zeropad; defaults for fill and alignment. If zero padding
5921 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00005922 fill = format_dict['fill']
5923 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00005924 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5925 if format_dict['zeropad']:
5926 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005927 raise ValueError("Fill character conflicts with '0'"
5928 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00005929 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005930 raise ValueError("Alignment conflicts with '0' in "
5931 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00005932 format_dict['fill'] = fill or ' '
Mark Dickinson46ab5d02009-09-08 20:22:46 +00005933 # PEP 3101 originally specified that the default alignment should
5934 # be left; it was later agreed that right-aligned makes more sense
5935 # for numeric types. See http://bugs.python.org/issue6857.
5936 format_dict['align'] = align or '>'
Christian Heimesf16baeb2008-02-29 14:57:44 +00005937
Mark Dickinson79f52032009-03-17 23:12:51 +00005938 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00005939 if format_dict['sign'] is None:
5940 format_dict['sign'] = '-'
5941
Christian Heimesf16baeb2008-02-29 14:57:44 +00005942 # minimumwidth defaults to 0; precision remains None if not given
5943 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5944 if format_dict['precision'] is not None:
5945 format_dict['precision'] = int(format_dict['precision'])
5946
5947 # if format type is 'g' or 'G' then a precision of 0 makes little
5948 # sense; convert it to 1. Same if format type is unspecified.
5949 if format_dict['precision'] == 0:
Mark Dickinson7718d2b2009-09-07 16:21:56 +00005950 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005951 format_dict['precision'] = 1
5952
Mark Dickinson79f52032009-03-17 23:12:51 +00005953 # determine thousands separator, grouping, and decimal separator, and
5954 # add appropriate entries to format_dict
5955 if format_dict['type'] == 'n':
5956 # apart from separators, 'n' behaves just like 'g'
5957 format_dict['type'] = 'g'
5958 if _localeconv is None:
5959 _localeconv = _locale.localeconv()
5960 if format_dict['thousands_sep'] is not None:
5961 raise ValueError("Explicit thousands separator conflicts with "
5962 "'n' type in format specifier: " + format_spec)
5963 format_dict['thousands_sep'] = _localeconv['thousands_sep']
5964 format_dict['grouping'] = _localeconv['grouping']
5965 format_dict['decimal_point'] = _localeconv['decimal_point']
5966 else:
5967 if format_dict['thousands_sep'] is None:
5968 format_dict['thousands_sep'] = ''
5969 format_dict['grouping'] = [3, 0]
5970 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00005971
5972 return format_dict
5973
Mark Dickinson79f52032009-03-17 23:12:51 +00005974def _format_align(sign, body, spec):
5975 """Given an unpadded, non-aligned numeric string 'body' and sign
5976 string 'sign', add padding and aligment conforming to the given
5977 format specifier dictionary 'spec' (as produced by
5978 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00005979
5980 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00005981 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00005982 minimumwidth = spec['minimumwidth']
5983 fill = spec['fill']
5984 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00005985
Mark Dickinson79f52032009-03-17 23:12:51 +00005986 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00005987 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005988 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00005989 elif align == '>':
5990 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00005991 elif align == '=':
5992 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00005993 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005994 half = len(padding)//2
5995 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00005996 else:
5997 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00005998
Christian Heimesf16baeb2008-02-29 14:57:44 +00005999 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00006000
Mark Dickinson79f52032009-03-17 23:12:51 +00006001def _group_lengths(grouping):
6002 """Convert a localeconv-style grouping into a (possibly infinite)
6003 iterable of integers representing group lengths.
6004
6005 """
6006 # The result from localeconv()['grouping'], and the input to this
6007 # function, should be a list of integers in one of the
6008 # following three forms:
6009 #
6010 # (1) an empty list, or
6011 # (2) nonempty list of positive integers + [0]
6012 # (3) list of positive integers + [locale.CHAR_MAX], or
6013
6014 from itertools import chain, repeat
6015 if not grouping:
6016 return []
6017 elif grouping[-1] == 0 and len(grouping) >= 2:
6018 return chain(grouping[:-1], repeat(grouping[-2]))
6019 elif grouping[-1] == _locale.CHAR_MAX:
6020 return grouping[:-1]
6021 else:
6022 raise ValueError('unrecognised format for grouping')
6023
6024def _insert_thousands_sep(digits, spec, min_width=1):
6025 """Insert thousands separators into a digit string.
6026
6027 spec is a dictionary whose keys should include 'thousands_sep' and
6028 'grouping'; typically it's the result of parsing the format
6029 specifier using _parse_format_specifier.
6030
6031 The min_width keyword argument gives the minimum length of the
6032 result, which will be padded on the left with zeros if necessary.
6033
6034 If necessary, the zero padding adds an extra '0' on the left to
6035 avoid a leading thousands separator. For example, inserting
6036 commas every three digits in '123456', with min_width=8, gives
6037 '0,123,456', even though that has length 9.
6038
6039 """
6040
6041 sep = spec['thousands_sep']
6042 grouping = spec['grouping']
6043
6044 groups = []
6045 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00006046 if l <= 0:
6047 raise ValueError("group length should be positive")
6048 # max(..., 1) forces at least 1 digit to the left of a separator
6049 l = min(max(len(digits), min_width, 1), l)
6050 groups.append('0'*(l - len(digits)) + digits[-l:])
6051 digits = digits[:-l]
6052 min_width -= l
6053 if not digits and min_width <= 0:
6054 break
Mark Dickinson7303b592009-03-18 08:25:36 +00006055 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00006056 else:
6057 l = max(len(digits), min_width, 1)
6058 groups.append('0'*(l - len(digits)) + digits[-l:])
6059 return sep.join(reversed(groups))
6060
6061def _format_sign(is_negative, spec):
6062 """Determine sign character."""
6063
6064 if is_negative:
6065 return '-'
6066 elif spec['sign'] in ' +':
6067 return spec['sign']
6068 else:
6069 return ''
6070
6071def _format_number(is_negative, intpart, fracpart, exp, spec):
6072 """Format a number, given the following data:
6073
6074 is_negative: true if the number is negative, else false
6075 intpart: string of digits that must appear before the decimal point
6076 fracpart: string of digits that must come after the point
6077 exp: exponent, as an integer
6078 spec: dictionary resulting from parsing the format specifier
6079
6080 This function uses the information in spec to:
6081 insert separators (decimal separator and thousands separators)
6082 format the sign
6083 format the exponent
6084 add trailing '%' for the '%' type
6085 zero-pad if necessary
6086 fill and align if necessary
6087 """
6088
6089 sign = _format_sign(is_negative, spec)
6090
6091 if fracpart:
6092 fracpart = spec['decimal_point'] + fracpart
6093
6094 if exp != 0 or spec['type'] in 'eE':
6095 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6096 fracpart += "{0}{1:+}".format(echar, exp)
6097 if spec['type'] == '%':
6098 fracpart += '%'
6099
6100 if spec['zeropad']:
6101 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6102 else:
6103 min_width = 0
6104 intpart = _insert_thousands_sep(intpart, spec, min_width)
6105
6106 return _format_align(sign, intpart+fracpart, spec)
6107
6108
Guido van Rossumd8faa362007-04-27 19:54:29 +00006109##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006110
Guido van Rossumd8faa362007-04-27 19:54:29 +00006111# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006112_Infinity = Decimal('Inf')
6113_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00006114_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006115_Zero = Decimal(0)
6116_One = Decimal(1)
6117_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006118
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006119# _SignedInfinity[sign] is infinity w/ that sign
6120_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006121
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006122
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006123
6124if __name__ == '__main__':
6125 import doctest, sys
6126 doctest.testmod(sys.modules[__name__])