blob: af29e68c2efcd92723632728cea491ab3836a33e [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
20 www2.hursley.ibm.com/decimal/decarith.html
21
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 Hettingereb260842005-06-07 18:52:34 +0000133import copy as _copy
Raymond Hettinger771ed762009-01-03 19:20:32 +0000134import math as _math
Raymond Hettinger82417ca2009-02-03 03:54:28 +0000135import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000136
Christian Heimes25bb7832008-01-11 16:17:00 +0000137try:
138 from collections import namedtuple as _namedtuple
139 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
140except ImportError:
141 DecimalTuple = lambda *args: args
142
Guido van Rossumd8faa362007-04-27 19:54:29 +0000143# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000144ROUND_DOWN = 'ROUND_DOWN'
145ROUND_HALF_UP = 'ROUND_HALF_UP'
146ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
147ROUND_CEILING = 'ROUND_CEILING'
148ROUND_FLOOR = 'ROUND_FLOOR'
149ROUND_UP = 'ROUND_UP'
150ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000151ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000152
Guido van Rossumd8faa362007-04-27 19:54:29 +0000153# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000154
155class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000156 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000157
158 Used exceptions derive from this.
159 If an exception derives from another exception besides this (such as
160 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
161 called if the others are present. This isn't actually used for
162 anything, though.
163
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000164 handle -- Called when context._raise_error is called and the
165 trap_enabler is set. First argument is self, second is the
166 context. More arguments can be given, those being after
167 the explanation in _raise_error (For example,
168 context._raise_error(NewError, '(-x)!', self._sign) would
169 call NewError().handle(context, self._sign).)
170
171 To define a new exception, it should be sufficient to have it derive
172 from DecimalException.
173 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000174 def handle(self, context, *args):
175 pass
176
177
178class Clamped(DecimalException):
179 """Exponent of a 0 changed to fit bounds.
180
181 This occurs and signals clamped if the exponent of a result has been
182 altered in order to fit the constraints of a specific concrete
Guido van Rossumd8faa362007-04-27 19:54:29 +0000183 representation. This may occur when the exponent of a zero result would
184 be outside the bounds of a representation, or when a large normal
185 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000186 this latter case, the exponent is reduced to fit and the corresponding
187 number of zero digits are appended to the coefficient ("fold-down").
188 """
189
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000190class InvalidOperation(DecimalException):
191 """An invalid operation was performed.
192
193 Various bad things cause this:
194
195 Something creates a signaling NaN
196 -INF + INF
Guido van Rossumd8faa362007-04-27 19:54:29 +0000197 0 * (+-)INF
198 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000199 x % 0
200 (+-)INF % x
201 x._rescale( non-integer )
202 sqrt(-x) , x > 0
203 0 ** 0
204 x ** (non-integer)
205 x ** (+-)INF
206 An operand is invalid
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000207
208 The result of the operation after these is a quiet positive NaN,
209 except when the cause is a signaling NaN, in which case the result is
210 also a quiet NaN, but with the original sign, and an optional
211 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000212 """
213 def handle(self, context, *args):
214 if args:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000215 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
216 return ans._fix_nan(context)
Mark Dickinsonf9236412009-01-02 23:23:21 +0000217 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000218
219class ConversionSyntax(InvalidOperation):
220 """Trying to convert badly formed string.
221
222 This occurs and signals invalid-operation if an string is being
223 converted to a number and it does not conform to the numeric string
Guido van Rossumd8faa362007-04-27 19:54:29 +0000224 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000225 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000226 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000227 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000228
229class DivisionByZero(DecimalException, ZeroDivisionError):
230 """Division by 0.
231
232 This occurs and signals division-by-zero if division of a finite number
233 by zero was attempted (during a divide-integer or divide operation, or a
234 power operation with negative right-hand operand), and the dividend was
235 not zero.
236
237 The result of the operation is [sign,inf], where sign is the exclusive
238 or of the signs of the operands for divide, or is 1 for an odd power of
239 -0, for power.
240 """
241
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000242 def handle(self, context, sign, *args):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000243 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000244
245class DivisionImpossible(InvalidOperation):
246 """Cannot perform the division adequately.
247
248 This occurs and signals invalid-operation if the integer result of a
249 divide-integer or remainder operation had too many digits (would be
Guido van Rossumd8faa362007-04-27 19:54:29 +0000250 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000251 """
252
253 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000254 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000255
256class DivisionUndefined(InvalidOperation, ZeroDivisionError):
257 """Undefined result of division.
258
259 This occurs and signals invalid-operation if division by zero was
260 attempted (during a divide-integer, divide, or remainder operation), and
Guido van Rossumd8faa362007-04-27 19:54:29 +0000261 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000262 """
263
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000264 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000265 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000266
267class Inexact(DecimalException):
268 """Had to round, losing information.
269
270 This occurs and signals inexact whenever the result of an operation is
271 not exact (that is, it needed to be rounded and any discarded digits
Guido van Rossumd8faa362007-04-27 19:54:29 +0000272 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000273 result in all cases is unchanged.
274
275 The inexact signal may be tested (or trapped) to determine if a given
276 operation (or sequence of operations) was inexact.
277 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000278
279class InvalidContext(InvalidOperation):
280 """Invalid context. Unknown rounding, for example.
281
282 This occurs and signals invalid-operation if an invalid context was
Guido van Rossumd8faa362007-04-27 19:54:29 +0000283 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000284 on creation and either the precision exceeds the capability of the
285 underlying concrete representation or an unknown or unsupported rounding
Guido van Rossumd8faa362007-04-27 19:54:29 +0000286 was specified. These aspects of the context need only be checked when
287 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000288 """
289
290 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000291 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000292
293class Rounded(DecimalException):
294 """Number got rounded (not necessarily changed during rounding).
295
296 This occurs and signals rounded whenever the result of an operation is
297 rounded (that is, some zero or non-zero digits were discarded from the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000298 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000299 result in all cases is unchanged.
300
301 The rounded signal may be tested (or trapped) to determine if a given
302 operation (or sequence of operations) caused a loss of precision.
303 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000304
305class Subnormal(DecimalException):
306 """Exponent < Emin before rounding.
307
308 This occurs and signals subnormal whenever the result of a conversion or
309 operation is subnormal (that is, its adjusted exponent is less than
Guido van Rossumd8faa362007-04-27 19:54:29 +0000310 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000311
312 The subnormal signal may be tested (or trapped) to determine if a given
313 or operation (or sequence of operations) yielded a subnormal result.
314 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000315
316class Overflow(Inexact, Rounded):
317 """Numerical overflow.
318
319 This occurs and signals overflow if the adjusted exponent of a result
320 (from a conversion or from an operation that is not an attempt to divide
321 by zero), after rounding, would be greater than the largest value that
322 can be handled by the implementation (the value Emax).
323
324 The result depends on the rounding mode:
325
326 For round-half-up and round-half-even (and for round-half-down and
327 round-up, if implemented), the result of the operation is [sign,inf],
Guido van Rossumd8faa362007-04-27 19:54:29 +0000328 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000329 result is the largest finite number that can be represented in the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000330 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000331 round-ceiling, the result is the same as for round-down if the sign of
Guido van Rossumd8faa362007-04-27 19:54:29 +0000332 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000333 the result is the same as for round-down if the sign of the intermediate
Guido van Rossumd8faa362007-04-27 19:54:29 +0000334 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000335 will also be raised.
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000336 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000337
338 def handle(self, context, sign, *args):
339 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000340 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000341 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000342 if sign == 0:
343 if context.rounding == ROUND_CEILING:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000344 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000345 return _dec_from_triple(sign, '9'*context.prec,
346 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000347 if sign == 1:
348 if context.rounding == ROUND_FLOOR:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000349 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000350 return _dec_from_triple(sign, '9'*context.prec,
351 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000352
353
354class Underflow(Inexact, Rounded, Subnormal):
355 """Numerical underflow with result rounded to 0.
356
357 This occurs and signals underflow if a result is inexact and the
358 adjusted exponent of the result would be smaller (more negative) than
359 the smallest value that can be handled by the implementation (the value
Guido van Rossumd8faa362007-04-27 19:54:29 +0000360 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000361
362 The result after an underflow will be a subnormal number rounded, if
Guido van Rossumd8faa362007-04-27 19:54:29 +0000363 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000364 in 0 with the sign of the intermediate result and an exponent of Etiny.
365
366 In all cases, Inexact, Rounded, and Subnormal will also be raised.
367 """
368
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000369# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000370_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000371 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000372
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000373# Map conditions (per the spec) to signals
374_condition_map = {ConversionSyntax:InvalidOperation,
375 DivisionImpossible:InvalidOperation,
376 DivisionUndefined:InvalidOperation,
377 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000378
Guido van Rossumd8faa362007-04-27 19:54:29 +0000379##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000380
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000381# The getcontext() and setcontext() function manage access to a thread-local
382# current context. Py2.4 offers direct support for thread locals. If that
Georg Brandlf9926402008-06-13 06:32:25 +0000383# is not available, use threading.current_thread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000384# work for older Pythons. If threads are not part of the build, create a
385# mock threading object with threading.local() returning the module namespace.
386
387try:
388 import threading
389except ImportError:
390 # Python was compiled without threads; create a mock object instead
391 import sys
Guido van Rossumd8faa362007-04-27 19:54:29 +0000392 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000393 def local(self, sys=sys):
394 return sys.modules[__name__]
395 threading = MockThreading()
396 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000397
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000398try:
399 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000400
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000401except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000402
Guido van Rossumd8faa362007-04-27 19:54:29 +0000403 # To fix reloading, force it to create a new context
404 # Old contexts have different exceptions in their dicts, making problems.
Georg Brandlf9926402008-06-13 06:32:25 +0000405 if hasattr(threading.current_thread(), '__decimal_context__'):
406 del threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000407
408 def setcontext(context):
409 """Set this thread's context to context."""
410 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000411 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000412 context.clear_flags()
Georg Brandlf9926402008-06-13 06:32:25 +0000413 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000414
415 def getcontext():
416 """Returns this thread's context.
417
418 If this thread does not yet have a context, returns
419 a new context and sets this thread's context.
420 New contexts are copies of DefaultContext.
421 """
422 try:
Georg Brandlf9926402008-06-13 06:32:25 +0000423 return threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000424 except AttributeError:
425 context = Context()
Georg Brandlf9926402008-06-13 06:32:25 +0000426 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000427 return context
428
429else:
430
431 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000432 if hasattr(local, '__decimal_context__'):
433 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000434
435 def getcontext(_local=local):
436 """Returns this thread's context.
437
438 If this thread does not yet have a context, returns
439 a new context and sets this thread's context.
440 New contexts are copies of DefaultContext.
441 """
442 try:
443 return _local.__decimal_context__
444 except AttributeError:
445 context = Context()
446 _local.__decimal_context__ = context
447 return context
448
449 def setcontext(context, _local=local):
450 """Set this thread's context to context."""
451 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000452 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000453 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000454 _local.__decimal_context__ = context
455
456 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000457
Thomas Wouters89f507f2006-12-13 04:49:30 +0000458def localcontext(ctx=None):
459 """Return a context manager for a copy of the supplied context
460
461 Uses a copy of the current context if no context is specified
462 The returned context manager creates a local decimal context
463 in a with statement:
464 def sin(x):
465 with localcontext() as ctx:
466 ctx.prec += 2
467 # Rest of sin calculation algorithm
468 # uses a precision 2 greater than normal
Guido van Rossumd8faa362007-04-27 19:54:29 +0000469 return +s # Convert result to normal precision
Thomas Wouters89f507f2006-12-13 04:49:30 +0000470
471 def sin(x):
472 with localcontext(ExtendedContext):
473 # Rest of sin calculation algorithm
474 # uses the Extended Context from the
475 # General Decimal Arithmetic Specification
Guido van Rossumd8faa362007-04-27 19:54:29 +0000476 return +s # Convert result to normal context
Thomas Wouters89f507f2006-12-13 04:49:30 +0000477
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000478 >>> setcontext(DefaultContext)
Guido van Rossum7131f842007-02-09 20:13:25 +0000479 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000480 28
481 >>> with localcontext():
482 ... ctx = getcontext()
Thomas Wouterscf297e42007-02-23 15:07:44 +0000483 ... ctx.prec += 2
Guido van Rossum7131f842007-02-09 20:13:25 +0000484 ... print(ctx.prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000485 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000486 30
487 >>> with localcontext(ExtendedContext):
Guido van Rossum7131f842007-02-09 20:13:25 +0000488 ... print(getcontext().prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000489 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000490 9
Guido van Rossum7131f842007-02-09 20:13:25 +0000491 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000492 28
493 """
494 if ctx is None: ctx = getcontext()
495 return _ContextManager(ctx)
496
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000497
Guido van Rossumd8faa362007-04-27 19:54:29 +0000498##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000499
Raymond Hettingera0fd8882009-01-20 07:24:44 +0000500# Do not subclass Decimal from numbers.Real and do not register it as such
501# (because Decimals are not interoperable with floats). See the notes in
502# numbers.py for more detail.
503
504class Decimal(object):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000505 """Floating point class for decimal arithmetic."""
506
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000507 __slots__ = ('_exp','_int','_sign', '_is_special')
508 # Generally, the value of the Decimal instance is given by
509 # (-1)**_sign * _int * 10**_exp
510 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000511
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000512 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000513 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000514 """Create a decimal point instance.
515
516 >>> Decimal('3.14') # string input
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000517 Decimal('3.14')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000518 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000519 Decimal('3.14')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000520 >>> Decimal(314) # int
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000521 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000522 >>> Decimal(Decimal(314)) # another decimal instance
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000523 Decimal('314')
Christian Heimesa62da1d2008-01-12 19:39:10 +0000524 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000525 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000526 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000527
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000528 # Note that the coefficient, self._int, is actually stored as
529 # a string rather than as a tuple of digits. This speeds up
530 # the "digits to integer" and "integer to digits" conversions
531 # that are used in almost every arithmetic operation on
532 # Decimals. This is an internal detail: the as_tuple function
533 # and the Decimal constructor still deal with tuples of
534 # digits.
535
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000536 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000537
Christian Heimesd59c64c2007-11-30 19:27:20 +0000538 # From a string
539 # REs insist on real strings, so we can too.
540 if isinstance(value, str):
Christian Heimesa62da1d2008-01-12 19:39:10 +0000541 m = _parser(value.strip())
Christian Heimesd59c64c2007-11-30 19:27:20 +0000542 if m is None:
543 if context is None:
544 context = getcontext()
545 return context._raise_error(ConversionSyntax,
546 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000547
Christian Heimesd59c64c2007-11-30 19:27:20 +0000548 if m.group('sign') == "-":
549 self._sign = 1
550 else:
551 self._sign = 0
552 intpart = m.group('int')
553 if intpart is not None:
554 # finite number
555 fracpart = m.group('frac')
556 exp = int(m.group('exp') or '0')
557 if fracpart is not None:
558 self._int = (intpart+fracpart).lstrip('0') or '0'
559 self._exp = exp - len(fracpart)
560 else:
561 self._int = intpart.lstrip('0') or '0'
562 self._exp = exp
563 self._is_special = False
564 else:
565 diag = m.group('diag')
566 if diag is not None:
567 # NaN
568 self._int = diag.lstrip('0')
569 if m.group('signal'):
570 self._exp = 'N'
571 else:
572 self._exp = 'n'
573 else:
574 # infinity
575 self._int = '0'
576 self._exp = 'F'
577 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000578 return self
579
580 # From an integer
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000581 if isinstance(value, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000582 if value >= 0:
583 self._sign = 0
584 else:
585 self._sign = 1
586 self._exp = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000587 self._int = str(abs(value))
Christian Heimesd59c64c2007-11-30 19:27:20 +0000588 self._is_special = False
589 return self
590
591 # From another decimal
592 if isinstance(value, Decimal):
593 self._exp = value._exp
594 self._sign = value._sign
595 self._int = value._int
596 self._is_special = value._is_special
597 return self
598
599 # From an internal working value
600 if isinstance(value, _WorkRep):
601 self._sign = value.sign
602 self._int = str(value.int)
603 self._exp = int(value.exp)
604 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000605 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000606
607 # tuple/list conversion (possibly from as_tuple())
608 if isinstance(value, (list,tuple)):
609 if len(value) != 3:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000610 raise ValueError('Invalid tuple size in creation of Decimal '
611 'from list or tuple. The list or tuple '
612 'should have exactly three elements.')
613 # process sign. The isinstance test rejects floats
614 if not (isinstance(value[0], int) and value[0] in (0,1)):
615 raise ValueError("Invalid sign. The first value in the tuple "
616 "should be an integer; either 0 for a "
617 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000618 self._sign = value[0]
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000619 if value[2] == 'F':
620 # infinity: value[1] is ignored
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000621 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000622 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000623 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000624 else:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000625 # process and validate the digits in value[1]
626 digits = []
627 for digit in value[1]:
628 if isinstance(digit, int) and 0 <= digit <= 9:
629 # skip leading zeros
630 if digits or digit != 0:
631 digits.append(digit)
632 else:
633 raise ValueError("The second value in the tuple must "
634 "be composed of integers in the range "
635 "0 through 9.")
636 if value[2] in ('n', 'N'):
637 # NaN: digits form the diagnostic
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000638 self._int = ''.join(map(str, digits))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000639 self._exp = value[2]
640 self._is_special = True
641 elif isinstance(value[2], int):
642 # finite number: digits give the coefficient
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000643 self._int = ''.join(map(str, digits or [0]))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000644 self._exp = value[2]
645 self._is_special = False
646 else:
647 raise ValueError("The third value in the tuple must "
648 "be an integer, or one of the "
649 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000650 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000651
Raymond Hettingerbf440692004-07-10 14:14:37 +0000652 if isinstance(value, float):
653 raise TypeError("Cannot convert float to Decimal. " +
654 "First convert the float to a string")
655
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000656 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000657
Mark Dickinsonba298e42009-01-04 21:17:43 +0000658 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
659 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000660 def from_float(cls, f):
661 """Converts a float to a decimal number, exactly.
662
663 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
664 Since 0.1 is not exactly representable in binary floating point, the
665 value is stored as the nearest representable value which is
666 0x1.999999999999ap-4. The exact equivalent of the value in decimal
667 is 0.1000000000000000055511151231257827021181583404541015625.
668
669 >>> Decimal.from_float(0.1)
670 Decimal('0.1000000000000000055511151231257827021181583404541015625')
671 >>> Decimal.from_float(float('nan'))
672 Decimal('NaN')
673 >>> Decimal.from_float(float('inf'))
674 Decimal('Infinity')
675 >>> Decimal.from_float(-float('inf'))
676 Decimal('-Infinity')
677 >>> Decimal.from_float(-0.0)
678 Decimal('-0')
679
680 """
681 if isinstance(f, int): # handle integer inputs
682 return cls(f)
683 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
684 return cls(repr(f))
Mark Dickinsonba298e42009-01-04 21:17:43 +0000685 if _math.copysign(1.0, f) == 1.0:
686 sign = 0
687 else:
688 sign = 1
Raymond Hettinger771ed762009-01-03 19:20:32 +0000689 n, d = abs(f).as_integer_ratio()
690 k = d.bit_length() - 1
691 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinsonba298e42009-01-04 21:17:43 +0000692 if cls is Decimal:
693 return result
694 else:
695 return cls(result)
696 from_float = classmethod(from_float)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000697
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000698 def _isnan(self):
699 """Returns whether the number is not actually one.
700
701 0 if a number
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000702 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000703 2 if sNaN
704 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000705 if self._is_special:
706 exp = self._exp
707 if exp == 'n':
708 return 1
709 elif exp == 'N':
710 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000711 return 0
712
713 def _isinfinity(self):
714 """Returns whether the number is infinite
715
716 0 if finite or not a number
717 1 if +INF
718 -1 if -INF
719 """
720 if self._exp == 'F':
721 if self._sign:
722 return -1
723 return 1
724 return 0
725
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000726 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000727 """Returns whether the number is not actually one.
728
729 if self, other are sNaN, signal
730 if self, other are NaN return nan
731 return 0
732
733 Done before operations.
734 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000735
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000736 self_is_nan = self._isnan()
737 if other is None:
738 other_is_nan = False
739 else:
740 other_is_nan = other._isnan()
741
742 if self_is_nan or other_is_nan:
743 if context is None:
744 context = getcontext()
745
746 if self_is_nan == 2:
747 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000748 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000749 if other_is_nan == 2:
750 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000751 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000752 if self_is_nan:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000753 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000754
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000755 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000756 return 0
757
Christian Heimes77c02eb2008-02-09 02:18:51 +0000758 def _compare_check_nans(self, other, context):
759 """Version of _check_nans used for the signaling comparisons
760 compare_signal, __le__, __lt__, __ge__, __gt__.
761
762 Signal InvalidOperation if either self or other is a (quiet
763 or signaling) NaN. Signaling NaNs take precedence over quiet
764 NaNs.
765
766 Return 0 if neither operand is a NaN.
767
768 """
769 if context is None:
770 context = getcontext()
771
772 if self._is_special or other._is_special:
773 if self.is_snan():
774 return context._raise_error(InvalidOperation,
775 'comparison involving sNaN',
776 self)
777 elif other.is_snan():
778 return context._raise_error(InvalidOperation,
779 'comparison involving sNaN',
780 other)
781 elif self.is_qnan():
782 return context._raise_error(InvalidOperation,
783 'comparison involving NaN',
784 self)
785 elif other.is_qnan():
786 return context._raise_error(InvalidOperation,
787 'comparison involving NaN',
788 other)
789 return 0
790
Jack Diederich4dafcc42006-11-28 19:15:13 +0000791 def __bool__(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000792 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000793
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000794 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000795 """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000796 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000797
Christian Heimes77c02eb2008-02-09 02:18:51 +0000798 def _cmp(self, other):
799 """Compare the two non-NaN decimal instances self and other.
800
801 Returns -1 if self < other, 0 if self == other and 1
802 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000803
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000804 if self._is_special or other._is_special:
Mark Dickinsone6aad752009-01-25 10:48:51 +0000805 self_inf = self._isinfinity()
806 other_inf = other._isinfinity()
807 if self_inf == other_inf:
808 return 0
809 elif self_inf < other_inf:
810 return -1
811 else:
812 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000813
Mark Dickinsone6aad752009-01-25 10:48:51 +0000814 # check for zeros; Decimal('0') == Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000815 if not self:
816 if not other:
817 return 0
818 else:
819 return -((-1)**other._sign)
820 if not other:
821 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000822
Guido van Rossumd8faa362007-04-27 19:54:29 +0000823 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000824 if other._sign < self._sign:
825 return -1
826 if self._sign < other._sign:
827 return 1
828
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000829 self_adjusted = self.adjusted()
830 other_adjusted = other.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000831 if self_adjusted == other_adjusted:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000832 self_padded = self._int + '0'*(self._exp - other._exp)
833 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone6aad752009-01-25 10:48:51 +0000834 if self_padded == other_padded:
835 return 0
836 elif self_padded < other_padded:
837 return -(-1)**self._sign
838 else:
839 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000840 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000841 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000842 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000843 return -((-1)**self._sign)
844
Christian Heimes77c02eb2008-02-09 02:18:51 +0000845 # Note: The Decimal standard doesn't cover rich comparisons for
846 # Decimals. In particular, the specification is silent on the
847 # subject of what should happen for a comparison involving a NaN.
848 # We take the following approach:
849 #
850 # == comparisons involving a NaN always return False
851 # != comparisons involving a NaN always return True
852 # <, >, <= and >= comparisons involving a (quiet or signaling)
853 # NaN signal InvalidOperation, and return False if the
Christian Heimes3feef612008-02-11 06:19:17 +0000854 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000855 #
856 # This behavior is designed to conform as closely as possible to
857 # that specified by IEEE 754.
858
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000859 def __eq__(self, other):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000860 other = _convert_other(other)
861 if other is NotImplemented:
862 return other
863 if self.is_nan() or other.is_nan():
864 return False
865 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000866
867 def __ne__(self, other):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000868 other = _convert_other(other)
869 if other is NotImplemented:
870 return other
871 if self.is_nan() or other.is_nan():
872 return True
873 return self._cmp(other) != 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000874
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000875
Christian Heimes77c02eb2008-02-09 02:18:51 +0000876 def __lt__(self, other, context=None):
877 other = _convert_other(other)
878 if other is NotImplemented:
879 return other
880 ans = self._compare_check_nans(other, context)
881 if ans:
882 return False
883 return self._cmp(other) < 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000884
Christian Heimes77c02eb2008-02-09 02:18:51 +0000885 def __le__(self, other, context=None):
886 other = _convert_other(other)
887 if other is NotImplemented:
888 return other
889 ans = self._compare_check_nans(other, context)
890 if ans:
891 return False
892 return self._cmp(other) <= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000893
Christian Heimes77c02eb2008-02-09 02:18:51 +0000894 def __gt__(self, other, context=None):
895 other = _convert_other(other)
896 if other is NotImplemented:
897 return other
898 ans = self._compare_check_nans(other, context)
899 if ans:
900 return False
901 return self._cmp(other) > 0
902
903 def __ge__(self, other, context=None):
904 other = _convert_other(other)
905 if other is NotImplemented:
906 return other
907 ans = self._compare_check_nans(other, context)
908 if ans:
909 return False
910 return self._cmp(other) >= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000911
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000912 def compare(self, other, context=None):
913 """Compares one to another.
914
915 -1 => a < b
916 0 => a = b
917 1 => a > b
918 NaN => one is NaN
919 Like __cmp__, but returns Decimal instances.
920 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000921 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000922
Guido van Rossumd8faa362007-04-27 19:54:29 +0000923 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000924 if (self._is_special or other and other._is_special):
925 ans = self._check_nans(other, context)
926 if ans:
927 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000928
Christian Heimes77c02eb2008-02-09 02:18:51 +0000929 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000930
931 def __hash__(self):
932 """x.__hash__() <==> hash(x)"""
933 # Decimal integers must hash the same as the ints
Christian Heimes2380ac72008-01-09 00:17:24 +0000934 #
935 # The hash of a nonspecial noninteger Decimal must depend only
936 # on the value of that Decimal, and not on its representation.
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000937 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000938 if self._is_special:
939 if self._isnan():
940 raise TypeError('Cannot hash a NaN value.')
941 return hash(str(self))
Thomas Wouters8ce81f72007-09-20 18:22:40 +0000942 if not self:
943 return 0
944 if self._isinteger():
945 op = _WorkRep(self.to_integral_value())
946 # to make computation feasible for Decimals with large
947 # exponent, we use the fact that hash(n) == hash(m) for
948 # any two nonzero integers n and m such that (i) n and m
949 # have the same sign, and (ii) n is congruent to m modulo
950 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
951 # hash((-1)**s*c*pow(10, e, 2**64-1).
952 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Christian Heimes2380ac72008-01-09 00:17:24 +0000953 # The value of a nonzero nonspecial Decimal instance is
954 # faithfully represented by the triple consisting of its sign,
955 # its adjusted exponent, and its coefficient with trailing
956 # zeros removed.
957 return hash((self._sign,
958 self._exp+len(self._int),
959 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000960
961 def as_tuple(self):
962 """Represents the number as a triple tuple.
963
964 To show the internals exactly as they are.
965 """
Christian Heimes25bb7832008-01-11 16:17:00 +0000966 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000967
968 def __repr__(self):
969 """Represents the number as an instance of Decimal."""
970 # Invariant: eval(repr(d)) == d
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000971 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000972
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000973 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000974 """Return string representation of the number in scientific notation.
975
976 Captures all of the information in the underlying representation.
977 """
978
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000979 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000980 if self._is_special:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000981 if self._exp == 'F':
982 return sign + 'Infinity'
983 elif self._exp == 'n':
984 return sign + 'NaN' + self._int
985 else: # self._exp == 'N'
986 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000987
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000988 # number of digits of self._int to left of decimal point
989 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000990
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000991 # dotplace is number of digits of self._int to the left of the
992 # decimal point in the mantissa of the output string (that is,
993 # after adjusting the exponent)
994 if self._exp <= 0 and leftdigits > -6:
995 # no exponent required
996 dotplace = leftdigits
997 elif not eng:
998 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000999 dotplace = 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001000 elif self._int == '0':
1001 # engineering notation, zero
1002 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001003 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001004 # engineering notation, nonzero
1005 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001006
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001007 if dotplace <= 0:
1008 intpart = '0'
1009 fracpart = '.' + '0'*(-dotplace) + self._int
1010 elif dotplace >= len(self._int):
1011 intpart = self._int+'0'*(dotplace-len(self._int))
1012 fracpart = ''
1013 else:
1014 intpart = self._int[:dotplace]
1015 fracpart = '.' + self._int[dotplace:]
1016 if leftdigits == dotplace:
1017 exp = ''
1018 else:
1019 if context is None:
1020 context = getcontext()
1021 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1022
1023 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001024
1025 def to_eng_string(self, context=None):
1026 """Convert to engineering-type string.
1027
1028 Engineering notation has an exponent which is a multiple of 3, so there
1029 are up to 3 digits left of the decimal place.
1030
1031 Same rules for when in exponential and when as a value as in __str__.
1032 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001033 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001034
1035 def __neg__(self, context=None):
1036 """Returns a copy with the sign switched.
1037
1038 Rounds, if it has reason.
1039 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001040 if self._is_special:
1041 ans = self._check_nans(context=context)
1042 if ans:
1043 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001044
1045 if not self:
1046 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001047 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001048 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001049 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001050
1051 if context is None:
1052 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001053 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001054
1055 def __pos__(self, context=None):
1056 """Returns a copy, unless it is a sNaN.
1057
1058 Rounds the number (if more then precision digits)
1059 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001060 if self._is_special:
1061 ans = self._check_nans(context=context)
1062 if ans:
1063 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001064
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001065 if not self:
1066 # + (-0) = 0
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001067 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001068 else:
1069 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001070
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001071 if context is None:
1072 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001073 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001074
Christian Heimes2c181612007-12-17 20:04:13 +00001075 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001076 """Returns the absolute value of self.
1077
Christian Heimes2c181612007-12-17 20:04:13 +00001078 If the keyword argument 'round' is false, do not round. The
1079 expression self.__abs__(round=False) is equivalent to
1080 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001081 """
Christian Heimes2c181612007-12-17 20:04:13 +00001082 if not round:
1083 return self.copy_abs()
1084
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001085 if self._is_special:
1086 ans = self._check_nans(context=context)
1087 if ans:
1088 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001089
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001090 if self._sign:
1091 ans = self.__neg__(context=context)
1092 else:
1093 ans = self.__pos__(context=context)
1094
1095 return ans
1096
1097 def __add__(self, other, context=None):
1098 """Returns self + other.
1099
1100 -INF + INF (or the reverse) cause InvalidOperation errors.
1101 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001102 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001103 if other is NotImplemented:
1104 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001105
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001106 if context is None:
1107 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001108
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001109 if self._is_special or other._is_special:
1110 ans = self._check_nans(other, context)
1111 if ans:
1112 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001113
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001114 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001115 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001116 if self._sign != other._sign and other._isinfinity():
1117 return context._raise_error(InvalidOperation, '-INF + INF')
1118 return Decimal(self)
1119 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001120 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001121
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001122 exp = min(self._exp, other._exp)
1123 negativezero = 0
1124 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001125 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001126 negativezero = 1
1127
1128 if not self and not other:
1129 sign = min(self._sign, other._sign)
1130 if negativezero:
1131 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001132 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001133 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001134 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001135 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001136 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001137 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001138 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001139 return ans
1140 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001141 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001142 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001143 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001144 return ans
1145
1146 op1 = _WorkRep(self)
1147 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001148 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149
1150 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001151 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001152 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001153 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001154 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001155 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001156 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001157 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001158 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001159 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001160 if op1.sign == 1:
1161 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001162 op1.sign, op2.sign = op2.sign, op1.sign
1163 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001164 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001165 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001166 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001167 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001168 op1.sign, op2.sign = (0, 0)
1169 else:
1170 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001171 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001172
Raymond Hettinger17931de2004-10-27 06:21:46 +00001173 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001174 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001175 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001176 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001177
1178 result.exp = op1.exp
1179 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001180 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001181 return ans
1182
1183 __radd__ = __add__
1184
1185 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001186 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001187 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001188 if other is NotImplemented:
1189 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001190
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001191 if self._is_special or other._is_special:
1192 ans = self._check_nans(other, context=context)
1193 if ans:
1194 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001195
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001196 # self - other is computed as self + other.copy_negate()
1197 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001198
1199 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001200 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001201 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001202 if other is NotImplemented:
1203 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001205 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001206
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001207 def __mul__(self, other, context=None):
1208 """Return self * other.
1209
1210 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1211 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001212 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001213 if other is NotImplemented:
1214 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001215
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001216 if context is None:
1217 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001218
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001219 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001220
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001221 if self._is_special or other._is_special:
1222 ans = self._check_nans(other, context)
1223 if ans:
1224 return ans
1225
1226 if self._isinfinity():
1227 if not other:
1228 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001229 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001230
1231 if other._isinfinity():
1232 if not self:
1233 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001234 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235
1236 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001237
1238 # Special case for multiplying by zero
1239 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001240 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001241 # Fixing in case the exponent is out of bounds
1242 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001243 return ans
1244
1245 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001246 if self._int == '1':
1247 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001248 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001249 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001250 if other._int == '1':
1251 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001252 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001253 return ans
1254
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001255 op1 = _WorkRep(self)
1256 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001257
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001258 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001259 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001260
1261 return ans
1262 __rmul__ = __mul__
1263
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001264 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001265 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001266 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001267 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001268 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001269
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001270 if context is None:
1271 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001272
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001273 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001274
1275 if self._is_special or other._is_special:
1276 ans = self._check_nans(other, context)
1277 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001278 return ans
1279
1280 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001281 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001282
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001283 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001284 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001285
1286 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001287 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001288 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001289
1290 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001291 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001292 if not self:
1293 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001294 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001295
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001296 if not self:
1297 exp = self._exp - other._exp
1298 coeff = 0
1299 else:
1300 # OK, so neither = 0, INF or NaN
1301 shift = len(other._int) - len(self._int) + context.prec + 1
1302 exp = self._exp - other._exp - shift
1303 op1 = _WorkRep(self)
1304 op2 = _WorkRep(other)
1305 if shift >= 0:
1306 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1307 else:
1308 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1309 if remainder:
1310 # result is not exact; adjust to ensure correct rounding
1311 if coeff % 5 == 0:
1312 coeff += 1
1313 else:
1314 # result is exact; get as close to ideal exponent as possible
1315 ideal_exp = self._exp - other._exp
1316 while exp < ideal_exp and coeff % 10 == 0:
1317 coeff //= 10
1318 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001319
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001320 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001321 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001322
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001323 def _divide(self, other, context):
1324 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001325
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001326 Assumes that neither self nor other is a NaN, that self is not
1327 infinite and that other is nonzero.
1328 """
1329 sign = self._sign ^ other._sign
1330 if other._isinfinity():
1331 ideal_exp = self._exp
1332 else:
1333 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001334
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001335 expdiff = self.adjusted() - other.adjusted()
1336 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001337 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001338 self._rescale(ideal_exp, context.rounding))
1339 if expdiff <= context.prec:
1340 op1 = _WorkRep(self)
1341 op2 = _WorkRep(other)
1342 if op1.exp >= op2.exp:
1343 op1.int *= 10**(op1.exp - op2.exp)
1344 else:
1345 op2.int *= 10**(op2.exp - op1.exp)
1346 q, r = divmod(op1.int, op2.int)
1347 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001348 return (_dec_from_triple(sign, str(q), 0),
1349 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001350
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001351 # Here the quotient is too large to be representable
1352 ans = context._raise_error(DivisionImpossible,
1353 'quotient too large in //, % or divmod')
1354 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001355
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001356 def __rtruediv__(self, other, context=None):
1357 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001358 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001359 if other is NotImplemented:
1360 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001361 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001362
1363 def __divmod__(self, other, context=None):
1364 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001365 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001366 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001367 other = _convert_other(other)
1368 if other is NotImplemented:
1369 return other
1370
1371 if context is None:
1372 context = getcontext()
1373
1374 ans = self._check_nans(other, context)
1375 if ans:
1376 return (ans, ans)
1377
1378 sign = self._sign ^ other._sign
1379 if self._isinfinity():
1380 if other._isinfinity():
1381 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1382 return ans, ans
1383 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001384 return (_SignedInfinity[sign],
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001385 context._raise_error(InvalidOperation, 'INF % x'))
1386
1387 if not other:
1388 if not self:
1389 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1390 return ans, ans
1391 else:
1392 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1393 context._raise_error(InvalidOperation, 'x % 0'))
1394
1395 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001396 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001397 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001398
1399 def __rdivmod__(self, other, context=None):
1400 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001401 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001402 if other is NotImplemented:
1403 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001404 return other.__divmod__(self, context=context)
1405
1406 def __mod__(self, other, context=None):
1407 """
1408 self % other
1409 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001410 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001411 if other is NotImplemented:
1412 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001413
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001414 if context is None:
1415 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001416
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001417 ans = self._check_nans(other, context)
1418 if ans:
1419 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001420
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001421 if self._isinfinity():
1422 return context._raise_error(InvalidOperation, 'INF % x')
1423 elif not other:
1424 if self:
1425 return context._raise_error(InvalidOperation, 'x % 0')
1426 else:
1427 return context._raise_error(DivisionUndefined, '0 % 0')
1428
1429 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001430 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001431 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001432
1433 def __rmod__(self, other, context=None):
1434 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001435 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001436 if other is NotImplemented:
1437 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001438 return other.__mod__(self, context=context)
1439
1440 def remainder_near(self, other, context=None):
1441 """
1442 Remainder nearest to 0- abs(remainder-near) <= other/2
1443 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001444 if context is None:
1445 context = getcontext()
1446
1447 other = _convert_other(other, raiseit=True)
1448
1449 ans = self._check_nans(other, context)
1450 if ans:
1451 return ans
1452
1453 # self == +/-infinity -> InvalidOperation
1454 if self._isinfinity():
1455 return context._raise_error(InvalidOperation,
1456 'remainder_near(infinity, x)')
1457
1458 # other == 0 -> either InvalidOperation or DivisionUndefined
1459 if not other:
1460 if self:
1461 return context._raise_error(InvalidOperation,
1462 'remainder_near(x, 0)')
1463 else:
1464 return context._raise_error(DivisionUndefined,
1465 'remainder_near(0, 0)')
1466
1467 # other = +/-infinity -> remainder = self
1468 if other._isinfinity():
1469 ans = Decimal(self)
1470 return ans._fix(context)
1471
1472 # self = 0 -> remainder = self, with ideal exponent
1473 ideal_exponent = min(self._exp, other._exp)
1474 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001475 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001476 return ans._fix(context)
1477
1478 # catch most cases of large or small quotient
1479 expdiff = self.adjusted() - other.adjusted()
1480 if expdiff >= context.prec + 1:
1481 # expdiff >= prec+1 => abs(self/other) > 10**prec
1482 return context._raise_error(DivisionImpossible)
1483 if expdiff <= -2:
1484 # expdiff <= -2 => abs(self/other) < 0.1
1485 ans = self._rescale(ideal_exponent, context.rounding)
1486 return ans._fix(context)
1487
1488 # adjust both arguments to have the same exponent, then divide
1489 op1 = _WorkRep(self)
1490 op2 = _WorkRep(other)
1491 if op1.exp >= op2.exp:
1492 op1.int *= 10**(op1.exp - op2.exp)
1493 else:
1494 op2.int *= 10**(op2.exp - op1.exp)
1495 q, r = divmod(op1.int, op2.int)
1496 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1497 # 10**ideal_exponent. Apply correction to ensure that
1498 # abs(remainder) <= abs(other)/2
1499 if 2*r + (q&1) > op2.int:
1500 r -= op2.int
1501 q += 1
1502
1503 if q >= 10**context.prec:
1504 return context._raise_error(DivisionImpossible)
1505
1506 # result has same sign as self unless r is negative
1507 sign = self._sign
1508 if r < 0:
1509 sign = 1-sign
1510 r = -r
1511
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001512 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001513 return ans._fix(context)
1514
1515 def __floordiv__(self, other, context=None):
1516 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001517 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001518 if other is NotImplemented:
1519 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001520
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001521 if context is None:
1522 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001523
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001524 ans = self._check_nans(other, context)
1525 if ans:
1526 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001527
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001528 if self._isinfinity():
1529 if other._isinfinity():
1530 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001531 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001532 return _SignedInfinity[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001533
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001534 if not other:
1535 if self:
1536 return context._raise_error(DivisionByZero, 'x // 0',
1537 self._sign ^ other._sign)
1538 else:
1539 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001540
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001541 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001542
1543 def __rfloordiv__(self, other, context=None):
1544 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001545 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001546 if other is NotImplemented:
1547 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001548 return other.__floordiv__(self, context=context)
1549
1550 def __float__(self):
1551 """Float representation."""
1552 return float(str(self))
1553
1554 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001555 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001556 if self._is_special:
1557 if self._isnan():
1558 context = getcontext()
1559 return context._raise_error(InvalidContext)
1560 elif self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001561 raise OverflowError("Cannot convert infinity to int")
1562 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001563 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001564 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001565 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001566 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001567
Christian Heimes969fe572008-01-25 11:23:10 +00001568 __trunc__ = __int__
1569
Christian Heimes0bd4e112008-02-12 22:59:25 +00001570 def real(self):
1571 return self
Mark Dickinson315a20a2009-01-04 21:34:18 +00001572 real = property(real)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001573
Christian Heimes0bd4e112008-02-12 22:59:25 +00001574 def imag(self):
1575 return Decimal(0)
Mark Dickinson315a20a2009-01-04 21:34:18 +00001576 imag = property(imag)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001577
1578 def conjugate(self):
1579 return self
1580
1581 def __complex__(self):
1582 return complex(float(self))
1583
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001584 def _fix_nan(self, context):
1585 """Decapitate the payload of a NaN to fit the context"""
1586 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001587
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001588 # maximum length of payload is precision if _clamp=0,
1589 # precision-1 if _clamp=1.
1590 max_payload_len = context.prec - context._clamp
1591 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001592 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1593 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001594 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001595
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001596 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001597 """Round if it is necessary to keep self within prec precision.
1598
1599 Rounds and fixes the exponent. Does not raise on a sNaN.
1600
1601 Arguments:
1602 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001603 context - context used.
1604 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001605
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001606 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001607 if self._isnan():
1608 # decapitate payload if necessary
1609 return self._fix_nan(context)
1610 else:
1611 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001612 return Decimal(self)
1613
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001614 # if self is zero then exponent should be between Etiny and
1615 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1616 Etiny = context.Etiny()
1617 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001618 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001619 exp_max = [context.Emax, Etop][context._clamp]
1620 new_exp = min(max(self._exp, Etiny), exp_max)
1621 if new_exp != self._exp:
1622 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001623 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001624 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001625 return Decimal(self)
1626
1627 # exp_min is the smallest allowable exponent of the result,
1628 # equal to max(self.adjusted()-context.prec+1, Etiny)
1629 exp_min = len(self._int) + self._exp - context.prec
1630 if exp_min > Etop:
1631 # overflow: exp_min > Etop iff self.adjusted() > Emax
1632 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001633 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001634 return context._raise_error(Overflow, 'above Emax', self._sign)
1635 self_is_subnormal = exp_min < Etiny
1636 if self_is_subnormal:
1637 context._raise_error(Subnormal)
1638 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001639
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001640 # round if self has too many digits
1641 if self._exp < exp_min:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001642 context._raise_error(Rounded)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001643 digits = len(self._int) + self._exp - exp_min
1644 if digits < 0:
1645 self = _dec_from_triple(self._sign, '1', exp_min-1)
1646 digits = 0
1647 this_function = getattr(self, self._pick_rounding_function[context.rounding])
1648 changed = this_function(digits)
1649 coeff = self._int[:digits] or '0'
1650 if changed == 1:
1651 coeff = str(int(coeff)+1)
1652 ans = _dec_from_triple(self._sign, coeff, exp_min)
1653
1654 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001655 context._raise_error(Inexact)
1656 if self_is_subnormal:
1657 context._raise_error(Underflow)
1658 if not ans:
1659 # raise Clamped on underflow to 0
1660 context._raise_error(Clamped)
1661 elif len(ans._int) == context.prec+1:
1662 # we get here only if rescaling rounds the
1663 # cofficient up to exactly 10**context.prec
1664 if ans._exp < Etop:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001665 ans = _dec_from_triple(ans._sign,
1666 ans._int[:-1], ans._exp+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001667 else:
1668 # Inexact and Rounded have already been raised
1669 ans = context._raise_error(Overflow, 'above Emax',
1670 self._sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001671 return ans
1672
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001673 # fold down if _clamp == 1 and self has too few digits
1674 if context._clamp == 1 and self._exp > Etop:
1675 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001676 self_padded = self._int + '0'*(self._exp - Etop)
1677 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001678
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001679 # here self was representable to begin with; return unchanged
1680 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001681
1682 _pick_rounding_function = {}
1683
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001684 # for each of the rounding functions below:
1685 # self is a finite, nonzero Decimal
1686 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001687 #
1688 # each function returns either -1, 0, or 1, as follows:
1689 # 1 indicates that self should be rounded up (away from zero)
1690 # 0 indicates that self should be truncated, and that all the
1691 # digits to be truncated are zeros (so the value is unchanged)
1692 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001693
1694 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001695 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001696 if _all_zeros(self._int, prec):
1697 return 0
1698 else:
1699 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001700
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001701 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001702 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001703 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001704
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001705 def _round_half_up(self, prec):
1706 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001707 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001708 return 1
1709 elif _all_zeros(self._int, prec):
1710 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001711 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001712 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001713
1714 def _round_half_down(self, prec):
1715 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001716 if _exact_half(self._int, prec):
1717 return -1
1718 else:
1719 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001720
1721 def _round_half_even(self, prec):
1722 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001723 if _exact_half(self._int, prec) and \
1724 (prec == 0 or self._int[prec-1] in '02468'):
1725 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001726 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001727 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001728
1729 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001730 """Rounds up (not away from 0 if negative.)"""
1731 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001732 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001733 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001734 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001735
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001736 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001737 """Rounds down (not towards 0 if negative)"""
1738 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001739 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001740 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001741 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001742
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001743 def _round_05up(self, prec):
1744 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001745 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001746 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001747 else:
1748 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001749
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001750 def __round__(self, n=None):
1751 """Round self to the nearest integer, or to a given precision.
1752
1753 If only one argument is supplied, round a finite Decimal
1754 instance self to the nearest integer. If self is infinite or
1755 a NaN then a Python exception is raised. If self is finite
1756 and lies exactly halfway between two integers then it is
1757 rounded to the integer with even last digit.
1758
1759 >>> round(Decimal('123.456'))
1760 123
1761 >>> round(Decimal('-456.789'))
1762 -457
1763 >>> round(Decimal('-3.0'))
1764 -3
1765 >>> round(Decimal('2.5'))
1766 2
1767 >>> round(Decimal('3.5'))
1768 4
1769 >>> round(Decimal('Inf'))
1770 Traceback (most recent call last):
1771 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001772 OverflowError: cannot round an infinity
1773 >>> round(Decimal('NaN'))
1774 Traceback (most recent call last):
1775 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001776 ValueError: cannot round a NaN
1777
1778 If a second argument n is supplied, self is rounded to n
1779 decimal places using the rounding mode for the current
1780 context.
1781
1782 For an integer n, round(self, -n) is exactly equivalent to
1783 self.quantize(Decimal('1En')).
1784
1785 >>> round(Decimal('123.456'), 0)
1786 Decimal('123')
1787 >>> round(Decimal('123.456'), 2)
1788 Decimal('123.46')
1789 >>> round(Decimal('123.456'), -2)
1790 Decimal('1E+2')
1791 >>> round(Decimal('-Infinity'), 37)
1792 Decimal('NaN')
1793 >>> round(Decimal('sNaN123'), 0)
1794 Decimal('NaN123')
1795
1796 """
1797 if n is not None:
1798 # two-argument form: use the equivalent quantize call
1799 if not isinstance(n, int):
1800 raise TypeError('Second argument to round should be integral')
1801 exp = _dec_from_triple(0, '1', -n)
1802 return self.quantize(exp)
1803
1804 # one-argument form
1805 if self._is_special:
1806 if self.is_nan():
1807 raise ValueError("cannot round a NaN")
1808 else:
1809 raise OverflowError("cannot round an infinity")
1810 return int(self._rescale(0, ROUND_HALF_EVEN))
1811
1812 def __floor__(self):
1813 """Return the floor of self, as an integer.
1814
1815 For a finite Decimal instance self, return the greatest
1816 integer n such that n <= self. If self is infinite or a NaN
1817 then a Python exception is raised.
1818
1819 """
1820 if self._is_special:
1821 if self.is_nan():
1822 raise ValueError("cannot round a NaN")
1823 else:
1824 raise OverflowError("cannot round an infinity")
1825 return int(self._rescale(0, ROUND_FLOOR))
1826
1827 def __ceil__(self):
1828 """Return the ceiling of self, as an integer.
1829
1830 For a finite Decimal instance self, return the least integer n
1831 such that n >= self. If self is infinite or a NaN then a
1832 Python exception is raised.
1833
1834 """
1835 if self._is_special:
1836 if self.is_nan():
1837 raise ValueError("cannot round a NaN")
1838 else:
1839 raise OverflowError("cannot round an infinity")
1840 return int(self._rescale(0, ROUND_CEILING))
1841
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001842 def fma(self, other, third, context=None):
1843 """Fused multiply-add.
1844
1845 Returns self*other+third with no rounding of the intermediate
1846 product self*other.
1847
1848 self and other are multiplied together, with no rounding of
1849 the result. The third operand is then added to the result,
1850 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001851 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001852
1853 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001854
1855 # compute product; raise InvalidOperation if either operand is
1856 # a signaling NaN or if the product is zero times infinity.
1857 if self._is_special or other._is_special:
1858 if context is None:
1859 context = getcontext()
1860 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001861 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001862 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001863 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001864 if self._exp == 'n':
1865 product = self
1866 elif other._exp == 'n':
1867 product = other
1868 elif self._exp == 'F':
1869 if not other:
1870 return context._raise_error(InvalidOperation,
1871 'INF * 0 in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001872 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001873 elif other._exp == 'F':
1874 if not self:
1875 return context._raise_error(InvalidOperation,
1876 '0 * INF in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001877 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001878 else:
1879 product = _dec_from_triple(self._sign ^ other._sign,
1880 str(int(self._int) * int(other._int)),
1881 self._exp + other._exp)
1882
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001883 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001884 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001885
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001886 def _power_modulo(self, other, modulo, context=None):
1887 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001888
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001889 # if can't convert other and modulo to Decimal, raise
1890 # TypeError; there's no point returning NotImplemented (no
1891 # equivalent of __rpow__ for three argument pow)
1892 other = _convert_other(other, raiseit=True)
1893 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001894
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001895 if context is None:
1896 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001897
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001898 # deal with NaNs: if there are any sNaNs then first one wins,
1899 # (i.e. behaviour for NaNs is identical to that of fma)
1900 self_is_nan = self._isnan()
1901 other_is_nan = other._isnan()
1902 modulo_is_nan = modulo._isnan()
1903 if self_is_nan or other_is_nan or modulo_is_nan:
1904 if self_is_nan == 2:
1905 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001906 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001907 if other_is_nan == 2:
1908 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001909 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001910 if modulo_is_nan == 2:
1911 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001912 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001913 if self_is_nan:
1914 return self._fix_nan(context)
1915 if other_is_nan:
1916 return other._fix_nan(context)
1917 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001918
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001919 # check inputs: we apply same restrictions as Python's pow()
1920 if not (self._isinteger() and
1921 other._isinteger() and
1922 modulo._isinteger()):
1923 return context._raise_error(InvalidOperation,
1924 'pow() 3rd argument not allowed '
1925 'unless all arguments are integers')
1926 if other < 0:
1927 return context._raise_error(InvalidOperation,
1928 'pow() 2nd argument cannot be '
1929 'negative when 3rd argument specified')
1930 if not modulo:
1931 return context._raise_error(InvalidOperation,
1932 'pow() 3rd argument cannot be 0')
1933
1934 # additional restriction for decimal: the modulus must be less
1935 # than 10**prec in absolute value
1936 if modulo.adjusted() >= context.prec:
1937 return context._raise_error(InvalidOperation,
1938 'insufficient precision: pow() 3rd '
1939 'argument must not have more than '
1940 'precision digits')
1941
1942 # define 0**0 == NaN, for consistency with two-argument pow
1943 # (even though it hurts!)
1944 if not other and not self:
1945 return context._raise_error(InvalidOperation,
1946 'at least one of pow() 1st argument '
1947 'and 2nd argument must be nonzero ;'
1948 '0**0 is not defined')
1949
1950 # compute sign of result
1951 if other._iseven():
1952 sign = 0
1953 else:
1954 sign = self._sign
1955
1956 # convert modulo to a Python integer, and self and other to
1957 # Decimal integers (i.e. force their exponents to be >= 0)
1958 modulo = abs(int(modulo))
1959 base = _WorkRep(self.to_integral_value())
1960 exponent = _WorkRep(other.to_integral_value())
1961
1962 # compute result using integer pow()
1963 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1964 for i in range(exponent.exp):
1965 base = pow(base, 10, modulo)
1966 base = pow(base, exponent.int, modulo)
1967
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001968 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001969
1970 def _power_exact(self, other, p):
1971 """Attempt to compute self**other exactly.
1972
1973 Given Decimals self and other and an integer p, attempt to
1974 compute an exact result for the power self**other, with p
1975 digits of precision. Return None if self**other is not
1976 exactly representable in p digits.
1977
1978 Assumes that elimination of special cases has already been
1979 performed: self and other must both be nonspecial; self must
1980 be positive and not numerically equal to 1; other must be
1981 nonzero. For efficiency, other._exp should not be too large,
1982 so that 10**abs(other._exp) is a feasible calculation."""
1983
1984 # In the comments below, we write x for the value of self and
1985 # y for the value of other. Write x = xc*10**xe and y =
1986 # yc*10**ye.
1987
1988 # The main purpose of this method is to identify the *failure*
1989 # of x**y to be exactly representable with as little effort as
1990 # possible. So we look for cheap and easy tests that
1991 # eliminate the possibility of x**y being exact. Only if all
1992 # these tests are passed do we go on to actually compute x**y.
1993
1994 # Here's the main idea. First normalize both x and y. We
1995 # express y as a rational m/n, with m and n relatively prime
1996 # and n>0. Then for x**y to be exactly representable (at
1997 # *any* precision), xc must be the nth power of a positive
1998 # integer and xe must be divisible by n. If m is negative
1999 # then additionally xc must be a power of either 2 or 5, hence
2000 # a power of 2**n or 5**n.
2001 #
2002 # There's a limit to how small |y| can be: if y=m/n as above
2003 # then:
2004 #
2005 # (1) if xc != 1 then for the result to be representable we
2006 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
2007 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
2008 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
2009 # representable.
2010 #
2011 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
2012 # |y| < 1/|xe| then the result is not representable.
2013 #
2014 # Note that since x is not equal to 1, at least one of (1) and
2015 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
2016 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
2017 #
2018 # There's also a limit to how large y can be, at least if it's
2019 # positive: the normalized result will have coefficient xc**y,
2020 # so if it's representable then xc**y < 10**p, and y <
2021 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
2022 # not exactly representable.
2023
2024 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
2025 # so |y| < 1/xe and the result is not representable.
2026 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
2027 # < 1/nbits(xc).
2028
2029 x = _WorkRep(self)
2030 xc, xe = x.int, x.exp
2031 while xc % 10 == 0:
2032 xc //= 10
2033 xe += 1
2034
2035 y = _WorkRep(other)
2036 yc, ye = y.int, y.exp
2037 while yc % 10 == 0:
2038 yc //= 10
2039 ye += 1
2040
2041 # case where xc == 1: result is 10**(xe*y), with xe*y
2042 # required to be an integer
2043 if xc == 1:
2044 if ye >= 0:
2045 exponent = xe*yc*10**ye
2046 else:
2047 exponent, remainder = divmod(xe*yc, 10**-ye)
2048 if remainder:
2049 return None
2050 if y.sign == 1:
2051 exponent = -exponent
2052 # if other is a nonnegative integer, use ideal exponent
2053 if other._isinteger() and other._sign == 0:
2054 ideal_exponent = self._exp*int(other)
2055 zeros = min(exponent-ideal_exponent, p-1)
2056 else:
2057 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002058 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002059
2060 # case where y is negative: xc must be either a power
2061 # of 2 or a power of 5.
2062 if y.sign == 1:
2063 last_digit = xc % 10
2064 if last_digit in (2,4,6,8):
2065 # quick test for power of 2
2066 if xc & -xc != xc:
2067 return None
2068 # now xc is a power of 2; e is its exponent
2069 e = _nbits(xc)-1
2070 # find e*y and xe*y; both must be integers
2071 if ye >= 0:
2072 y_as_int = yc*10**ye
2073 e = e*y_as_int
2074 xe = xe*y_as_int
2075 else:
2076 ten_pow = 10**-ye
2077 e, remainder = divmod(e*yc, ten_pow)
2078 if remainder:
2079 return None
2080 xe, remainder = divmod(xe*yc, ten_pow)
2081 if remainder:
2082 return None
2083
2084 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2085 return None
2086 xc = 5**e
2087
2088 elif last_digit == 5:
2089 # e >= log_5(xc) if xc is a power of 5; we have
2090 # equality all the way up to xc=5**2658
2091 e = _nbits(xc)*28//65
2092 xc, remainder = divmod(5**e, xc)
2093 if remainder:
2094 return None
2095 while xc % 5 == 0:
2096 xc //= 5
2097 e -= 1
2098 if ye >= 0:
2099 y_as_integer = yc*10**ye
2100 e = e*y_as_integer
2101 xe = xe*y_as_integer
2102 else:
2103 ten_pow = 10**-ye
2104 e, remainder = divmod(e*yc, ten_pow)
2105 if remainder:
2106 return None
2107 xe, remainder = divmod(xe*yc, ten_pow)
2108 if remainder:
2109 return None
2110 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2111 return None
2112 xc = 2**e
2113 else:
2114 return None
2115
2116 if xc >= 10**p:
2117 return None
2118 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002119 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002120
2121 # now y is positive; find m and n such that y = m/n
2122 if ye >= 0:
2123 m, n = yc*10**ye, 1
2124 else:
2125 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2126 return None
2127 xc_bits = _nbits(xc)
2128 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2129 return None
2130 m, n = yc, 10**(-ye)
2131 while m % 2 == n % 2 == 0:
2132 m //= 2
2133 n //= 2
2134 while m % 5 == n % 5 == 0:
2135 m //= 5
2136 n //= 5
2137
2138 # compute nth root of xc*10**xe
2139 if n > 1:
2140 # if 1 < xc < 2**n then xc isn't an nth power
2141 if xc != 1 and xc_bits <= n:
2142 return None
2143
2144 xe, rem = divmod(xe, n)
2145 if rem != 0:
2146 return None
2147
2148 # compute nth root of xc using Newton's method
2149 a = 1 << -(-_nbits(xc)//n) # initial estimate
2150 while True:
2151 q, r = divmod(xc, a**(n-1))
2152 if a <= q:
2153 break
2154 else:
2155 a = (a*(n-1) + q)//n
2156 if not (a == q and r == 0):
2157 return None
2158 xc = a
2159
2160 # now xc*10**xe is the nth root of the original xc*10**xe
2161 # compute mth power of xc*10**xe
2162
2163 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2164 # 10**p and the result is not representable.
2165 if xc > 1 and m > p*100//_log10_lb(xc):
2166 return None
2167 xc = xc**m
2168 xe *= m
2169 if xc > 10**p:
2170 return None
2171
2172 # by this point the result *is* exactly representable
2173 # adjust the exponent to get as close as possible to the ideal
2174 # exponent, if necessary
2175 str_xc = str(xc)
2176 if other._isinteger() and other._sign == 0:
2177 ideal_exponent = self._exp*int(other)
2178 zeros = min(xe-ideal_exponent, p-len(str_xc))
2179 else:
2180 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002181 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002182
2183 def __pow__(self, other, modulo=None, context=None):
2184 """Return self ** other [ % modulo].
2185
2186 With two arguments, compute self**other.
2187
2188 With three arguments, compute (self**other) % modulo. For the
2189 three argument form, the following restrictions on the
2190 arguments hold:
2191
2192 - all three arguments must be integral
2193 - other must be nonnegative
2194 - either self or other (or both) must be nonzero
2195 - modulo must be nonzero and must have at most p digits,
2196 where p is the context precision.
2197
2198 If any of these restrictions is violated the InvalidOperation
2199 flag is raised.
2200
2201 The result of pow(self, other, modulo) is identical to the
2202 result that would be obtained by computing (self**other) %
2203 modulo with unbounded precision, but is computed more
2204 efficiently. It is always exact.
2205 """
2206
2207 if modulo is not None:
2208 return self._power_modulo(other, modulo, context)
2209
2210 other = _convert_other(other)
2211 if other is NotImplemented:
2212 return other
2213
2214 if context is None:
2215 context = getcontext()
2216
2217 # either argument is a NaN => result is NaN
2218 ans = self._check_nans(other, context)
2219 if ans:
2220 return ans
2221
2222 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2223 if not other:
2224 if not self:
2225 return context._raise_error(InvalidOperation, '0 ** 0')
2226 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002227 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002228
2229 # result has sign 1 iff self._sign is 1 and other is an odd integer
2230 result_sign = 0
2231 if self._sign == 1:
2232 if other._isinteger():
2233 if not other._iseven():
2234 result_sign = 1
2235 else:
2236 # -ve**noninteger = NaN
2237 # (-0)**noninteger = 0**noninteger
2238 if self:
2239 return context._raise_error(InvalidOperation,
2240 'x ** y with x negative and y not an integer')
2241 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002242 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002243
2244 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2245 if not self:
2246 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002247 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002248 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002249 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002250
2251 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002252 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002253 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002254 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002255 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002256 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002257
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002258 # 1**other = 1, but the choice of exponent and the flags
2259 # depend on the exponent of self, and on whether other is a
2260 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002261 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002262 if other._isinteger():
2263 # exp = max(self._exp*max(int(other), 0),
2264 # 1-context.prec) but evaluating int(other) directly
2265 # is dangerous until we know other is small (other
2266 # could be 1e999999999)
2267 if other._sign == 1:
2268 multiplier = 0
2269 elif other > context.prec:
2270 multiplier = context.prec
2271 else:
2272 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002273
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002274 exp = self._exp * multiplier
2275 if exp < 1-context.prec:
2276 exp = 1-context.prec
2277 context._raise_error(Rounded)
2278 else:
2279 context._raise_error(Inexact)
2280 context._raise_error(Rounded)
2281 exp = 1-context.prec
2282
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002283 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002284
2285 # compute adjusted exponent of self
2286 self_adj = self.adjusted()
2287
2288 # self ** infinity is infinity if self > 1, 0 if self < 1
2289 # self ** -infinity is infinity if self < 1, 0 if self > 1
2290 if other._isinfinity():
2291 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002292 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002293 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002294 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002295
2296 # from here on, the result always goes through the call
2297 # to _fix at the end of this function.
2298 ans = None
2299
2300 # crude test to catch cases of extreme overflow/underflow. If
2301 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2302 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2303 # self**other >= 10**(Emax+1), so overflow occurs. The test
2304 # for underflow is similar.
2305 bound = self._log10_exp_bound() + other.adjusted()
2306 if (self_adj >= 0) == (other._sign == 0):
2307 # self > 1 and other +ve, or self < 1 and other -ve
2308 # possibility of overflow
2309 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002310 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002311 else:
2312 # self > 1 and other -ve, or self < 1 and other +ve
2313 # possibility of underflow to 0
2314 Etiny = context.Etiny()
2315 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002316 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002317
2318 # try for an exact result with precision +1
2319 if ans is None:
2320 ans = self._power_exact(other, context.prec + 1)
2321 if ans is not None and result_sign == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002322 ans = _dec_from_triple(1, ans._int, ans._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002323
2324 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2325 if ans is None:
2326 p = context.prec
2327 x = _WorkRep(self)
2328 xc, xe = x.int, x.exp
2329 y = _WorkRep(other)
2330 yc, ye = y.int, y.exp
2331 if y.sign == 1:
2332 yc = -yc
2333
2334 # compute correctly rounded result: start with precision +3,
2335 # then increase precision until result is unambiguously roundable
2336 extra = 3
2337 while True:
2338 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2339 if coeff % (5*10**(len(str(coeff))-p-1)):
2340 break
2341 extra += 3
2342
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002343 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002344
2345 # the specification says that for non-integer other we need to
2346 # raise Inexact, even when the result is actually exact. In
2347 # the same way, we need to raise Underflow here if the result
2348 # is subnormal. (The call to _fix will take care of raising
2349 # Rounded and Subnormal, as usual.)
2350 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002351 context._raise_error(Inexact)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002352 # pad with zeros up to length context.prec+1 if necessary
2353 if len(ans._int) <= context.prec:
2354 expdiff = context.prec+1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002355 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2356 ans._exp-expdiff)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002357 if ans.adjusted() < context.Emin:
2358 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002359
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002360 # unlike exp, ln and log10, the power function respects the
2361 # rounding mode; no need to use ROUND_HALF_EVEN here
2362 ans = ans._fix(context)
2363 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002364
2365 def __rpow__(self, other, context=None):
2366 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002367 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002368 if other is NotImplemented:
2369 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002370 return other.__pow__(self, context=context)
2371
2372 def normalize(self, context=None):
2373 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002374
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002375 if context is None:
2376 context = getcontext()
2377
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002378 if self._is_special:
2379 ans = self._check_nans(context=context)
2380 if ans:
2381 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002382
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002383 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002384 if dup._isinfinity():
2385 return dup
2386
2387 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002388 return _dec_from_triple(dup._sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002389 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002390 end = len(dup._int)
2391 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002392 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002393 exp += 1
2394 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002395 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002396
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002397 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002398 """Quantize self so its exponent is the same as that of exp.
2399
2400 Similar to self._rescale(exp._exp) but with error checking.
2401 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002402 exp = _convert_other(exp, raiseit=True)
2403
2404 if context is None:
2405 context = getcontext()
2406 if rounding is None:
2407 rounding = context.rounding
2408
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002409 if self._is_special or exp._is_special:
2410 ans = self._check_nans(exp, context)
2411 if ans:
2412 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002413
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002414 if exp._isinfinity() or self._isinfinity():
2415 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002416 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002417 return context._raise_error(InvalidOperation,
2418 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002419
2420 # if we're not watching exponents, do a simple rescale
2421 if not watchexp:
2422 ans = self._rescale(exp._exp, rounding)
2423 # raise Inexact and Rounded where appropriate
2424 if ans._exp > self._exp:
2425 context._raise_error(Rounded)
2426 if ans != self:
2427 context._raise_error(Inexact)
2428 return ans
2429
2430 # exp._exp should be between Etiny and Emax
2431 if not (context.Etiny() <= exp._exp <= context.Emax):
2432 return context._raise_error(InvalidOperation,
2433 'target exponent out of bounds in quantize')
2434
2435 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002436 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002437 return ans._fix(context)
2438
2439 self_adjusted = self.adjusted()
2440 if self_adjusted > context.Emax:
2441 return context._raise_error(InvalidOperation,
2442 'exponent of quantize result too large for current context')
2443 if self_adjusted - exp._exp + 1 > context.prec:
2444 return context._raise_error(InvalidOperation,
2445 'quantize result has too many digits for current context')
2446
2447 ans = self._rescale(exp._exp, rounding)
2448 if ans.adjusted() > context.Emax:
2449 return context._raise_error(InvalidOperation,
2450 'exponent of quantize result too large for current context')
2451 if len(ans._int) > context.prec:
2452 return context._raise_error(InvalidOperation,
2453 'quantize result has too many digits for current context')
2454
2455 # raise appropriate flags
2456 if ans._exp > self._exp:
2457 context._raise_error(Rounded)
2458 if ans != self:
2459 context._raise_error(Inexact)
2460 if ans and ans.adjusted() < context.Emin:
2461 context._raise_error(Subnormal)
2462
2463 # call to fix takes care of any necessary folddown
2464 ans = ans._fix(context)
2465 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002466
2467 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002468 """Return True if self and other have the same exponent; otherwise
2469 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002470
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002471 If either operand is a special value, the following rules are used:
2472 * return True if both operands are infinities
2473 * return True if both operands are NaNs
2474 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002475 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002476 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002477 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002478 return (self.is_nan() and other.is_nan() or
2479 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002480 return self._exp == other._exp
2481
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002482 def _rescale(self, exp, rounding):
2483 """Rescale self so that the exponent is exp, either by padding with zeros
2484 or by truncating digits, using the given rounding mode.
2485
2486 Specials are returned without change. This operation is
2487 quiet: it raises no flags, and uses no information from the
2488 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002489
2490 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002491 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002492 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002493 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002494 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002495 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002496 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002497
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002498 if self._exp >= exp:
2499 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002500 return _dec_from_triple(self._sign,
2501 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002502
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002503 # too many digits; round and lose data. If self.adjusted() <
2504 # exp-1, replace self by 10**(exp-1) before rounding
2505 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002506 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002507 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002508 digits = 0
2509 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002510 changed = this_function(digits)
2511 coeff = self._int[:digits] or '0'
2512 if changed == 1:
2513 coeff = str(int(coeff)+1)
2514 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002515
Christian Heimesf16baeb2008-02-29 14:57:44 +00002516 def _round(self, places, rounding):
2517 """Round a nonzero, nonspecial Decimal to a fixed number of
2518 significant figures, using the given rounding mode.
2519
2520 Infinities, NaNs and zeros are returned unaltered.
2521
2522 This operation is quiet: it raises no flags, and uses no
2523 information from the context.
2524
2525 """
2526 if places <= 0:
2527 raise ValueError("argument should be at least 1 in _round")
2528 if self._is_special or not self:
2529 return Decimal(self)
2530 ans = self._rescale(self.adjusted()+1-places, rounding)
2531 # it can happen that the rescale alters the adjusted exponent;
2532 # for example when rounding 99.97 to 3 significant figures.
2533 # When this happens we end up with an extra 0 at the end of
2534 # the number; a second rescale fixes this.
2535 if ans.adjusted() != self.adjusted():
2536 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2537 return ans
2538
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002539 def to_integral_exact(self, rounding=None, context=None):
2540 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002541
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002542 If no rounding mode is specified, take the rounding mode from
2543 the context. This method raises the Rounded and Inexact flags
2544 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002545
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002546 See also: to_integral_value, which does exactly the same as
2547 this method except that it doesn't raise Inexact or Rounded.
2548 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002549 if self._is_special:
2550 ans = self._check_nans(context=context)
2551 if ans:
2552 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002553 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002554 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002555 return Decimal(self)
2556 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002557 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002558 if context is None:
2559 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002560 if rounding is None:
2561 rounding = context.rounding
2562 context._raise_error(Rounded)
2563 ans = self._rescale(0, rounding)
2564 if ans != self:
2565 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002566 return ans
2567
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002568 def to_integral_value(self, rounding=None, context=None):
2569 """Rounds to the nearest integer, without raising inexact, rounded."""
2570 if context is None:
2571 context = getcontext()
2572 if rounding is None:
2573 rounding = context.rounding
2574 if self._is_special:
2575 ans = self._check_nans(context=context)
2576 if ans:
2577 return ans
2578 return Decimal(self)
2579 if self._exp >= 0:
2580 return Decimal(self)
2581 else:
2582 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002583
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002584 # the method name changed, but we provide also the old one, for compatibility
2585 to_integral = to_integral_value
2586
2587 def sqrt(self, context=None):
2588 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002589 if context is None:
2590 context = getcontext()
2591
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002592 if self._is_special:
2593 ans = self._check_nans(context=context)
2594 if ans:
2595 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002596
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002597 if self._isinfinity() and self._sign == 0:
2598 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002599
2600 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002601 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002602 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002603 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002604
2605 if self._sign == 1:
2606 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2607
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002608 # At this point self represents a positive number. Let p be
2609 # the desired precision and express self in the form c*100**e
2610 # with c a positive real number and e an integer, c and e
2611 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2612 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2613 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2614 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2615 # the closest integer to sqrt(c) with the even integer chosen
2616 # in the case of a tie.
2617 #
2618 # To ensure correct rounding in all cases, we use the
2619 # following trick: we compute the square root to an extra
2620 # place (precision p+1 instead of precision p), rounding down.
2621 # Then, if the result is inexact and its last digit is 0 or 5,
2622 # we increase the last digit to 1 or 6 respectively; if it's
2623 # exact we leave the last digit alone. Now the final round to
2624 # p places (or fewer in the case of underflow) will round
2625 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002626
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002627 # use an extra digit of precision
2628 prec = context.prec+1
2629
2630 # write argument in the form c*100**e where e = self._exp//2
2631 # is the 'ideal' exponent, to be used if the square root is
2632 # exactly representable. l is the number of 'digits' of c in
2633 # base 100, so that 100**(l-1) <= c < 100**l.
2634 op = _WorkRep(self)
2635 e = op.exp >> 1
2636 if op.exp & 1:
2637 c = op.int * 10
2638 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002639 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002640 c = op.int
2641 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002642
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002643 # rescale so that c has exactly prec base 100 'digits'
2644 shift = prec-l
2645 if shift >= 0:
2646 c *= 100**shift
2647 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002648 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002649 c, remainder = divmod(c, 100**-shift)
2650 exact = not remainder
2651 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002652
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002653 # find n = floor(sqrt(c)) using Newton's method
2654 n = 10**prec
2655 while True:
2656 q = c//n
2657 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002658 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002659 else:
2660 n = n + q >> 1
2661 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002662
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002663 if exact:
2664 # result is exact; rescale to use ideal exponent e
2665 if shift >= 0:
2666 # assert n % 10**shift == 0
2667 n //= 10**shift
2668 else:
2669 n *= 10**-shift
2670 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002671 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002672 # result is not exact; fix last digit as described above
2673 if n % 5 == 0:
2674 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002675
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002676 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002677
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002678 # round, and fit to current context
2679 context = context._shallow_copy()
2680 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002681 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002682 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002683
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002684 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002685
2686 def max(self, other, context=None):
2687 """Returns the larger value.
2688
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002689 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002690 NaN (and signals if one is sNaN). Also rounds.
2691 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002692 other = _convert_other(other, raiseit=True)
2693
2694 if context is None:
2695 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002696
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002697 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002698 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002699 # number is always returned
2700 sn = self._isnan()
2701 on = other._isnan()
2702 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002703 if on == 1 and sn == 0:
2704 return self._fix(context)
2705 if sn == 1 and on == 0:
2706 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002707 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002708
Christian Heimes77c02eb2008-02-09 02:18:51 +00002709 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002710 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002711 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002712 # then an ordering is applied:
2713 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002714 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002715 # positive sign and min returns the operand with the negative sign
2716 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002717 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002718 # the result. This is exactly the ordering used in compare_total.
2719 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002720
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002721 if c == -1:
2722 ans = other
2723 else:
2724 ans = self
2725
Christian Heimes2c181612007-12-17 20:04:13 +00002726 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002727
2728 def min(self, other, context=None):
2729 """Returns the smaller value.
2730
Guido van Rossumd8faa362007-04-27 19:54:29 +00002731 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002732 NaN (and signals if one is sNaN). Also rounds.
2733 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002734 other = _convert_other(other, raiseit=True)
2735
2736 if context is None:
2737 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002738
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002739 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002740 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002741 # number is always returned
2742 sn = self._isnan()
2743 on = other._isnan()
2744 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002745 if on == 1 and sn == 0:
2746 return self._fix(context)
2747 if sn == 1 and on == 0:
2748 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002749 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002750
Christian Heimes77c02eb2008-02-09 02:18:51 +00002751 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002752 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002753 c = self.compare_total(other)
2754
2755 if c == -1:
2756 ans = self
2757 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002758 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002759
Christian Heimes2c181612007-12-17 20:04:13 +00002760 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002761
2762 def _isinteger(self):
2763 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002764 if self._is_special:
2765 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002766 if self._exp >= 0:
2767 return True
2768 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002769 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002770
2771 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002772 """Returns True if self is even. Assumes self is an integer."""
2773 if not self or self._exp > 0:
2774 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002775 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002776
2777 def adjusted(self):
2778 """Return the adjusted exponent of self"""
2779 try:
2780 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002781 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002782 except TypeError:
2783 return 0
2784
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002785 def canonical(self, context=None):
2786 """Returns the same Decimal object.
2787
2788 As we do not have different encodings for the same number, the
2789 received object already is in its canonical form.
2790 """
2791 return self
2792
2793 def compare_signal(self, other, context=None):
2794 """Compares self to the other operand numerically.
2795
2796 It's pretty much like compare(), but all NaNs signal, with signaling
2797 NaNs taking precedence over quiet NaNs.
2798 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002799 other = _convert_other(other, raiseit = True)
2800 ans = self._compare_check_nans(other, context)
2801 if ans:
2802 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002803 return self.compare(other, context=context)
2804
2805 def compare_total(self, other):
2806 """Compares self to other using the abstract representations.
2807
2808 This is not like the standard compare, which use their numerical
2809 value. Note that a total ordering is defined for all possible abstract
2810 representations.
2811 """
2812 # if one is negative and the other is positive, it's easy
2813 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002814 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002815 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002816 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002817 sign = self._sign
2818
2819 # let's handle both NaN types
2820 self_nan = self._isnan()
2821 other_nan = other._isnan()
2822 if self_nan or other_nan:
2823 if self_nan == other_nan:
2824 if self._int < other._int:
2825 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002826 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002827 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002828 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002829 if self._int > other._int:
2830 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002831 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002832 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002833 return _One
2834 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002835
2836 if sign:
2837 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002838 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002839 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002840 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002841 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002842 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002843 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002844 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002845 else:
2846 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002847 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002848 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002849 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002850 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002851 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002852 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002853 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002854
2855 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002856 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002857 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002858 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002859
2860 if self._exp < other._exp:
2861 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002862 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002863 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002864 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002865 if self._exp > other._exp:
2866 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002867 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002868 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002869 return _One
2870 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002871
2872
2873 def compare_total_mag(self, other):
2874 """Compares self to other using abstract repr., ignoring sign.
2875
2876 Like compare_total, but with operand's sign ignored and assumed to be 0.
2877 """
2878 s = self.copy_abs()
2879 o = other.copy_abs()
2880 return s.compare_total(o)
2881
2882 def copy_abs(self):
2883 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002884 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002885
2886 def copy_negate(self):
2887 """Returns a copy with the sign inverted."""
2888 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002889 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002890 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002891 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002892
2893 def copy_sign(self, other):
2894 """Returns self with the sign of other."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002895 return _dec_from_triple(other._sign, self._int,
2896 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002897
2898 def exp(self, context=None):
2899 """Returns e ** self."""
2900
2901 if context is None:
2902 context = getcontext()
2903
2904 # exp(NaN) = NaN
2905 ans = self._check_nans(context=context)
2906 if ans:
2907 return ans
2908
2909 # exp(-Infinity) = 0
2910 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002911 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002912
2913 # exp(0) = 1
2914 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002915 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002916
2917 # exp(Infinity) = Infinity
2918 if self._isinfinity() == 1:
2919 return Decimal(self)
2920
2921 # the result is now guaranteed to be inexact (the true
2922 # mathematical result is transcendental). There's no need to
2923 # raise Rounded and Inexact here---they'll always be raised as
2924 # a result of the call to _fix.
2925 p = context.prec
2926 adj = self.adjusted()
2927
2928 # we only need to do any computation for quite a small range
2929 # of adjusted exponents---for example, -29 <= adj <= 10 for
2930 # the default context. For smaller exponent the result is
2931 # indistinguishable from 1 at the given precision, while for
2932 # larger exponent the result either overflows or underflows.
2933 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2934 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002935 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002936 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2937 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002938 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002939 elif self._sign == 0 and adj < -p:
2940 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002941 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002942 elif self._sign == 1 and adj < -p-1:
2943 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002944 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002945 # general case
2946 else:
2947 op = _WorkRep(self)
2948 c, e = op.int, op.exp
2949 if op.sign == 1:
2950 c = -c
2951
2952 # compute correctly rounded result: increase precision by
2953 # 3 digits at a time until we get an unambiguously
2954 # roundable result
2955 extra = 3
2956 while True:
2957 coeff, exp = _dexp(c, e, p+extra)
2958 if coeff % (5*10**(len(str(coeff))-p-1)):
2959 break
2960 extra += 3
2961
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002962 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002963
2964 # at this stage, ans should round correctly with *any*
2965 # rounding mode, not just with ROUND_HALF_EVEN
2966 context = context._shallow_copy()
2967 rounding = context._set_rounding(ROUND_HALF_EVEN)
2968 ans = ans._fix(context)
2969 context.rounding = rounding
2970
2971 return ans
2972
2973 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002974 """Return True if self is canonical; otherwise return False.
2975
2976 Currently, the encoding of a Decimal instance is always
2977 canonical, so this method returns True for any Decimal.
2978 """
2979 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002980
2981 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002982 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002983
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002984 A Decimal instance is considered finite if it is neither
2985 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002986 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002987 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002988
2989 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002990 """Return True if self is infinite; otherwise return False."""
2991 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002992
2993 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002994 """Return True if self is a qNaN or sNaN; otherwise return False."""
2995 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002996
2997 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002998 """Return True if self is a normal number; otherwise return False."""
2999 if self._is_special or not self:
3000 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003001 if context is None:
3002 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003003 return context.Emin <= self.adjusted() <= context.Emax
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003004
3005 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003006 """Return True if self is a quiet NaN; otherwise return False."""
3007 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003008
3009 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003010 """Return True if self is negative; otherwise return False."""
3011 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003012
3013 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003014 """Return True if self is a signaling NaN; otherwise return False."""
3015 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003016
3017 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003018 """Return True if self is subnormal; otherwise return False."""
3019 if self._is_special or not self:
3020 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003021 if context is None:
3022 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003023 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003024
3025 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003026 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003027 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003028
3029 def _ln_exp_bound(self):
3030 """Compute a lower bound for the adjusted exponent of self.ln().
3031 In other words, compute r such that self.ln() >= 10**r. Assumes
3032 that self is finite and positive and that self != 1.
3033 """
3034
3035 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3036 adj = self._exp + len(self._int) - 1
3037 if adj >= 1:
3038 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3039 return len(str(adj*23//10)) - 1
3040 if adj <= -2:
3041 # argument <= 0.1
3042 return len(str((-1-adj)*23//10)) - 1
3043 op = _WorkRep(self)
3044 c, e = op.int, op.exp
3045 if adj == 0:
3046 # 1 < self < 10
3047 num = str(c-10**-e)
3048 den = str(c)
3049 return len(num) - len(den) - (num < den)
3050 # adj == -1, 0.1 <= self < 1
3051 return e + len(str(10**-e - c)) - 1
3052
3053
3054 def ln(self, context=None):
3055 """Returns the natural (base e) logarithm of self."""
3056
3057 if context is None:
3058 context = getcontext()
3059
3060 # ln(NaN) = NaN
3061 ans = self._check_nans(context=context)
3062 if ans:
3063 return ans
3064
3065 # ln(0.0) == -Infinity
3066 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003067 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003068
3069 # ln(Infinity) = Infinity
3070 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003071 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003072
3073 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003074 if self == _One:
3075 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003076
3077 # ln(negative) raises InvalidOperation
3078 if self._sign == 1:
3079 return context._raise_error(InvalidOperation,
3080 'ln of a negative value')
3081
3082 # result is irrational, so necessarily inexact
3083 op = _WorkRep(self)
3084 c, e = op.int, op.exp
3085 p = context.prec
3086
3087 # correctly rounded result: repeatedly increase precision by 3
3088 # until we get an unambiguously roundable result
3089 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3090 while True:
3091 coeff = _dlog(c, e, places)
3092 # assert len(str(abs(coeff)))-p >= 1
3093 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3094 break
3095 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003096 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003097
3098 context = context._shallow_copy()
3099 rounding = context._set_rounding(ROUND_HALF_EVEN)
3100 ans = ans._fix(context)
3101 context.rounding = rounding
3102 return ans
3103
3104 def _log10_exp_bound(self):
3105 """Compute a lower bound for the adjusted exponent of self.log10().
3106 In other words, find r such that self.log10() >= 10**r.
3107 Assumes that self is finite and positive and that self != 1.
3108 """
3109
3110 # For x >= 10 or x < 0.1 we only need a bound on the integer
3111 # part of log10(self), and this comes directly from the
3112 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3113 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3114 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3115
3116 adj = self._exp + len(self._int) - 1
3117 if adj >= 1:
3118 # self >= 10
3119 return len(str(adj))-1
3120 if adj <= -2:
3121 # self < 0.1
3122 return len(str(-1-adj))-1
3123 op = _WorkRep(self)
3124 c, e = op.int, op.exp
3125 if adj == 0:
3126 # 1 < self < 10
3127 num = str(c-10**-e)
3128 den = str(231*c)
3129 return len(num) - len(den) - (num < den) + 2
3130 # adj == -1, 0.1 <= self < 1
3131 num = str(10**-e-c)
3132 return len(num) + e - (num < "231") - 1
3133
3134 def log10(self, context=None):
3135 """Returns the base 10 logarithm of self."""
3136
3137 if context is None:
3138 context = getcontext()
3139
3140 # log10(NaN) = NaN
3141 ans = self._check_nans(context=context)
3142 if ans:
3143 return ans
3144
3145 # log10(0.0) == -Infinity
3146 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003147 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003148
3149 # log10(Infinity) = Infinity
3150 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003151 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003152
3153 # log10(negative or -Infinity) raises InvalidOperation
3154 if self._sign == 1:
3155 return context._raise_error(InvalidOperation,
3156 'log10 of a negative value')
3157
3158 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003159 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003160 # answer may need rounding
3161 ans = Decimal(self._exp + len(self._int) - 1)
3162 else:
3163 # result is irrational, so necessarily inexact
3164 op = _WorkRep(self)
3165 c, e = op.int, op.exp
3166 p = context.prec
3167
3168 # correctly rounded result: repeatedly increase precision
3169 # until result is unambiguously roundable
3170 places = p-self._log10_exp_bound()+2
3171 while True:
3172 coeff = _dlog10(c, e, places)
3173 # assert len(str(abs(coeff)))-p >= 1
3174 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3175 break
3176 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003177 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003178
3179 context = context._shallow_copy()
3180 rounding = context._set_rounding(ROUND_HALF_EVEN)
3181 ans = ans._fix(context)
3182 context.rounding = rounding
3183 return ans
3184
3185 def logb(self, context=None):
3186 """ Returns the exponent of the magnitude of self's MSD.
3187
3188 The result is the integer which is the exponent of the magnitude
3189 of the most significant digit of self (as though it were truncated
3190 to a single digit while maintaining the value of that digit and
3191 without limiting the resulting exponent).
3192 """
3193 # logb(NaN) = NaN
3194 ans = self._check_nans(context=context)
3195 if ans:
3196 return ans
3197
3198 if context is None:
3199 context = getcontext()
3200
3201 # logb(+/-Inf) = +Inf
3202 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003203 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003204
3205 # logb(0) = -Inf, DivisionByZero
3206 if not self:
3207 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3208
3209 # otherwise, simply return the adjusted exponent of self, as a
3210 # Decimal. Note that no attempt is made to fit the result
3211 # into the current context.
3212 return Decimal(self.adjusted())
3213
3214 def _islogical(self):
3215 """Return True if self is a logical operand.
3216
Christian Heimes679db4a2008-01-18 09:56:22 +00003217 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003218 an exponent of 0, and a coefficient whose digits must all be
3219 either 0 or 1.
3220 """
3221 if self._sign != 0 or self._exp != 0:
3222 return False
3223 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003224 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003225 return False
3226 return True
3227
3228 def _fill_logical(self, context, opa, opb):
3229 dif = context.prec - len(opa)
3230 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003231 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003232 elif dif < 0:
3233 opa = opa[-context.prec:]
3234 dif = context.prec - len(opb)
3235 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003236 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003237 elif dif < 0:
3238 opb = opb[-context.prec:]
3239 return opa, opb
3240
3241 def logical_and(self, other, context=None):
3242 """Applies an 'and' operation between self and other's digits."""
3243 if context is None:
3244 context = getcontext()
3245 if not self._islogical() or not other._islogical():
3246 return context._raise_error(InvalidOperation)
3247
3248 # fill to context.prec
3249 (opa, opb) = self._fill_logical(context, self._int, other._int)
3250
3251 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003252 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3253 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003254
3255 def logical_invert(self, context=None):
3256 """Invert all its digits."""
3257 if context is None:
3258 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003259 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3260 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003261
3262 def logical_or(self, other, context=None):
3263 """Applies an 'or' operation between self and other's digits."""
3264 if context is None:
3265 context = getcontext()
3266 if not self._islogical() or not other._islogical():
3267 return context._raise_error(InvalidOperation)
3268
3269 # fill to context.prec
3270 (opa, opb) = self._fill_logical(context, self._int, other._int)
3271
3272 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003273 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003274 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003275
3276 def logical_xor(self, other, context=None):
3277 """Applies an 'xor' operation between self and other's digits."""
3278 if context is None:
3279 context = getcontext()
3280 if not self._islogical() or not other._islogical():
3281 return context._raise_error(InvalidOperation)
3282
3283 # fill to context.prec
3284 (opa, opb) = self._fill_logical(context, self._int, other._int)
3285
3286 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003287 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003288 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003289
3290 def max_mag(self, other, context=None):
3291 """Compares the values numerically with their sign ignored."""
3292 other = _convert_other(other, raiseit=True)
3293
3294 if context is None:
3295 context = getcontext()
3296
3297 if self._is_special or other._is_special:
3298 # If one operand is a quiet NaN and the other is number, then the
3299 # number is always returned
3300 sn = self._isnan()
3301 on = other._isnan()
3302 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003303 if on == 1 and sn == 0:
3304 return self._fix(context)
3305 if sn == 1 and on == 0:
3306 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003307 return self._check_nans(other, context)
3308
Christian Heimes77c02eb2008-02-09 02:18:51 +00003309 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003310 if c == 0:
3311 c = self.compare_total(other)
3312
3313 if c == -1:
3314 ans = other
3315 else:
3316 ans = self
3317
Christian Heimes2c181612007-12-17 20:04:13 +00003318 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003319
3320 def min_mag(self, other, context=None):
3321 """Compares the values numerically with their sign ignored."""
3322 other = _convert_other(other, raiseit=True)
3323
3324 if context is None:
3325 context = getcontext()
3326
3327 if self._is_special or other._is_special:
3328 # If one operand is a quiet NaN and the other is number, then the
3329 # number is always returned
3330 sn = self._isnan()
3331 on = other._isnan()
3332 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003333 if on == 1 and sn == 0:
3334 return self._fix(context)
3335 if sn == 1 and on == 0:
3336 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003337 return self._check_nans(other, context)
3338
Christian Heimes77c02eb2008-02-09 02:18:51 +00003339 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003340 if c == 0:
3341 c = self.compare_total(other)
3342
3343 if c == -1:
3344 ans = self
3345 else:
3346 ans = other
3347
Christian Heimes2c181612007-12-17 20:04:13 +00003348 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003349
3350 def next_minus(self, context=None):
3351 """Returns the largest representable number smaller than itself."""
3352 if context is None:
3353 context = getcontext()
3354
3355 ans = self._check_nans(context=context)
3356 if ans:
3357 return ans
3358
3359 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003360 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003361 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003362 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003363
3364 context = context.copy()
3365 context._set_rounding(ROUND_FLOOR)
3366 context._ignore_all_flags()
3367 new_self = self._fix(context)
3368 if new_self != self:
3369 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003370 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3371 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003372
3373 def next_plus(self, context=None):
3374 """Returns the smallest representable number larger than itself."""
3375 if context is None:
3376 context = getcontext()
3377
3378 ans = self._check_nans(context=context)
3379 if ans:
3380 return ans
3381
3382 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003383 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003384 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003385 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003386
3387 context = context.copy()
3388 context._set_rounding(ROUND_CEILING)
3389 context._ignore_all_flags()
3390 new_self = self._fix(context)
3391 if new_self != self:
3392 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003393 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3394 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003395
3396 def next_toward(self, other, context=None):
3397 """Returns the number closest to self, in the direction towards other.
3398
3399 The result is the closest representable number to self
3400 (excluding self) that is in the direction towards other,
3401 unless both have the same value. If the two operands are
3402 numerically equal, then the result is a copy of self with the
3403 sign set to be the same as the sign of other.
3404 """
3405 other = _convert_other(other, raiseit=True)
3406
3407 if context is None:
3408 context = getcontext()
3409
3410 ans = self._check_nans(other, context)
3411 if ans:
3412 return ans
3413
Christian Heimes77c02eb2008-02-09 02:18:51 +00003414 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003415 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003416 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003417
3418 if comparison == -1:
3419 ans = self.next_plus(context)
3420 else: # comparison == 1
3421 ans = self.next_minus(context)
3422
3423 # decide which flags to raise using value of ans
3424 if ans._isinfinity():
3425 context._raise_error(Overflow,
3426 'Infinite result from next_toward',
3427 ans._sign)
3428 context._raise_error(Rounded)
3429 context._raise_error(Inexact)
3430 elif ans.adjusted() < context.Emin:
3431 context._raise_error(Underflow)
3432 context._raise_error(Subnormal)
3433 context._raise_error(Rounded)
3434 context._raise_error(Inexact)
3435 # if precision == 1 then we don't raise Clamped for a
3436 # result 0E-Etiny.
3437 if not ans:
3438 context._raise_error(Clamped)
3439
3440 return ans
3441
3442 def number_class(self, context=None):
3443 """Returns an indication of the class of self.
3444
3445 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003446 sNaN
3447 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003448 -Infinity
3449 -Normal
3450 -Subnormal
3451 -Zero
3452 +Zero
3453 +Subnormal
3454 +Normal
3455 +Infinity
3456 """
3457 if self.is_snan():
3458 return "sNaN"
3459 if self.is_qnan():
3460 return "NaN"
3461 inf = self._isinfinity()
3462 if inf == 1:
3463 return "+Infinity"
3464 if inf == -1:
3465 return "-Infinity"
3466 if self.is_zero():
3467 if self._sign:
3468 return "-Zero"
3469 else:
3470 return "+Zero"
3471 if context is None:
3472 context = getcontext()
3473 if self.is_subnormal(context=context):
3474 if self._sign:
3475 return "-Subnormal"
3476 else:
3477 return "+Subnormal"
3478 # just a normal, regular, boring number, :)
3479 if self._sign:
3480 return "-Normal"
3481 else:
3482 return "+Normal"
3483
3484 def radix(self):
3485 """Just returns 10, as this is Decimal, :)"""
3486 return Decimal(10)
3487
3488 def rotate(self, other, context=None):
3489 """Returns a rotated copy of self, value-of-other times."""
3490 if context is None:
3491 context = getcontext()
3492
3493 ans = self._check_nans(other, context)
3494 if ans:
3495 return ans
3496
3497 if other._exp != 0:
3498 return context._raise_error(InvalidOperation)
3499 if not (-context.prec <= int(other) <= context.prec):
3500 return context._raise_error(InvalidOperation)
3501
3502 if self._isinfinity():
3503 return Decimal(self)
3504
3505 # get values, pad if necessary
3506 torot = int(other)
3507 rotdig = self._int
3508 topad = context.prec - len(rotdig)
3509 if topad:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003510 rotdig = '0'*topad + rotdig
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003511
3512 # let's rotate!
3513 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003514 return _dec_from_triple(self._sign,
3515 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003516
3517 def scaleb (self, other, context=None):
3518 """Returns self operand after adding the second value to its exp."""
3519 if context is None:
3520 context = getcontext()
3521
3522 ans = self._check_nans(other, context)
3523 if ans:
3524 return ans
3525
3526 if other._exp != 0:
3527 return context._raise_error(InvalidOperation)
3528 liminf = -2 * (context.Emax + context.prec)
3529 limsup = 2 * (context.Emax + context.prec)
3530 if not (liminf <= int(other) <= limsup):
3531 return context._raise_error(InvalidOperation)
3532
3533 if self._isinfinity():
3534 return Decimal(self)
3535
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003536 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003537 d = d._fix(context)
3538 return d
3539
3540 def shift(self, other, context=None):
3541 """Returns a shifted copy of self, value-of-other times."""
3542 if context is None:
3543 context = getcontext()
3544
3545 ans = self._check_nans(other, context)
3546 if ans:
3547 return ans
3548
3549 if other._exp != 0:
3550 return context._raise_error(InvalidOperation)
3551 if not (-context.prec <= int(other) <= context.prec):
3552 return context._raise_error(InvalidOperation)
3553
3554 if self._isinfinity():
3555 return Decimal(self)
3556
3557 # get values, pad if necessary
3558 torot = int(other)
3559 if not torot:
3560 return Decimal(self)
3561 rotdig = self._int
3562 topad = context.prec - len(rotdig)
3563 if topad:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003564 rotdig = '0'*topad + rotdig
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003565
3566 # let's shift!
3567 if torot < 0:
3568 rotated = rotdig[:torot]
3569 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003570 rotated = rotdig + '0'*torot
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003571 rotated = rotated[-context.prec:]
3572
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003573 return _dec_from_triple(self._sign,
3574 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003575
Guido van Rossumd8faa362007-04-27 19:54:29 +00003576 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003577 def __reduce__(self):
3578 return (self.__class__, (str(self),))
3579
3580 def __copy__(self):
3581 if type(self) == Decimal:
3582 return self # I'm immutable; therefore I am my own clone
3583 return self.__class__(str(self))
3584
3585 def __deepcopy__(self, memo):
3586 if type(self) == Decimal:
3587 return self # My components are also immutable
3588 return self.__class__(str(self))
3589
Mark Dickinson79f52032009-03-17 23:12:51 +00003590 # PEP 3101 support. the _localeconv keyword argument should be
3591 # considered private: it's provided for ease of testing only.
3592 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003593 """Format a Decimal instance according to the given specifier.
3594
3595 The specifier should be a standard format specifier, with the
3596 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003597 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3598 type is omitted it defaults to 'g' or 'G', depending on the
3599 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003600 """
3601
3602 # Note: PEP 3101 says that if the type is not present then
3603 # there should be at least one digit after the decimal point.
3604 # We take the liberty of ignoring this requirement for
3605 # Decimal---it's presumably there to make sure that
3606 # format(float, '') behaves similarly to str(float).
3607 if context is None:
3608 context = getcontext()
3609
Mark Dickinson79f52032009-03-17 23:12:51 +00003610 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003611
Mark Dickinson79f52032009-03-17 23:12:51 +00003612 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003613 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003614 sign = _format_sign(self._sign, spec)
3615 body = str(self.copy_abs())
3616 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003617
3618 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003619 if spec['type'] is None:
3620 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003621
3622 # if type is '%', adjust exponent of self accordingly
3623 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003624 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3625
3626 # round if necessary, taking rounding mode from the context
3627 rounding = context.rounding
3628 precision = spec['precision']
3629 if precision is not None:
3630 if spec['type'] in 'eE':
3631 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003632 elif spec['type'] in 'fF%':
3633 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003634 elif spec['type'] in 'gG' and len(self._int) > precision:
3635 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003636 # special case: zeros with a positive exponent can't be
3637 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003638 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003639 self = self._rescale(0, rounding)
3640
3641 # figure out placement of the decimal point
3642 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003643 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003644 if not self and precision is not None:
3645 dotplace = 1 - precision
3646 else:
3647 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003648 elif spec['type'] in 'fF%':
3649 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003650 elif spec['type'] in 'gG':
3651 if self._exp <= 0 and leftdigits > -6:
3652 dotplace = leftdigits
3653 else:
3654 dotplace = 1
3655
Mark Dickinson79f52032009-03-17 23:12:51 +00003656 # find digits before and after decimal point, and get exponent
3657 if dotplace < 0:
3658 intpart = '0'
3659 fracpart = '0'*(-dotplace) + self._int
3660 elif dotplace > len(self._int):
3661 intpart = self._int + '0'*(dotplace-len(self._int))
3662 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003663 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003664 intpart = self._int[:dotplace] or '0'
3665 fracpart = self._int[dotplace:]
3666 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003667
Mark Dickinson79f52032009-03-17 23:12:51 +00003668 # done with the decimal-specific stuff; hand over the rest
3669 # of the formatting to the _format_number function
3670 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003671
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003672def _dec_from_triple(sign, coefficient, exponent, special=False):
3673 """Create a decimal instance directly, without any validation,
3674 normalization (e.g. removal of leading zeros) or argument
3675 conversion.
3676
3677 This function is for *internal use only*.
3678 """
3679
3680 self = object.__new__(Decimal)
3681 self._sign = sign
3682 self._int = coefficient
3683 self._exp = exponent
3684 self._is_special = special
3685
3686 return self
3687
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003688# Register Decimal as a kind of Number (an abstract base class).
3689# However, do not register it as Real (because Decimals are not
3690# interoperable with floats).
3691_numbers.Number.register(Decimal)
3692
3693
Guido van Rossumd8faa362007-04-27 19:54:29 +00003694##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003695
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003696
3697# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003698rounding_functions = [name for name in Decimal.__dict__.keys()
3699 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003700for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003701 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003702 globalname = name[1:].upper()
3703 val = globals()[globalname]
3704 Decimal._pick_rounding_function[val] = name
3705
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003706del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003707
Thomas Wouters89f507f2006-12-13 04:49:30 +00003708class _ContextManager(object):
3709 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003710
Thomas Wouters89f507f2006-12-13 04:49:30 +00003711 Sets a copy of the supplied context in __enter__() and restores
3712 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003713 """
3714 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003715 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003716 def __enter__(self):
3717 self.saved_context = getcontext()
3718 setcontext(self.new_context)
3719 return self.new_context
3720 def __exit__(self, t, v, tb):
3721 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003722
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003723class Context(object):
3724 """Contains the context for a Decimal instance.
3725
3726 Contains:
3727 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003728 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003729 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003730 raised when it is caused. Otherwise, a value is
3731 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003732 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003733 (Whether or not the trap_enabler is set)
3734 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003735 Emin - Minimum exponent
3736 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003737 capitals - If 1, 1*10^1 is printed as 1E+1.
3738 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003739 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003740 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003741
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003742 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003743 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003744 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003745 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003746 _ignored_flags=None):
3747 if flags is None:
3748 flags = []
3749 if _ignored_flags is None:
3750 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003751 if not isinstance(flags, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003752 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerbf440692004-07-10 14:14:37 +00003753 if traps is not None and not isinstance(traps, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003754 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003755 for name, val in locals().items():
3756 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003757 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003758 else:
3759 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003760 del self.self
3761
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003762 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003763 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003764 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003765 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3766 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3767 % vars(self))
3768 names = [f.__name__ for f, v in self.flags.items() if v]
3769 s.append('flags=[' + ', '.join(names) + ']')
3770 names = [t.__name__ for t, v in self.traps.items() if v]
3771 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003772 return ', '.join(s) + ')'
3773
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003774 def clear_flags(self):
3775 """Reset all flags to zero"""
3776 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003777 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003778
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003779 def _shallow_copy(self):
3780 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003781 nc = Context(self.prec, self.rounding, self.traps,
3782 self.flags, self.Emin, self.Emax,
3783 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003784 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003785
3786 def copy(self):
3787 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003788 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003789 self.flags.copy(), self.Emin, self.Emax,
3790 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003791 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003792 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003793
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003794 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003795 """Handles an error
3796
3797 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003798 Otherwise, it sets the flag, then, if the corresponding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003799 trap_enabler is set, it reaises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003800 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003801 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003802 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003803 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003804 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003805 return error().handle(self, *args)
3806
Raymond Hettinger86173da2008-02-01 20:38:12 +00003807 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003808 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003809 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003810 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003811
3812 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003813 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003814 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003815
3816 def _ignore_all_flags(self):
3817 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003818 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003819
3820 def _ignore_flags(self, *flags):
3821 """Ignore the flags, if they are raised"""
3822 # Do not mutate-- This way, copies of a context leave the original
3823 # alone.
3824 self._ignored_flags = (self._ignored_flags + list(flags))
3825 return list(flags)
3826
3827 def _regard_flags(self, *flags):
3828 """Stop ignoring the flags, if they are raised"""
3829 if flags and isinstance(flags[0], (tuple,list)):
3830 flags = flags[0]
3831 for flag in flags:
3832 self._ignored_flags.remove(flag)
3833
Nick Coghland1abd252008-07-15 15:46:38 +00003834 # We inherit object.__hash__, so we must deny this explicitly
3835 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003836
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003837 def Etiny(self):
3838 """Returns Etiny (= Emin - prec + 1)"""
3839 return int(self.Emin - self.prec + 1)
3840
3841 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003842 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003843 return int(self.Emax - self.prec + 1)
3844
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003845 def _set_rounding(self, type):
3846 """Sets the rounding type.
3847
3848 Sets the rounding type, and returns the current (previous)
3849 rounding type. Often used like:
3850
3851 context = context.copy()
3852 # so you don't change the calling context
3853 # if an error occurs in the middle.
3854 rounding = context._set_rounding(ROUND_UP)
3855 val = self.__sub__(other, context=context)
3856 context._set_rounding(rounding)
3857
3858 This will make it round up for that operation.
3859 """
3860 rounding = self.rounding
3861 self.rounding= type
3862 return rounding
3863
Raymond Hettingerfed52962004-07-14 15:41:57 +00003864 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003865 """Creates a new Decimal instance but using self as context.
3866
3867 This method implements the to-number operation of the
3868 IBM Decimal specification."""
3869
3870 if isinstance(num, str) and num != num.strip():
3871 return self._raise_error(ConversionSyntax,
3872 "no trailing or leading whitespace is "
3873 "permitted.")
3874
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003875 d = Decimal(num, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003876 if d._isnan() and len(d._int) > self.prec - self._clamp:
3877 return self._raise_error(ConversionSyntax,
3878 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003879 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003880
Raymond Hettinger771ed762009-01-03 19:20:32 +00003881 def create_decimal_from_float(self, f):
3882 """Creates a new Decimal instance from a float but rounding using self
3883 as the context.
3884
3885 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3886 >>> context.create_decimal_from_float(3.1415926535897932)
3887 Decimal('3.1415')
3888 >>> context = Context(prec=5, traps=[Inexact])
3889 >>> context.create_decimal_from_float(3.1415926535897932)
3890 Traceback (most recent call last):
3891 ...
3892 decimal.Inexact: None
3893
3894 """
3895 d = Decimal.from_float(f) # An exact conversion
3896 return d._fix(self) # Apply the context rounding
3897
Guido van Rossumd8faa362007-04-27 19:54:29 +00003898 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003899 def abs(self, a):
3900 """Returns the absolute value of the operand.
3901
3902 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00003903 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003904 the plus operation on the operand.
3905
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003906 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003907 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003908 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003909 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003910 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003911 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003912 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003913 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003914 """
3915 return a.__abs__(context=self)
3916
3917 def add(self, a, b):
3918 """Return the sum of the two operands.
3919
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003920 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003921 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003922 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003923 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003924 """
3925 return a.__add__(b, context=self)
3926
3927 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003928 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003929
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003930 def canonical(self, a):
3931 """Returns the same Decimal object.
3932
3933 As we do not have different encodings for the same number, the
3934 received object already is in its canonical form.
3935
3936 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003937 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003938 """
3939 return a.canonical(context=self)
3940
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003941 def compare(self, a, b):
3942 """Compares values numerically.
3943
3944 If the signs of the operands differ, a value representing each operand
3945 ('-1' if the operand is less than zero, '0' if the operand is zero or
3946 negative zero, or '1' if the operand is greater than zero) is used in
3947 place of that operand for the comparison instead of the actual
3948 operand.
3949
3950 The comparison is then effected by subtracting the second operand from
3951 the first and then returning a value according to the result of the
3952 subtraction: '-1' if the result is less than zero, '0' if the result is
3953 zero or negative zero, or '1' if the result is greater than zero.
3954
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003955 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003956 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003957 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003958 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003959 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003960 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003961 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003962 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003963 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003964 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003965 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003966 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003967 """
3968 return a.compare(b, context=self)
3969
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003970 def compare_signal(self, a, b):
3971 """Compares the values of the two operands numerically.
3972
3973 It's pretty much like compare(), but all NaNs signal, with signaling
3974 NaNs taking precedence over quiet NaNs.
3975
3976 >>> c = ExtendedContext
3977 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003978 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003979 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003980 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003981 >>> c.flags[InvalidOperation] = 0
3982 >>> print(c.flags[InvalidOperation])
3983 0
3984 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003985 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003986 >>> print(c.flags[InvalidOperation])
3987 1
3988 >>> c.flags[InvalidOperation] = 0
3989 >>> print(c.flags[InvalidOperation])
3990 0
3991 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003992 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003993 >>> print(c.flags[InvalidOperation])
3994 1
3995 """
3996 return a.compare_signal(b, context=self)
3997
3998 def compare_total(self, a, b):
3999 """Compares two operands using their abstract representation.
4000
4001 This is not like the standard compare, which use their numerical
4002 value. Note that a total ordering is defined for all possible abstract
4003 representations.
4004
4005 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004006 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004007 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004008 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004009 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004010 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004011 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004012 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004013 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004014 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004015 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004016 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004017 """
4018 return a.compare_total(b)
4019
4020 def compare_total_mag(self, a, b):
4021 """Compares two operands using their abstract representation ignoring sign.
4022
4023 Like compare_total, but with operand's sign ignored and assumed to be 0.
4024 """
4025 return a.compare_total_mag(b)
4026
4027 def copy_abs(self, a):
4028 """Returns a copy of the operand with the sign set to 0.
4029
4030 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004031 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004032 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004033 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004034 """
4035 return a.copy_abs()
4036
4037 def copy_decimal(self, a):
4038 """Returns a copy of the decimal objet.
4039
4040 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004041 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004042 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004043 Decimal('-1.00')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004044 """
4045 return Decimal(a)
4046
4047 def copy_negate(self, a):
4048 """Returns a copy of the operand with the sign inverted.
4049
4050 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004051 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004052 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004053 Decimal('101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004054 """
4055 return a.copy_negate()
4056
4057 def copy_sign(self, a, b):
4058 """Copies the second operand's sign to the first one.
4059
4060 In detail, it returns a copy of the first operand with the sign
4061 equal to the sign of the second operand.
4062
4063 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004064 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004065 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004066 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004067 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004068 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004069 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004070 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004071 """
4072 return a.copy_sign(b)
4073
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004074 def divide(self, a, b):
4075 """Decimal division in a specified context.
4076
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004077 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004078 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004079 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004080 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004081 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004082 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004083 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004084 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004085 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004086 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004087 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004088 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004089 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004090 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004091 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004092 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004093 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004094 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004095 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004096 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004097 """
Neal Norwitzbcc0db82006-03-24 08:14:36 +00004098 return a.__truediv__(b, context=self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004099
4100 def divide_int(self, a, b):
4101 """Divides two numbers and returns the integer part of the result.
4102
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004103 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004104 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004105 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004106 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004107 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004108 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004109 """
4110 return a.__floordiv__(b, context=self)
4111
4112 def divmod(self, a, b):
4113 return a.__divmod__(b, context=self)
4114
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004115 def exp(self, a):
4116 """Returns e ** a.
4117
4118 >>> c = ExtendedContext.copy()
4119 >>> c.Emin = -999
4120 >>> c.Emax = 999
4121 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004122 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004123 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004124 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004125 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004126 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004127 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004128 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004129 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004130 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004131 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004132 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004133 """
4134 return a.exp(context=self)
4135
4136 def fma(self, a, b, c):
4137 """Returns a multiplied by b, plus c.
4138
4139 The first two operands are multiplied together, using multiply,
4140 the third operand is then added to the result of that
4141 multiplication, using add, all with only one final rounding.
4142
4143 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004144 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004145 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004146 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004147 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004148 Decimal('1.38435736E+12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004149 """
4150 return a.fma(b, c, context=self)
4151
4152 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004153 """Return True if the operand is canonical; otherwise return False.
4154
4155 Currently, the encoding of a Decimal instance is always
4156 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004157
4158 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004159 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004160 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004161 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004162
4163 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004164 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004165
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004166 A Decimal instance is considered finite if it is neither
4167 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004168
4169 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004170 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004171 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004172 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004173 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004174 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004175 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004176 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004177 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004178 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004179 """
4180 return a.is_finite()
4181
4182 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004183 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004184
4185 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004186 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004187 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004188 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004189 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004190 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004191 """
4192 return a.is_infinite()
4193
4194 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004195 """Return True if the operand is a qNaN or sNaN;
4196 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004197
4198 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004199 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004200 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004201 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004202 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004203 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004204 """
4205 return a.is_nan()
4206
4207 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004208 """Return True if the operand is a normal number;
4209 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004210
4211 >>> c = ExtendedContext.copy()
4212 >>> c.Emin = -999
4213 >>> c.Emax = 999
4214 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004215 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004216 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004217 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004218 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004219 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004220 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004221 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004222 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004223 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004224 """
4225 return a.is_normal(context=self)
4226
4227 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004228 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004229
4230 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004231 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004232 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004233 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004234 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004235 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004236 """
4237 return a.is_qnan()
4238
4239 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004240 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004241
4242 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004243 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004244 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004245 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004246 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004247 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004248 """
4249 return a.is_signed()
4250
4251 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004252 """Return True if the operand is a signaling NaN;
4253 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004254
4255 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004256 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004257 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004258 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004259 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004260 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004261 """
4262 return a.is_snan()
4263
4264 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004265 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004266
4267 >>> c = ExtendedContext.copy()
4268 >>> c.Emin = -999
4269 >>> c.Emax = 999
4270 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004271 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004272 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004273 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004274 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004275 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004276 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004277 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004278 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004279 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004280 """
4281 return a.is_subnormal(context=self)
4282
4283 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004284 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004285
4286 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004287 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004288 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004289 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004290 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004291 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004292 """
4293 return a.is_zero()
4294
4295 def ln(self, a):
4296 """Returns the natural (base e) logarithm of the operand.
4297
4298 >>> c = ExtendedContext.copy()
4299 >>> c.Emin = -999
4300 >>> c.Emax = 999
4301 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004302 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004303 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004304 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004305 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004306 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004307 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004308 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004309 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004310 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004311 """
4312 return a.ln(context=self)
4313
4314 def log10(self, a):
4315 """Returns the base 10 logarithm of the operand.
4316
4317 >>> c = ExtendedContext.copy()
4318 >>> c.Emin = -999
4319 >>> c.Emax = 999
4320 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004321 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004322 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004323 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004324 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004325 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004326 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004327 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004328 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004329 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004330 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004331 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004332 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004333 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004334 """
4335 return a.log10(context=self)
4336
4337 def logb(self, a):
4338 """ Returns the exponent of the magnitude of the operand's MSD.
4339
4340 The result is the integer which is the exponent of the magnitude
4341 of the most significant digit of the operand (as though the
4342 operand were truncated to a single digit while maintaining the
4343 value of that digit and without limiting the resulting exponent).
4344
4345 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004346 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004347 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004348 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004349 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004350 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004351 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004352 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004353 """
4354 return a.logb(context=self)
4355
4356 def logical_and(self, a, b):
4357 """Applies the logical operation 'and' between each operand's digits.
4358
4359 The operands must be both logical numbers.
4360
4361 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004362 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004363 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004364 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004365 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004366 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004367 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004368 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004369 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004370 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004371 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004372 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004373 """
4374 return a.logical_and(b, context=self)
4375
4376 def logical_invert(self, a):
4377 """Invert all the digits in the operand.
4378
4379 The operand must be a logical number.
4380
4381 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004382 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004383 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004384 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004385 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004386 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004387 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004388 Decimal('10101010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004389 """
4390 return a.logical_invert(context=self)
4391
4392 def logical_or(self, a, b):
4393 """Applies the logical operation 'or' between each operand's digits.
4394
4395 The operands must be both logical numbers.
4396
4397 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004398 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004399 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004400 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004401 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004402 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004403 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004404 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004405 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004406 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004407 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004408 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004409 """
4410 return a.logical_or(b, context=self)
4411
4412 def logical_xor(self, a, b):
4413 """Applies the logical operation 'xor' between each operand's digits.
4414
4415 The operands must be both logical numbers.
4416
4417 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004418 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004419 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004420 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004421 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004422 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004423 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004424 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004425 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004426 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004427 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004428 Decimal('1101')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004429 """
4430 return a.logical_xor(b, context=self)
4431
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004432 def max(self, a,b):
4433 """max compares two values numerically and returns the maximum.
4434
4435 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004436 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004437 operation. If they are numerically equal then the left-hand operand
4438 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004439 infinity) of the two operands is chosen as the result.
4440
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004441 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004442 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004443 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004444 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004445 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004446 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004447 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004448 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004449 """
4450 return a.max(b, context=self)
4451
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004452 def max_mag(self, a, b):
4453 """Compares the values numerically with their sign ignored."""
4454 return a.max_mag(b, context=self)
4455
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004456 def min(self, a,b):
4457 """min compares two values numerically and returns the minimum.
4458
4459 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004460 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004461 operation. If they are numerically equal then the left-hand operand
4462 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004463 infinity) of the two operands is chosen as the result.
4464
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004465 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004466 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004467 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004468 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004469 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004470 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004471 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004472 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004473 """
4474 return a.min(b, context=self)
4475
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004476 def min_mag(self, a, b):
4477 """Compares the values numerically with their sign ignored."""
4478 return a.min_mag(b, context=self)
4479
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004480 def minus(self, a):
4481 """Minus corresponds to unary prefix minus in Python.
4482
4483 The operation is evaluated using the same rules as subtract; the
4484 operation minus(a) is calculated as subtract('0', a) where the '0'
4485 has the same exponent as the operand.
4486
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004487 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004488 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004489 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004490 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004491 """
4492 return a.__neg__(context=self)
4493
4494 def multiply(self, a, b):
4495 """multiply multiplies two operands.
4496
4497 If either operand is a special value then the general rules apply.
4498 Otherwise, the operands are multiplied together ('long multiplication'),
4499 resulting in a number which may be as long as the sum of the lengths
4500 of the two operands.
4501
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004502 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004503 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004504 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004505 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004506 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004507 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004508 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004509 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004510 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004511 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004512 """
4513 return a.__mul__(b, context=self)
4514
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004515 def next_minus(self, a):
4516 """Returns the largest representable number smaller than a.
4517
4518 >>> c = ExtendedContext.copy()
4519 >>> c.Emin = -999
4520 >>> c.Emax = 999
4521 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004522 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004523 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004524 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004525 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004526 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004527 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004528 Decimal('9.99999999E+999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004529 """
4530 return a.next_minus(context=self)
4531
4532 def next_plus(self, a):
4533 """Returns the smallest representable number larger than a.
4534
4535 >>> c = ExtendedContext.copy()
4536 >>> c.Emin = -999
4537 >>> c.Emax = 999
4538 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004539 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004540 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004541 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004542 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004543 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004544 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004545 Decimal('-9.99999999E+999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004546 """
4547 return a.next_plus(context=self)
4548
4549 def next_toward(self, a, b):
4550 """Returns the number closest to a, in direction towards b.
4551
4552 The result is the closest representable number from the first
4553 operand (but not the first operand) that is in the direction
4554 towards the second operand, unless the operands have the same
4555 value.
4556
4557 >>> c = ExtendedContext.copy()
4558 >>> c.Emin = -999
4559 >>> c.Emax = 999
4560 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004561 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004562 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004563 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004564 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004565 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004566 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004567 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004568 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004569 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004570 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004571 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004572 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004573 Decimal('-0.00')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004574 """
4575 return a.next_toward(b, context=self)
4576
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004577 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004578 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004579
4580 Essentially a plus operation with all trailing zeros removed from the
4581 result.
4582
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004583 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004584 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004585 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004586 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004587 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004588 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004589 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004590 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004591 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004592 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004593 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004594 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004595 """
4596 return a.normalize(context=self)
4597
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004598 def number_class(self, a):
4599 """Returns an indication of the class of the operand.
4600
4601 The class is one of the following strings:
4602 -sNaN
4603 -NaN
4604 -Infinity
4605 -Normal
4606 -Subnormal
4607 -Zero
4608 +Zero
4609 +Subnormal
4610 +Normal
4611 +Infinity
4612
4613 >>> c = Context(ExtendedContext)
4614 >>> c.Emin = -999
4615 >>> c.Emax = 999
4616 >>> c.number_class(Decimal('Infinity'))
4617 '+Infinity'
4618 >>> c.number_class(Decimal('1E-10'))
4619 '+Normal'
4620 >>> c.number_class(Decimal('2.50'))
4621 '+Normal'
4622 >>> c.number_class(Decimal('0.1E-999'))
4623 '+Subnormal'
4624 >>> c.number_class(Decimal('0'))
4625 '+Zero'
4626 >>> c.number_class(Decimal('-0'))
4627 '-Zero'
4628 >>> c.number_class(Decimal('-0.1E-999'))
4629 '-Subnormal'
4630 >>> c.number_class(Decimal('-1E-10'))
4631 '-Normal'
4632 >>> c.number_class(Decimal('-2.50'))
4633 '-Normal'
4634 >>> c.number_class(Decimal('-Infinity'))
4635 '-Infinity'
4636 >>> c.number_class(Decimal('NaN'))
4637 'NaN'
4638 >>> c.number_class(Decimal('-NaN'))
4639 'NaN'
4640 >>> c.number_class(Decimal('sNaN'))
4641 'sNaN'
4642 """
4643 return a.number_class(context=self)
4644
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004645 def plus(self, a):
4646 """Plus corresponds to unary prefix plus in Python.
4647
4648 The operation is evaluated using the same rules as add; the
4649 operation plus(a) is calculated as add('0', a) where the '0'
4650 has the same exponent as the operand.
4651
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004652 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004653 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004654 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004655 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004656 """
4657 return a.__pos__(context=self)
4658
4659 def power(self, a, b, modulo=None):
4660 """Raises a to the power of b, to modulo if given.
4661
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004662 With two arguments, compute a**b. If a is negative then b
4663 must be integral. The result will be inexact unless b is
4664 integral and the result is finite and can be expressed exactly
4665 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004666
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004667 With three arguments, compute (a**b) % modulo. For the
4668 three argument form, the following restrictions on the
4669 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004670
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004671 - all three arguments must be integral
4672 - b must be nonnegative
4673 - at least one of a or b must be nonzero
4674 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004675
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004676 The result of pow(a, b, modulo) is identical to the result
4677 that would be obtained by computing (a**b) % modulo with
4678 unbounded precision, but is computed more efficiently. It is
4679 always exact.
4680
4681 >>> c = ExtendedContext.copy()
4682 >>> c.Emin = -999
4683 >>> c.Emax = 999
4684 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004685 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004686 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004687 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004688 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004689 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004690 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004691 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004692 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004693 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004694 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004695 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004696 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004697 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004698 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004699 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004700 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004701 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004702 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004703 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004704 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004705 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004706 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004707 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004708 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004709 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004710
4711 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004712 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004713 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004714 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004715 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004716 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004717 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004718 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004719 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004720 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004721 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004722 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004723 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004724 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004725 """
4726 return a.__pow__(b, modulo, context=self)
4727
4728 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00004729 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004730
4731 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00004732 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004733 exponent is being increased), multiplied by a positive power of ten (if
4734 the exponent is being decreased), or is unchanged (if the exponent is
4735 already equal to that of the right-hand operand).
4736
4737 Unlike other operations, if the length of the coefficient after the
4738 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00004739 operation condition is raised. This guarantees that, unless there is
4740 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004741 equal to that of the right-hand operand.
4742
4743 Also unlike other operations, quantize will never raise Underflow, even
4744 if the result is subnormal and inexact.
4745
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004746 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004747 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004748 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004749 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004750 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004751 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004752 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004753 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004754 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004755 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004756 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004757 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004758 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004759 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004760 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004761 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004762 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004763 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004764 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004765 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004766 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004767 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004768 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004769 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004770 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004771 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004772 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004773 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004774 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004775 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004776 """
4777 return a.quantize(b, context=self)
4778
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004779 def radix(self):
4780 """Just returns 10, as this is Decimal, :)
4781
4782 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004783 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004784 """
4785 return Decimal(10)
4786
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004787 def remainder(self, a, b):
4788 """Returns the remainder from integer division.
4789
4790 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00004791 calculating integer division as described for divide-integer, rounded
4792 to precision digits if necessary. The sign of the result, if
4793 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004794
4795 This operation will fail under the same conditions as integer division
4796 (that is, if integer division on the same two operands would fail, the
4797 remainder cannot be calculated).
4798
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004799 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004800 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004801 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004802 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004803 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004804 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004805 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004806 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004807 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004808 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004809 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004810 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004811 """
4812 return a.__mod__(b, context=self)
4813
4814 def remainder_near(self, a, b):
4815 """Returns to be "a - b * n", where n is the integer nearest the exact
4816 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00004817 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004818 sign of a.
4819
4820 This operation will fail under the same conditions as integer division
4821 (that is, if integer division on the same two operands would fail, the
4822 remainder cannot be calculated).
4823
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004824 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004825 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004826 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004827 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004828 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004829 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004830 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004831 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004832 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004833 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004834 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004835 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004836 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004837 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004838 """
4839 return a.remainder_near(b, context=self)
4840
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004841 def rotate(self, a, b):
4842 """Returns a rotated copy of a, b times.
4843
4844 The coefficient of the result is a rotated copy of the digits in
4845 the coefficient of the first operand. The number of places of
4846 rotation is taken from the absolute value of the second operand,
4847 with the rotation being to the left if the second operand is
4848 positive or to the right otherwise.
4849
4850 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004851 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004852 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004853 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004854 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004855 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004856 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004857 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004858 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004859 Decimal('345678912')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004860 """
4861 return a.rotate(b, context=self)
4862
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004863 def same_quantum(self, a, b):
4864 """Returns True if the two operands have the same exponent.
4865
4866 The result is never affected by either the sign or the coefficient of
4867 either operand.
4868
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004869 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004870 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004871 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004872 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004873 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004874 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004875 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004876 True
4877 """
4878 return a.same_quantum(b)
4879
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004880 def scaleb (self, a, b):
4881 """Returns the first operand after adding the second value its exp.
4882
4883 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004884 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004885 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004886 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004887 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004888 Decimal('7.50E+3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004889 """
4890 return a.scaleb (b, context=self)
4891
4892 def shift(self, a, b):
4893 """Returns a shifted copy of a, b times.
4894
4895 The coefficient of the result is a shifted copy of the digits
4896 in the coefficient of the first operand. The number of places
4897 to shift is taken from the absolute value of the second operand,
4898 with the shift being to the left if the second operand is
4899 positive or to the right otherwise. Digits shifted into the
4900 coefficient are zeros.
4901
4902 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004903 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004904 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004905 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004906 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004907 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004908 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004909 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004910 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004911 Decimal('345678900')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004912 """
4913 return a.shift(b, context=self)
4914
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004915 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00004916 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004917
4918 If the result must be inexact, it is rounded using the round-half-even
4919 algorithm.
4920
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004921 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004922 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004923 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004924 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004925 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004926 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004927 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004928 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004929 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004930 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004931 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004932 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004933 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004934 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004935 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004936 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004937 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004938 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004939 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00004940 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004941 """
4942 return a.sqrt(context=self)
4943
4944 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00004945 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004946
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004947 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004948 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004949 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004950 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004951 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004952 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004953 """
4954 return a.__sub__(b, context=self)
4955
4956 def to_eng_string(self, a):
4957 """Converts a number to a string, using scientific notation.
4958
4959 The operation is not affected by the context.
4960 """
4961 return a.to_eng_string(context=self)
4962
4963 def to_sci_string(self, a):
4964 """Converts a number to a string, using scientific notation.
4965
4966 The operation is not affected by the context.
4967 """
4968 return a.__str__(context=self)
4969
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004970 def to_integral_exact(self, a):
4971 """Rounds to an integer.
4972
4973 When the operand has a negative exponent, the result is the same
4974 as using the quantize() operation using the given operand as the
4975 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
4976 of the operand as the precision setting; Inexact and Rounded flags
4977 are allowed in this operation. The rounding mode is taken from the
4978 context.
4979
4980 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004981 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004982 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004983 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004984 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004985 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004986 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004987 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004988 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004989 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004990 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004991 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004992 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004993 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004994 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004995 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004996 """
4997 return a.to_integral_exact(context=self)
4998
4999 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005000 """Rounds to an integer.
5001
5002 When the operand has a negative exponent, the result is the same
5003 as using the quantize() operation using the given operand as the
5004 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5005 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00005006 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005007
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005008 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005009 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005010 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005011 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005012 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005013 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005014 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005015 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005016 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005017 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005018 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005019 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005020 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005021 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005022 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005023 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005024 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005025 return a.to_integral_value(context=self)
5026
5027 # the method name changed, but we provide also the old one, for compatibility
5028 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005029
5030class _WorkRep(object):
5031 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005032 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005033 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005034 # exp: None, int, or string
5035
5036 def __init__(self, value=None):
5037 if value is None:
5038 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005039 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005040 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005041 elif isinstance(value, Decimal):
5042 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005043 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005044 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005045 else:
5046 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005047 self.sign = value[0]
5048 self.int = value[1]
5049 self.exp = value[2]
5050
5051 def __repr__(self):
5052 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5053
5054 __str__ = __repr__
5055
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005056
5057
Christian Heimes2c181612007-12-17 20:04:13 +00005058def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005059 """Normalizes op1, op2 to have the same exp and length of coefficient.
5060
5061 Done during addition.
5062 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005063 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005064 tmp = op2
5065 other = op1
5066 else:
5067 tmp = op1
5068 other = op2
5069
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005070 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5071 # Then adding 10**exp to tmp has the same effect (after rounding)
5072 # as adding any positive quantity smaller than 10**exp; similarly
5073 # for subtraction. So if other is smaller than 10**exp we replace
5074 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00005075 tmp_len = len(str(tmp.int))
5076 other_len = len(str(other.int))
5077 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5078 if other_len + other.exp - 1 < exp:
5079 other.int = 1
5080 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005081
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005082 tmp.int *= 10 ** (tmp.exp - other.exp)
5083 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005084 return op1, op2
5085
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005086##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005087
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005088# This function from Tim Peters was taken from here:
5089# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5090# The correction being in the function definition is for speed, and
5091# the whole function is not resolved with math.log because of avoiding
5092# the use of floats.
5093def _nbits(n, correction = {
5094 '0': 4, '1': 3, '2': 2, '3': 2,
5095 '4': 1, '5': 1, '6': 1, '7': 1,
5096 '8': 0, '9': 0, 'a': 0, 'b': 0,
5097 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5098 """Number of bits in binary representation of the positive integer n,
5099 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005100 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005101 if n < 0:
5102 raise ValueError("The argument to _nbits should be nonnegative.")
5103 hex_n = "%x" % n
5104 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005105
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005106def _sqrt_nearest(n, a):
5107 """Closest integer to the square root of the positive integer n. a is
5108 an initial approximation to the square root. Any positive integer
5109 will do for a, but the closer a is to the square root of n the
5110 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005111
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005112 """
5113 if n <= 0 or a <= 0:
5114 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5115
5116 b=0
5117 while a != b:
5118 b, a = a, a--n//a>>1
5119 return a
5120
5121def _rshift_nearest(x, shift):
5122 """Given an integer x and a nonnegative integer shift, return closest
5123 integer to x / 2**shift; use round-to-even in case of a tie.
5124
5125 """
5126 b, q = 1 << shift, x >> shift
5127 return q + (2*(x & (b-1)) + (q&1) > b)
5128
5129def _div_nearest(a, b):
5130 """Closest integer to a/b, a and b positive integers; rounds to even
5131 in the case of a tie.
5132
5133 """
5134 q, r = divmod(a, b)
5135 return q + (2*r + (q&1) > b)
5136
5137def _ilog(x, M, L = 8):
5138 """Integer approximation to M*log(x/M), with absolute error boundable
5139 in terms only of x/M.
5140
5141 Given positive integers x and M, return an integer approximation to
5142 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5143 between the approximation and the exact result is at most 22. For
5144 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5145 both cases these are upper bounds on the error; it will usually be
5146 much smaller."""
5147
5148 # The basic algorithm is the following: let log1p be the function
5149 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5150 # the reduction
5151 #
5152 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5153 #
5154 # repeatedly until the argument to log1p is small (< 2**-L in
5155 # absolute value). For small y we can use the Taylor series
5156 # expansion
5157 #
5158 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5159 #
5160 # truncating at T such that y**T is small enough. The whole
5161 # computation is carried out in a form of fixed-point arithmetic,
5162 # with a real number z being represented by an integer
5163 # approximation to z*M. To avoid loss of precision, the y below
5164 # is actually an integer approximation to 2**R*y*M, where R is the
5165 # number of reductions performed so far.
5166
5167 y = x-M
5168 # argument reduction; R = number of reductions performed
5169 R = 0
5170 while (R <= L and abs(y) << L-R >= M or
5171 R > L and abs(y) >> R-L >= M):
5172 y = _div_nearest((M*y) << 1,
5173 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5174 R += 1
5175
5176 # Taylor series with T terms
5177 T = -int(-10*len(str(M))//(3*L))
5178 yshift = _rshift_nearest(y, R)
5179 w = _div_nearest(M, T)
5180 for k in range(T-1, 0, -1):
5181 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5182
5183 return _div_nearest(w*y, M)
5184
5185def _dlog10(c, e, p):
5186 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5187 approximation to 10**p * log10(c*10**e), with an absolute error of
5188 at most 1. Assumes that c*10**e is not exactly 1."""
5189
5190 # increase precision by 2; compensate for this by dividing
5191 # final result by 100
5192 p += 2
5193
5194 # write c*10**e as d*10**f with either:
5195 # f >= 0 and 1 <= d <= 10, or
5196 # f <= 0 and 0.1 <= d <= 1.
5197 # Thus for c*10**e close to 1, f = 0
5198 l = len(str(c))
5199 f = e+l - (e+l >= 1)
5200
5201 if p > 0:
5202 M = 10**p
5203 k = e+p-f
5204 if k >= 0:
5205 c *= 10**k
5206 else:
5207 c = _div_nearest(c, 10**-k)
5208
5209 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005210 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005211 log_d = _div_nearest(log_d*M, log_10)
5212 log_tenpower = f*M # exact
5213 else:
5214 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005215 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005216
5217 return _div_nearest(log_tenpower+log_d, 100)
5218
5219def _dlog(c, e, p):
5220 """Given integers c, e and p with c > 0, compute an integer
5221 approximation to 10**p * log(c*10**e), with an absolute error of
5222 at most 1. Assumes that c*10**e is not exactly 1."""
5223
5224 # Increase precision by 2. The precision increase is compensated
5225 # for at the end with a division by 100.
5226 p += 2
5227
5228 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5229 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5230 # as 10**p * log(d) + 10**p*f * log(10).
5231 l = len(str(c))
5232 f = e+l - (e+l >= 1)
5233
5234 # compute approximation to 10**p*log(d), with error < 27
5235 if p > 0:
5236 k = e+p-f
5237 if k >= 0:
5238 c *= 10**k
5239 else:
5240 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5241
5242 # _ilog magnifies existing error in c by a factor of at most 10
5243 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5244 else:
5245 # p <= 0: just approximate the whole thing by 0; error < 2.31
5246 log_d = 0
5247
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005248 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005249 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005250 extra = len(str(abs(f)))-1
5251 if p + extra >= 0:
5252 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5253 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5254 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005255 else:
5256 f_log_ten = 0
5257 else:
5258 f_log_ten = 0
5259
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005260 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005261 return _div_nearest(f_log_ten + log_d, 100)
5262
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005263class _Log10Memoize(object):
5264 """Class to compute, store, and allow retrieval of, digits of the
5265 constant log(10) = 2.302585.... This constant is needed by
5266 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5267 def __init__(self):
5268 self.digits = "23025850929940456840179914546843642076011014886"
5269
5270 def getdigits(self, p):
5271 """Given an integer p >= 0, return floor(10**p)*log(10).
5272
5273 For example, self.getdigits(3) returns 2302.
5274 """
5275 # digits are stored as a string, for quick conversion to
5276 # integer in the case that we've already computed enough
5277 # digits; the stored digits should always be correct
5278 # (truncated, not rounded to nearest).
5279 if p < 0:
5280 raise ValueError("p should be nonnegative")
5281
5282 if p >= len(self.digits):
5283 # compute p+3, p+6, p+9, ... digits; continue until at
5284 # least one of the extra digits is nonzero
5285 extra = 3
5286 while True:
5287 # compute p+extra digits, correct to within 1ulp
5288 M = 10**(p+extra+2)
5289 digits = str(_div_nearest(_ilog(10*M, M), 100))
5290 if digits[-extra:] != '0'*extra:
5291 break
5292 extra += 3
5293 # keep all reliable digits so far; remove trailing zeros
5294 # and next nonzero digit
5295 self.digits = digits.rstrip('0')[:-1]
5296 return int(self.digits[:p+1])
5297
5298_log10_digits = _Log10Memoize().getdigits
5299
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005300def _iexp(x, M, L=8):
5301 """Given integers x and M, M > 0, such that x/M is small in absolute
5302 value, compute an integer approximation to M*exp(x/M). For 0 <=
5303 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5304 is usually much smaller)."""
5305
5306 # Algorithm: to compute exp(z) for a real number z, first divide z
5307 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5308 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5309 # series
5310 #
5311 # expm1(x) = x + x**2/2! + x**3/3! + ...
5312 #
5313 # Now use the identity
5314 #
5315 # expm1(2x) = expm1(x)*(expm1(x)+2)
5316 #
5317 # R times to compute the sequence expm1(z/2**R),
5318 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5319
5320 # Find R such that x/2**R/M <= 2**-L
5321 R = _nbits((x<<L)//M)
5322
5323 # Taylor series. (2**L)**T > M
5324 T = -int(-10*len(str(M))//(3*L))
5325 y = _div_nearest(x, T)
5326 Mshift = M<<R
5327 for i in range(T-1, 0, -1):
5328 y = _div_nearest(x*(Mshift + y), Mshift * i)
5329
5330 # Expansion
5331 for k in range(R-1, -1, -1):
5332 Mshift = M<<(k+2)
5333 y = _div_nearest(y*(y+Mshift), Mshift)
5334
5335 return M+y
5336
5337def _dexp(c, e, p):
5338 """Compute an approximation to exp(c*10**e), with p decimal places of
5339 precision.
5340
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005341 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005342
5343 10**(p-1) <= d <= 10**p, and
5344 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5345
5346 In other words, d*10**f is an approximation to exp(c*10**e) with p
5347 digits of precision, and with an error in d of at most 1. This is
5348 almost, but not quite, the same as the error being < 1ulp: when d
5349 = 10**(p-1) the error could be up to 10 ulp."""
5350
5351 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5352 p += 2
5353
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005354 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005355 extra = max(0, e + len(str(c)) - 1)
5356 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005357
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005358 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005359 # rounding down
5360 shift = e+q
5361 if shift >= 0:
5362 cshift = c*10**shift
5363 else:
5364 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005365 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005366
5367 # reduce remainder back to original precision
5368 rem = _div_nearest(rem, 10**extra)
5369
5370 # error in result of _iexp < 120; error after division < 0.62
5371 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5372
5373def _dpower(xc, xe, yc, ye, p):
5374 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5375 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5376
5377 10**(p-1) <= c <= 10**p, and
5378 (c-1)*10**e < x**y < (c+1)*10**e
5379
5380 in other words, c*10**e is an approximation to x**y with p digits
5381 of precision, and with an error in c of at most 1. (This is
5382 almost, but not quite, the same as the error being < 1ulp: when c
5383 == 10**(p-1) we can only guarantee error < 10ulp.)
5384
5385 We assume that: x is positive and not equal to 1, and y is nonzero.
5386 """
5387
5388 # Find b such that 10**(b-1) <= |y| <= 10**b
5389 b = len(str(abs(yc))) + ye
5390
5391 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5392 lxc = _dlog(xc, xe, p+b+1)
5393
5394 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5395 shift = ye-b
5396 if shift >= 0:
5397 pc = lxc*yc*10**shift
5398 else:
5399 pc = _div_nearest(lxc*yc, 10**-shift)
5400
5401 if pc == 0:
5402 # we prefer a result that isn't exactly 1; this makes it
5403 # easier to compute a correctly rounded result in __pow__
5404 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5405 coeff, exp = 10**(p-1)+1, 1-p
5406 else:
5407 coeff, exp = 10**p-1, -p
5408 else:
5409 coeff, exp = _dexp(pc, -(p+1), p+1)
5410 coeff = _div_nearest(coeff, 10)
5411 exp += 1
5412
5413 return coeff, exp
5414
5415def _log10_lb(c, correction = {
5416 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5417 '6': 23, '7': 16, '8': 10, '9': 5}):
5418 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5419 if c <= 0:
5420 raise ValueError("The argument to _log10_lb should be nonnegative.")
5421 str_c = str(c)
5422 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005423
Guido van Rossumd8faa362007-04-27 19:54:29 +00005424##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005425
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005426def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005427 """Convert other to Decimal.
5428
5429 Verifies that it's ok to use in an implicit construction.
5430 """
5431 if isinstance(other, Decimal):
5432 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005433 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005434 return Decimal(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005435 if raiseit:
5436 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005437 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005438
Guido van Rossumd8faa362007-04-27 19:54:29 +00005439##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005440
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005441# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005442# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005443
5444DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005445 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005446 traps=[DivisionByZero, Overflow, InvalidOperation],
5447 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005448 Emax=999999999,
5449 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005450 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005451)
5452
5453# Pre-made alternate contexts offered by the specification
5454# Don't change these; the user should be able to select these
5455# contexts and be able to reproduce results from other implementations
5456# of the spec.
5457
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005458BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005459 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005460 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5461 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005462)
5463
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005464ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005465 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005466 traps=[],
5467 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005468)
5469
5470
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005471##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005472#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005473# Regular expression used for parsing numeric strings. Additional
5474# comments:
5475#
5476# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5477# whitespace. But note that the specification disallows whitespace in
5478# a numeric string.
5479#
5480# 2. For finite numbers (not infinities and NaNs) the body of the
5481# number between the optional sign and the optional exponent must have
5482# at least one decimal digit, possibly after the decimal point. The
Antoine Pitroufd036452008-08-19 17:56:33 +00005483# lookahead expression '(?=[0-9]|\.[0-9])' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005484#
5485# As the flag UNICODE is not enabled here, we're explicitly avoiding any
5486# other meaning for \d than the numbers [0-9].
5487
5488import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005489_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005490# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005491 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005492 (
Benjamin Peterson41181742008-07-02 20:22:54 +00005493 (?=[0-9]|\.[0-9]) # ...a number (with at least one digit)
5494 (?P<int>[0-9]*) # having a (possibly empty) integer part
5495 (\.(?P<frac>[0-9]*))? # followed by an optional fractional part
5496 (E(?P<exp>[-+]?[0-9]+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005497 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005498 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005499 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005500 (?P<signal>s)? # ...an (optionally signaling)
5501 NaN # NaN
5502 (?P<diag>[0-9]*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005503 )
5504# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005505 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005506""", re.VERBOSE | re.IGNORECASE).match
5507
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005508_all_zeros = re.compile('0*$').match
5509_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005510
5511##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005512# The functions in this section have little to do with the Decimal
5513# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005514# Python numeric classes that want to implement __format__
5515#
5516# A format specifier for Decimal looks like:
5517#
Mark Dickinson79f52032009-03-17 23:12:51 +00005518# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005519
5520_parse_format_specifier_regex = re.compile(r"""\A
5521(?:
5522 (?P<fill>.)?
5523 (?P<align>[<>=^])
5524)?
5525(?P<sign>[-+ ])?
5526(?P<zeropad>0)?
5527(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00005528(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005529(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00005530(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005531\Z
5532""", re.VERBOSE)
5533
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005534del re
5535
Mark Dickinson79f52032009-03-17 23:12:51 +00005536# The locale module is only needed for the 'n' format specifier. The
5537# rest of the PEP 3101 code functions quite happily without it, so we
5538# don't care too much if locale isn't present.
5539try:
5540 import locale as _locale
5541except ImportError:
5542 pass
5543
5544def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00005545 """Parse and validate a format specifier.
5546
5547 Turns a standard numeric format specifier into a dict, with the
5548 following entries:
5549
5550 fill: fill character to pad field to minimum width
5551 align: alignment type, either '<', '>', '=' or '^'
5552 sign: either '+', '-' or ' '
5553 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00005554 zeropad: boolean, indicating whether to pad with zeros
5555 thousands_sep: string to use as thousands separator, or ''
5556 grouping: grouping for thousands separators, in format
5557 used by localeconv
5558 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00005559 precision: nonnegative integer giving precision, or None
5560 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00005561
5562 """
5563 m = _parse_format_specifier_regex.match(format_spec)
5564 if m is None:
5565 raise ValueError("Invalid format specifier: " + format_spec)
5566
5567 # get the dictionary
5568 format_dict = m.groupdict()
5569
Mark Dickinson79f52032009-03-17 23:12:51 +00005570 # zeropad; defaults for fill and alignment. If zero padding
5571 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00005572 fill = format_dict['fill']
5573 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00005574 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5575 if format_dict['zeropad']:
5576 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005577 raise ValueError("Fill character conflicts with '0'"
5578 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00005579 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005580 raise ValueError("Alignment conflicts with '0' in "
5581 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00005582 format_dict['fill'] = fill or ' '
5583 format_dict['align'] = align or '<'
5584
Mark Dickinson79f52032009-03-17 23:12:51 +00005585 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00005586 if format_dict['sign'] is None:
5587 format_dict['sign'] = '-'
5588
Christian Heimesf16baeb2008-02-29 14:57:44 +00005589 # minimumwidth defaults to 0; precision remains None if not given
5590 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5591 if format_dict['precision'] is not None:
5592 format_dict['precision'] = int(format_dict['precision'])
5593
5594 # if format type is 'g' or 'G' then a precision of 0 makes little
5595 # sense; convert it to 1. Same if format type is unspecified.
5596 if format_dict['precision'] == 0:
5597 if format_dict['type'] in 'gG' or format_dict['type'] is None:
5598 format_dict['precision'] = 1
5599
Mark Dickinson79f52032009-03-17 23:12:51 +00005600 # determine thousands separator, grouping, and decimal separator, and
5601 # add appropriate entries to format_dict
5602 if format_dict['type'] == 'n':
5603 # apart from separators, 'n' behaves just like 'g'
5604 format_dict['type'] = 'g'
5605 if _localeconv is None:
5606 _localeconv = _locale.localeconv()
5607 if format_dict['thousands_sep'] is not None:
5608 raise ValueError("Explicit thousands separator conflicts with "
5609 "'n' type in format specifier: " + format_spec)
5610 format_dict['thousands_sep'] = _localeconv['thousands_sep']
5611 format_dict['grouping'] = _localeconv['grouping']
5612 format_dict['decimal_point'] = _localeconv['decimal_point']
5613 else:
5614 if format_dict['thousands_sep'] is None:
5615 format_dict['thousands_sep'] = ''
5616 format_dict['grouping'] = [3, 0]
5617 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00005618
5619 return format_dict
5620
Mark Dickinson79f52032009-03-17 23:12:51 +00005621def _format_align(sign, body, spec):
5622 """Given an unpadded, non-aligned numeric string 'body' and sign
5623 string 'sign', add padding and aligment conforming to the given
5624 format specifier dictionary 'spec' (as produced by
5625 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00005626
5627 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00005628 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00005629 minimumwidth = spec['minimumwidth']
5630 fill = spec['fill']
5631 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00005632
Mark Dickinson79f52032009-03-17 23:12:51 +00005633 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00005634 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005635 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00005636 elif align == '>':
5637 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00005638 elif align == '=':
5639 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00005640 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005641 half = len(padding)//2
5642 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00005643 else:
5644 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00005645
Christian Heimesf16baeb2008-02-29 14:57:44 +00005646 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005647
Mark Dickinson79f52032009-03-17 23:12:51 +00005648def _group_lengths(grouping):
5649 """Convert a localeconv-style grouping into a (possibly infinite)
5650 iterable of integers representing group lengths.
5651
5652 """
5653 # The result from localeconv()['grouping'], and the input to this
5654 # function, should be a list of integers in one of the
5655 # following three forms:
5656 #
5657 # (1) an empty list, or
5658 # (2) nonempty list of positive integers + [0]
5659 # (3) list of positive integers + [locale.CHAR_MAX], or
5660
5661 from itertools import chain, repeat
5662 if not grouping:
5663 return []
5664 elif grouping[-1] == 0 and len(grouping) >= 2:
5665 return chain(grouping[:-1], repeat(grouping[-2]))
5666 elif grouping[-1] == _locale.CHAR_MAX:
5667 return grouping[:-1]
5668 else:
5669 raise ValueError('unrecognised format for grouping')
5670
5671def _insert_thousands_sep(digits, spec, min_width=1):
5672 """Insert thousands separators into a digit string.
5673
5674 spec is a dictionary whose keys should include 'thousands_sep' and
5675 'grouping'; typically it's the result of parsing the format
5676 specifier using _parse_format_specifier.
5677
5678 The min_width keyword argument gives the minimum length of the
5679 result, which will be padded on the left with zeros if necessary.
5680
5681 If necessary, the zero padding adds an extra '0' on the left to
5682 avoid a leading thousands separator. For example, inserting
5683 commas every three digits in '123456', with min_width=8, gives
5684 '0,123,456', even though that has length 9.
5685
5686 """
5687
5688 sep = spec['thousands_sep']
5689 grouping = spec['grouping']
5690
5691 groups = []
5692 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00005693 if l <= 0:
5694 raise ValueError("group length should be positive")
5695 # max(..., 1) forces at least 1 digit to the left of a separator
5696 l = min(max(len(digits), min_width, 1), l)
5697 groups.append('0'*(l - len(digits)) + digits[-l:])
5698 digits = digits[:-l]
5699 min_width -= l
5700 if not digits and min_width <= 0:
5701 break
Mark Dickinson7303b592009-03-18 08:25:36 +00005702 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00005703 else:
5704 l = max(len(digits), min_width, 1)
5705 groups.append('0'*(l - len(digits)) + digits[-l:])
5706 return sep.join(reversed(groups))
5707
5708def _format_sign(is_negative, spec):
5709 """Determine sign character."""
5710
5711 if is_negative:
5712 return '-'
5713 elif spec['sign'] in ' +':
5714 return spec['sign']
5715 else:
5716 return ''
5717
5718def _format_number(is_negative, intpart, fracpart, exp, spec):
5719 """Format a number, given the following data:
5720
5721 is_negative: true if the number is negative, else false
5722 intpart: string of digits that must appear before the decimal point
5723 fracpart: string of digits that must come after the point
5724 exp: exponent, as an integer
5725 spec: dictionary resulting from parsing the format specifier
5726
5727 This function uses the information in spec to:
5728 insert separators (decimal separator and thousands separators)
5729 format the sign
5730 format the exponent
5731 add trailing '%' for the '%' type
5732 zero-pad if necessary
5733 fill and align if necessary
5734 """
5735
5736 sign = _format_sign(is_negative, spec)
5737
5738 if fracpart:
5739 fracpart = spec['decimal_point'] + fracpart
5740
5741 if exp != 0 or spec['type'] in 'eE':
5742 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
5743 fracpart += "{0}{1:+}".format(echar, exp)
5744 if spec['type'] == '%':
5745 fracpart += '%'
5746
5747 if spec['zeropad']:
5748 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
5749 else:
5750 min_width = 0
5751 intpart = _insert_thousands_sep(intpart, spec, min_width)
5752
5753 return _format_align(sign, intpart+fracpart, spec)
5754
5755
Guido van Rossumd8faa362007-04-27 19:54:29 +00005756##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005757
Guido van Rossumd8faa362007-04-27 19:54:29 +00005758# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005759_Infinity = Decimal('Inf')
5760_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00005761_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005762_Zero = Decimal(0)
5763_One = Decimal(1)
5764_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005765
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005766# _SignedInfinity[sign] is infinity w/ that sign
5767_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005768
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005769
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005770
5771if __name__ == '__main__':
5772 import doctest, sys
5773 doctest.testmod(sys.modules[__name__])