blob: e3fa8cb84fa21ecc21d34bd69447866303b14a7c [file] [log] [blame]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001# Copyright (c) 2004 Python Software Foundation.
2# All rights reserved.
3
4# Written by Eric Price <eprice at tjhsst.edu>
5# and Facundo Batista <facundo at taniquetil.com.ar>
6# and Raymond Hettinger <python at rcn.com>
Fred Drake1f34eb12004-07-01 14:28:36 +00007# and Aahz <aahz at pobox.com>
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00008# and Tim Peters
9
Facundo Batista6ab24792009-02-16 15:41:37 +000010# This module should be kept in sync with the latest updates of the
11# IBM specification as it evolves. Those updates will be treated
Raymond Hettinger27dbcf22004-08-19 22:39:55 +000012# as bug fixes (deviation from the spec is a compatibility, usability
13# bug) and will be backported. At this point the spec is stabilizing
14# and the updates are becoming fewer, smaller, and less significant.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000015
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000016"""
Facundo Batista6ab24792009-02-16 15:41:37 +000017This is an implementation of decimal floating point arithmetic based on
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000018the General Decimal Arithmetic Specification:
19
Raymond Hettinger960dc362009-04-21 03:43:15 +000020 http://speleotrove.com/decimal/decarith.html
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000021
Raymond Hettinger0ea241e2004-07-04 13:53:24 +000022and IEEE standard 854-1987:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000023
24 www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html
25
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000026Decimal floating point has finite precision with arbitrarily large bounds.
27
Guido van Rossumd8faa362007-04-27 19:54:29 +000028The purpose of this module is to support arithmetic using familiar
29"schoolhouse" rules and to avoid some of the tricky representation
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000030issues associated with binary floating point. The package is especially
31useful for financial applications or for contexts where users have
32expectations that are at odds with binary floating point (for instance,
33in binary floating point, 1.00 % 0.1 gives 0.09999999999999995 instead
Christian Heimes68f5fbe2008-02-14 08:27:37 +000034of the expected Decimal('0.00') returned by decimal floating point).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000035
36Here are some examples of using the decimal module:
37
38>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000039>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000040>>> Decimal(0)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000041Decimal('0')
42>>> Decimal('1')
43Decimal('1')
44>>> Decimal('-.0123')
45Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000046>>> Decimal(123456)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000047Decimal('123456')
48>>> Decimal('123.45e12345678901234567890')
49Decimal('1.2345E+12345678901234567892')
50>>> Decimal('1.33') + Decimal('1.27')
51Decimal('2.60')
52>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
53Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000054>>> dig = Decimal(1)
Guido van Rossum7131f842007-02-09 20:13:25 +000055>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000560.333333333
57>>> getcontext().prec = 18
Guido van Rossum7131f842007-02-09 20:13:25 +000058>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000590.333333333333333333
Guido van Rossum7131f842007-02-09 20:13:25 +000060>>> print(dig.sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000611
Guido van Rossum7131f842007-02-09 20:13:25 +000062>>> print(Decimal(3).sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000631.73205080756887729
Guido van Rossum7131f842007-02-09 20:13:25 +000064>>> print(Decimal(3) ** 123)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000654.85192780976896427E+58
66>>> inf = Decimal(1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000067>>> print(inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000068Infinity
69>>> neginf = Decimal(-1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000070>>> print(neginf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000071-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000072>>> print(neginf + inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000073NaN
Guido van Rossum7131f842007-02-09 20:13:25 +000074>>> print(neginf * inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000075-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000076>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000077Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000078>>> getcontext().traps[DivisionByZero] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000079>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000080Traceback (most recent call last):
81 ...
82 ...
83 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +000084decimal.DivisionByZero: x / 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000085>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000086>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000087>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000880
89>>> c.divide(Decimal(0), Decimal(0))
Christian Heimes68f5fbe2008-02-14 08:27:37 +000090Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000091>>> c.traps[InvalidOperation] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000092>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000931
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000094>>> c.flags[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000095>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000960
Guido van Rossum7131f842007-02-09 20:13:25 +000097>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000098Traceback (most recent call last):
99 ...
100 ...
101 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +0000102decimal.InvalidOperation: 0 / 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000103>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001041
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000105>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000106>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000107>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000108NaN
Guido van Rossum7131f842007-02-09 20:13:25 +0000109>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001101
111>>>
112"""
113
114__all__ = [
115 # Two major classes
116 'Decimal', 'Context',
117
118 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000119 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000120
121 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000122 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
123 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000124
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000125 # Constants for use in setting up contexts
126 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000127 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000128
129 # Functions for manipulating contexts
Thomas Wouters89f507f2006-12-13 04:49:30 +0000130 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000131]
132
Raymond Hettinger960dc362009-04-21 03:43:15 +0000133__version__ = '1.70' # Highest version of the spec this complies with
134
Raymond Hettingereb260842005-06-07 18:52:34 +0000135import copy as _copy
Raymond Hettinger771ed762009-01-03 19:20:32 +0000136import math as _math
Raymond Hettinger82417ca2009-02-03 03:54:28 +0000137import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000138
Christian Heimes25bb7832008-01-11 16:17:00 +0000139try:
140 from collections import namedtuple as _namedtuple
141 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
142except ImportError:
143 DecimalTuple = lambda *args: args
144
Guido van Rossumd8faa362007-04-27 19:54:29 +0000145# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000146ROUND_DOWN = 'ROUND_DOWN'
147ROUND_HALF_UP = 'ROUND_HALF_UP'
148ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
149ROUND_CEILING = 'ROUND_CEILING'
150ROUND_FLOOR = 'ROUND_FLOOR'
151ROUND_UP = 'ROUND_UP'
152ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000153ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000154
Guido van Rossumd8faa362007-04-27 19:54:29 +0000155# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000156
157class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000158 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000159
160 Used exceptions derive from this.
161 If an exception derives from another exception besides this (such as
162 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
163 called if the others are present. This isn't actually used for
164 anything, though.
165
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000166 handle -- Called when context._raise_error is called and the
167 trap_enabler is set. First argument is self, second is the
168 context. More arguments can be given, those being after
169 the explanation in _raise_error (For example,
170 context._raise_error(NewError, '(-x)!', self._sign) would
171 call NewError().handle(context, self._sign).)
172
173 To define a new exception, it should be sufficient to have it derive
174 from DecimalException.
175 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000176 def handle(self, context, *args):
177 pass
178
179
180class Clamped(DecimalException):
181 """Exponent of a 0 changed to fit bounds.
182
183 This occurs and signals clamped if the exponent of a result has been
184 altered in order to fit the constraints of a specific concrete
Guido van Rossumd8faa362007-04-27 19:54:29 +0000185 representation. This may occur when the exponent of a zero result would
186 be outside the bounds of a representation, or when a large normal
187 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000188 this latter case, the exponent is reduced to fit and the corresponding
189 number of zero digits are appended to the coefficient ("fold-down").
190 """
191
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000192class InvalidOperation(DecimalException):
193 """An invalid operation was performed.
194
195 Various bad things cause this:
196
197 Something creates a signaling NaN
198 -INF + INF
Guido van Rossumd8faa362007-04-27 19:54:29 +0000199 0 * (+-)INF
200 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000201 x % 0
202 (+-)INF % x
203 x._rescale( non-integer )
204 sqrt(-x) , x > 0
205 0 ** 0
206 x ** (non-integer)
207 x ** (+-)INF
208 An operand is invalid
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000209
210 The result of the operation after these is a quiet positive NaN,
211 except when the cause is a signaling NaN, in which case the result is
212 also a quiet NaN, but with the original sign, and an optional
213 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000214 """
215 def handle(self, context, *args):
216 if args:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000217 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
218 return ans._fix_nan(context)
Mark Dickinsonf9236412009-01-02 23:23:21 +0000219 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000220
221class ConversionSyntax(InvalidOperation):
222 """Trying to convert badly formed string.
223
224 This occurs and signals invalid-operation if an string is being
225 converted to a number and it does not conform to the numeric string
Guido van Rossumd8faa362007-04-27 19:54:29 +0000226 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000227 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000228 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000229 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000230
231class DivisionByZero(DecimalException, ZeroDivisionError):
232 """Division by 0.
233
234 This occurs and signals division-by-zero if division of a finite number
235 by zero was attempted (during a divide-integer or divide operation, or a
236 power operation with negative right-hand operand), and the dividend was
237 not zero.
238
239 The result of the operation is [sign,inf], where sign is the exclusive
240 or of the signs of the operands for divide, or is 1 for an odd power of
241 -0, for power.
242 """
243
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000244 def handle(self, context, sign, *args):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000245 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000246
247class DivisionImpossible(InvalidOperation):
248 """Cannot perform the division adequately.
249
250 This occurs and signals invalid-operation if the integer result of a
251 divide-integer or remainder operation had too many digits (would be
Guido van Rossumd8faa362007-04-27 19:54:29 +0000252 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000253 """
254
255 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000256 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000257
258class DivisionUndefined(InvalidOperation, ZeroDivisionError):
259 """Undefined result of division.
260
261 This occurs and signals invalid-operation if division by zero was
262 attempted (during a divide-integer, divide, or remainder operation), and
Guido van Rossumd8faa362007-04-27 19:54:29 +0000263 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000264 """
265
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000266 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000267 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000268
269class Inexact(DecimalException):
270 """Had to round, losing information.
271
272 This occurs and signals inexact whenever the result of an operation is
273 not exact (that is, it needed to be rounded and any discarded digits
Guido van Rossumd8faa362007-04-27 19:54:29 +0000274 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000275 result in all cases is unchanged.
276
277 The inexact signal may be tested (or trapped) to determine if a given
278 operation (or sequence of operations) was inexact.
279 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000280
281class InvalidContext(InvalidOperation):
282 """Invalid context. Unknown rounding, for example.
283
284 This occurs and signals invalid-operation if an invalid context was
Guido van Rossumd8faa362007-04-27 19:54:29 +0000285 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000286 on creation and either the precision exceeds the capability of the
287 underlying concrete representation or an unknown or unsupported rounding
Guido van Rossumd8faa362007-04-27 19:54:29 +0000288 was specified. These aspects of the context need only be checked when
289 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000290 """
291
292 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000293 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000294
295class Rounded(DecimalException):
296 """Number got rounded (not necessarily changed during rounding).
297
298 This occurs and signals rounded whenever the result of an operation is
299 rounded (that is, some zero or non-zero digits were discarded from the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000300 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000301 result in all cases is unchanged.
302
303 The rounded signal may be tested (or trapped) to determine if a given
304 operation (or sequence of operations) caused a loss of precision.
305 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000306
307class Subnormal(DecimalException):
308 """Exponent < Emin before rounding.
309
310 This occurs and signals subnormal whenever the result of a conversion or
311 operation is subnormal (that is, its adjusted exponent is less than
Guido van Rossumd8faa362007-04-27 19:54:29 +0000312 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000313
314 The subnormal signal may be tested (or trapped) to determine if a given
315 or operation (or sequence of operations) yielded a subnormal result.
316 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000317
318class Overflow(Inexact, Rounded):
319 """Numerical overflow.
320
321 This occurs and signals overflow if the adjusted exponent of a result
322 (from a conversion or from an operation that is not an attempt to divide
323 by zero), after rounding, would be greater than the largest value that
324 can be handled by the implementation (the value Emax).
325
326 The result depends on the rounding mode:
327
328 For round-half-up and round-half-even (and for round-half-down and
329 round-up, if implemented), the result of the operation is [sign,inf],
Guido van Rossumd8faa362007-04-27 19:54:29 +0000330 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000331 result is the largest finite number that can be represented in the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000332 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000333 round-ceiling, the result is the same as for round-down if the sign of
Guido van Rossumd8faa362007-04-27 19:54:29 +0000334 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000335 the result is the same as for round-down if the sign of the intermediate
Guido van Rossumd8faa362007-04-27 19:54:29 +0000336 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000337 will also be raised.
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000338 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000339
340 def handle(self, context, sign, *args):
341 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000342 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000343 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000344 if sign == 0:
345 if context.rounding == ROUND_CEILING:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000346 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000347 return _dec_from_triple(sign, '9'*context.prec,
348 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000349 if sign == 1:
350 if context.rounding == ROUND_FLOOR:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000351 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000352 return _dec_from_triple(sign, '9'*context.prec,
353 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000354
355
356class Underflow(Inexact, Rounded, Subnormal):
357 """Numerical underflow with result rounded to 0.
358
359 This occurs and signals underflow if a result is inexact and the
360 adjusted exponent of the result would be smaller (more negative) than
361 the smallest value that can be handled by the implementation (the value
Guido van Rossumd8faa362007-04-27 19:54:29 +0000362 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000363
364 The result after an underflow will be a subnormal number rounded, if
Guido van Rossumd8faa362007-04-27 19:54:29 +0000365 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000366 in 0 with the sign of the intermediate result and an exponent of Etiny.
367
368 In all cases, Inexact, Rounded, and Subnormal will also be raised.
369 """
370
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000371# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000372_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000373 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000374
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000375# Map conditions (per the spec) to signals
376_condition_map = {ConversionSyntax:InvalidOperation,
377 DivisionImpossible:InvalidOperation,
378 DivisionUndefined:InvalidOperation,
379 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000380
Guido van Rossumd8faa362007-04-27 19:54:29 +0000381##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000382
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000383# The getcontext() and setcontext() function manage access to a thread-local
384# current context. Py2.4 offers direct support for thread locals. If that
Georg Brandlf9926402008-06-13 06:32:25 +0000385# is not available, use threading.current_thread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000386# work for older Pythons. If threads are not part of the build, create a
387# mock threading object with threading.local() returning the module namespace.
388
389try:
390 import threading
391except ImportError:
392 # Python was compiled without threads; create a mock object instead
393 import sys
Guido van Rossumd8faa362007-04-27 19:54:29 +0000394 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000395 def local(self, sys=sys):
396 return sys.modules[__name__]
397 threading = MockThreading()
398 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000399
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000400try:
401 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000402
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000403except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000404
Guido van Rossumd8faa362007-04-27 19:54:29 +0000405 # To fix reloading, force it to create a new context
406 # Old contexts have different exceptions in their dicts, making problems.
Georg Brandlf9926402008-06-13 06:32:25 +0000407 if hasattr(threading.current_thread(), '__decimal_context__'):
408 del threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000409
410 def setcontext(context):
411 """Set this thread's context to context."""
412 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000413 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000414 context.clear_flags()
Georg Brandlf9926402008-06-13 06:32:25 +0000415 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000416
417 def getcontext():
418 """Returns this thread's context.
419
420 If this thread does not yet have a context, returns
421 a new context and sets this thread's context.
422 New contexts are copies of DefaultContext.
423 """
424 try:
Georg Brandlf9926402008-06-13 06:32:25 +0000425 return threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000426 except AttributeError:
427 context = Context()
Georg Brandlf9926402008-06-13 06:32:25 +0000428 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000429 return context
430
431else:
432
433 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000434 if hasattr(local, '__decimal_context__'):
435 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000436
437 def getcontext(_local=local):
438 """Returns this thread's context.
439
440 If this thread does not yet have a context, returns
441 a new context and sets this thread's context.
442 New contexts are copies of DefaultContext.
443 """
444 try:
445 return _local.__decimal_context__
446 except AttributeError:
447 context = Context()
448 _local.__decimal_context__ = context
449 return context
450
451 def setcontext(context, _local=local):
452 """Set this thread's context to context."""
453 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000454 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000455 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000456 _local.__decimal_context__ = context
457
458 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000459
Thomas Wouters89f507f2006-12-13 04:49:30 +0000460def localcontext(ctx=None):
461 """Return a context manager for a copy of the supplied context
462
463 Uses a copy of the current context if no context is specified
464 The returned context manager creates a local decimal context
465 in a with statement:
466 def sin(x):
467 with localcontext() as ctx:
468 ctx.prec += 2
469 # Rest of sin calculation algorithm
470 # uses a precision 2 greater than normal
Guido van Rossumd8faa362007-04-27 19:54:29 +0000471 return +s # Convert result to normal precision
Thomas Wouters89f507f2006-12-13 04:49:30 +0000472
473 def sin(x):
474 with localcontext(ExtendedContext):
475 # Rest of sin calculation algorithm
476 # uses the Extended Context from the
477 # General Decimal Arithmetic Specification
Guido van Rossumd8faa362007-04-27 19:54:29 +0000478 return +s # Convert result to normal context
Thomas Wouters89f507f2006-12-13 04:49:30 +0000479
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000480 >>> setcontext(DefaultContext)
Guido van Rossum7131f842007-02-09 20:13:25 +0000481 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000482 28
483 >>> with localcontext():
484 ... ctx = getcontext()
Thomas Wouterscf297e42007-02-23 15:07:44 +0000485 ... ctx.prec += 2
Guido van Rossum7131f842007-02-09 20:13:25 +0000486 ... print(ctx.prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000487 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000488 30
489 >>> with localcontext(ExtendedContext):
Guido van Rossum7131f842007-02-09 20:13:25 +0000490 ... print(getcontext().prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000491 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000492 9
Guido van Rossum7131f842007-02-09 20:13:25 +0000493 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000494 28
495 """
496 if ctx is None: ctx = getcontext()
497 return _ContextManager(ctx)
498
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000499
Guido van Rossumd8faa362007-04-27 19:54:29 +0000500##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000501
Raymond Hettingera0fd8882009-01-20 07:24:44 +0000502# Do not subclass Decimal from numbers.Real and do not register it as such
503# (because Decimals are not interoperable with floats). See the notes in
504# numbers.py for more detail.
505
506class Decimal(object):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000507 """Floating point class for decimal arithmetic."""
508
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000509 __slots__ = ('_exp','_int','_sign', '_is_special')
510 # Generally, the value of the Decimal instance is given by
511 # (-1)**_sign * _int * 10**_exp
512 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000513
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000514 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000515 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000516 """Create a decimal point instance.
517
518 >>> Decimal('3.14') # string input
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000519 Decimal('3.14')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000520 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000521 Decimal('3.14')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000522 >>> Decimal(314) # int
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000523 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000524 >>> Decimal(Decimal(314)) # another decimal instance
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000525 Decimal('314')
Christian Heimesa62da1d2008-01-12 19:39:10 +0000526 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000527 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000528 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000529
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000530 # Note that the coefficient, self._int, is actually stored as
531 # a string rather than as a tuple of digits. This speeds up
532 # the "digits to integer" and "integer to digits" conversions
533 # that are used in almost every arithmetic operation on
534 # Decimals. This is an internal detail: the as_tuple function
535 # and the Decimal constructor still deal with tuples of
536 # digits.
537
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000538 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000539
Christian Heimesd59c64c2007-11-30 19:27:20 +0000540 # From a string
541 # REs insist on real strings, so we can too.
542 if isinstance(value, str):
Christian Heimesa62da1d2008-01-12 19:39:10 +0000543 m = _parser(value.strip())
Christian Heimesd59c64c2007-11-30 19:27:20 +0000544 if m is None:
545 if context is None:
546 context = getcontext()
547 return context._raise_error(ConversionSyntax,
548 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000549
Christian Heimesd59c64c2007-11-30 19:27:20 +0000550 if m.group('sign') == "-":
551 self._sign = 1
552 else:
553 self._sign = 0
554 intpart = m.group('int')
555 if intpart is not None:
556 # finite number
Mark Dickinson8d238292009-08-02 10:16:33 +0000557 fracpart = m.group('frac') or ''
Christian Heimesd59c64c2007-11-30 19:27:20 +0000558 exp = int(m.group('exp') or '0')
Mark Dickinson8d238292009-08-02 10:16:33 +0000559 self._int = str(int(intpart+fracpart))
560 self._exp = exp - len(fracpart)
Christian Heimesd59c64c2007-11-30 19:27:20 +0000561 self._is_special = False
562 else:
563 diag = m.group('diag')
564 if diag is not None:
565 # NaN
Mark Dickinson8d238292009-08-02 10:16:33 +0000566 self._int = str(int(diag or '0')).lstrip('0')
Christian Heimesd59c64c2007-11-30 19:27:20 +0000567 if m.group('signal'):
568 self._exp = 'N'
569 else:
570 self._exp = 'n'
571 else:
572 # infinity
573 self._int = '0'
574 self._exp = 'F'
575 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000576 return self
577
578 # From an integer
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000579 if isinstance(value, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000580 if value >= 0:
581 self._sign = 0
582 else:
583 self._sign = 1
584 self._exp = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000585 self._int = str(abs(value))
Christian Heimesd59c64c2007-11-30 19:27:20 +0000586 self._is_special = False
587 return self
588
589 # From another decimal
590 if isinstance(value, Decimal):
591 self._exp = value._exp
592 self._sign = value._sign
593 self._int = value._int
594 self._is_special = value._is_special
595 return self
596
597 # From an internal working value
598 if isinstance(value, _WorkRep):
599 self._sign = value.sign
600 self._int = str(value.int)
601 self._exp = int(value.exp)
602 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000603 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000604
605 # tuple/list conversion (possibly from as_tuple())
606 if isinstance(value, (list,tuple)):
607 if len(value) != 3:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000608 raise ValueError('Invalid tuple size in creation of Decimal '
609 'from list or tuple. The list or tuple '
610 'should have exactly three elements.')
611 # process sign. The isinstance test rejects floats
612 if not (isinstance(value[0], int) and value[0] in (0,1)):
613 raise ValueError("Invalid sign. The first value in the tuple "
614 "should be an integer; either 0 for a "
615 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000616 self._sign = value[0]
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000617 if value[2] == 'F':
618 # infinity: value[1] is ignored
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000619 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000620 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000621 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000622 else:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000623 # process and validate the digits in value[1]
624 digits = []
625 for digit in value[1]:
626 if isinstance(digit, int) and 0 <= digit <= 9:
627 # skip leading zeros
628 if digits or digit != 0:
629 digits.append(digit)
630 else:
631 raise ValueError("The second value in the tuple must "
632 "be composed of integers in the range "
633 "0 through 9.")
634 if value[2] in ('n', 'N'):
635 # NaN: digits form the diagnostic
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000636 self._int = ''.join(map(str, digits))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000637 self._exp = value[2]
638 self._is_special = True
639 elif isinstance(value[2], int):
640 # finite number: digits give the coefficient
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000641 self._int = ''.join(map(str, digits or [0]))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000642 self._exp = value[2]
643 self._is_special = False
644 else:
645 raise ValueError("The third value in the tuple must "
646 "be an integer, or one of the "
647 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000648 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000649
Raymond Hettingerbf440692004-07-10 14:14:37 +0000650 if isinstance(value, float):
651 raise TypeError("Cannot convert float to Decimal. " +
652 "First convert the float to a string")
653
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000654 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000655
Mark Dickinsonba298e42009-01-04 21:17:43 +0000656 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
657 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000658 def from_float(cls, f):
659 """Converts a float to a decimal number, exactly.
660
661 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
662 Since 0.1 is not exactly representable in binary floating point, the
663 value is stored as the nearest representable value which is
664 0x1.999999999999ap-4. The exact equivalent of the value in decimal
665 is 0.1000000000000000055511151231257827021181583404541015625.
666
667 >>> Decimal.from_float(0.1)
668 Decimal('0.1000000000000000055511151231257827021181583404541015625')
669 >>> Decimal.from_float(float('nan'))
670 Decimal('NaN')
671 >>> Decimal.from_float(float('inf'))
672 Decimal('Infinity')
673 >>> Decimal.from_float(-float('inf'))
674 Decimal('-Infinity')
675 >>> Decimal.from_float(-0.0)
676 Decimal('-0')
677
678 """
679 if isinstance(f, int): # handle integer inputs
680 return cls(f)
681 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
682 return cls(repr(f))
Mark Dickinsonba298e42009-01-04 21:17:43 +0000683 if _math.copysign(1.0, f) == 1.0:
684 sign = 0
685 else:
686 sign = 1
Raymond Hettinger771ed762009-01-03 19:20:32 +0000687 n, d = abs(f).as_integer_ratio()
688 k = d.bit_length() - 1
689 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinsonba298e42009-01-04 21:17:43 +0000690 if cls is Decimal:
691 return result
692 else:
693 return cls(result)
694 from_float = classmethod(from_float)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000695
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000696 def _isnan(self):
697 """Returns whether the number is not actually one.
698
699 0 if a number
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000700 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000701 2 if sNaN
702 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000703 if self._is_special:
704 exp = self._exp
705 if exp == 'n':
706 return 1
707 elif exp == 'N':
708 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000709 return 0
710
711 def _isinfinity(self):
712 """Returns whether the number is infinite
713
714 0 if finite or not a number
715 1 if +INF
716 -1 if -INF
717 """
718 if self._exp == 'F':
719 if self._sign:
720 return -1
721 return 1
722 return 0
723
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000724 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000725 """Returns whether the number is not actually one.
726
727 if self, other are sNaN, signal
728 if self, other are NaN return nan
729 return 0
730
731 Done before operations.
732 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000733
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000734 self_is_nan = self._isnan()
735 if other is None:
736 other_is_nan = False
737 else:
738 other_is_nan = other._isnan()
739
740 if self_is_nan or other_is_nan:
741 if context is None:
742 context = getcontext()
743
744 if self_is_nan == 2:
745 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000746 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000747 if other_is_nan == 2:
748 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000749 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000750 if self_is_nan:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000751 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000752
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000753 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000754 return 0
755
Christian Heimes77c02eb2008-02-09 02:18:51 +0000756 def _compare_check_nans(self, other, context):
757 """Version of _check_nans used for the signaling comparisons
758 compare_signal, __le__, __lt__, __ge__, __gt__.
759
760 Signal InvalidOperation if either self or other is a (quiet
761 or signaling) NaN. Signaling NaNs take precedence over quiet
762 NaNs.
763
764 Return 0 if neither operand is a NaN.
765
766 """
767 if context is None:
768 context = getcontext()
769
770 if self._is_special or other._is_special:
771 if self.is_snan():
772 return context._raise_error(InvalidOperation,
773 'comparison involving sNaN',
774 self)
775 elif other.is_snan():
776 return context._raise_error(InvalidOperation,
777 'comparison involving sNaN',
778 other)
779 elif self.is_qnan():
780 return context._raise_error(InvalidOperation,
781 'comparison involving NaN',
782 self)
783 elif other.is_qnan():
784 return context._raise_error(InvalidOperation,
785 'comparison involving NaN',
786 other)
787 return 0
788
Jack Diederich4dafcc42006-11-28 19:15:13 +0000789 def __bool__(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000790 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000791
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000792 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000793 """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000794 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000795
Christian Heimes77c02eb2008-02-09 02:18:51 +0000796 def _cmp(self, other):
797 """Compare the two non-NaN decimal instances self and other.
798
799 Returns -1 if self < other, 0 if self == other and 1
800 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000801
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000802 if self._is_special or other._is_special:
Mark Dickinsone6aad752009-01-25 10:48:51 +0000803 self_inf = self._isinfinity()
804 other_inf = other._isinfinity()
805 if self_inf == other_inf:
806 return 0
807 elif self_inf < other_inf:
808 return -1
809 else:
810 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000811
Mark Dickinsone6aad752009-01-25 10:48:51 +0000812 # check for zeros; Decimal('0') == Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000813 if not self:
814 if not other:
815 return 0
816 else:
817 return -((-1)**other._sign)
818 if not other:
819 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000820
Guido van Rossumd8faa362007-04-27 19:54:29 +0000821 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000822 if other._sign < self._sign:
823 return -1
824 if self._sign < other._sign:
825 return 1
826
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000827 self_adjusted = self.adjusted()
828 other_adjusted = other.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000829 if self_adjusted == other_adjusted:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000830 self_padded = self._int + '0'*(self._exp - other._exp)
831 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone6aad752009-01-25 10:48:51 +0000832 if self_padded == other_padded:
833 return 0
834 elif self_padded < other_padded:
835 return -(-1)**self._sign
836 else:
837 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000838 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000839 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000840 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000841 return -((-1)**self._sign)
842
Christian Heimes77c02eb2008-02-09 02:18:51 +0000843 # Note: The Decimal standard doesn't cover rich comparisons for
844 # Decimals. In particular, the specification is silent on the
845 # subject of what should happen for a comparison involving a NaN.
846 # We take the following approach:
847 #
848 # == comparisons involving a NaN always return False
849 # != comparisons involving a NaN always return True
850 # <, >, <= and >= comparisons involving a (quiet or signaling)
851 # NaN signal InvalidOperation, and return False if the
Christian Heimes3feef612008-02-11 06:19:17 +0000852 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000853 #
854 # This behavior is designed to conform as closely as possible to
855 # that specified by IEEE 754.
856
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000857 def __eq__(self, other):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000858 other = _convert_other(other)
859 if other is NotImplemented:
860 return other
861 if self.is_nan() or other.is_nan():
862 return False
863 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000864
865 def __ne__(self, other):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000866 other = _convert_other(other)
867 if other is NotImplemented:
868 return other
869 if self.is_nan() or other.is_nan():
870 return True
871 return self._cmp(other) != 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000872
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000873
Christian Heimes77c02eb2008-02-09 02:18:51 +0000874 def __lt__(self, other, context=None):
875 other = _convert_other(other)
876 if other is NotImplemented:
877 return other
878 ans = self._compare_check_nans(other, context)
879 if ans:
880 return False
881 return self._cmp(other) < 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000882
Christian Heimes77c02eb2008-02-09 02:18:51 +0000883 def __le__(self, other, context=None):
884 other = _convert_other(other)
885 if other is NotImplemented:
886 return other
887 ans = self._compare_check_nans(other, context)
888 if ans:
889 return False
890 return self._cmp(other) <= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000891
Christian Heimes77c02eb2008-02-09 02:18:51 +0000892 def __gt__(self, other, context=None):
893 other = _convert_other(other)
894 if other is NotImplemented:
895 return other
896 ans = self._compare_check_nans(other, context)
897 if ans:
898 return False
899 return self._cmp(other) > 0
900
901 def __ge__(self, other, context=None):
902 other = _convert_other(other)
903 if other is NotImplemented:
904 return other
905 ans = self._compare_check_nans(other, context)
906 if ans:
907 return False
908 return self._cmp(other) >= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000909
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000910 def compare(self, other, context=None):
911 """Compares one to another.
912
913 -1 => a < b
914 0 => a = b
915 1 => a > b
916 NaN => one is NaN
917 Like __cmp__, but returns Decimal instances.
918 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000919 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
Guido van Rossumd8faa362007-04-27 19:54:29 +0000921 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000922 if (self._is_special or other and other._is_special):
923 ans = self._check_nans(other, context)
924 if ans:
925 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000926
Christian Heimes77c02eb2008-02-09 02:18:51 +0000927 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000928
929 def __hash__(self):
930 """x.__hash__() <==> hash(x)"""
931 # Decimal integers must hash the same as the ints
Christian Heimes2380ac72008-01-09 00:17:24 +0000932 #
933 # The hash of a nonspecial noninteger Decimal must depend only
934 # on the value of that Decimal, and not on its representation.
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000935 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000936 if self._is_special:
937 if self._isnan():
938 raise TypeError('Cannot hash a NaN value.')
939 return hash(str(self))
Thomas Wouters8ce81f72007-09-20 18:22:40 +0000940 if not self:
941 return 0
942 if self._isinteger():
943 op = _WorkRep(self.to_integral_value())
944 # to make computation feasible for Decimals with large
945 # exponent, we use the fact that hash(n) == hash(m) for
946 # any two nonzero integers n and m such that (i) n and m
947 # have the same sign, and (ii) n is congruent to m modulo
948 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
949 # hash((-1)**s*c*pow(10, e, 2**64-1).
950 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Christian Heimes2380ac72008-01-09 00:17:24 +0000951 # The value of a nonzero nonspecial Decimal instance is
952 # faithfully represented by the triple consisting of its sign,
953 # its adjusted exponent, and its coefficient with trailing
954 # zeros removed.
955 return hash((self._sign,
956 self._exp+len(self._int),
957 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000958
959 def as_tuple(self):
960 """Represents the number as a triple tuple.
961
962 To show the internals exactly as they are.
963 """
Christian Heimes25bb7832008-01-11 16:17:00 +0000964 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000965
966 def __repr__(self):
967 """Represents the number as an instance of Decimal."""
968 # Invariant: eval(repr(d)) == d
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000969 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000970
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000971 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000972 """Return string representation of the number in scientific notation.
973
974 Captures all of the information in the underlying representation.
975 """
976
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000977 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000978 if self._is_special:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000979 if self._exp == 'F':
980 return sign + 'Infinity'
981 elif self._exp == 'n':
982 return sign + 'NaN' + self._int
983 else: # self._exp == 'N'
984 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000985
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000986 # number of digits of self._int to left of decimal point
987 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000988
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000989 # dotplace is number of digits of self._int to the left of the
990 # decimal point in the mantissa of the output string (that is,
991 # after adjusting the exponent)
992 if self._exp <= 0 and leftdigits > -6:
993 # no exponent required
994 dotplace = leftdigits
995 elif not eng:
996 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000997 dotplace = 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000998 elif self._int == '0':
999 # engineering notation, zero
1000 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001001 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001002 # engineering notation, nonzero
1003 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001004
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001005 if dotplace <= 0:
1006 intpart = '0'
1007 fracpart = '.' + '0'*(-dotplace) + self._int
1008 elif dotplace >= len(self._int):
1009 intpart = self._int+'0'*(dotplace-len(self._int))
1010 fracpart = ''
1011 else:
1012 intpart = self._int[:dotplace]
1013 fracpart = '.' + self._int[dotplace:]
1014 if leftdigits == dotplace:
1015 exp = ''
1016 else:
1017 if context is None:
1018 context = getcontext()
1019 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1020
1021 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001022
1023 def to_eng_string(self, context=None):
1024 """Convert to engineering-type string.
1025
1026 Engineering notation has an exponent which is a multiple of 3, so there
1027 are up to 3 digits left of the decimal place.
1028
1029 Same rules for when in exponential and when as a value as in __str__.
1030 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001031 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001032
1033 def __neg__(self, context=None):
1034 """Returns a copy with the sign switched.
1035
1036 Rounds, if it has reason.
1037 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001038 if self._is_special:
1039 ans = self._check_nans(context=context)
1040 if ans:
1041 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001042
1043 if not self:
1044 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001045 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001046 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001047 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001048
1049 if context is None:
1050 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001051 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001052
1053 def __pos__(self, context=None):
1054 """Returns a copy, unless it is a sNaN.
1055
1056 Rounds the number (if more then precision digits)
1057 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001058 if self._is_special:
1059 ans = self._check_nans(context=context)
1060 if ans:
1061 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001062
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001063 if not self:
1064 # + (-0) = 0
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001065 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001066 else:
1067 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001068
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001069 if context is None:
1070 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001071 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001072
Christian Heimes2c181612007-12-17 20:04:13 +00001073 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001074 """Returns the absolute value of self.
1075
Christian Heimes2c181612007-12-17 20:04:13 +00001076 If the keyword argument 'round' is false, do not round. The
1077 expression self.__abs__(round=False) is equivalent to
1078 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001079 """
Christian Heimes2c181612007-12-17 20:04:13 +00001080 if not round:
1081 return self.copy_abs()
1082
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001083 if self._is_special:
1084 ans = self._check_nans(context=context)
1085 if ans:
1086 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001087
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001088 if self._sign:
1089 ans = self.__neg__(context=context)
1090 else:
1091 ans = self.__pos__(context=context)
1092
1093 return ans
1094
1095 def __add__(self, other, context=None):
1096 """Returns self + other.
1097
1098 -INF + INF (or the reverse) cause InvalidOperation errors.
1099 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001100 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001101 if other is NotImplemented:
1102 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001103
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001104 if context is None:
1105 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001106
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001107 if self._is_special or other._is_special:
1108 ans = self._check_nans(other, context)
1109 if ans:
1110 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001111
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001112 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001113 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001114 if self._sign != other._sign and other._isinfinity():
1115 return context._raise_error(InvalidOperation, '-INF + INF')
1116 return Decimal(self)
1117 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001118 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001119
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001120 exp = min(self._exp, other._exp)
1121 negativezero = 0
1122 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001123 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001124 negativezero = 1
1125
1126 if not self and not other:
1127 sign = min(self._sign, other._sign)
1128 if negativezero:
1129 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001130 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001131 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001132 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001133 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001134 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001135 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001136 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001137 return ans
1138 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001139 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001140 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001141 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001142 return ans
1143
1144 op1 = _WorkRep(self)
1145 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001146 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001147
1148 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001150 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001151 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001152 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001153 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001154 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001155 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001156 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001157 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001158 if op1.sign == 1:
1159 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001160 op1.sign, op2.sign = op2.sign, op1.sign
1161 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001162 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001163 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001164 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001165 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001166 op1.sign, op2.sign = (0, 0)
1167 else:
1168 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001169 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001170
Raymond Hettinger17931de2004-10-27 06:21:46 +00001171 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001172 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001173 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001174 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001175
1176 result.exp = op1.exp
1177 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001178 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001179 return ans
1180
1181 __radd__ = __add__
1182
1183 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001184 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001185 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001186 if other is NotImplemented:
1187 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001188
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001189 if self._is_special or other._is_special:
1190 ans = self._check_nans(other, context=context)
1191 if ans:
1192 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001193
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001194 # self - other is computed as self + other.copy_negate()
1195 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001196
1197 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001198 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001199 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001200 if other is NotImplemented:
1201 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001202
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001203 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001205 def __mul__(self, other, context=None):
1206 """Return self * other.
1207
1208 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1209 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001210 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001211 if other is NotImplemented:
1212 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001213
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001214 if context is None:
1215 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001216
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001217 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001218
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001219 if self._is_special or other._is_special:
1220 ans = self._check_nans(other, context)
1221 if ans:
1222 return ans
1223
1224 if self._isinfinity():
1225 if not other:
1226 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001227 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001228
1229 if other._isinfinity():
1230 if not self:
1231 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001232 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233
1234 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235
1236 # Special case for multiplying by zero
1237 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001238 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001239 # Fixing in case the exponent is out of bounds
1240 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001241 return ans
1242
1243 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001244 if self._int == '1':
1245 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001246 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001247 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001248 if other._int == '1':
1249 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001250 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001251 return ans
1252
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001253 op1 = _WorkRep(self)
1254 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001255
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001256 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001257 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001258
1259 return ans
1260 __rmul__ = __mul__
1261
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001262 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001263 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001264 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001265 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001266 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001267
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001268 if context is None:
1269 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001270
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001271 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001272
1273 if self._is_special or other._is_special:
1274 ans = self._check_nans(other, context)
1275 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001276 return ans
1277
1278 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001279 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001280
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001281 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001282 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001283
1284 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001285 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001286 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001287
1288 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001289 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001290 if not self:
1291 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001292 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001293
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001294 if not self:
1295 exp = self._exp - other._exp
1296 coeff = 0
1297 else:
1298 # OK, so neither = 0, INF or NaN
1299 shift = len(other._int) - len(self._int) + context.prec + 1
1300 exp = self._exp - other._exp - shift
1301 op1 = _WorkRep(self)
1302 op2 = _WorkRep(other)
1303 if shift >= 0:
1304 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1305 else:
1306 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1307 if remainder:
1308 # result is not exact; adjust to ensure correct rounding
1309 if coeff % 5 == 0:
1310 coeff += 1
1311 else:
1312 # result is exact; get as close to ideal exponent as possible
1313 ideal_exp = self._exp - other._exp
1314 while exp < ideal_exp and coeff % 10 == 0:
1315 coeff //= 10
1316 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001317
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001318 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001319 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001320
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001321 def _divide(self, other, context):
1322 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001323
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001324 Assumes that neither self nor other is a NaN, that self is not
1325 infinite and that other is nonzero.
1326 """
1327 sign = self._sign ^ other._sign
1328 if other._isinfinity():
1329 ideal_exp = self._exp
1330 else:
1331 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001332
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001333 expdiff = self.adjusted() - other.adjusted()
1334 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001335 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001336 self._rescale(ideal_exp, context.rounding))
1337 if expdiff <= context.prec:
1338 op1 = _WorkRep(self)
1339 op2 = _WorkRep(other)
1340 if op1.exp >= op2.exp:
1341 op1.int *= 10**(op1.exp - op2.exp)
1342 else:
1343 op2.int *= 10**(op2.exp - op1.exp)
1344 q, r = divmod(op1.int, op2.int)
1345 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001346 return (_dec_from_triple(sign, str(q), 0),
1347 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001348
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001349 # Here the quotient is too large to be representable
1350 ans = context._raise_error(DivisionImpossible,
1351 'quotient too large in //, % or divmod')
1352 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001353
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001354 def __rtruediv__(self, other, context=None):
1355 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001356 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001357 if other is NotImplemented:
1358 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001359 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001360
1361 def __divmod__(self, other, context=None):
1362 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001363 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001364 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001365 other = _convert_other(other)
1366 if other is NotImplemented:
1367 return other
1368
1369 if context is None:
1370 context = getcontext()
1371
1372 ans = self._check_nans(other, context)
1373 if ans:
1374 return (ans, ans)
1375
1376 sign = self._sign ^ other._sign
1377 if self._isinfinity():
1378 if other._isinfinity():
1379 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1380 return ans, ans
1381 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001382 return (_SignedInfinity[sign],
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001383 context._raise_error(InvalidOperation, 'INF % x'))
1384
1385 if not other:
1386 if not self:
1387 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1388 return ans, ans
1389 else:
1390 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1391 context._raise_error(InvalidOperation, 'x % 0'))
1392
1393 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001394 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001395 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001396
1397 def __rdivmod__(self, other, context=None):
1398 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001399 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001400 if other is NotImplemented:
1401 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001402 return other.__divmod__(self, context=context)
1403
1404 def __mod__(self, other, context=None):
1405 """
1406 self % other
1407 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001408 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001409 if other is NotImplemented:
1410 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001411
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001412 if context is None:
1413 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001414
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001415 ans = self._check_nans(other, context)
1416 if ans:
1417 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001418
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001419 if self._isinfinity():
1420 return context._raise_error(InvalidOperation, 'INF % x')
1421 elif not other:
1422 if self:
1423 return context._raise_error(InvalidOperation, 'x % 0')
1424 else:
1425 return context._raise_error(DivisionUndefined, '0 % 0')
1426
1427 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001428 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001429 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001430
1431 def __rmod__(self, other, context=None):
1432 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001433 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001434 if other is NotImplemented:
1435 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001436 return other.__mod__(self, context=context)
1437
1438 def remainder_near(self, other, context=None):
1439 """
1440 Remainder nearest to 0- abs(remainder-near) <= other/2
1441 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001442 if context is None:
1443 context = getcontext()
1444
1445 other = _convert_other(other, raiseit=True)
1446
1447 ans = self._check_nans(other, context)
1448 if ans:
1449 return ans
1450
1451 # self == +/-infinity -> InvalidOperation
1452 if self._isinfinity():
1453 return context._raise_error(InvalidOperation,
1454 'remainder_near(infinity, x)')
1455
1456 # other == 0 -> either InvalidOperation or DivisionUndefined
1457 if not other:
1458 if self:
1459 return context._raise_error(InvalidOperation,
1460 'remainder_near(x, 0)')
1461 else:
1462 return context._raise_error(DivisionUndefined,
1463 'remainder_near(0, 0)')
1464
1465 # other = +/-infinity -> remainder = self
1466 if other._isinfinity():
1467 ans = Decimal(self)
1468 return ans._fix(context)
1469
1470 # self = 0 -> remainder = self, with ideal exponent
1471 ideal_exponent = min(self._exp, other._exp)
1472 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001473 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001474 return ans._fix(context)
1475
1476 # catch most cases of large or small quotient
1477 expdiff = self.adjusted() - other.adjusted()
1478 if expdiff >= context.prec + 1:
1479 # expdiff >= prec+1 => abs(self/other) > 10**prec
1480 return context._raise_error(DivisionImpossible)
1481 if expdiff <= -2:
1482 # expdiff <= -2 => abs(self/other) < 0.1
1483 ans = self._rescale(ideal_exponent, context.rounding)
1484 return ans._fix(context)
1485
1486 # adjust both arguments to have the same exponent, then divide
1487 op1 = _WorkRep(self)
1488 op2 = _WorkRep(other)
1489 if op1.exp >= op2.exp:
1490 op1.int *= 10**(op1.exp - op2.exp)
1491 else:
1492 op2.int *= 10**(op2.exp - op1.exp)
1493 q, r = divmod(op1.int, op2.int)
1494 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1495 # 10**ideal_exponent. Apply correction to ensure that
1496 # abs(remainder) <= abs(other)/2
1497 if 2*r + (q&1) > op2.int:
1498 r -= op2.int
1499 q += 1
1500
1501 if q >= 10**context.prec:
1502 return context._raise_error(DivisionImpossible)
1503
1504 # result has same sign as self unless r is negative
1505 sign = self._sign
1506 if r < 0:
1507 sign = 1-sign
1508 r = -r
1509
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001510 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001511 return ans._fix(context)
1512
1513 def __floordiv__(self, other, context=None):
1514 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001515 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001516 if other is NotImplemented:
1517 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001518
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001519 if context is None:
1520 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001521
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001522 ans = self._check_nans(other, context)
1523 if ans:
1524 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001525
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001526 if self._isinfinity():
1527 if other._isinfinity():
1528 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001529 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001530 return _SignedInfinity[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001531
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001532 if not other:
1533 if self:
1534 return context._raise_error(DivisionByZero, 'x // 0',
1535 self._sign ^ other._sign)
1536 else:
1537 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001538
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001539 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001540
1541 def __rfloordiv__(self, other, context=None):
1542 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001543 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001544 if other is NotImplemented:
1545 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001546 return other.__floordiv__(self, context=context)
1547
1548 def __float__(self):
1549 """Float representation."""
1550 return float(str(self))
1551
1552 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001553 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001554 if self._is_special:
1555 if self._isnan():
Mark Dickinson8fde3da2009-09-08 19:23:44 +00001556 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001557 elif self._isinfinity():
Mark Dickinson8fde3da2009-09-08 19:23:44 +00001558 raise OverflowError("Cannot convert infinity to integer")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001559 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001560 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001561 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001562 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001563 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001564
Christian Heimes969fe572008-01-25 11:23:10 +00001565 __trunc__ = __int__
1566
Christian Heimes0bd4e112008-02-12 22:59:25 +00001567 def real(self):
1568 return self
Mark Dickinson315a20a2009-01-04 21:34:18 +00001569 real = property(real)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001570
Christian Heimes0bd4e112008-02-12 22:59:25 +00001571 def imag(self):
1572 return Decimal(0)
Mark Dickinson315a20a2009-01-04 21:34:18 +00001573 imag = property(imag)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001574
1575 def conjugate(self):
1576 return self
1577
1578 def __complex__(self):
1579 return complex(float(self))
1580
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001581 def _fix_nan(self, context):
1582 """Decapitate the payload of a NaN to fit the context"""
1583 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001584
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001585 # maximum length of payload is precision if _clamp=0,
1586 # precision-1 if _clamp=1.
1587 max_payload_len = context.prec - context._clamp
1588 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001589 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1590 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001591 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001592
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001593 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001594 """Round if it is necessary to keep self within prec precision.
1595
1596 Rounds and fixes the exponent. Does not raise on a sNaN.
1597
1598 Arguments:
1599 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001600 context - context used.
1601 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001602
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001603 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001604 if self._isnan():
1605 # decapitate payload if necessary
1606 return self._fix_nan(context)
1607 else:
1608 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001609 return Decimal(self)
1610
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001611 # if self is zero then exponent should be between Etiny and
1612 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1613 Etiny = context.Etiny()
1614 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001615 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001616 exp_max = [context.Emax, Etop][context._clamp]
1617 new_exp = min(max(self._exp, Etiny), exp_max)
1618 if new_exp != self._exp:
1619 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001620 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001621 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001622 return Decimal(self)
1623
1624 # exp_min is the smallest allowable exponent of the result,
1625 # equal to max(self.adjusted()-context.prec+1, Etiny)
1626 exp_min = len(self._int) + self._exp - context.prec
1627 if exp_min > Etop:
1628 # overflow: exp_min > Etop iff self.adjusted() > Emax
1629 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001630 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001631 return context._raise_error(Overflow, 'above Emax', self._sign)
1632 self_is_subnormal = exp_min < Etiny
1633 if self_is_subnormal:
1634 context._raise_error(Subnormal)
1635 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001636
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001637 # round if self has too many digits
1638 if self._exp < exp_min:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001639 context._raise_error(Rounded)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001640 digits = len(self._int) + self._exp - exp_min
1641 if digits < 0:
1642 self = _dec_from_triple(self._sign, '1', exp_min-1)
1643 digits = 0
1644 this_function = getattr(self, self._pick_rounding_function[context.rounding])
1645 changed = this_function(digits)
1646 coeff = self._int[:digits] or '0'
1647 if changed == 1:
1648 coeff = str(int(coeff)+1)
1649 ans = _dec_from_triple(self._sign, coeff, exp_min)
1650
1651 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001652 context._raise_error(Inexact)
1653 if self_is_subnormal:
1654 context._raise_error(Underflow)
1655 if not ans:
1656 # raise Clamped on underflow to 0
1657 context._raise_error(Clamped)
1658 elif len(ans._int) == context.prec+1:
1659 # we get here only if rescaling rounds the
1660 # cofficient up to exactly 10**context.prec
1661 if ans._exp < Etop:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001662 ans = _dec_from_triple(ans._sign,
1663 ans._int[:-1], ans._exp+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001664 else:
1665 # Inexact and Rounded have already been raised
1666 ans = context._raise_error(Overflow, 'above Emax',
1667 self._sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001668 return ans
1669
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001670 # fold down if _clamp == 1 and self has too few digits
1671 if context._clamp == 1 and self._exp > Etop:
1672 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001673 self_padded = self._int + '0'*(self._exp - Etop)
1674 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001675
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001676 # here self was representable to begin with; return unchanged
1677 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001678
1679 _pick_rounding_function = {}
1680
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001681 # for each of the rounding functions below:
1682 # self is a finite, nonzero Decimal
1683 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001684 #
1685 # each function returns either -1, 0, or 1, as follows:
1686 # 1 indicates that self should be rounded up (away from zero)
1687 # 0 indicates that self should be truncated, and that all the
1688 # digits to be truncated are zeros (so the value is unchanged)
1689 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001690
1691 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001692 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001693 if _all_zeros(self._int, prec):
1694 return 0
1695 else:
1696 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001697
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001698 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001699 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001700 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001701
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001702 def _round_half_up(self, prec):
1703 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001704 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001705 return 1
1706 elif _all_zeros(self._int, prec):
1707 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001708 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001709 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001710
1711 def _round_half_down(self, prec):
1712 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001713 if _exact_half(self._int, prec):
1714 return -1
1715 else:
1716 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001717
1718 def _round_half_even(self, prec):
1719 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001720 if _exact_half(self._int, prec) and \
1721 (prec == 0 or self._int[prec-1] in '02468'):
1722 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001723 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001724 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001725
1726 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001727 """Rounds up (not away from 0 if negative.)"""
1728 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001729 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001730 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001731 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001732
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001733 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001734 """Rounds down (not towards 0 if negative)"""
1735 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001736 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001737 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001738 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001739
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001740 def _round_05up(self, prec):
1741 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001742 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001743 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001744 else:
1745 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001746
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001747 def __round__(self, n=None):
1748 """Round self to the nearest integer, or to a given precision.
1749
1750 If only one argument is supplied, round a finite Decimal
1751 instance self to the nearest integer. If self is infinite or
1752 a NaN then a Python exception is raised. If self is finite
1753 and lies exactly halfway between two integers then it is
1754 rounded to the integer with even last digit.
1755
1756 >>> round(Decimal('123.456'))
1757 123
1758 >>> round(Decimal('-456.789'))
1759 -457
1760 >>> round(Decimal('-3.0'))
1761 -3
1762 >>> round(Decimal('2.5'))
1763 2
1764 >>> round(Decimal('3.5'))
1765 4
1766 >>> round(Decimal('Inf'))
1767 Traceback (most recent call last):
1768 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001769 OverflowError: cannot round an infinity
1770 >>> round(Decimal('NaN'))
1771 Traceback (most recent call last):
1772 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001773 ValueError: cannot round a NaN
1774
1775 If a second argument n is supplied, self is rounded to n
1776 decimal places using the rounding mode for the current
1777 context.
1778
1779 For an integer n, round(self, -n) is exactly equivalent to
1780 self.quantize(Decimal('1En')).
1781
1782 >>> round(Decimal('123.456'), 0)
1783 Decimal('123')
1784 >>> round(Decimal('123.456'), 2)
1785 Decimal('123.46')
1786 >>> round(Decimal('123.456'), -2)
1787 Decimal('1E+2')
1788 >>> round(Decimal('-Infinity'), 37)
1789 Decimal('NaN')
1790 >>> round(Decimal('sNaN123'), 0)
1791 Decimal('NaN123')
1792
1793 """
1794 if n is not None:
1795 # two-argument form: use the equivalent quantize call
1796 if not isinstance(n, int):
1797 raise TypeError('Second argument to round should be integral')
1798 exp = _dec_from_triple(0, '1', -n)
1799 return self.quantize(exp)
1800
1801 # one-argument form
1802 if self._is_special:
1803 if self.is_nan():
1804 raise ValueError("cannot round a NaN")
1805 else:
1806 raise OverflowError("cannot round an infinity")
1807 return int(self._rescale(0, ROUND_HALF_EVEN))
1808
1809 def __floor__(self):
1810 """Return the floor of self, as an integer.
1811
1812 For a finite Decimal instance self, return the greatest
1813 integer n such that n <= self. If self is infinite or a NaN
1814 then a Python exception is raised.
1815
1816 """
1817 if self._is_special:
1818 if self.is_nan():
1819 raise ValueError("cannot round a NaN")
1820 else:
1821 raise OverflowError("cannot round an infinity")
1822 return int(self._rescale(0, ROUND_FLOOR))
1823
1824 def __ceil__(self):
1825 """Return the ceiling of self, as an integer.
1826
1827 For a finite Decimal instance self, return the least integer n
1828 such that n >= self. If self is infinite or a NaN then a
1829 Python exception is raised.
1830
1831 """
1832 if self._is_special:
1833 if self.is_nan():
1834 raise ValueError("cannot round a NaN")
1835 else:
1836 raise OverflowError("cannot round an infinity")
1837 return int(self._rescale(0, ROUND_CEILING))
1838
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001839 def fma(self, other, third, context=None):
1840 """Fused multiply-add.
1841
1842 Returns self*other+third with no rounding of the intermediate
1843 product self*other.
1844
1845 self and other are multiplied together, with no rounding of
1846 the result. The third operand is then added to the result,
1847 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001848 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001849
1850 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001851
1852 # compute product; raise InvalidOperation if either operand is
1853 # a signaling NaN or if the product is zero times infinity.
1854 if self._is_special or other._is_special:
1855 if context is None:
1856 context = getcontext()
1857 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001858 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001859 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001860 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001861 if self._exp == 'n':
1862 product = self
1863 elif other._exp == 'n':
1864 product = other
1865 elif self._exp == 'F':
1866 if not other:
1867 return context._raise_error(InvalidOperation,
1868 'INF * 0 in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001869 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001870 elif other._exp == 'F':
1871 if not self:
1872 return context._raise_error(InvalidOperation,
1873 '0 * INF in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001874 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001875 else:
1876 product = _dec_from_triple(self._sign ^ other._sign,
1877 str(int(self._int) * int(other._int)),
1878 self._exp + other._exp)
1879
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001880 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001881 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001882
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001883 def _power_modulo(self, other, modulo, context=None):
1884 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001885
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001886 # if can't convert other and modulo to Decimal, raise
1887 # TypeError; there's no point returning NotImplemented (no
1888 # equivalent of __rpow__ for three argument pow)
1889 other = _convert_other(other, raiseit=True)
1890 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001891
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001892 if context is None:
1893 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001894
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001895 # deal with NaNs: if there are any sNaNs then first one wins,
1896 # (i.e. behaviour for NaNs is identical to that of fma)
1897 self_is_nan = self._isnan()
1898 other_is_nan = other._isnan()
1899 modulo_is_nan = modulo._isnan()
1900 if self_is_nan or other_is_nan or modulo_is_nan:
1901 if self_is_nan == 2:
1902 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001903 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001904 if other_is_nan == 2:
1905 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001906 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001907 if modulo_is_nan == 2:
1908 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001909 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001910 if self_is_nan:
1911 return self._fix_nan(context)
1912 if other_is_nan:
1913 return other._fix_nan(context)
1914 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001915
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001916 # check inputs: we apply same restrictions as Python's pow()
1917 if not (self._isinteger() and
1918 other._isinteger() and
1919 modulo._isinteger()):
1920 return context._raise_error(InvalidOperation,
1921 'pow() 3rd argument not allowed '
1922 'unless all arguments are integers')
1923 if other < 0:
1924 return context._raise_error(InvalidOperation,
1925 'pow() 2nd argument cannot be '
1926 'negative when 3rd argument specified')
1927 if not modulo:
1928 return context._raise_error(InvalidOperation,
1929 'pow() 3rd argument cannot be 0')
1930
1931 # additional restriction for decimal: the modulus must be less
1932 # than 10**prec in absolute value
1933 if modulo.adjusted() >= context.prec:
1934 return context._raise_error(InvalidOperation,
1935 'insufficient precision: pow() 3rd '
1936 'argument must not have more than '
1937 'precision digits')
1938
1939 # define 0**0 == NaN, for consistency with two-argument pow
1940 # (even though it hurts!)
1941 if not other and not self:
1942 return context._raise_error(InvalidOperation,
1943 'at least one of pow() 1st argument '
1944 'and 2nd argument must be nonzero ;'
1945 '0**0 is not defined')
1946
1947 # compute sign of result
1948 if other._iseven():
1949 sign = 0
1950 else:
1951 sign = self._sign
1952
1953 # convert modulo to a Python integer, and self and other to
1954 # Decimal integers (i.e. force their exponents to be >= 0)
1955 modulo = abs(int(modulo))
1956 base = _WorkRep(self.to_integral_value())
1957 exponent = _WorkRep(other.to_integral_value())
1958
1959 # compute result using integer pow()
1960 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1961 for i in range(exponent.exp):
1962 base = pow(base, 10, modulo)
1963 base = pow(base, exponent.int, modulo)
1964
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001965 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001966
1967 def _power_exact(self, other, p):
1968 """Attempt to compute self**other exactly.
1969
1970 Given Decimals self and other and an integer p, attempt to
1971 compute an exact result for the power self**other, with p
1972 digits of precision. Return None if self**other is not
1973 exactly representable in p digits.
1974
1975 Assumes that elimination of special cases has already been
1976 performed: self and other must both be nonspecial; self must
1977 be positive and not numerically equal to 1; other must be
1978 nonzero. For efficiency, other._exp should not be too large,
1979 so that 10**abs(other._exp) is a feasible calculation."""
1980
1981 # In the comments below, we write x for the value of self and
1982 # y for the value of other. Write x = xc*10**xe and y =
1983 # yc*10**ye.
1984
1985 # The main purpose of this method is to identify the *failure*
1986 # of x**y to be exactly representable with as little effort as
1987 # possible. So we look for cheap and easy tests that
1988 # eliminate the possibility of x**y being exact. Only if all
1989 # these tests are passed do we go on to actually compute x**y.
1990
1991 # Here's the main idea. First normalize both x and y. We
1992 # express y as a rational m/n, with m and n relatively prime
1993 # and n>0. Then for x**y to be exactly representable (at
1994 # *any* precision), xc must be the nth power of a positive
1995 # integer and xe must be divisible by n. If m is negative
1996 # then additionally xc must be a power of either 2 or 5, hence
1997 # a power of 2**n or 5**n.
1998 #
1999 # There's a limit to how small |y| can be: if y=m/n as above
2000 # then:
2001 #
2002 # (1) if xc != 1 then for the result to be representable we
2003 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
2004 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
2005 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
2006 # representable.
2007 #
2008 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
2009 # |y| < 1/|xe| then the result is not representable.
2010 #
2011 # Note that since x is not equal to 1, at least one of (1) and
2012 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
2013 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
2014 #
2015 # There's also a limit to how large y can be, at least if it's
2016 # positive: the normalized result will have coefficient xc**y,
2017 # so if it's representable then xc**y < 10**p, and y <
2018 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
2019 # not exactly representable.
2020
2021 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
2022 # so |y| < 1/xe and the result is not representable.
2023 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
2024 # < 1/nbits(xc).
2025
2026 x = _WorkRep(self)
2027 xc, xe = x.int, x.exp
2028 while xc % 10 == 0:
2029 xc //= 10
2030 xe += 1
2031
2032 y = _WorkRep(other)
2033 yc, ye = y.int, y.exp
2034 while yc % 10 == 0:
2035 yc //= 10
2036 ye += 1
2037
2038 # case where xc == 1: result is 10**(xe*y), with xe*y
2039 # required to be an integer
2040 if xc == 1:
2041 if ye >= 0:
2042 exponent = xe*yc*10**ye
2043 else:
2044 exponent, remainder = divmod(xe*yc, 10**-ye)
2045 if remainder:
2046 return None
2047 if y.sign == 1:
2048 exponent = -exponent
2049 # if other is a nonnegative integer, use ideal exponent
2050 if other._isinteger() and other._sign == 0:
2051 ideal_exponent = self._exp*int(other)
2052 zeros = min(exponent-ideal_exponent, p-1)
2053 else:
2054 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002055 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002056
2057 # case where y is negative: xc must be either a power
2058 # of 2 or a power of 5.
2059 if y.sign == 1:
2060 last_digit = xc % 10
2061 if last_digit in (2,4,6,8):
2062 # quick test for power of 2
2063 if xc & -xc != xc:
2064 return None
2065 # now xc is a power of 2; e is its exponent
2066 e = _nbits(xc)-1
2067 # find e*y and xe*y; both must be integers
2068 if ye >= 0:
2069 y_as_int = yc*10**ye
2070 e = e*y_as_int
2071 xe = xe*y_as_int
2072 else:
2073 ten_pow = 10**-ye
2074 e, remainder = divmod(e*yc, ten_pow)
2075 if remainder:
2076 return None
2077 xe, remainder = divmod(xe*yc, ten_pow)
2078 if remainder:
2079 return None
2080
2081 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2082 return None
2083 xc = 5**e
2084
2085 elif last_digit == 5:
2086 # e >= log_5(xc) if xc is a power of 5; we have
2087 # equality all the way up to xc=5**2658
2088 e = _nbits(xc)*28//65
2089 xc, remainder = divmod(5**e, xc)
2090 if remainder:
2091 return None
2092 while xc % 5 == 0:
2093 xc //= 5
2094 e -= 1
2095 if ye >= 0:
2096 y_as_integer = yc*10**ye
2097 e = e*y_as_integer
2098 xe = xe*y_as_integer
2099 else:
2100 ten_pow = 10**-ye
2101 e, remainder = divmod(e*yc, ten_pow)
2102 if remainder:
2103 return None
2104 xe, remainder = divmod(xe*yc, ten_pow)
2105 if remainder:
2106 return None
2107 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2108 return None
2109 xc = 2**e
2110 else:
2111 return None
2112
2113 if xc >= 10**p:
2114 return None
2115 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002116 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002117
2118 # now y is positive; find m and n such that y = m/n
2119 if ye >= 0:
2120 m, n = yc*10**ye, 1
2121 else:
2122 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2123 return None
2124 xc_bits = _nbits(xc)
2125 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2126 return None
2127 m, n = yc, 10**(-ye)
2128 while m % 2 == n % 2 == 0:
2129 m //= 2
2130 n //= 2
2131 while m % 5 == n % 5 == 0:
2132 m //= 5
2133 n //= 5
2134
2135 # compute nth root of xc*10**xe
2136 if n > 1:
2137 # if 1 < xc < 2**n then xc isn't an nth power
2138 if xc != 1 and xc_bits <= n:
2139 return None
2140
2141 xe, rem = divmod(xe, n)
2142 if rem != 0:
2143 return None
2144
2145 # compute nth root of xc using Newton's method
2146 a = 1 << -(-_nbits(xc)//n) # initial estimate
2147 while True:
2148 q, r = divmod(xc, a**(n-1))
2149 if a <= q:
2150 break
2151 else:
2152 a = (a*(n-1) + q)//n
2153 if not (a == q and r == 0):
2154 return None
2155 xc = a
2156
2157 # now xc*10**xe is the nth root of the original xc*10**xe
2158 # compute mth power of xc*10**xe
2159
2160 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2161 # 10**p and the result is not representable.
2162 if xc > 1 and m > p*100//_log10_lb(xc):
2163 return None
2164 xc = xc**m
2165 xe *= m
2166 if xc > 10**p:
2167 return None
2168
2169 # by this point the result *is* exactly representable
2170 # adjust the exponent to get as close as possible to the ideal
2171 # exponent, if necessary
2172 str_xc = str(xc)
2173 if other._isinteger() and other._sign == 0:
2174 ideal_exponent = self._exp*int(other)
2175 zeros = min(xe-ideal_exponent, p-len(str_xc))
2176 else:
2177 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002178 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002179
2180 def __pow__(self, other, modulo=None, context=None):
2181 """Return self ** other [ % modulo].
2182
2183 With two arguments, compute self**other.
2184
2185 With three arguments, compute (self**other) % modulo. For the
2186 three argument form, the following restrictions on the
2187 arguments hold:
2188
2189 - all three arguments must be integral
2190 - other must be nonnegative
2191 - either self or other (or both) must be nonzero
2192 - modulo must be nonzero and must have at most p digits,
2193 where p is the context precision.
2194
2195 If any of these restrictions is violated the InvalidOperation
2196 flag is raised.
2197
2198 The result of pow(self, other, modulo) is identical to the
2199 result that would be obtained by computing (self**other) %
2200 modulo with unbounded precision, but is computed more
2201 efficiently. It is always exact.
2202 """
2203
2204 if modulo is not None:
2205 return self._power_modulo(other, modulo, context)
2206
2207 other = _convert_other(other)
2208 if other is NotImplemented:
2209 return other
2210
2211 if context is None:
2212 context = getcontext()
2213
2214 # either argument is a NaN => result is NaN
2215 ans = self._check_nans(other, context)
2216 if ans:
2217 return ans
2218
2219 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2220 if not other:
2221 if not self:
2222 return context._raise_error(InvalidOperation, '0 ** 0')
2223 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002224 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002225
2226 # result has sign 1 iff self._sign is 1 and other is an odd integer
2227 result_sign = 0
2228 if self._sign == 1:
2229 if other._isinteger():
2230 if not other._iseven():
2231 result_sign = 1
2232 else:
2233 # -ve**noninteger = NaN
2234 # (-0)**noninteger = 0**noninteger
2235 if self:
2236 return context._raise_error(InvalidOperation,
2237 'x ** y with x negative and y not an integer')
2238 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002239 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002240
2241 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2242 if not self:
2243 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002244 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002245 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002246 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002247
2248 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002249 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002250 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002251 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002252 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002253 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002254
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002255 # 1**other = 1, but the choice of exponent and the flags
2256 # depend on the exponent of self, and on whether other is a
2257 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002258 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002259 if other._isinteger():
2260 # exp = max(self._exp*max(int(other), 0),
2261 # 1-context.prec) but evaluating int(other) directly
2262 # is dangerous until we know other is small (other
2263 # could be 1e999999999)
2264 if other._sign == 1:
2265 multiplier = 0
2266 elif other > context.prec:
2267 multiplier = context.prec
2268 else:
2269 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002270
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002271 exp = self._exp * multiplier
2272 if exp < 1-context.prec:
2273 exp = 1-context.prec
2274 context._raise_error(Rounded)
2275 else:
2276 context._raise_error(Inexact)
2277 context._raise_error(Rounded)
2278 exp = 1-context.prec
2279
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002280 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002281
2282 # compute adjusted exponent of self
2283 self_adj = self.adjusted()
2284
2285 # self ** infinity is infinity if self > 1, 0 if self < 1
2286 # self ** -infinity is infinity if self < 1, 0 if self > 1
2287 if other._isinfinity():
2288 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002289 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002290 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002291 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002292
2293 # from here on, the result always goes through the call
2294 # to _fix at the end of this function.
2295 ans = None
2296
2297 # crude test to catch cases of extreme overflow/underflow. If
2298 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2299 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2300 # self**other >= 10**(Emax+1), so overflow occurs. The test
2301 # for underflow is similar.
2302 bound = self._log10_exp_bound() + other.adjusted()
2303 if (self_adj >= 0) == (other._sign == 0):
2304 # self > 1 and other +ve, or self < 1 and other -ve
2305 # possibility of overflow
2306 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002307 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002308 else:
2309 # self > 1 and other -ve, or self < 1 and other +ve
2310 # possibility of underflow to 0
2311 Etiny = context.Etiny()
2312 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002313 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002314
2315 # try for an exact result with precision +1
2316 if ans is None:
2317 ans = self._power_exact(other, context.prec + 1)
2318 if ans is not None and result_sign == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002319 ans = _dec_from_triple(1, ans._int, ans._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002320
2321 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2322 if ans is None:
2323 p = context.prec
2324 x = _WorkRep(self)
2325 xc, xe = x.int, x.exp
2326 y = _WorkRep(other)
2327 yc, ye = y.int, y.exp
2328 if y.sign == 1:
2329 yc = -yc
2330
2331 # compute correctly rounded result: start with precision +3,
2332 # then increase precision until result is unambiguously roundable
2333 extra = 3
2334 while True:
2335 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2336 if coeff % (5*10**(len(str(coeff))-p-1)):
2337 break
2338 extra += 3
2339
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002340 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002341
2342 # the specification says that for non-integer other we need to
2343 # raise Inexact, even when the result is actually exact. In
2344 # the same way, we need to raise Underflow here if the result
2345 # is subnormal. (The call to _fix will take care of raising
2346 # Rounded and Subnormal, as usual.)
2347 if not other._isinteger():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002348 context._raise_error(Inexact)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002349 # pad with zeros up to length context.prec+1 if necessary
2350 if len(ans._int) <= context.prec:
2351 expdiff = context.prec+1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002352 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2353 ans._exp-expdiff)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002354 if ans.adjusted() < context.Emin:
2355 context._raise_error(Underflow)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002356
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002357 # unlike exp, ln and log10, the power function respects the
2358 # rounding mode; no need to use ROUND_HALF_EVEN here
2359 ans = ans._fix(context)
2360 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002361
2362 def __rpow__(self, other, context=None):
2363 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002364 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002365 if other is NotImplemented:
2366 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002367 return other.__pow__(self, context=context)
2368
2369 def normalize(self, context=None):
2370 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002371
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002372 if context is None:
2373 context = getcontext()
2374
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002375 if self._is_special:
2376 ans = self._check_nans(context=context)
2377 if ans:
2378 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002379
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002380 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002381 if dup._isinfinity():
2382 return dup
2383
2384 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002385 return _dec_from_triple(dup._sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002386 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002387 end = len(dup._int)
2388 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002389 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002390 exp += 1
2391 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002392 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002393
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002394 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002395 """Quantize self so its exponent is the same as that of exp.
2396
2397 Similar to self._rescale(exp._exp) but with error checking.
2398 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002399 exp = _convert_other(exp, raiseit=True)
2400
2401 if context is None:
2402 context = getcontext()
2403 if rounding is None:
2404 rounding = context.rounding
2405
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002406 if self._is_special or exp._is_special:
2407 ans = self._check_nans(exp, context)
2408 if ans:
2409 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002410
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002411 if exp._isinfinity() or self._isinfinity():
2412 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002413 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002414 return context._raise_error(InvalidOperation,
2415 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002416
2417 # if we're not watching exponents, do a simple rescale
2418 if not watchexp:
2419 ans = self._rescale(exp._exp, rounding)
2420 # raise Inexact and Rounded where appropriate
2421 if ans._exp > self._exp:
2422 context._raise_error(Rounded)
2423 if ans != self:
2424 context._raise_error(Inexact)
2425 return ans
2426
2427 # exp._exp should be between Etiny and Emax
2428 if not (context.Etiny() <= exp._exp <= context.Emax):
2429 return context._raise_error(InvalidOperation,
2430 'target exponent out of bounds in quantize')
2431
2432 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002433 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002434 return ans._fix(context)
2435
2436 self_adjusted = self.adjusted()
2437 if self_adjusted > context.Emax:
2438 return context._raise_error(InvalidOperation,
2439 'exponent of quantize result too large for current context')
2440 if self_adjusted - exp._exp + 1 > context.prec:
2441 return context._raise_error(InvalidOperation,
2442 'quantize result has too many digits for current context')
2443
2444 ans = self._rescale(exp._exp, rounding)
2445 if ans.adjusted() > context.Emax:
2446 return context._raise_error(InvalidOperation,
2447 'exponent of quantize result too large for current context')
2448 if len(ans._int) > context.prec:
2449 return context._raise_error(InvalidOperation,
2450 'quantize result has too many digits for current context')
2451
2452 # raise appropriate flags
2453 if ans._exp > self._exp:
2454 context._raise_error(Rounded)
2455 if ans != self:
2456 context._raise_error(Inexact)
2457 if ans and ans.adjusted() < context.Emin:
2458 context._raise_error(Subnormal)
2459
2460 # call to fix takes care of any necessary folddown
2461 ans = ans._fix(context)
2462 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002463
2464 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002465 """Return True if self and other have the same exponent; otherwise
2466 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002467
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002468 If either operand is a special value, the following rules are used:
2469 * return True if both operands are infinities
2470 * return True if both operands are NaNs
2471 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002472 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002473 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002474 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002475 return (self.is_nan() and other.is_nan() or
2476 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002477 return self._exp == other._exp
2478
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002479 def _rescale(self, exp, rounding):
2480 """Rescale self so that the exponent is exp, either by padding with zeros
2481 or by truncating digits, using the given rounding mode.
2482
2483 Specials are returned without change. This operation is
2484 quiet: it raises no flags, and uses no information from the
2485 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002486
2487 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002488 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002489 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002490 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002491 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002492 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002493 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002494
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002495 if self._exp >= exp:
2496 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002497 return _dec_from_triple(self._sign,
2498 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002499
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002500 # too many digits; round and lose data. If self.adjusted() <
2501 # exp-1, replace self by 10**(exp-1) before rounding
2502 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002503 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002504 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002505 digits = 0
2506 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002507 changed = this_function(digits)
2508 coeff = self._int[:digits] or '0'
2509 if changed == 1:
2510 coeff = str(int(coeff)+1)
2511 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002512
Christian Heimesf16baeb2008-02-29 14:57:44 +00002513 def _round(self, places, rounding):
2514 """Round a nonzero, nonspecial Decimal to a fixed number of
2515 significant figures, using the given rounding mode.
2516
2517 Infinities, NaNs and zeros are returned unaltered.
2518
2519 This operation is quiet: it raises no flags, and uses no
2520 information from the context.
2521
2522 """
2523 if places <= 0:
2524 raise ValueError("argument should be at least 1 in _round")
2525 if self._is_special or not self:
2526 return Decimal(self)
2527 ans = self._rescale(self.adjusted()+1-places, rounding)
2528 # it can happen that the rescale alters the adjusted exponent;
2529 # for example when rounding 99.97 to 3 significant figures.
2530 # When this happens we end up with an extra 0 at the end of
2531 # the number; a second rescale fixes this.
2532 if ans.adjusted() != self.adjusted():
2533 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2534 return ans
2535
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002536 def to_integral_exact(self, rounding=None, context=None):
2537 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002538
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002539 If no rounding mode is specified, take the rounding mode from
2540 the context. This method raises the Rounded and Inexact flags
2541 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002542
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002543 See also: to_integral_value, which does exactly the same as
2544 this method except that it doesn't raise Inexact or Rounded.
2545 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002546 if self._is_special:
2547 ans = self._check_nans(context=context)
2548 if ans:
2549 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002550 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002551 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002552 return Decimal(self)
2553 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002554 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002555 if context is None:
2556 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002557 if rounding is None:
2558 rounding = context.rounding
2559 context._raise_error(Rounded)
2560 ans = self._rescale(0, rounding)
2561 if ans != self:
2562 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002563 return ans
2564
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002565 def to_integral_value(self, rounding=None, context=None):
2566 """Rounds to the nearest integer, without raising inexact, rounded."""
2567 if context is None:
2568 context = getcontext()
2569 if rounding is None:
2570 rounding = context.rounding
2571 if self._is_special:
2572 ans = self._check_nans(context=context)
2573 if ans:
2574 return ans
2575 return Decimal(self)
2576 if self._exp >= 0:
2577 return Decimal(self)
2578 else:
2579 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002580
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002581 # the method name changed, but we provide also the old one, for compatibility
2582 to_integral = to_integral_value
2583
2584 def sqrt(self, context=None):
2585 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002586 if context is None:
2587 context = getcontext()
2588
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002589 if self._is_special:
2590 ans = self._check_nans(context=context)
2591 if ans:
2592 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002593
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002594 if self._isinfinity() and self._sign == 0:
2595 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002596
2597 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002598 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002599 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002600 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002601
2602 if self._sign == 1:
2603 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2604
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002605 # At this point self represents a positive number. Let p be
2606 # the desired precision and express self in the form c*100**e
2607 # with c a positive real number and e an integer, c and e
2608 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2609 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2610 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2611 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2612 # the closest integer to sqrt(c) with the even integer chosen
2613 # in the case of a tie.
2614 #
2615 # To ensure correct rounding in all cases, we use the
2616 # following trick: we compute the square root to an extra
2617 # place (precision p+1 instead of precision p), rounding down.
2618 # Then, if the result is inexact and its last digit is 0 or 5,
2619 # we increase the last digit to 1 or 6 respectively; if it's
2620 # exact we leave the last digit alone. Now the final round to
2621 # p places (or fewer in the case of underflow) will round
2622 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002623
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002624 # use an extra digit of precision
2625 prec = context.prec+1
2626
2627 # write argument in the form c*100**e where e = self._exp//2
2628 # is the 'ideal' exponent, to be used if the square root is
2629 # exactly representable. l is the number of 'digits' of c in
2630 # base 100, so that 100**(l-1) <= c < 100**l.
2631 op = _WorkRep(self)
2632 e = op.exp >> 1
2633 if op.exp & 1:
2634 c = op.int * 10
2635 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002636 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002637 c = op.int
2638 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002639
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002640 # rescale so that c has exactly prec base 100 'digits'
2641 shift = prec-l
2642 if shift >= 0:
2643 c *= 100**shift
2644 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002645 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002646 c, remainder = divmod(c, 100**-shift)
2647 exact = not remainder
2648 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002649
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002650 # find n = floor(sqrt(c)) using Newton's method
2651 n = 10**prec
2652 while True:
2653 q = c//n
2654 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002655 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002656 else:
2657 n = n + q >> 1
2658 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002659
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002660 if exact:
2661 # result is exact; rescale to use ideal exponent e
2662 if shift >= 0:
2663 # assert n % 10**shift == 0
2664 n //= 10**shift
2665 else:
2666 n *= 10**-shift
2667 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002668 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002669 # result is not exact; fix last digit as described above
2670 if n % 5 == 0:
2671 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002672
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002673 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002674
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002675 # round, and fit to current context
2676 context = context._shallow_copy()
2677 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002678 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002679 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002680
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002681 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002682
2683 def max(self, other, context=None):
2684 """Returns the larger value.
2685
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002686 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002687 NaN (and signals if one is sNaN). Also rounds.
2688 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002689 other = _convert_other(other, raiseit=True)
2690
2691 if context is None:
2692 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002693
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002694 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002695 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002696 # number is always returned
2697 sn = self._isnan()
2698 on = other._isnan()
2699 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002700 if on == 1 and sn == 0:
2701 return self._fix(context)
2702 if sn == 1 and on == 0:
2703 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002704 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002705
Christian Heimes77c02eb2008-02-09 02:18:51 +00002706 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002707 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002708 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002709 # then an ordering is applied:
2710 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002711 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002712 # positive sign and min returns the operand with the negative sign
2713 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002714 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002715 # the result. This is exactly the ordering used in compare_total.
2716 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002717
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002718 if c == -1:
2719 ans = other
2720 else:
2721 ans = self
2722
Christian Heimes2c181612007-12-17 20:04:13 +00002723 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002724
2725 def min(self, other, context=None):
2726 """Returns the smaller value.
2727
Guido van Rossumd8faa362007-04-27 19:54:29 +00002728 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002729 NaN (and signals if one is sNaN). Also rounds.
2730 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002731 other = _convert_other(other, raiseit=True)
2732
2733 if context is None:
2734 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002735
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002736 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002737 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002738 # number is always returned
2739 sn = self._isnan()
2740 on = other._isnan()
2741 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002742 if on == 1 and sn == 0:
2743 return self._fix(context)
2744 if sn == 1 and on == 0:
2745 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002746 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002747
Christian Heimes77c02eb2008-02-09 02:18:51 +00002748 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002749 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002750 c = self.compare_total(other)
2751
2752 if c == -1:
2753 ans = self
2754 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002755 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002756
Christian Heimes2c181612007-12-17 20:04:13 +00002757 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002758
2759 def _isinteger(self):
2760 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002761 if self._is_special:
2762 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002763 if self._exp >= 0:
2764 return True
2765 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002766 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002767
2768 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002769 """Returns True if self is even. Assumes self is an integer."""
2770 if not self or self._exp > 0:
2771 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002772 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002773
2774 def adjusted(self):
2775 """Return the adjusted exponent of self"""
2776 try:
2777 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002778 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002779 except TypeError:
2780 return 0
2781
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002782 def canonical(self, context=None):
2783 """Returns the same Decimal object.
2784
2785 As we do not have different encodings for the same number, the
2786 received object already is in its canonical form.
2787 """
2788 return self
2789
2790 def compare_signal(self, other, context=None):
2791 """Compares self to the other operand numerically.
2792
2793 It's pretty much like compare(), but all NaNs signal, with signaling
2794 NaNs taking precedence over quiet NaNs.
2795 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002796 other = _convert_other(other, raiseit = True)
2797 ans = self._compare_check_nans(other, context)
2798 if ans:
2799 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002800 return self.compare(other, context=context)
2801
2802 def compare_total(self, other):
2803 """Compares self to other using the abstract representations.
2804
2805 This is not like the standard compare, which use their numerical
2806 value. Note that a total ordering is defined for all possible abstract
2807 representations.
2808 """
2809 # if one is negative and the other is positive, it's easy
2810 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002811 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002812 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002813 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002814 sign = self._sign
2815
2816 # let's handle both NaN types
2817 self_nan = self._isnan()
2818 other_nan = other._isnan()
2819 if self_nan or other_nan:
2820 if self_nan == other_nan:
Mark Dickinson7a6bcce2009-08-28 13:44:35 +00002821 # compare payloads as though they're integers
2822 self_key = len(self._int), self._int
2823 other_key = len(other._int), other._int
2824 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002825 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
Mark Dickinson7a6bcce2009-08-28 13:44:35 +00002829 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002830 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
Mark Dickinson8d238292009-08-02 10:16:33 +00005483# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005484
5485import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005486_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005487# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005488 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005489 (
Mark Dickinson8d238292009-08-02 10:16:33 +00005490 (?=\d|\.\d) # ...a number (with at least one digit)
5491 (?P<int>\d*) # having a (possibly empty) integer part
5492 (\.(?P<frac>\d*))? # followed by an optional fractional part
5493 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005494 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005495 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005496 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005497 (?P<signal>s)? # ...an (optionally signaling)
5498 NaN # NaN
Mark Dickinson8d238292009-08-02 10:16:33 +00005499 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005500 )
5501# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005502 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005503""", re.VERBOSE | re.IGNORECASE).match
5504
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005505_all_zeros = re.compile('0*$').match
5506_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005507
5508##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005509# The functions in this section have little to do with the Decimal
5510# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005511# Python numeric classes that want to implement __format__
5512#
5513# A format specifier for Decimal looks like:
5514#
Mark Dickinson79f52032009-03-17 23:12:51 +00005515# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005516
5517_parse_format_specifier_regex = re.compile(r"""\A
5518(?:
5519 (?P<fill>.)?
5520 (?P<align>[<>=^])
5521)?
5522(?P<sign>[-+ ])?
5523(?P<zeropad>0)?
5524(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00005525(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005526(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00005527(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005528\Z
5529""", re.VERBOSE)
5530
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005531del re
5532
Mark Dickinson79f52032009-03-17 23:12:51 +00005533# The locale module is only needed for the 'n' format specifier. The
5534# rest of the PEP 3101 code functions quite happily without it, so we
5535# don't care too much if locale isn't present.
5536try:
5537 import locale as _locale
5538except ImportError:
5539 pass
5540
5541def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00005542 """Parse and validate a format specifier.
5543
5544 Turns a standard numeric format specifier into a dict, with the
5545 following entries:
5546
5547 fill: fill character to pad field to minimum width
5548 align: alignment type, either '<', '>', '=' or '^'
5549 sign: either '+', '-' or ' '
5550 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00005551 zeropad: boolean, indicating whether to pad with zeros
5552 thousands_sep: string to use as thousands separator, or ''
5553 grouping: grouping for thousands separators, in format
5554 used by localeconv
5555 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00005556 precision: nonnegative integer giving precision, or None
5557 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00005558
5559 """
5560 m = _parse_format_specifier_regex.match(format_spec)
5561 if m is None:
5562 raise ValueError("Invalid format specifier: " + format_spec)
5563
5564 # get the dictionary
5565 format_dict = m.groupdict()
5566
Mark Dickinson79f52032009-03-17 23:12:51 +00005567 # zeropad; defaults for fill and alignment. If zero padding
5568 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00005569 fill = format_dict['fill']
5570 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00005571 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5572 if format_dict['zeropad']:
5573 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005574 raise ValueError("Fill character conflicts with '0'"
5575 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00005576 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005577 raise ValueError("Alignment conflicts with '0' in "
5578 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00005579 format_dict['fill'] = fill or ' '
5580 format_dict['align'] = align or '<'
5581
Mark Dickinson79f52032009-03-17 23:12:51 +00005582 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00005583 if format_dict['sign'] is None:
5584 format_dict['sign'] = '-'
5585
Christian Heimesf16baeb2008-02-29 14:57:44 +00005586 # minimumwidth defaults to 0; precision remains None if not given
5587 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5588 if format_dict['precision'] is not None:
5589 format_dict['precision'] = int(format_dict['precision'])
5590
5591 # if format type is 'g' or 'G' then a precision of 0 makes little
5592 # sense; convert it to 1. Same if format type is unspecified.
5593 if format_dict['precision'] == 0:
Mark Dickinsond496d302009-09-07 16:23:26 +00005594 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005595 format_dict['precision'] = 1
5596
Mark Dickinson79f52032009-03-17 23:12:51 +00005597 # determine thousands separator, grouping, and decimal separator, and
5598 # add appropriate entries to format_dict
5599 if format_dict['type'] == 'n':
5600 # apart from separators, 'n' behaves just like 'g'
5601 format_dict['type'] = 'g'
5602 if _localeconv is None:
5603 _localeconv = _locale.localeconv()
5604 if format_dict['thousands_sep'] is not None:
5605 raise ValueError("Explicit thousands separator conflicts with "
5606 "'n' type in format specifier: " + format_spec)
5607 format_dict['thousands_sep'] = _localeconv['thousands_sep']
5608 format_dict['grouping'] = _localeconv['grouping']
5609 format_dict['decimal_point'] = _localeconv['decimal_point']
5610 else:
5611 if format_dict['thousands_sep'] is None:
5612 format_dict['thousands_sep'] = ''
5613 format_dict['grouping'] = [3, 0]
5614 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00005615
5616 return format_dict
5617
Mark Dickinson79f52032009-03-17 23:12:51 +00005618def _format_align(sign, body, spec):
5619 """Given an unpadded, non-aligned numeric string 'body' and sign
5620 string 'sign', add padding and aligment conforming to the given
5621 format specifier dictionary 'spec' (as produced by
5622 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00005623
5624 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00005625 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00005626 minimumwidth = spec['minimumwidth']
5627 fill = spec['fill']
5628 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00005629
Mark Dickinson79f52032009-03-17 23:12:51 +00005630 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00005631 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005632 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00005633 elif align == '>':
5634 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00005635 elif align == '=':
5636 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00005637 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005638 half = len(padding)//2
5639 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00005640 else:
5641 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00005642
Christian Heimesf16baeb2008-02-29 14:57:44 +00005643 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005644
Mark Dickinson79f52032009-03-17 23:12:51 +00005645def _group_lengths(grouping):
5646 """Convert a localeconv-style grouping into a (possibly infinite)
5647 iterable of integers representing group lengths.
5648
5649 """
5650 # The result from localeconv()['grouping'], and the input to this
5651 # function, should be a list of integers in one of the
5652 # following three forms:
5653 #
5654 # (1) an empty list, or
5655 # (2) nonempty list of positive integers + [0]
5656 # (3) list of positive integers + [locale.CHAR_MAX], or
5657
5658 from itertools import chain, repeat
5659 if not grouping:
5660 return []
5661 elif grouping[-1] == 0 and len(grouping) >= 2:
5662 return chain(grouping[:-1], repeat(grouping[-2]))
5663 elif grouping[-1] == _locale.CHAR_MAX:
5664 return grouping[:-1]
5665 else:
5666 raise ValueError('unrecognised format for grouping')
5667
5668def _insert_thousands_sep(digits, spec, min_width=1):
5669 """Insert thousands separators into a digit string.
5670
5671 spec is a dictionary whose keys should include 'thousands_sep' and
5672 'grouping'; typically it's the result of parsing the format
5673 specifier using _parse_format_specifier.
5674
5675 The min_width keyword argument gives the minimum length of the
5676 result, which will be padded on the left with zeros if necessary.
5677
5678 If necessary, the zero padding adds an extra '0' on the left to
5679 avoid a leading thousands separator. For example, inserting
5680 commas every three digits in '123456', with min_width=8, gives
5681 '0,123,456', even though that has length 9.
5682
5683 """
5684
5685 sep = spec['thousands_sep']
5686 grouping = spec['grouping']
5687
5688 groups = []
5689 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00005690 if l <= 0:
5691 raise ValueError("group length should be positive")
5692 # max(..., 1) forces at least 1 digit to the left of a separator
5693 l = min(max(len(digits), min_width, 1), l)
5694 groups.append('0'*(l - len(digits)) + digits[-l:])
5695 digits = digits[:-l]
5696 min_width -= l
5697 if not digits and min_width <= 0:
5698 break
Mark Dickinson7303b592009-03-18 08:25:36 +00005699 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00005700 else:
5701 l = max(len(digits), min_width, 1)
5702 groups.append('0'*(l - len(digits)) + digits[-l:])
5703 return sep.join(reversed(groups))
5704
5705def _format_sign(is_negative, spec):
5706 """Determine sign character."""
5707
5708 if is_negative:
5709 return '-'
5710 elif spec['sign'] in ' +':
5711 return spec['sign']
5712 else:
5713 return ''
5714
5715def _format_number(is_negative, intpart, fracpart, exp, spec):
5716 """Format a number, given the following data:
5717
5718 is_negative: true if the number is negative, else false
5719 intpart: string of digits that must appear before the decimal point
5720 fracpart: string of digits that must come after the point
5721 exp: exponent, as an integer
5722 spec: dictionary resulting from parsing the format specifier
5723
5724 This function uses the information in spec to:
5725 insert separators (decimal separator and thousands separators)
5726 format the sign
5727 format the exponent
5728 add trailing '%' for the '%' type
5729 zero-pad if necessary
5730 fill and align if necessary
5731 """
5732
5733 sign = _format_sign(is_negative, spec)
5734
5735 if fracpart:
5736 fracpart = spec['decimal_point'] + fracpart
5737
5738 if exp != 0 or spec['type'] in 'eE':
5739 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
5740 fracpart += "{0}{1:+}".format(echar, exp)
5741 if spec['type'] == '%':
5742 fracpart += '%'
5743
5744 if spec['zeropad']:
5745 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
5746 else:
5747 min_width = 0
5748 intpart = _insert_thousands_sep(intpart, spec, min_width)
5749
5750 return _format_align(sign, intpart+fracpart, spec)
5751
5752
Guido van Rossumd8faa362007-04-27 19:54:29 +00005753##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005754
Guido van Rossumd8faa362007-04-27 19:54:29 +00005755# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005756_Infinity = Decimal('Inf')
5757_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00005758_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005759_Zero = Decimal(0)
5760_One = Decimal(1)
5761_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005762
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005763# _SignedInfinity[sign] is infinity w/ that sign
5764_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005765
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005766
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005767
5768if __name__ == '__main__':
5769 import doctest, sys
5770 doctest.testmod(sys.modules[__name__])