blob: cc71cd834032e358594ebed9fb8c0e9c864d776a [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
Stefan Krah2eb4a072010-05-19 15:52:31 +0000167 trap_enabler is not set. First argument is self, second is the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000168 context. More arguments can be given, those being after
169 the explanation in _raise_error (For example,
170 context._raise_error(NewError, '(-x)!', self._sign) would
171 call NewError().handle(context, self._sign).)
172
173 To define a new exception, it should be sufficient to have it derive
174 from DecimalException.
175 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000176 def handle(self, context, *args):
177 pass
178
179
180class Clamped(DecimalException):
181 """Exponent of a 0 changed to fit bounds.
182
183 This occurs and signals clamped if the exponent of a result has been
184 altered in order to fit the constraints of a specific concrete
Guido van Rossumd8faa362007-04-27 19:54:29 +0000185 representation. This may occur when the exponent of a zero result would
186 be outside the bounds of a representation, or when a large normal
187 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000188 this latter case, the exponent is reduced to fit and the corresponding
189 number of zero digits are appended to the coefficient ("fold-down").
190 """
191
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000192class InvalidOperation(DecimalException):
193 """An invalid operation was performed.
194
195 Various bad things cause this:
196
197 Something creates a signaling NaN
198 -INF + INF
Guido van Rossumd8faa362007-04-27 19:54:29 +0000199 0 * (+-)INF
200 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000201 x % 0
202 (+-)INF % x
203 x._rescale( non-integer )
204 sqrt(-x) , x > 0
205 0 ** 0
206 x ** (non-integer)
207 x ** (+-)INF
208 An operand is invalid
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000209
210 The result of the operation after these is a quiet positive NaN,
211 except when the cause is a signaling NaN, in which case the result is
212 also a quiet NaN, but with the original sign, and an optional
213 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000214 """
215 def handle(self, context, *args):
216 if args:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000217 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
218 return ans._fix_nan(context)
Mark Dickinsonf9236412009-01-02 23:23:21 +0000219 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000220
221class ConversionSyntax(InvalidOperation):
222 """Trying to convert badly formed string.
223
224 This occurs and signals invalid-operation if an string is being
225 converted to a number and it does not conform to the numeric string
Guido van Rossumd8faa362007-04-27 19:54:29 +0000226 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000227 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000228 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000229 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000230
231class DivisionByZero(DecimalException, ZeroDivisionError):
232 """Division by 0.
233
234 This occurs and signals division-by-zero if division of a finite number
235 by zero was attempted (during a divide-integer or divide operation, or a
236 power operation with negative right-hand operand), and the dividend was
237 not zero.
238
239 The result of the operation is [sign,inf], where sign is the exclusive
240 or of the signs of the operands for divide, or is 1 for an odd power of
241 -0, for power.
242 """
243
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000244 def handle(self, context, sign, *args):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000245 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000246
247class DivisionImpossible(InvalidOperation):
248 """Cannot perform the division adequately.
249
250 This occurs and signals invalid-operation if the integer result of a
251 divide-integer or remainder operation had too many digits (would be
Guido van Rossumd8faa362007-04-27 19:54:29 +0000252 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000253 """
254
255 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000256 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000257
258class DivisionUndefined(InvalidOperation, ZeroDivisionError):
259 """Undefined result of division.
260
261 This occurs and signals invalid-operation if division by zero was
262 attempted (during a divide-integer, divide, or remainder operation), and
Guido van Rossumd8faa362007-04-27 19:54:29 +0000263 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000264 """
265
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000266 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000267 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000268
269class Inexact(DecimalException):
270 """Had to round, losing information.
271
272 This occurs and signals inexact whenever the result of an operation is
273 not exact (that is, it needed to be rounded and any discarded digits
Guido van Rossumd8faa362007-04-27 19:54:29 +0000274 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000275 result in all cases is unchanged.
276
277 The inexact signal may be tested (or trapped) to determine if a given
278 operation (or sequence of operations) was inexact.
279 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000280
281class InvalidContext(InvalidOperation):
282 """Invalid context. Unknown rounding, for example.
283
284 This occurs and signals invalid-operation if an invalid context was
Guido van Rossumd8faa362007-04-27 19:54:29 +0000285 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000286 on creation and either the precision exceeds the capability of the
287 underlying concrete representation or an unknown or unsupported rounding
Guido van Rossumd8faa362007-04-27 19:54:29 +0000288 was specified. These aspects of the context need only be checked when
289 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000290 """
291
292 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000293 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000294
295class Rounded(DecimalException):
296 """Number got rounded (not necessarily changed during rounding).
297
298 This occurs and signals rounded whenever the result of an operation is
299 rounded (that is, some zero or non-zero digits were discarded from the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000300 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000301 result in all cases is unchanged.
302
303 The rounded signal may be tested (or trapped) to determine if a given
304 operation (or sequence of operations) caused a loss of precision.
305 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000306
307class Subnormal(DecimalException):
308 """Exponent < Emin before rounding.
309
310 This occurs and signals subnormal whenever the result of a conversion or
311 operation is subnormal (that is, its adjusted exponent is less than
Guido van Rossumd8faa362007-04-27 19:54:29 +0000312 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000313
314 The subnormal signal may be tested (or trapped) to determine if a given
315 or operation (or sequence of operations) yielded a subnormal result.
316 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000317
318class Overflow(Inexact, Rounded):
319 """Numerical overflow.
320
321 This occurs and signals overflow if the adjusted exponent of a result
322 (from a conversion or from an operation that is not an attempt to divide
323 by zero), after rounding, would be greater than the largest value that
324 can be handled by the implementation (the value Emax).
325
326 The result depends on the rounding mode:
327
328 For round-half-up and round-half-even (and for round-half-down and
329 round-up, if implemented), the result of the operation is [sign,inf],
Guido van Rossumd8faa362007-04-27 19:54:29 +0000330 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000331 result is the largest finite number that can be represented in the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000332 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000333 round-ceiling, the result is the same as for round-down if the sign of
Guido van Rossumd8faa362007-04-27 19:54:29 +0000334 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000335 the result is the same as for round-down if the sign of the intermediate
Guido van Rossumd8faa362007-04-27 19:54:29 +0000336 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000337 will also be raised.
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000338 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000339
340 def handle(self, context, sign, *args):
341 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000342 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000343 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000344 if sign == 0:
345 if context.rounding == ROUND_CEILING:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000346 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000347 return _dec_from_triple(sign, '9'*context.prec,
348 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000349 if sign == 1:
350 if context.rounding == ROUND_FLOOR:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000351 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000352 return _dec_from_triple(sign, '9'*context.prec,
353 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000354
355
356class Underflow(Inexact, Rounded, Subnormal):
357 """Numerical underflow with result rounded to 0.
358
359 This occurs and signals underflow if a result is inexact and the
360 adjusted exponent of the result would be smaller (more negative) than
361 the smallest value that can be handled by the implementation (the value
Guido van Rossumd8faa362007-04-27 19:54:29 +0000362 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000363
364 The result after an underflow will be a subnormal number rounded, if
Guido van Rossumd8faa362007-04-27 19:54:29 +0000365 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000366 in 0 with the sign of the intermediate result and an exponent of Etiny.
367
368 In all cases, Inexact, Rounded, and Subnormal will also be raised.
369 """
370
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000371# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000372_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000373 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000374
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000375# Map conditions (per the spec) to signals
376_condition_map = {ConversionSyntax:InvalidOperation,
377 DivisionImpossible:InvalidOperation,
378 DivisionUndefined:InvalidOperation,
379 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000380
Guido van Rossumd8faa362007-04-27 19:54:29 +0000381##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000382
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000383# The getcontext() and setcontext() function manage access to a thread-local
384# current context. Py2.4 offers direct support for thread locals. If that
Georg Brandlf9926402008-06-13 06:32:25 +0000385# is not available, use threading.current_thread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000386# work for older Pythons. If threads are not part of the build, create a
387# mock threading object with threading.local() returning the module namespace.
388
389try:
390 import threading
391except ImportError:
392 # Python was compiled without threads; create a mock object instead
393 import sys
Guido van Rossumd8faa362007-04-27 19:54:29 +0000394 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000395 def local(self, sys=sys):
396 return sys.modules[__name__]
397 threading = MockThreading()
398 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000399
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000400try:
401 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000402
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000403except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000404
Guido van Rossumd8faa362007-04-27 19:54:29 +0000405 # To fix reloading, force it to create a new context
406 # Old contexts have different exceptions in their dicts, making problems.
Georg Brandlf9926402008-06-13 06:32:25 +0000407 if hasattr(threading.current_thread(), '__decimal_context__'):
408 del threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000409
410 def setcontext(context):
411 """Set this thread's context to context."""
412 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000413 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000414 context.clear_flags()
Georg Brandlf9926402008-06-13 06:32:25 +0000415 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000416
417 def getcontext():
418 """Returns this thread's context.
419
420 If this thread does not yet have a context, returns
421 a new context and sets this thread's context.
422 New contexts are copies of DefaultContext.
423 """
424 try:
Georg Brandlf9926402008-06-13 06:32:25 +0000425 return threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000426 except AttributeError:
427 context = Context()
Georg Brandlf9926402008-06-13 06:32:25 +0000428 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000429 return context
430
431else:
432
433 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000434 if hasattr(local, '__decimal_context__'):
435 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000436
437 def getcontext(_local=local):
438 """Returns this thread's context.
439
440 If this thread does not yet have a context, returns
441 a new context and sets this thread's context.
442 New contexts are copies of DefaultContext.
443 """
444 try:
445 return _local.__decimal_context__
446 except AttributeError:
447 context = Context()
448 _local.__decimal_context__ = context
449 return context
450
451 def setcontext(context, _local=local):
452 """Set this thread's context to context."""
453 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000454 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000455 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000456 _local.__decimal_context__ = context
457
458 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000459
Thomas Wouters89f507f2006-12-13 04:49:30 +0000460def localcontext(ctx=None):
461 """Return a context manager for a copy of the supplied context
462
463 Uses a copy of the current context if no context is specified
464 The returned context manager creates a local decimal context
465 in a with statement:
466 def sin(x):
467 with localcontext() as ctx:
468 ctx.prec += 2
469 # Rest of sin calculation algorithm
470 # uses a precision 2 greater than normal
Guido van Rossumd8faa362007-04-27 19:54:29 +0000471 return +s # Convert result to normal precision
Thomas Wouters89f507f2006-12-13 04:49:30 +0000472
473 def sin(x):
474 with localcontext(ExtendedContext):
475 # Rest of sin calculation algorithm
476 # uses the Extended Context from the
477 # General Decimal Arithmetic Specification
Guido van Rossumd8faa362007-04-27 19:54:29 +0000478 return +s # Convert result to normal context
Thomas Wouters89f507f2006-12-13 04:49:30 +0000479
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000480 >>> setcontext(DefaultContext)
Guido van Rossum7131f842007-02-09 20:13:25 +0000481 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000482 28
483 >>> with localcontext():
484 ... ctx = getcontext()
Thomas Wouterscf297e42007-02-23 15:07:44 +0000485 ... ctx.prec += 2
Guido van Rossum7131f842007-02-09 20:13:25 +0000486 ... print(ctx.prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000487 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000488 30
489 >>> with localcontext(ExtendedContext):
Guido van Rossum7131f842007-02-09 20:13:25 +0000490 ... print(getcontext().prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000491 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000492 9
Guido van Rossum7131f842007-02-09 20:13:25 +0000493 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000494 28
495 """
496 if ctx is None: ctx = getcontext()
497 return _ContextManager(ctx)
498
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000499
Guido van Rossumd8faa362007-04-27 19:54:29 +0000500##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000501
Raymond Hettingera0fd8882009-01-20 07:24:44 +0000502# Do not subclass Decimal from numbers.Real and do not register it as such
503# (because Decimals are not interoperable with floats). See the notes in
504# numbers.py for more detail.
505
506class Decimal(object):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000507 """Floating point class for decimal arithmetic."""
508
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000509 __slots__ = ('_exp','_int','_sign', '_is_special')
510 # Generally, the value of the Decimal instance is given by
511 # (-1)**_sign * _int * 10**_exp
512 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000513
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000514 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000515 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000516 """Create a decimal point instance.
517
518 >>> Decimal('3.14') # string input
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000519 Decimal('3.14')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000520 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000521 Decimal('3.14')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000522 >>> Decimal(314) # int
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000523 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000524 >>> Decimal(Decimal(314)) # another decimal instance
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000525 Decimal('314')
Christian Heimesa62da1d2008-01-12 19:39:10 +0000526 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000527 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000528 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000529
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000530 # Note that the coefficient, self._int, is actually stored as
531 # a string rather than as a tuple of digits. This speeds up
532 # the "digits to integer" and "integer to digits" conversions
533 # that are used in almost every arithmetic operation on
534 # Decimals. This is an internal detail: the as_tuple function
535 # and the Decimal constructor still deal with tuples of
536 # digits.
537
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000538 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000539
Christian Heimesd59c64c2007-11-30 19:27:20 +0000540 # From a string
541 # REs insist on real strings, so we can too.
542 if isinstance(value, str):
Christian Heimesa62da1d2008-01-12 19:39:10 +0000543 m = _parser(value.strip())
Christian Heimesd59c64c2007-11-30 19:27:20 +0000544 if m is None:
545 if context is None:
546 context = getcontext()
547 return context._raise_error(ConversionSyntax,
548 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000549
Christian Heimesd59c64c2007-11-30 19:27:20 +0000550 if m.group('sign') == "-":
551 self._sign = 1
552 else:
553 self._sign = 0
554 intpart = m.group('int')
555 if intpart is not None:
556 # finite number
Mark Dickinson345adc42009-08-02 10:14:23 +0000557 fracpart = m.group('frac') or ''
Christian Heimesd59c64c2007-11-30 19:27:20 +0000558 exp = int(m.group('exp') or '0')
Mark Dickinson345adc42009-08-02 10:14:23 +0000559 self._int = str(int(intpart+fracpart))
560 self._exp = exp - len(fracpart)
Christian Heimesd59c64c2007-11-30 19:27:20 +0000561 self._is_special = False
562 else:
563 diag = m.group('diag')
564 if diag is not None:
565 # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +0000566 self._int = str(int(diag or '0')).lstrip('0')
Christian Heimesd59c64c2007-11-30 19:27:20 +0000567 if m.group('signal'):
568 self._exp = 'N'
569 else:
570 self._exp = 'n'
571 else:
572 # infinity
573 self._int = '0'
574 self._exp = 'F'
575 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000576 return self
577
578 # From an integer
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000579 if isinstance(value, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000580 if value >= 0:
581 self._sign = 0
582 else:
583 self._sign = 1
584 self._exp = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000585 self._int = str(abs(value))
Christian Heimesd59c64c2007-11-30 19:27:20 +0000586 self._is_special = False
587 return self
588
589 # From another decimal
590 if isinstance(value, Decimal):
591 self._exp = value._exp
592 self._sign = value._sign
593 self._int = value._int
594 self._is_special = value._is_special
595 return self
596
597 # From an internal working value
598 if isinstance(value, _WorkRep):
599 self._sign = value.sign
600 self._int = str(value.int)
601 self._exp = int(value.exp)
602 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000603 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000604
605 # tuple/list conversion (possibly from as_tuple())
606 if isinstance(value, (list,tuple)):
607 if len(value) != 3:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000608 raise ValueError('Invalid tuple size in creation of Decimal '
609 'from list or tuple. The list or tuple '
610 'should have exactly three elements.')
611 # process sign. The isinstance test rejects floats
612 if not (isinstance(value[0], int) and value[0] in (0,1)):
613 raise ValueError("Invalid sign. The first value in the tuple "
614 "should be an integer; either 0 for a "
615 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000616 self._sign = value[0]
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000617 if value[2] == 'F':
618 # infinity: value[1] is ignored
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000619 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000620 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000621 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000622 else:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000623 # process and validate the digits in value[1]
624 digits = []
625 for digit in value[1]:
626 if isinstance(digit, int) and 0 <= digit <= 9:
627 # skip leading zeros
628 if digits or digit != 0:
629 digits.append(digit)
630 else:
631 raise ValueError("The second value in the tuple must "
632 "be composed of integers in the range "
633 "0 through 9.")
634 if value[2] in ('n', 'N'):
635 # NaN: digits form the diagnostic
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000636 self._int = ''.join(map(str, digits))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000637 self._exp = value[2]
638 self._is_special = True
639 elif isinstance(value[2], int):
640 # finite number: digits give the coefficient
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000641 self._int = ''.join(map(str, digits or [0]))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000642 self._exp = value[2]
643 self._is_special = False
644 else:
645 raise ValueError("The third value in the tuple must "
646 "be an integer, or one of the "
647 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000648 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000649
Raymond Hettingerbf440692004-07-10 14:14:37 +0000650 if isinstance(value, float):
Raymond Hettinger96798592010-04-02 16:58:27 +0000651 value = Decimal.from_float(value)
652 self._exp = value._exp
653 self._sign = value._sign
654 self._int = value._int
655 self._is_special = value._is_special
656 return self
Raymond Hettingerbf440692004-07-10 14:14:37 +0000657
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000658 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000659
Mark Dickinsonba298e42009-01-04 21:17:43 +0000660 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
661 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000662 def from_float(cls, f):
663 """Converts a float to a decimal number, exactly.
664
665 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
666 Since 0.1 is not exactly representable in binary floating point, the
667 value is stored as the nearest representable value which is
668 0x1.999999999999ap-4. The exact equivalent of the value in decimal
669 is 0.1000000000000000055511151231257827021181583404541015625.
670
671 >>> Decimal.from_float(0.1)
672 Decimal('0.1000000000000000055511151231257827021181583404541015625')
673 >>> Decimal.from_float(float('nan'))
674 Decimal('NaN')
675 >>> Decimal.from_float(float('inf'))
676 Decimal('Infinity')
677 >>> Decimal.from_float(-float('inf'))
678 Decimal('-Infinity')
679 >>> Decimal.from_float(-0.0)
680 Decimal('-0')
681
682 """
683 if isinstance(f, int): # handle integer inputs
684 return cls(f)
685 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
686 return cls(repr(f))
Mark Dickinsonba298e42009-01-04 21:17:43 +0000687 if _math.copysign(1.0, f) == 1.0:
688 sign = 0
689 else:
690 sign = 1
Raymond Hettinger771ed762009-01-03 19:20:32 +0000691 n, d = abs(f).as_integer_ratio()
692 k = d.bit_length() - 1
693 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinsonba298e42009-01-04 21:17:43 +0000694 if cls is Decimal:
695 return result
696 else:
697 return cls(result)
698 from_float = classmethod(from_float)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000699
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000700 def _isnan(self):
701 """Returns whether the number is not actually one.
702
703 0 if a number
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000704 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000705 2 if sNaN
706 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000707 if self._is_special:
708 exp = self._exp
709 if exp == 'n':
710 return 1
711 elif exp == 'N':
712 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000713 return 0
714
715 def _isinfinity(self):
716 """Returns whether the number is infinite
717
718 0 if finite or not a number
719 1 if +INF
720 -1 if -INF
721 """
722 if self._exp == 'F':
723 if self._sign:
724 return -1
725 return 1
726 return 0
727
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000728 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000729 """Returns whether the number is not actually one.
730
731 if self, other are sNaN, signal
732 if self, other are NaN return nan
733 return 0
734
735 Done before operations.
736 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000737
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000738 self_is_nan = self._isnan()
739 if other is None:
740 other_is_nan = False
741 else:
742 other_is_nan = other._isnan()
743
744 if self_is_nan or other_is_nan:
745 if context is None:
746 context = getcontext()
747
748 if self_is_nan == 2:
749 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000750 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000751 if other_is_nan == 2:
752 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000753 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000754 if self_is_nan:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000755 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000756
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000757 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000758 return 0
759
Christian Heimes77c02eb2008-02-09 02:18:51 +0000760 def _compare_check_nans(self, other, context):
761 """Version of _check_nans used for the signaling comparisons
762 compare_signal, __le__, __lt__, __ge__, __gt__.
763
764 Signal InvalidOperation if either self or other is a (quiet
765 or signaling) NaN. Signaling NaNs take precedence over quiet
766 NaNs.
767
768 Return 0 if neither operand is a NaN.
769
770 """
771 if context is None:
772 context = getcontext()
773
774 if self._is_special or other._is_special:
775 if self.is_snan():
776 return context._raise_error(InvalidOperation,
777 'comparison involving sNaN',
778 self)
779 elif other.is_snan():
780 return context._raise_error(InvalidOperation,
781 'comparison involving sNaN',
782 other)
783 elif self.is_qnan():
784 return context._raise_error(InvalidOperation,
785 'comparison involving NaN',
786 self)
787 elif other.is_qnan():
788 return context._raise_error(InvalidOperation,
789 'comparison involving NaN',
790 other)
791 return 0
792
Jack Diederich4dafcc42006-11-28 19:15:13 +0000793 def __bool__(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000794 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000795
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000796 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000797 """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000798 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000799
Christian Heimes77c02eb2008-02-09 02:18:51 +0000800 def _cmp(self, other):
801 """Compare the two non-NaN decimal instances self and other.
802
803 Returns -1 if self < other, 0 if self == other and 1
804 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000805
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000806 if self._is_special or other._is_special:
Mark Dickinsone6aad752009-01-25 10:48:51 +0000807 self_inf = self._isinfinity()
808 other_inf = other._isinfinity()
809 if self_inf == other_inf:
810 return 0
811 elif self_inf < other_inf:
812 return -1
813 else:
814 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000815
Mark Dickinsone6aad752009-01-25 10:48:51 +0000816 # check for zeros; Decimal('0') == Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000817 if not self:
818 if not other:
819 return 0
820 else:
821 return -((-1)**other._sign)
822 if not other:
823 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000824
Guido van Rossumd8faa362007-04-27 19:54:29 +0000825 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000826 if other._sign < self._sign:
827 return -1
828 if self._sign < other._sign:
829 return 1
830
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000831 self_adjusted = self.adjusted()
832 other_adjusted = other.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000833 if self_adjusted == other_adjusted:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000834 self_padded = self._int + '0'*(self._exp - other._exp)
835 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone6aad752009-01-25 10:48:51 +0000836 if self_padded == other_padded:
837 return 0
838 elif self_padded < other_padded:
839 return -(-1)**self._sign
840 else:
841 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000842 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000843 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000844 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000845 return -((-1)**self._sign)
846
Christian Heimes77c02eb2008-02-09 02:18:51 +0000847 # Note: The Decimal standard doesn't cover rich comparisons for
848 # Decimals. In particular, the specification is silent on the
849 # subject of what should happen for a comparison involving a NaN.
850 # We take the following approach:
851 #
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000852 # == comparisons involving a quiet NaN always return False
853 # != comparisons involving a quiet NaN always return True
854 # == or != comparisons involving a signaling NaN signal
855 # InvalidOperation, and return False or True as above if the
856 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000857 # <, >, <= and >= comparisons involving a (quiet or signaling)
858 # NaN signal InvalidOperation, and return False if the
Christian Heimes3feef612008-02-11 06:19:17 +0000859 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000860 #
861 # This behavior is designed to conform as closely as possible to
862 # that specified by IEEE 754.
863
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000864 def __eq__(self, other, context=None):
865 other = _convert_other(other, allow_float=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000866 if other is NotImplemented:
867 return other
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000868 if self._check_nans(other, context):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000869 return False
870 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000871
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000872 def __ne__(self, other, context=None):
873 other = _convert_other(other, allow_float=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000874 if other is NotImplemented:
875 return other
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000876 if self._check_nans(other, context):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000877 return True
878 return self._cmp(other) != 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000879
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000880
Christian Heimes77c02eb2008-02-09 02:18:51 +0000881 def __lt__(self, other, context=None):
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000882 other = _convert_other(other, allow_float=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000883 if other is NotImplemented:
884 return other
885 ans = self._compare_check_nans(other, context)
886 if ans:
887 return False
888 return self._cmp(other) < 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000889
Christian Heimes77c02eb2008-02-09 02:18:51 +0000890 def __le__(self, other, context=None):
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000891 other = _convert_other(other, allow_float=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000892 if other is NotImplemented:
893 return other
894 ans = self._compare_check_nans(other, context)
895 if ans:
896 return False
897 return self._cmp(other) <= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000898
Christian Heimes77c02eb2008-02-09 02:18:51 +0000899 def __gt__(self, other, context=None):
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000900 other = _convert_other(other, allow_float=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000901 if other is NotImplemented:
902 return other
903 ans = self._compare_check_nans(other, context)
904 if ans:
905 return False
906 return self._cmp(other) > 0
907
908 def __ge__(self, other, context=None):
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000909 other = _convert_other(other, allow_float=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000910 if other is NotImplemented:
911 return other
912 ans = self._compare_check_nans(other, context)
913 if ans:
914 return False
915 return self._cmp(other) >= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000916
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000917 def compare(self, other, context=None):
918 """Compares one to another.
919
920 -1 => a < b
921 0 => a = b
922 1 => a > b
923 NaN => one is NaN
924 Like __cmp__, but returns Decimal instances.
925 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000926 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000927
Guido van Rossumd8faa362007-04-27 19:54:29 +0000928 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000929 if (self._is_special or other and other._is_special):
930 ans = self._check_nans(other, context)
931 if ans:
932 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000933
Christian Heimes77c02eb2008-02-09 02:18:51 +0000934 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000935
936 def __hash__(self):
937 """x.__hash__() <==> hash(x)"""
938 # Decimal integers must hash the same as the ints
Christian Heimes2380ac72008-01-09 00:17:24 +0000939 #
940 # The hash of a nonspecial noninteger Decimal must depend only
941 # on the value of that Decimal, and not on its representation.
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000942 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000943
944 # Equality comparisons involving signaling nans can raise an
945 # exception; since equality checks are implicitly and
946 # unpredictably used when checking set and dict membership, we
947 # prevent signaling nans from being used as set elements or
948 # dict keys by making __hash__ raise an exception.
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000949 if self._is_special:
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000950 if self.is_snan():
951 raise TypeError('Cannot hash a signaling NaN value.')
952 elif self.is_nan():
953 # 0 to match hash(float('nan'))
954 return 0
955 else:
956 # values chosen to match hash(float('inf')) and
957 # hash(float('-inf')).
958 if self._sign:
959 return -271828
960 else:
961 return 314159
962
963 # In Python 2.7, we're allowing comparisons (but not
964 # arithmetic operations) between floats and Decimals; so if
965 # a Decimal instance is exactly representable as a float then
966 # its hash should match that of the float.
967 self_as_float = float(self)
968 if Decimal.from_float(self_as_float) == self:
969 return hash(self_as_float)
970
Thomas Wouters8ce81f72007-09-20 18:22:40 +0000971 if self._isinteger():
972 op = _WorkRep(self.to_integral_value())
973 # to make computation feasible for Decimals with large
974 # exponent, we use the fact that hash(n) == hash(m) for
975 # any two nonzero integers n and m such that (i) n and m
976 # have the same sign, and (ii) n is congruent to m modulo
977 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
978 # hash((-1)**s*c*pow(10, e, 2**64-1).
979 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Christian Heimes2380ac72008-01-09 00:17:24 +0000980 # The value of a nonzero nonspecial Decimal instance is
981 # faithfully represented by the triple consisting of its sign,
982 # its adjusted exponent, and its coefficient with trailing
983 # zeros removed.
984 return hash((self._sign,
985 self._exp+len(self._int),
986 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000987
988 def as_tuple(self):
989 """Represents the number as a triple tuple.
990
991 To show the internals exactly as they are.
992 """
Christian Heimes25bb7832008-01-11 16:17:00 +0000993 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000994
995 def __repr__(self):
996 """Represents the number as an instance of Decimal."""
997 # Invariant: eval(repr(d)) == d
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000998 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000999
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001000 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001001 """Return string representation of the number in scientific notation.
1002
1003 Captures all of the information in the underlying representation.
1004 """
1005
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001006 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +00001007 if self._is_special:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001008 if self._exp == 'F':
1009 return sign + 'Infinity'
1010 elif self._exp == 'n':
1011 return sign + 'NaN' + self._int
1012 else: # self._exp == 'N'
1013 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001014
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001015 # number of digits of self._int to left of decimal point
1016 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001017
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001018 # dotplace is number of digits of self._int to the left of the
1019 # decimal point in the mantissa of the output string (that is,
1020 # after adjusting the exponent)
1021 if self._exp <= 0 and leftdigits > -6:
1022 # no exponent required
1023 dotplace = leftdigits
1024 elif not eng:
1025 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001026 dotplace = 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001027 elif self._int == '0':
1028 # engineering notation, zero
1029 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001030 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001031 # engineering notation, nonzero
1032 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001033
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001034 if dotplace <= 0:
1035 intpart = '0'
1036 fracpart = '.' + '0'*(-dotplace) + self._int
1037 elif dotplace >= len(self._int):
1038 intpart = self._int+'0'*(dotplace-len(self._int))
1039 fracpart = ''
1040 else:
1041 intpart = self._int[:dotplace]
1042 fracpart = '.' + self._int[dotplace:]
1043 if leftdigits == dotplace:
1044 exp = ''
1045 else:
1046 if context is None:
1047 context = getcontext()
1048 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1049
1050 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001051
1052 def to_eng_string(self, context=None):
1053 """Convert to engineering-type string.
1054
1055 Engineering notation has an exponent which is a multiple of 3, so there
1056 are up to 3 digits left of the decimal place.
1057
1058 Same rules for when in exponential and when as a value as in __str__.
1059 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001060 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001061
1062 def __neg__(self, context=None):
1063 """Returns a copy with the sign switched.
1064
1065 Rounds, if it has reason.
1066 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001067 if self._is_special:
1068 ans = self._check_nans(context=context)
1069 if ans:
1070 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001071
1072 if not self:
1073 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001074 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001075 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001076 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001077
1078 if context is None:
1079 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001080 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001081
1082 def __pos__(self, context=None):
1083 """Returns a copy, unless it is a sNaN.
1084
1085 Rounds the number (if more then precision digits)
1086 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001087 if self._is_special:
1088 ans = self._check_nans(context=context)
1089 if ans:
1090 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001091
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001092 if not self:
1093 # + (-0) = 0
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001094 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001095 else:
1096 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001097
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001098 if context is None:
1099 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001100 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001101
Christian Heimes2c181612007-12-17 20:04:13 +00001102 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001103 """Returns the absolute value of self.
1104
Christian Heimes2c181612007-12-17 20:04:13 +00001105 If the keyword argument 'round' is false, do not round. The
1106 expression self.__abs__(round=False) is equivalent to
1107 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001108 """
Christian Heimes2c181612007-12-17 20:04:13 +00001109 if not round:
1110 return self.copy_abs()
1111
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001112 if self._is_special:
1113 ans = self._check_nans(context=context)
1114 if ans:
1115 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001116
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001117 if self._sign:
1118 ans = self.__neg__(context=context)
1119 else:
1120 ans = self.__pos__(context=context)
1121
1122 return ans
1123
1124 def __add__(self, other, context=None):
1125 """Returns self + other.
1126
1127 -INF + INF (or the reverse) cause InvalidOperation errors.
1128 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001129 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001130 if other is NotImplemented:
1131 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001132
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001133 if context is None:
1134 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001135
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001136 if self._is_special or other._is_special:
1137 ans = self._check_nans(other, context)
1138 if ans:
1139 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001140
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001141 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001142 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001143 if self._sign != other._sign and other._isinfinity():
1144 return context._raise_error(InvalidOperation, '-INF + INF')
1145 return Decimal(self)
1146 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001147 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001148
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149 exp = min(self._exp, other._exp)
1150 negativezero = 0
1151 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001152 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001153 negativezero = 1
1154
1155 if not self and not other:
1156 sign = min(self._sign, other._sign)
1157 if negativezero:
1158 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001159 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001160 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001161 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001162 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001163 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001164 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001165 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001166 return ans
1167 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001168 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001169 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001170 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001171 return ans
1172
1173 op1 = _WorkRep(self)
1174 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001175 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001176
1177 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001179 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001180 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001181 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001182 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001183 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001184 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001185 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001186 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001187 if op1.sign == 1:
1188 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001189 op1.sign, op2.sign = op2.sign, op1.sign
1190 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001191 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001192 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001193 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001194 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001195 op1.sign, op2.sign = (0, 0)
1196 else:
1197 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001198 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001199
Raymond Hettinger17931de2004-10-27 06:21:46 +00001200 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001201 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001202 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001203 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204
1205 result.exp = op1.exp
1206 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001207 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001208 return ans
1209
1210 __radd__ = __add__
1211
1212 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001213 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001214 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001215 if other is NotImplemented:
1216 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001217
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001218 if self._is_special or other._is_special:
1219 ans = self._check_nans(other, context=context)
1220 if ans:
1221 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001222
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001223 # self - other is computed as self + other.copy_negate()
1224 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001225
1226 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001227 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001228 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001229 if other is NotImplemented:
1230 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001231
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001232 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001234 def __mul__(self, other, context=None):
1235 """Return self * other.
1236
1237 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1238 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001239 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001240 if other is NotImplemented:
1241 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001242
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001243 if context is None:
1244 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001245
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001246 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001247
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001248 if self._is_special or other._is_special:
1249 ans = self._check_nans(other, context)
1250 if ans:
1251 return ans
1252
1253 if self._isinfinity():
1254 if not other:
1255 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001256 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001257
1258 if other._isinfinity():
1259 if not self:
1260 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001261 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001262
1263 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001264
1265 # Special case for multiplying by zero
1266 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001267 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001268 # Fixing in case the exponent is out of bounds
1269 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001270 return ans
1271
1272 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001273 if self._int == '1':
1274 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001275 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001276 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001277 if other._int == '1':
1278 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001279 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001280 return ans
1281
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001282 op1 = _WorkRep(self)
1283 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001284
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001285 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001286 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001287
1288 return ans
1289 __rmul__ = __mul__
1290
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001291 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001292 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001293 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001294 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001295 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001296
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001297 if context is None:
1298 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001299
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001300 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001301
1302 if self._is_special or other._is_special:
1303 ans = self._check_nans(other, context)
1304 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001305 return ans
1306
1307 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001308 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001309
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001310 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001311 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001312
1313 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001314 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001315 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001316
1317 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001318 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001319 if not self:
1320 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001321 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001322
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001323 if not self:
1324 exp = self._exp - other._exp
1325 coeff = 0
1326 else:
1327 # OK, so neither = 0, INF or NaN
1328 shift = len(other._int) - len(self._int) + context.prec + 1
1329 exp = self._exp - other._exp - shift
1330 op1 = _WorkRep(self)
1331 op2 = _WorkRep(other)
1332 if shift >= 0:
1333 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1334 else:
1335 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1336 if remainder:
1337 # result is not exact; adjust to ensure correct rounding
1338 if coeff % 5 == 0:
1339 coeff += 1
1340 else:
1341 # result is exact; get as close to ideal exponent as possible
1342 ideal_exp = self._exp - other._exp
1343 while exp < ideal_exp and coeff % 10 == 0:
1344 coeff //= 10
1345 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001346
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001347 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001348 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001349
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001350 def _divide(self, other, context):
1351 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001352
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001353 Assumes that neither self nor other is a NaN, that self is not
1354 infinite and that other is nonzero.
1355 """
1356 sign = self._sign ^ other._sign
1357 if other._isinfinity():
1358 ideal_exp = self._exp
1359 else:
1360 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001361
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001362 expdiff = self.adjusted() - other.adjusted()
1363 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001364 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001365 self._rescale(ideal_exp, context.rounding))
1366 if expdiff <= context.prec:
1367 op1 = _WorkRep(self)
1368 op2 = _WorkRep(other)
1369 if op1.exp >= op2.exp:
1370 op1.int *= 10**(op1.exp - op2.exp)
1371 else:
1372 op2.int *= 10**(op2.exp - op1.exp)
1373 q, r = divmod(op1.int, op2.int)
1374 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001375 return (_dec_from_triple(sign, str(q), 0),
1376 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001377
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001378 # Here the quotient is too large to be representable
1379 ans = context._raise_error(DivisionImpossible,
1380 'quotient too large in //, % or divmod')
1381 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001382
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001383 def __rtruediv__(self, other, context=None):
1384 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001385 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001386 if other is NotImplemented:
1387 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001388 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001389
1390 def __divmod__(self, other, context=None):
1391 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001392 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001393 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001394 other = _convert_other(other)
1395 if other is NotImplemented:
1396 return other
1397
1398 if context is None:
1399 context = getcontext()
1400
1401 ans = self._check_nans(other, context)
1402 if ans:
1403 return (ans, ans)
1404
1405 sign = self._sign ^ other._sign
1406 if self._isinfinity():
1407 if other._isinfinity():
1408 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1409 return ans, ans
1410 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001411 return (_SignedInfinity[sign],
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001412 context._raise_error(InvalidOperation, 'INF % x'))
1413
1414 if not other:
1415 if not self:
1416 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1417 return ans, ans
1418 else:
1419 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1420 context._raise_error(InvalidOperation, 'x % 0'))
1421
1422 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001423 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001424 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001425
1426 def __rdivmod__(self, other, context=None):
1427 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001428 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001429 if other is NotImplemented:
1430 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001431 return other.__divmod__(self, context=context)
1432
1433 def __mod__(self, other, context=None):
1434 """
1435 self % other
1436 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001437 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001438 if other is NotImplemented:
1439 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001440
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001441 if context is None:
1442 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001443
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001444 ans = self._check_nans(other, context)
1445 if ans:
1446 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001447
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001448 if self._isinfinity():
1449 return context._raise_error(InvalidOperation, 'INF % x')
1450 elif not other:
1451 if self:
1452 return context._raise_error(InvalidOperation, 'x % 0')
1453 else:
1454 return context._raise_error(DivisionUndefined, '0 % 0')
1455
1456 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001457 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001458 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001459
1460 def __rmod__(self, other, context=None):
1461 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001462 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001463 if other is NotImplemented:
1464 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001465 return other.__mod__(self, context=context)
1466
1467 def remainder_near(self, other, context=None):
1468 """
1469 Remainder nearest to 0- abs(remainder-near) <= other/2
1470 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001471 if context is None:
1472 context = getcontext()
1473
1474 other = _convert_other(other, raiseit=True)
1475
1476 ans = self._check_nans(other, context)
1477 if ans:
1478 return ans
1479
1480 # self == +/-infinity -> InvalidOperation
1481 if self._isinfinity():
1482 return context._raise_error(InvalidOperation,
1483 'remainder_near(infinity, x)')
1484
1485 # other == 0 -> either InvalidOperation or DivisionUndefined
1486 if not other:
1487 if self:
1488 return context._raise_error(InvalidOperation,
1489 'remainder_near(x, 0)')
1490 else:
1491 return context._raise_error(DivisionUndefined,
1492 'remainder_near(0, 0)')
1493
1494 # other = +/-infinity -> remainder = self
1495 if other._isinfinity():
1496 ans = Decimal(self)
1497 return ans._fix(context)
1498
1499 # self = 0 -> remainder = self, with ideal exponent
1500 ideal_exponent = min(self._exp, other._exp)
1501 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001502 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001503 return ans._fix(context)
1504
1505 # catch most cases of large or small quotient
1506 expdiff = self.adjusted() - other.adjusted()
1507 if expdiff >= context.prec + 1:
1508 # expdiff >= prec+1 => abs(self/other) > 10**prec
1509 return context._raise_error(DivisionImpossible)
1510 if expdiff <= -2:
1511 # expdiff <= -2 => abs(self/other) < 0.1
1512 ans = self._rescale(ideal_exponent, context.rounding)
1513 return ans._fix(context)
1514
1515 # adjust both arguments to have the same exponent, then divide
1516 op1 = _WorkRep(self)
1517 op2 = _WorkRep(other)
1518 if op1.exp >= op2.exp:
1519 op1.int *= 10**(op1.exp - op2.exp)
1520 else:
1521 op2.int *= 10**(op2.exp - op1.exp)
1522 q, r = divmod(op1.int, op2.int)
1523 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1524 # 10**ideal_exponent. Apply correction to ensure that
1525 # abs(remainder) <= abs(other)/2
1526 if 2*r + (q&1) > op2.int:
1527 r -= op2.int
1528 q += 1
1529
1530 if q >= 10**context.prec:
1531 return context._raise_error(DivisionImpossible)
1532
1533 # result has same sign as self unless r is negative
1534 sign = self._sign
1535 if r < 0:
1536 sign = 1-sign
1537 r = -r
1538
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001539 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001540 return ans._fix(context)
1541
1542 def __floordiv__(self, other, context=None):
1543 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001544 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001545 if other is NotImplemented:
1546 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001547
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001548 if context is None:
1549 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001550
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001551 ans = self._check_nans(other, context)
1552 if ans:
1553 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001554
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001555 if self._isinfinity():
1556 if other._isinfinity():
1557 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001558 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001559 return _SignedInfinity[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001560
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001561 if not other:
1562 if self:
1563 return context._raise_error(DivisionByZero, 'x // 0',
1564 self._sign ^ other._sign)
1565 else:
1566 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001567
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001568 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001569
1570 def __rfloordiv__(self, other, context=None):
1571 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001572 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001573 if other is NotImplemented:
1574 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001575 return other.__floordiv__(self, context=context)
1576
1577 def __float__(self):
1578 """Float representation."""
1579 return float(str(self))
1580
1581 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001582 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001583 if self._is_special:
1584 if self._isnan():
Mark Dickinson825fce32009-09-07 18:08:12 +00001585 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001586 elif self._isinfinity():
Mark Dickinson825fce32009-09-07 18:08:12 +00001587 raise OverflowError("Cannot convert infinity to integer")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001588 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001589 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001590 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001591 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001592 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001593
Christian Heimes969fe572008-01-25 11:23:10 +00001594 __trunc__ = __int__
1595
Christian Heimes0bd4e112008-02-12 22:59:25 +00001596 def real(self):
1597 return self
Mark Dickinson315a20a2009-01-04 21:34:18 +00001598 real = property(real)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001599
Christian Heimes0bd4e112008-02-12 22:59:25 +00001600 def imag(self):
1601 return Decimal(0)
Mark Dickinson315a20a2009-01-04 21:34:18 +00001602 imag = property(imag)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001603
1604 def conjugate(self):
1605 return self
1606
1607 def __complex__(self):
1608 return complex(float(self))
1609
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001610 def _fix_nan(self, context):
1611 """Decapitate the payload of a NaN to fit the context"""
1612 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001613
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001614 # maximum length of payload is precision if clamp=0,
1615 # precision-1 if clamp=1.
1616 max_payload_len = context.prec - context.clamp
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001617 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001618 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1619 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001620 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001621
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001622 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001623 """Round if it is necessary to keep self within prec precision.
1624
1625 Rounds and fixes the exponent. Does not raise on a sNaN.
1626
1627 Arguments:
1628 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001629 context - context used.
1630 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001631
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001632 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001633 if self._isnan():
1634 # decapitate payload if necessary
1635 return self._fix_nan(context)
1636 else:
1637 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001638 return Decimal(self)
1639
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001640 # if self is zero then exponent should be between Etiny and
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001641 # Emax if clamp==0, and between Etiny and Etop if clamp==1.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001642 Etiny = context.Etiny()
1643 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001644 if not self:
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001645 exp_max = [context.Emax, Etop][context.clamp]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001646 new_exp = min(max(self._exp, Etiny), exp_max)
1647 if new_exp != self._exp:
1648 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001649 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001650 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001651 return Decimal(self)
1652
1653 # exp_min is the smallest allowable exponent of the result,
1654 # equal to max(self.adjusted()-context.prec+1, Etiny)
1655 exp_min = len(self._int) + self._exp - context.prec
1656 if exp_min > Etop:
1657 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001658 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001659 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001660 context._raise_error(Rounded)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001661 return ans
1662
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001663 self_is_subnormal = exp_min < Etiny
1664 if self_is_subnormal:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001665 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001666
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001667 # round if self has too many digits
1668 if self._exp < exp_min:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001669 digits = len(self._int) + self._exp - exp_min
1670 if digits < 0:
1671 self = _dec_from_triple(self._sign, '1', exp_min-1)
1672 digits = 0
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001673 rounding_method = self._pick_rounding_function[context.rounding]
1674 changed = getattr(self, rounding_method)(digits)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001675 coeff = self._int[:digits] or '0'
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001676 if changed > 0:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001677 coeff = str(int(coeff)+1)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001678 if len(coeff) > context.prec:
1679 coeff = coeff[:-1]
1680 exp_min += 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001681
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001682 # check whether the rounding pushed the exponent out of range
1683 if exp_min > Etop:
1684 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1685 else:
1686 ans = _dec_from_triple(self._sign, coeff, exp_min)
1687
1688 # raise the appropriate signals, taking care to respect
1689 # the precedence described in the specification
1690 if changed and self_is_subnormal:
1691 context._raise_error(Underflow)
1692 if self_is_subnormal:
1693 context._raise_error(Subnormal)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001694 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001695 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001696 context._raise_error(Rounded)
1697 if not ans:
1698 # raise Clamped on underflow to 0
1699 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001700 return ans
1701
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001702 if self_is_subnormal:
1703 context._raise_error(Subnormal)
1704
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001705 # fold down if clamp == 1 and self has too few digits
1706 if context.clamp == 1 and self._exp > Etop:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001707 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001708 self_padded = self._int + '0'*(self._exp - Etop)
1709 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001710
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001711 # here self was representable to begin with; return unchanged
1712 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001713
1714 _pick_rounding_function = {}
1715
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001716 # for each of the rounding functions below:
1717 # self is a finite, nonzero Decimal
1718 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001719 #
1720 # each function returns either -1, 0, or 1, as follows:
1721 # 1 indicates that self should be rounded up (away from zero)
1722 # 0 indicates that self should be truncated, and that all the
1723 # digits to be truncated are zeros (so the value is unchanged)
1724 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001725
1726 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001727 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001728 if _all_zeros(self._int, prec):
1729 return 0
1730 else:
1731 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001732
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001733 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001734 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001735 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001736
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001737 def _round_half_up(self, prec):
1738 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001739 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001740 return 1
1741 elif _all_zeros(self._int, prec):
1742 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001743 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001744 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001745
1746 def _round_half_down(self, prec):
1747 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001748 if _exact_half(self._int, prec):
1749 return -1
1750 else:
1751 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001752
1753 def _round_half_even(self, prec):
1754 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001755 if _exact_half(self._int, prec) and \
1756 (prec == 0 or self._int[prec-1] in '02468'):
1757 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001758 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001759 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001760
1761 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001762 """Rounds up (not away from 0 if negative.)"""
1763 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001764 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001765 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001766 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001767
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001768 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001769 """Rounds down (not towards 0 if negative)"""
1770 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001771 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001772 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001773 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001774
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001775 def _round_05up(self, prec):
1776 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001777 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001778 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001779 else:
1780 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001781
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001782 def __round__(self, n=None):
1783 """Round self to the nearest integer, or to a given precision.
1784
1785 If only one argument is supplied, round a finite Decimal
1786 instance self to the nearest integer. If self is infinite or
1787 a NaN then a Python exception is raised. If self is finite
1788 and lies exactly halfway between two integers then it is
1789 rounded to the integer with even last digit.
1790
1791 >>> round(Decimal('123.456'))
1792 123
1793 >>> round(Decimal('-456.789'))
1794 -457
1795 >>> round(Decimal('-3.0'))
1796 -3
1797 >>> round(Decimal('2.5'))
1798 2
1799 >>> round(Decimal('3.5'))
1800 4
1801 >>> round(Decimal('Inf'))
1802 Traceback (most recent call last):
1803 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001804 OverflowError: cannot round an infinity
1805 >>> round(Decimal('NaN'))
1806 Traceback (most recent call last):
1807 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001808 ValueError: cannot round a NaN
1809
1810 If a second argument n is supplied, self is rounded to n
1811 decimal places using the rounding mode for the current
1812 context.
1813
1814 For an integer n, round(self, -n) is exactly equivalent to
1815 self.quantize(Decimal('1En')).
1816
1817 >>> round(Decimal('123.456'), 0)
1818 Decimal('123')
1819 >>> round(Decimal('123.456'), 2)
1820 Decimal('123.46')
1821 >>> round(Decimal('123.456'), -2)
1822 Decimal('1E+2')
1823 >>> round(Decimal('-Infinity'), 37)
1824 Decimal('NaN')
1825 >>> round(Decimal('sNaN123'), 0)
1826 Decimal('NaN123')
1827
1828 """
1829 if n is not None:
1830 # two-argument form: use the equivalent quantize call
1831 if not isinstance(n, int):
1832 raise TypeError('Second argument to round should be integral')
1833 exp = _dec_from_triple(0, '1', -n)
1834 return self.quantize(exp)
1835
1836 # one-argument form
1837 if self._is_special:
1838 if self.is_nan():
1839 raise ValueError("cannot round a NaN")
1840 else:
1841 raise OverflowError("cannot round an infinity")
1842 return int(self._rescale(0, ROUND_HALF_EVEN))
1843
1844 def __floor__(self):
1845 """Return the floor of self, as an integer.
1846
1847 For a finite Decimal instance self, return the greatest
1848 integer n such that n <= self. If self is infinite or a NaN
1849 then a Python exception is raised.
1850
1851 """
1852 if self._is_special:
1853 if self.is_nan():
1854 raise ValueError("cannot round a NaN")
1855 else:
1856 raise OverflowError("cannot round an infinity")
1857 return int(self._rescale(0, ROUND_FLOOR))
1858
1859 def __ceil__(self):
1860 """Return the ceiling of self, as an integer.
1861
1862 For a finite Decimal instance self, return the least integer n
1863 such that n >= self. If self is infinite or a NaN then a
1864 Python exception is raised.
1865
1866 """
1867 if self._is_special:
1868 if self.is_nan():
1869 raise ValueError("cannot round a NaN")
1870 else:
1871 raise OverflowError("cannot round an infinity")
1872 return int(self._rescale(0, ROUND_CEILING))
1873
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001874 def fma(self, other, third, context=None):
1875 """Fused multiply-add.
1876
1877 Returns self*other+third with no rounding of the intermediate
1878 product self*other.
1879
1880 self and other are multiplied together, with no rounding of
1881 the result. The third operand is then added to the result,
1882 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001883 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001884
1885 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001886
1887 # compute product; raise InvalidOperation if either operand is
1888 # a signaling NaN or if the product is zero times infinity.
1889 if self._is_special or other._is_special:
1890 if context is None:
1891 context = getcontext()
1892 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001893 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001894 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001895 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001896 if self._exp == 'n':
1897 product = self
1898 elif other._exp == 'n':
1899 product = other
1900 elif self._exp == 'F':
1901 if not other:
1902 return context._raise_error(InvalidOperation,
1903 'INF * 0 in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001904 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001905 elif other._exp == 'F':
1906 if not self:
1907 return context._raise_error(InvalidOperation,
1908 '0 * INF in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001909 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001910 else:
1911 product = _dec_from_triple(self._sign ^ other._sign,
1912 str(int(self._int) * int(other._int)),
1913 self._exp + other._exp)
1914
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001915 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001916 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001917
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001918 def _power_modulo(self, other, modulo, context=None):
1919 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001920
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001921 # if can't convert other and modulo to Decimal, raise
1922 # TypeError; there's no point returning NotImplemented (no
1923 # equivalent of __rpow__ for three argument pow)
1924 other = _convert_other(other, raiseit=True)
1925 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001926
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001927 if context is None:
1928 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001929
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001930 # deal with NaNs: if there are any sNaNs then first one wins,
1931 # (i.e. behaviour for NaNs is identical to that of fma)
1932 self_is_nan = self._isnan()
1933 other_is_nan = other._isnan()
1934 modulo_is_nan = modulo._isnan()
1935 if self_is_nan or other_is_nan or modulo_is_nan:
1936 if self_is_nan == 2:
1937 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001938 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001939 if other_is_nan == 2:
1940 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001941 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001942 if modulo_is_nan == 2:
1943 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001944 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001945 if self_is_nan:
1946 return self._fix_nan(context)
1947 if other_is_nan:
1948 return other._fix_nan(context)
1949 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001950
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001951 # check inputs: we apply same restrictions as Python's pow()
1952 if not (self._isinteger() and
1953 other._isinteger() and
1954 modulo._isinteger()):
1955 return context._raise_error(InvalidOperation,
1956 'pow() 3rd argument not allowed '
1957 'unless all arguments are integers')
1958 if other < 0:
1959 return context._raise_error(InvalidOperation,
1960 'pow() 2nd argument cannot be '
1961 'negative when 3rd argument specified')
1962 if not modulo:
1963 return context._raise_error(InvalidOperation,
1964 'pow() 3rd argument cannot be 0')
1965
1966 # additional restriction for decimal: the modulus must be less
1967 # than 10**prec in absolute value
1968 if modulo.adjusted() >= context.prec:
1969 return context._raise_error(InvalidOperation,
1970 'insufficient precision: pow() 3rd '
1971 'argument must not have more than '
1972 'precision digits')
1973
1974 # define 0**0 == NaN, for consistency with two-argument pow
1975 # (even though it hurts!)
1976 if not other and not self:
1977 return context._raise_error(InvalidOperation,
1978 'at least one of pow() 1st argument '
1979 'and 2nd argument must be nonzero ;'
1980 '0**0 is not defined')
1981
1982 # compute sign of result
1983 if other._iseven():
1984 sign = 0
1985 else:
1986 sign = self._sign
1987
1988 # convert modulo to a Python integer, and self and other to
1989 # Decimal integers (i.e. force their exponents to be >= 0)
1990 modulo = abs(int(modulo))
1991 base = _WorkRep(self.to_integral_value())
1992 exponent = _WorkRep(other.to_integral_value())
1993
1994 # compute result using integer pow()
1995 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1996 for i in range(exponent.exp):
1997 base = pow(base, 10, modulo)
1998 base = pow(base, exponent.int, modulo)
1999
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002000 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002001
2002 def _power_exact(self, other, p):
2003 """Attempt to compute self**other exactly.
2004
2005 Given Decimals self and other and an integer p, attempt to
2006 compute an exact result for the power self**other, with p
2007 digits of precision. Return None if self**other is not
2008 exactly representable in p digits.
2009
2010 Assumes that elimination of special cases has already been
2011 performed: self and other must both be nonspecial; self must
2012 be positive and not numerically equal to 1; other must be
2013 nonzero. For efficiency, other._exp should not be too large,
2014 so that 10**abs(other._exp) is a feasible calculation."""
2015
2016 # In the comments below, we write x for the value of self and
2017 # y for the value of other. Write x = xc*10**xe and y =
2018 # yc*10**ye.
2019
2020 # The main purpose of this method is to identify the *failure*
2021 # of x**y to be exactly representable with as little effort as
2022 # possible. So we look for cheap and easy tests that
2023 # eliminate the possibility of x**y being exact. Only if all
2024 # these tests are passed do we go on to actually compute x**y.
2025
2026 # Here's the main idea. First normalize both x and y. We
2027 # express y as a rational m/n, with m and n relatively prime
2028 # and n>0. Then for x**y to be exactly representable (at
2029 # *any* precision), xc must be the nth power of a positive
2030 # integer and xe must be divisible by n. If m is negative
2031 # then additionally xc must be a power of either 2 or 5, hence
2032 # a power of 2**n or 5**n.
2033 #
2034 # There's a limit to how small |y| can be: if y=m/n as above
2035 # then:
2036 #
2037 # (1) if xc != 1 then for the result to be representable we
2038 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
2039 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
2040 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
2041 # representable.
2042 #
2043 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
2044 # |y| < 1/|xe| then the result is not representable.
2045 #
2046 # Note that since x is not equal to 1, at least one of (1) and
2047 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
2048 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
2049 #
2050 # There's also a limit to how large y can be, at least if it's
2051 # positive: the normalized result will have coefficient xc**y,
2052 # so if it's representable then xc**y < 10**p, and y <
2053 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
2054 # not exactly representable.
2055
2056 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
2057 # so |y| < 1/xe and the result is not representable.
2058 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
2059 # < 1/nbits(xc).
2060
2061 x = _WorkRep(self)
2062 xc, xe = x.int, x.exp
2063 while xc % 10 == 0:
2064 xc //= 10
2065 xe += 1
2066
2067 y = _WorkRep(other)
2068 yc, ye = y.int, y.exp
2069 while yc % 10 == 0:
2070 yc //= 10
2071 ye += 1
2072
2073 # case where xc == 1: result is 10**(xe*y), with xe*y
2074 # required to be an integer
2075 if xc == 1:
2076 if ye >= 0:
2077 exponent = xe*yc*10**ye
2078 else:
2079 exponent, remainder = divmod(xe*yc, 10**-ye)
2080 if remainder:
2081 return None
2082 if y.sign == 1:
2083 exponent = -exponent
2084 # if other is a nonnegative integer, use ideal exponent
2085 if other._isinteger() and other._sign == 0:
2086 ideal_exponent = self._exp*int(other)
2087 zeros = min(exponent-ideal_exponent, p-1)
2088 else:
2089 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002090 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002091
2092 # case where y is negative: xc must be either a power
2093 # of 2 or a power of 5.
2094 if y.sign == 1:
2095 last_digit = xc % 10
2096 if last_digit in (2,4,6,8):
2097 # quick test for power of 2
2098 if xc & -xc != xc:
2099 return None
2100 # now xc is a power of 2; e is its exponent
2101 e = _nbits(xc)-1
2102 # find e*y and xe*y; both must be integers
2103 if ye >= 0:
2104 y_as_int = yc*10**ye
2105 e = e*y_as_int
2106 xe = xe*y_as_int
2107 else:
2108 ten_pow = 10**-ye
2109 e, remainder = divmod(e*yc, ten_pow)
2110 if remainder:
2111 return None
2112 xe, remainder = divmod(xe*yc, ten_pow)
2113 if remainder:
2114 return None
2115
2116 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2117 return None
2118 xc = 5**e
2119
2120 elif last_digit == 5:
2121 # e >= log_5(xc) if xc is a power of 5; we have
2122 # equality all the way up to xc=5**2658
2123 e = _nbits(xc)*28//65
2124 xc, remainder = divmod(5**e, xc)
2125 if remainder:
2126 return None
2127 while xc % 5 == 0:
2128 xc //= 5
2129 e -= 1
2130 if ye >= 0:
2131 y_as_integer = yc*10**ye
2132 e = e*y_as_integer
2133 xe = xe*y_as_integer
2134 else:
2135 ten_pow = 10**-ye
2136 e, remainder = divmod(e*yc, ten_pow)
2137 if remainder:
2138 return None
2139 xe, remainder = divmod(xe*yc, ten_pow)
2140 if remainder:
2141 return None
2142 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2143 return None
2144 xc = 2**e
2145 else:
2146 return None
2147
2148 if xc >= 10**p:
2149 return None
2150 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002151 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002152
2153 # now y is positive; find m and n such that y = m/n
2154 if ye >= 0:
2155 m, n = yc*10**ye, 1
2156 else:
2157 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2158 return None
2159 xc_bits = _nbits(xc)
2160 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2161 return None
2162 m, n = yc, 10**(-ye)
2163 while m % 2 == n % 2 == 0:
2164 m //= 2
2165 n //= 2
2166 while m % 5 == n % 5 == 0:
2167 m //= 5
2168 n //= 5
2169
2170 # compute nth root of xc*10**xe
2171 if n > 1:
2172 # if 1 < xc < 2**n then xc isn't an nth power
2173 if xc != 1 and xc_bits <= n:
2174 return None
2175
2176 xe, rem = divmod(xe, n)
2177 if rem != 0:
2178 return None
2179
2180 # compute nth root of xc using Newton's method
2181 a = 1 << -(-_nbits(xc)//n) # initial estimate
2182 while True:
2183 q, r = divmod(xc, a**(n-1))
2184 if a <= q:
2185 break
2186 else:
2187 a = (a*(n-1) + q)//n
2188 if not (a == q and r == 0):
2189 return None
2190 xc = a
2191
2192 # now xc*10**xe is the nth root of the original xc*10**xe
2193 # compute mth power of xc*10**xe
2194
2195 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2196 # 10**p and the result is not representable.
2197 if xc > 1 and m > p*100//_log10_lb(xc):
2198 return None
2199 xc = xc**m
2200 xe *= m
2201 if xc > 10**p:
2202 return None
2203
2204 # by this point the result *is* exactly representable
2205 # adjust the exponent to get as close as possible to the ideal
2206 # exponent, if necessary
2207 str_xc = str(xc)
2208 if other._isinteger() and other._sign == 0:
2209 ideal_exponent = self._exp*int(other)
2210 zeros = min(xe-ideal_exponent, p-len(str_xc))
2211 else:
2212 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002213 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002214
2215 def __pow__(self, other, modulo=None, context=None):
2216 """Return self ** other [ % modulo].
2217
2218 With two arguments, compute self**other.
2219
2220 With three arguments, compute (self**other) % modulo. For the
2221 three argument form, the following restrictions on the
2222 arguments hold:
2223
2224 - all three arguments must be integral
2225 - other must be nonnegative
2226 - either self or other (or both) must be nonzero
2227 - modulo must be nonzero and must have at most p digits,
2228 where p is the context precision.
2229
2230 If any of these restrictions is violated the InvalidOperation
2231 flag is raised.
2232
2233 The result of pow(self, other, modulo) is identical to the
2234 result that would be obtained by computing (self**other) %
2235 modulo with unbounded precision, but is computed more
2236 efficiently. It is always exact.
2237 """
2238
2239 if modulo is not None:
2240 return self._power_modulo(other, modulo, context)
2241
2242 other = _convert_other(other)
2243 if other is NotImplemented:
2244 return other
2245
2246 if context is None:
2247 context = getcontext()
2248
2249 # either argument is a NaN => result is NaN
2250 ans = self._check_nans(other, context)
2251 if ans:
2252 return ans
2253
2254 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2255 if not other:
2256 if not self:
2257 return context._raise_error(InvalidOperation, '0 ** 0')
2258 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002259 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002260
2261 # result has sign 1 iff self._sign is 1 and other is an odd integer
2262 result_sign = 0
2263 if self._sign == 1:
2264 if other._isinteger():
2265 if not other._iseven():
2266 result_sign = 1
2267 else:
2268 # -ve**noninteger = NaN
2269 # (-0)**noninteger = 0**noninteger
2270 if self:
2271 return context._raise_error(InvalidOperation,
2272 'x ** y with x negative and y not an integer')
2273 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002274 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002275
2276 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2277 if not self:
2278 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002279 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002280 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002281 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002282
2283 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002284 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002285 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002286 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002287 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002288 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002289
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002290 # 1**other = 1, but the choice of exponent and the flags
2291 # depend on the exponent of self, and on whether other is a
2292 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002293 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002294 if other._isinteger():
2295 # exp = max(self._exp*max(int(other), 0),
2296 # 1-context.prec) but evaluating int(other) directly
2297 # is dangerous until we know other is small (other
2298 # could be 1e999999999)
2299 if other._sign == 1:
2300 multiplier = 0
2301 elif other > context.prec:
2302 multiplier = context.prec
2303 else:
2304 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002305
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002306 exp = self._exp * multiplier
2307 if exp < 1-context.prec:
2308 exp = 1-context.prec
2309 context._raise_error(Rounded)
2310 else:
2311 context._raise_error(Inexact)
2312 context._raise_error(Rounded)
2313 exp = 1-context.prec
2314
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002315 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002316
2317 # compute adjusted exponent of self
2318 self_adj = self.adjusted()
2319
2320 # self ** infinity is infinity if self > 1, 0 if self < 1
2321 # self ** -infinity is infinity if self < 1, 0 if self > 1
2322 if other._isinfinity():
2323 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002324 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002325 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002326 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002327
2328 # from here on, the result always goes through the call
2329 # to _fix at the end of this function.
2330 ans = None
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002331 exact = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002332
2333 # crude test to catch cases of extreme overflow/underflow. If
2334 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2335 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2336 # self**other >= 10**(Emax+1), so overflow occurs. The test
2337 # for underflow is similar.
2338 bound = self._log10_exp_bound() + other.adjusted()
2339 if (self_adj >= 0) == (other._sign == 0):
2340 # self > 1 and other +ve, or self < 1 and other -ve
2341 # possibility of overflow
2342 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002343 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002344 else:
2345 # self > 1 and other -ve, or self < 1 and other +ve
2346 # possibility of underflow to 0
2347 Etiny = context.Etiny()
2348 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002349 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002350
2351 # try for an exact result with precision +1
2352 if ans is None:
2353 ans = self._power_exact(other, context.prec + 1)
2354 if ans is not None and result_sign == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002355 ans = _dec_from_triple(1, ans._int, ans._exp)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002356 exact = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002357
2358 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2359 if ans is None:
2360 p = context.prec
2361 x = _WorkRep(self)
2362 xc, xe = x.int, x.exp
2363 y = _WorkRep(other)
2364 yc, ye = y.int, y.exp
2365 if y.sign == 1:
2366 yc = -yc
2367
2368 # compute correctly rounded result: start with precision +3,
2369 # then increase precision until result is unambiguously roundable
2370 extra = 3
2371 while True:
2372 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2373 if coeff % (5*10**(len(str(coeff))-p-1)):
2374 break
2375 extra += 3
2376
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002377 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002378
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002379 # unlike exp, ln and log10, the power function respects the
2380 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2381
2382 # There's a difficulty here when 'other' is not an integer and
2383 # the result is exact. In this case, the specification
2384 # requires that the Inexact flag be raised (in spite of
2385 # exactness), but since the result is exact _fix won't do this
2386 # for us. (Correspondingly, the Underflow signal should also
2387 # be raised for subnormal results.) We can't directly raise
2388 # these signals either before or after calling _fix, since
2389 # that would violate the precedence for signals. So we wrap
2390 # the ._fix call in a temporary context, and reraise
2391 # afterwards.
2392 if exact and not other._isinteger():
2393 # pad with zeros up to length context.prec+1 if necessary; this
2394 # ensures that the Rounded signal will be raised.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002395 if len(ans._int) <= context.prec:
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002396 expdiff = context.prec + 1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002397 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2398 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002399
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002400 # create a copy of the current context, with cleared flags/traps
2401 newcontext = context.copy()
2402 newcontext.clear_flags()
2403 for exception in _signals:
2404 newcontext.traps[exception] = 0
2405
2406 # round in the new context
2407 ans = ans._fix(newcontext)
2408
2409 # raise Inexact, and if necessary, Underflow
2410 newcontext._raise_error(Inexact)
2411 if newcontext.flags[Subnormal]:
2412 newcontext._raise_error(Underflow)
2413
2414 # propagate signals to the original context; _fix could
2415 # have raised any of Overflow, Underflow, Subnormal,
2416 # Inexact, Rounded, Clamped. Overflow needs the correct
2417 # arguments. Note that the order of the exceptions is
2418 # important here.
2419 if newcontext.flags[Overflow]:
2420 context._raise_error(Overflow, 'above Emax', ans._sign)
2421 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2422 if newcontext.flags[exception]:
2423 context._raise_error(exception)
2424
2425 else:
2426 ans = ans._fix(context)
2427
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002428 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002429
2430 def __rpow__(self, other, context=None):
2431 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002432 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002433 if other is NotImplemented:
2434 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002435 return other.__pow__(self, context=context)
2436
2437 def normalize(self, context=None):
2438 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002439
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002440 if context is None:
2441 context = getcontext()
2442
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002443 if self._is_special:
2444 ans = self._check_nans(context=context)
2445 if ans:
2446 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002447
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002448 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002449 if dup._isinfinity():
2450 return dup
2451
2452 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002453 return _dec_from_triple(dup._sign, '0', 0)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00002454 exp_max = [context.Emax, context.Etop()][context.clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002455 end = len(dup._int)
2456 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002457 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002458 exp += 1
2459 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002460 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002461
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002462 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002463 """Quantize self so its exponent is the same as that of exp.
2464
2465 Similar to self._rescale(exp._exp) but with error checking.
2466 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002467 exp = _convert_other(exp, raiseit=True)
2468
2469 if context is None:
2470 context = getcontext()
2471 if rounding is None:
2472 rounding = context.rounding
2473
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002474 if self._is_special or exp._is_special:
2475 ans = self._check_nans(exp, context)
2476 if ans:
2477 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002478
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002479 if exp._isinfinity() or self._isinfinity():
2480 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002481 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002482 return context._raise_error(InvalidOperation,
2483 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002484
2485 # if we're not watching exponents, do a simple rescale
2486 if not watchexp:
2487 ans = self._rescale(exp._exp, rounding)
2488 # raise Inexact and Rounded where appropriate
2489 if ans._exp > self._exp:
2490 context._raise_error(Rounded)
2491 if ans != self:
2492 context._raise_error(Inexact)
2493 return ans
2494
2495 # exp._exp should be between Etiny and Emax
2496 if not (context.Etiny() <= exp._exp <= context.Emax):
2497 return context._raise_error(InvalidOperation,
2498 'target exponent out of bounds in quantize')
2499
2500 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002501 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002502 return ans._fix(context)
2503
2504 self_adjusted = self.adjusted()
2505 if self_adjusted > context.Emax:
2506 return context._raise_error(InvalidOperation,
2507 'exponent of quantize result too large for current context')
2508 if self_adjusted - exp._exp + 1 > context.prec:
2509 return context._raise_error(InvalidOperation,
2510 'quantize result has too many digits for current context')
2511
2512 ans = self._rescale(exp._exp, rounding)
2513 if ans.adjusted() > context.Emax:
2514 return context._raise_error(InvalidOperation,
2515 'exponent of quantize result too large for current context')
2516 if len(ans._int) > context.prec:
2517 return context._raise_error(InvalidOperation,
2518 'quantize result has too many digits for current context')
2519
2520 # raise appropriate flags
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002521 if ans and ans.adjusted() < context.Emin:
2522 context._raise_error(Subnormal)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002523 if ans._exp > self._exp:
2524 if ans != self:
2525 context._raise_error(Inexact)
2526 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002527
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002528 # call to fix takes care of any necessary folddown, and
2529 # signals Clamped if necessary
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002530 ans = ans._fix(context)
2531 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002532
2533 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002534 """Return True if self and other have the same exponent; otherwise
2535 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002536
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002537 If either operand is a special value, the following rules are used:
2538 * return True if both operands are infinities
2539 * return True if both operands are NaNs
2540 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002541 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002542 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002543 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002544 return (self.is_nan() and other.is_nan() or
2545 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002546 return self._exp == other._exp
2547
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002548 def _rescale(self, exp, rounding):
2549 """Rescale self so that the exponent is exp, either by padding with zeros
2550 or by truncating digits, using the given rounding mode.
2551
2552 Specials are returned without change. This operation is
2553 quiet: it raises no flags, and uses no information from the
2554 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002555
2556 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002557 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002558 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002559 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002560 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002561 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002562 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002563
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002564 if self._exp >= exp:
2565 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002566 return _dec_from_triple(self._sign,
2567 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002568
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002569 # too many digits; round and lose data. If self.adjusted() <
2570 # exp-1, replace self by 10**(exp-1) before rounding
2571 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002572 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002573 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002574 digits = 0
2575 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002576 changed = this_function(digits)
2577 coeff = self._int[:digits] or '0'
2578 if changed == 1:
2579 coeff = str(int(coeff)+1)
2580 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002581
Christian Heimesf16baeb2008-02-29 14:57:44 +00002582 def _round(self, places, rounding):
2583 """Round a nonzero, nonspecial Decimal to a fixed number of
2584 significant figures, using the given rounding mode.
2585
2586 Infinities, NaNs and zeros are returned unaltered.
2587
2588 This operation is quiet: it raises no flags, and uses no
2589 information from the context.
2590
2591 """
2592 if places <= 0:
2593 raise ValueError("argument should be at least 1 in _round")
2594 if self._is_special or not self:
2595 return Decimal(self)
2596 ans = self._rescale(self.adjusted()+1-places, rounding)
2597 # it can happen that the rescale alters the adjusted exponent;
2598 # for example when rounding 99.97 to 3 significant figures.
2599 # When this happens we end up with an extra 0 at the end of
2600 # the number; a second rescale fixes this.
2601 if ans.adjusted() != self.adjusted():
2602 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2603 return ans
2604
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002605 def to_integral_exact(self, rounding=None, context=None):
2606 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002607
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002608 If no rounding mode is specified, take the rounding mode from
2609 the context. This method raises the Rounded and Inexact flags
2610 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002611
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002612 See also: to_integral_value, which does exactly the same as
2613 this method except that it doesn't raise Inexact or Rounded.
2614 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002615 if self._is_special:
2616 ans = self._check_nans(context=context)
2617 if ans:
2618 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002619 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002620 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002621 return Decimal(self)
2622 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002623 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002624 if context is None:
2625 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002626 if rounding is None:
2627 rounding = context.rounding
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002628 ans = self._rescale(0, rounding)
2629 if ans != self:
2630 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002631 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002632 return ans
2633
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002634 def to_integral_value(self, rounding=None, context=None):
2635 """Rounds to the nearest integer, without raising inexact, rounded."""
2636 if context is None:
2637 context = getcontext()
2638 if rounding is None:
2639 rounding = context.rounding
2640 if self._is_special:
2641 ans = self._check_nans(context=context)
2642 if ans:
2643 return ans
2644 return Decimal(self)
2645 if self._exp >= 0:
2646 return Decimal(self)
2647 else:
2648 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002649
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002650 # the method name changed, but we provide also the old one, for compatibility
2651 to_integral = to_integral_value
2652
2653 def sqrt(self, context=None):
2654 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002655 if context is None:
2656 context = getcontext()
2657
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002658 if self._is_special:
2659 ans = self._check_nans(context=context)
2660 if ans:
2661 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002662
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002663 if self._isinfinity() and self._sign == 0:
2664 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002665
2666 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002667 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002668 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002669 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002670
2671 if self._sign == 1:
2672 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2673
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002674 # At this point self represents a positive number. Let p be
2675 # the desired precision and express self in the form c*100**e
2676 # with c a positive real number and e an integer, c and e
2677 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2678 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2679 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2680 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2681 # the closest integer to sqrt(c) with the even integer chosen
2682 # in the case of a tie.
2683 #
2684 # To ensure correct rounding in all cases, we use the
2685 # following trick: we compute the square root to an extra
2686 # place (precision p+1 instead of precision p), rounding down.
2687 # Then, if the result is inexact and its last digit is 0 or 5,
2688 # we increase the last digit to 1 or 6 respectively; if it's
2689 # exact we leave the last digit alone. Now the final round to
2690 # p places (or fewer in the case of underflow) will round
2691 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002692
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002693 # use an extra digit of precision
2694 prec = context.prec+1
2695
2696 # write argument in the form c*100**e where e = self._exp//2
2697 # is the 'ideal' exponent, to be used if the square root is
2698 # exactly representable. l is the number of 'digits' of c in
2699 # base 100, so that 100**(l-1) <= c < 100**l.
2700 op = _WorkRep(self)
2701 e = op.exp >> 1
2702 if op.exp & 1:
2703 c = op.int * 10
2704 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002705 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002706 c = op.int
2707 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002708
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002709 # rescale so that c has exactly prec base 100 'digits'
2710 shift = prec-l
2711 if shift >= 0:
2712 c *= 100**shift
2713 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002714 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002715 c, remainder = divmod(c, 100**-shift)
2716 exact = not remainder
2717 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002718
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002719 # find n = floor(sqrt(c)) using Newton's method
2720 n = 10**prec
2721 while True:
2722 q = c//n
2723 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002724 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002725 else:
2726 n = n + q >> 1
2727 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002728
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002729 if exact:
2730 # result is exact; rescale to use ideal exponent e
2731 if shift >= 0:
2732 # assert n % 10**shift == 0
2733 n //= 10**shift
2734 else:
2735 n *= 10**-shift
2736 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002737 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002738 # result is not exact; fix last digit as described above
2739 if n % 5 == 0:
2740 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002741
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002742 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002743
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002744 # round, and fit to current context
2745 context = context._shallow_copy()
2746 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002747 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002748 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002749
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002750 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002751
2752 def max(self, other, context=None):
2753 """Returns the larger value.
2754
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002755 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002756 NaN (and signals if one is sNaN). Also rounds.
2757 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002758 other = _convert_other(other, raiseit=True)
2759
2760 if context is None:
2761 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002762
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002763 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002764 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002765 # number is always returned
2766 sn = self._isnan()
2767 on = other._isnan()
2768 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002769 if on == 1 and sn == 0:
2770 return self._fix(context)
2771 if sn == 1 and on == 0:
2772 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002773 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002774
Christian Heimes77c02eb2008-02-09 02:18:51 +00002775 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002776 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002777 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002778 # then an ordering is applied:
2779 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002780 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002781 # positive sign and min returns the operand with the negative sign
2782 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002783 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002784 # the result. This is exactly the ordering used in compare_total.
2785 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002786
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002787 if c == -1:
2788 ans = other
2789 else:
2790 ans = self
2791
Christian Heimes2c181612007-12-17 20:04:13 +00002792 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002793
2794 def min(self, other, context=None):
2795 """Returns the smaller value.
2796
Guido van Rossumd8faa362007-04-27 19:54:29 +00002797 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002798 NaN (and signals if one is sNaN). Also rounds.
2799 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002800 other = _convert_other(other, raiseit=True)
2801
2802 if context is None:
2803 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002804
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002805 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002806 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002807 # number is always returned
2808 sn = self._isnan()
2809 on = other._isnan()
2810 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002811 if on == 1 and sn == 0:
2812 return self._fix(context)
2813 if sn == 1 and on == 0:
2814 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002815 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002816
Christian Heimes77c02eb2008-02-09 02:18:51 +00002817 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002818 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002819 c = self.compare_total(other)
2820
2821 if c == -1:
2822 ans = self
2823 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002824 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002825
Christian Heimes2c181612007-12-17 20:04:13 +00002826 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002827
2828 def _isinteger(self):
2829 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002830 if self._is_special:
2831 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002832 if self._exp >= 0:
2833 return True
2834 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002835 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002836
2837 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002838 """Returns True if self is even. Assumes self is an integer."""
2839 if not self or self._exp > 0:
2840 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002841 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002842
2843 def adjusted(self):
2844 """Return the adjusted exponent of self"""
2845 try:
2846 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002847 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002848 except TypeError:
2849 return 0
2850
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002851 def canonical(self, context=None):
2852 """Returns the same Decimal object.
2853
2854 As we do not have different encodings for the same number, the
2855 received object already is in its canonical form.
2856 """
2857 return self
2858
2859 def compare_signal(self, other, context=None):
2860 """Compares self to the other operand numerically.
2861
2862 It's pretty much like compare(), but all NaNs signal, with signaling
2863 NaNs taking precedence over quiet NaNs.
2864 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002865 other = _convert_other(other, raiseit = True)
2866 ans = self._compare_check_nans(other, context)
2867 if ans:
2868 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002869 return self.compare(other, context=context)
2870
2871 def compare_total(self, other):
2872 """Compares self to other using the abstract representations.
2873
2874 This is not like the standard compare, which use their numerical
2875 value. Note that a total ordering is defined for all possible abstract
2876 representations.
2877 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002878 other = _convert_other(other, raiseit=True)
2879
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002880 # if one is negative and the other is positive, it's easy
2881 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002882 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002883 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002884 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002885 sign = self._sign
2886
2887 # let's handle both NaN types
2888 self_nan = self._isnan()
2889 other_nan = other._isnan()
2890 if self_nan or other_nan:
2891 if self_nan == other_nan:
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002892 # compare payloads as though they're integers
2893 self_key = len(self._int), self._int
2894 other_key = len(other._int), other._int
2895 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002896 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002897 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002898 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002899 return _NegativeOne
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002900 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002901 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002902 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002903 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002904 return _One
2905 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002906
2907 if sign:
2908 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002909 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002910 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002911 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002912 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002913 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002914 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002915 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002916 else:
2917 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002918 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002919 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002920 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002921 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002922 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002923 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002924 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002925
2926 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002927 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002928 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002929 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002930
2931 if self._exp < other._exp:
2932 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002933 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002934 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002935 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002936 if self._exp > other._exp:
2937 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002938 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002939 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002940 return _One
2941 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002942
2943
2944 def compare_total_mag(self, other):
2945 """Compares self to other using abstract repr., ignoring sign.
2946
2947 Like compare_total, but with operand's sign ignored and assumed to be 0.
2948 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002949 other = _convert_other(other, raiseit=True)
2950
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002951 s = self.copy_abs()
2952 o = other.copy_abs()
2953 return s.compare_total(o)
2954
2955 def copy_abs(self):
2956 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002957 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002958
2959 def copy_negate(self):
2960 """Returns a copy with the sign inverted."""
2961 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002962 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002963 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002964 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002965
2966 def copy_sign(self, other):
2967 """Returns self with the sign of other."""
Mark Dickinson84230a12010-02-18 14:49:50 +00002968 other = _convert_other(other, raiseit=True)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002969 return _dec_from_triple(other._sign, self._int,
2970 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002971
2972 def exp(self, context=None):
2973 """Returns e ** self."""
2974
2975 if context is None:
2976 context = getcontext()
2977
2978 # exp(NaN) = NaN
2979 ans = self._check_nans(context=context)
2980 if ans:
2981 return ans
2982
2983 # exp(-Infinity) = 0
2984 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002985 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002986
2987 # exp(0) = 1
2988 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002989 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002990
2991 # exp(Infinity) = Infinity
2992 if self._isinfinity() == 1:
2993 return Decimal(self)
2994
2995 # the result is now guaranteed to be inexact (the true
2996 # mathematical result is transcendental). There's no need to
2997 # raise Rounded and Inexact here---they'll always be raised as
2998 # a result of the call to _fix.
2999 p = context.prec
3000 adj = self.adjusted()
3001
3002 # we only need to do any computation for quite a small range
3003 # of adjusted exponents---for example, -29 <= adj <= 10 for
3004 # the default context. For smaller exponent the result is
3005 # indistinguishable from 1 at the given precision, while for
3006 # larger exponent the result either overflows or underflows.
3007 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
3008 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003009 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003010 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
3011 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003012 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003013 elif self._sign == 0 and adj < -p:
3014 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003015 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003016 elif self._sign == 1 and adj < -p-1:
3017 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003018 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003019 # general case
3020 else:
3021 op = _WorkRep(self)
3022 c, e = op.int, op.exp
3023 if op.sign == 1:
3024 c = -c
3025
3026 # compute correctly rounded result: increase precision by
3027 # 3 digits at a time until we get an unambiguously
3028 # roundable result
3029 extra = 3
3030 while True:
3031 coeff, exp = _dexp(c, e, p+extra)
3032 if coeff % (5*10**(len(str(coeff))-p-1)):
3033 break
3034 extra += 3
3035
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003036 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003037
3038 # at this stage, ans should round correctly with *any*
3039 # rounding mode, not just with ROUND_HALF_EVEN
3040 context = context._shallow_copy()
3041 rounding = context._set_rounding(ROUND_HALF_EVEN)
3042 ans = ans._fix(context)
3043 context.rounding = rounding
3044
3045 return ans
3046
3047 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003048 """Return True if self is canonical; otherwise return False.
3049
3050 Currently, the encoding of a Decimal instance is always
3051 canonical, so this method returns True for any Decimal.
3052 """
3053 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003054
3055 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003056 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003057
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003058 A Decimal instance is considered finite if it is neither
3059 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003060 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003061 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003062
3063 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003064 """Return True if self is infinite; otherwise return False."""
3065 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003066
3067 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003068 """Return True if self is a qNaN or sNaN; otherwise return False."""
3069 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003070
3071 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003072 """Return True if self is a normal number; otherwise return False."""
3073 if self._is_special or not self:
3074 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003075 if context is None:
3076 context = getcontext()
Mark Dickinson06bb6742009-10-20 13:38:04 +00003077 return context.Emin <= self.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003078
3079 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003080 """Return True if self is a quiet NaN; otherwise return False."""
3081 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003082
3083 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003084 """Return True if self is negative; otherwise return False."""
3085 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003086
3087 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003088 """Return True if self is a signaling NaN; otherwise return False."""
3089 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003090
3091 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003092 """Return True if self is subnormal; otherwise return False."""
3093 if self._is_special or not self:
3094 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003095 if context is None:
3096 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003097 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003098
3099 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003100 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003101 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003102
3103 def _ln_exp_bound(self):
3104 """Compute a lower bound for the adjusted exponent of self.ln().
3105 In other words, compute r such that self.ln() >= 10**r. Assumes
3106 that self is finite and positive and that self != 1.
3107 """
3108
3109 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3110 adj = self._exp + len(self._int) - 1
3111 if adj >= 1:
3112 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3113 return len(str(adj*23//10)) - 1
3114 if adj <= -2:
3115 # argument <= 0.1
3116 return len(str((-1-adj)*23//10)) - 1
3117 op = _WorkRep(self)
3118 c, e = op.int, op.exp
3119 if adj == 0:
3120 # 1 < self < 10
3121 num = str(c-10**-e)
3122 den = str(c)
3123 return len(num) - len(den) - (num < den)
3124 # adj == -1, 0.1 <= self < 1
3125 return e + len(str(10**-e - c)) - 1
3126
3127
3128 def ln(self, context=None):
3129 """Returns the natural (base e) logarithm of self."""
3130
3131 if context is None:
3132 context = getcontext()
3133
3134 # ln(NaN) = NaN
3135 ans = self._check_nans(context=context)
3136 if ans:
3137 return ans
3138
3139 # ln(0.0) == -Infinity
3140 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003141 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003142
3143 # ln(Infinity) = Infinity
3144 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003145 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003146
3147 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003148 if self == _One:
3149 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003150
3151 # ln(negative) raises InvalidOperation
3152 if self._sign == 1:
3153 return context._raise_error(InvalidOperation,
3154 'ln of a negative value')
3155
3156 # result is irrational, so necessarily inexact
3157 op = _WorkRep(self)
3158 c, e = op.int, op.exp
3159 p = context.prec
3160
3161 # correctly rounded result: repeatedly increase precision by 3
3162 # until we get an unambiguously roundable result
3163 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3164 while True:
3165 coeff = _dlog(c, e, places)
3166 # assert len(str(abs(coeff)))-p >= 1
3167 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3168 break
3169 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003170 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003171
3172 context = context._shallow_copy()
3173 rounding = context._set_rounding(ROUND_HALF_EVEN)
3174 ans = ans._fix(context)
3175 context.rounding = rounding
3176 return ans
3177
3178 def _log10_exp_bound(self):
3179 """Compute a lower bound for the adjusted exponent of self.log10().
3180 In other words, find r such that self.log10() >= 10**r.
3181 Assumes that self is finite and positive and that self != 1.
3182 """
3183
3184 # For x >= 10 or x < 0.1 we only need a bound on the integer
3185 # part of log10(self), and this comes directly from the
3186 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3187 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3188 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3189
3190 adj = self._exp + len(self._int) - 1
3191 if adj >= 1:
3192 # self >= 10
3193 return len(str(adj))-1
3194 if adj <= -2:
3195 # self < 0.1
3196 return len(str(-1-adj))-1
3197 op = _WorkRep(self)
3198 c, e = op.int, op.exp
3199 if adj == 0:
3200 # 1 < self < 10
3201 num = str(c-10**-e)
3202 den = str(231*c)
3203 return len(num) - len(den) - (num < den) + 2
3204 # adj == -1, 0.1 <= self < 1
3205 num = str(10**-e-c)
3206 return len(num) + e - (num < "231") - 1
3207
3208 def log10(self, context=None):
3209 """Returns the base 10 logarithm of self."""
3210
3211 if context is None:
3212 context = getcontext()
3213
3214 # log10(NaN) = NaN
3215 ans = self._check_nans(context=context)
3216 if ans:
3217 return ans
3218
3219 # log10(0.0) == -Infinity
3220 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003221 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003222
3223 # log10(Infinity) = Infinity
3224 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003225 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003226
3227 # log10(negative or -Infinity) raises InvalidOperation
3228 if self._sign == 1:
3229 return context._raise_error(InvalidOperation,
3230 'log10 of a negative value')
3231
3232 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003233 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003234 # answer may need rounding
3235 ans = Decimal(self._exp + len(self._int) - 1)
3236 else:
3237 # result is irrational, so necessarily inexact
3238 op = _WorkRep(self)
3239 c, e = op.int, op.exp
3240 p = context.prec
3241
3242 # correctly rounded result: repeatedly increase precision
3243 # until result is unambiguously roundable
3244 places = p-self._log10_exp_bound()+2
3245 while True:
3246 coeff = _dlog10(c, e, places)
3247 # assert len(str(abs(coeff)))-p >= 1
3248 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3249 break
3250 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003251 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003252
3253 context = context._shallow_copy()
3254 rounding = context._set_rounding(ROUND_HALF_EVEN)
3255 ans = ans._fix(context)
3256 context.rounding = rounding
3257 return ans
3258
3259 def logb(self, context=None):
3260 """ Returns the exponent of the magnitude of self's MSD.
3261
3262 The result is the integer which is the exponent of the magnitude
3263 of the most significant digit of self (as though it were truncated
3264 to a single digit while maintaining the value of that digit and
3265 without limiting the resulting exponent).
3266 """
3267 # logb(NaN) = NaN
3268 ans = self._check_nans(context=context)
3269 if ans:
3270 return ans
3271
3272 if context is None:
3273 context = getcontext()
3274
3275 # logb(+/-Inf) = +Inf
3276 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003277 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003278
3279 # logb(0) = -Inf, DivisionByZero
3280 if not self:
3281 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3282
3283 # otherwise, simply return the adjusted exponent of self, as a
3284 # Decimal. Note that no attempt is made to fit the result
3285 # into the current context.
Mark Dickinson56df8872009-10-07 19:23:50 +00003286 ans = Decimal(self.adjusted())
3287 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003288
3289 def _islogical(self):
3290 """Return True if self is a logical operand.
3291
Christian Heimes679db4a2008-01-18 09:56:22 +00003292 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003293 an exponent of 0, and a coefficient whose digits must all be
3294 either 0 or 1.
3295 """
3296 if self._sign != 0 or self._exp != 0:
3297 return False
3298 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003299 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003300 return False
3301 return True
3302
3303 def _fill_logical(self, context, opa, opb):
3304 dif = context.prec - len(opa)
3305 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003306 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003307 elif dif < 0:
3308 opa = opa[-context.prec:]
3309 dif = context.prec - len(opb)
3310 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003311 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003312 elif dif < 0:
3313 opb = opb[-context.prec:]
3314 return opa, opb
3315
3316 def logical_and(self, other, context=None):
3317 """Applies an 'and' operation between self and other's digits."""
3318 if context is None:
3319 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003320
3321 other = _convert_other(other, raiseit=True)
3322
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003323 if not self._islogical() or not other._islogical():
3324 return context._raise_error(InvalidOperation)
3325
3326 # fill to context.prec
3327 (opa, opb) = self._fill_logical(context, self._int, other._int)
3328
3329 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003330 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3331 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003332
3333 def logical_invert(self, context=None):
3334 """Invert all its digits."""
3335 if context is None:
3336 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003337 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3338 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003339
3340 def logical_or(self, other, context=None):
3341 """Applies an 'or' operation between self and other's digits."""
3342 if context is None:
3343 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003344
3345 other = _convert_other(other, raiseit=True)
3346
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003347 if not self._islogical() or not other._islogical():
3348 return context._raise_error(InvalidOperation)
3349
3350 # fill to context.prec
3351 (opa, opb) = self._fill_logical(context, self._int, other._int)
3352
3353 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003354 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003355 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003356
3357 def logical_xor(self, other, context=None):
3358 """Applies an 'xor' operation between self and other's digits."""
3359 if context is None:
3360 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003361
3362 other = _convert_other(other, raiseit=True)
3363
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003364 if not self._islogical() or not other._islogical():
3365 return context._raise_error(InvalidOperation)
3366
3367 # fill to context.prec
3368 (opa, opb) = self._fill_logical(context, self._int, other._int)
3369
3370 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003371 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003372 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003373
3374 def max_mag(self, other, context=None):
3375 """Compares the values numerically with their sign ignored."""
3376 other = _convert_other(other, raiseit=True)
3377
3378 if context is None:
3379 context = getcontext()
3380
3381 if self._is_special or other._is_special:
3382 # If one operand is a quiet NaN and the other is number, then the
3383 # number is always returned
3384 sn = self._isnan()
3385 on = other._isnan()
3386 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003387 if on == 1 and sn == 0:
3388 return self._fix(context)
3389 if sn == 1 and on == 0:
3390 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003391 return self._check_nans(other, context)
3392
Christian Heimes77c02eb2008-02-09 02:18:51 +00003393 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003394 if c == 0:
3395 c = self.compare_total(other)
3396
3397 if c == -1:
3398 ans = other
3399 else:
3400 ans = self
3401
Christian Heimes2c181612007-12-17 20:04:13 +00003402 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003403
3404 def min_mag(self, other, context=None):
3405 """Compares the values numerically with their sign ignored."""
3406 other = _convert_other(other, raiseit=True)
3407
3408 if context is None:
3409 context = getcontext()
3410
3411 if self._is_special or other._is_special:
3412 # If one operand is a quiet NaN and the other is number, then the
3413 # number is always returned
3414 sn = self._isnan()
3415 on = other._isnan()
3416 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003417 if on == 1 and sn == 0:
3418 return self._fix(context)
3419 if sn == 1 and on == 0:
3420 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003421 return self._check_nans(other, context)
3422
Christian Heimes77c02eb2008-02-09 02:18:51 +00003423 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003424 if c == 0:
3425 c = self.compare_total(other)
3426
3427 if c == -1:
3428 ans = self
3429 else:
3430 ans = other
3431
Christian Heimes2c181612007-12-17 20:04:13 +00003432 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003433
3434 def next_minus(self, context=None):
3435 """Returns the largest representable number smaller than itself."""
3436 if context is None:
3437 context = getcontext()
3438
3439 ans = self._check_nans(context=context)
3440 if ans:
3441 return ans
3442
3443 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003444 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003445 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003446 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003447
3448 context = context.copy()
3449 context._set_rounding(ROUND_FLOOR)
3450 context._ignore_all_flags()
3451 new_self = self._fix(context)
3452 if new_self != self:
3453 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003454 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3455 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003456
3457 def next_plus(self, context=None):
3458 """Returns the smallest representable number larger than itself."""
3459 if context is None:
3460 context = getcontext()
3461
3462 ans = self._check_nans(context=context)
3463 if ans:
3464 return ans
3465
3466 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003467 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003468 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003469 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003470
3471 context = context.copy()
3472 context._set_rounding(ROUND_CEILING)
3473 context._ignore_all_flags()
3474 new_self = self._fix(context)
3475 if new_self != self:
3476 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003477 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3478 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003479
3480 def next_toward(self, other, context=None):
3481 """Returns the number closest to self, in the direction towards other.
3482
3483 The result is the closest representable number to self
3484 (excluding self) that is in the direction towards other,
3485 unless both have the same value. If the two operands are
3486 numerically equal, then the result is a copy of self with the
3487 sign set to be the same as the sign of other.
3488 """
3489 other = _convert_other(other, raiseit=True)
3490
3491 if context is None:
3492 context = getcontext()
3493
3494 ans = self._check_nans(other, context)
3495 if ans:
3496 return ans
3497
Christian Heimes77c02eb2008-02-09 02:18:51 +00003498 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003499 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003500 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003501
3502 if comparison == -1:
3503 ans = self.next_plus(context)
3504 else: # comparison == 1
3505 ans = self.next_minus(context)
3506
3507 # decide which flags to raise using value of ans
3508 if ans._isinfinity():
3509 context._raise_error(Overflow,
3510 'Infinite result from next_toward',
3511 ans._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003512 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003513 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003514 elif ans.adjusted() < context.Emin:
3515 context._raise_error(Underflow)
3516 context._raise_error(Subnormal)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003517 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003518 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003519 # if precision == 1 then we don't raise Clamped for a
3520 # result 0E-Etiny.
3521 if not ans:
3522 context._raise_error(Clamped)
3523
3524 return ans
3525
3526 def number_class(self, context=None):
3527 """Returns an indication of the class of self.
3528
3529 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003530 sNaN
3531 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003532 -Infinity
3533 -Normal
3534 -Subnormal
3535 -Zero
3536 +Zero
3537 +Subnormal
3538 +Normal
3539 +Infinity
3540 """
3541 if self.is_snan():
3542 return "sNaN"
3543 if self.is_qnan():
3544 return "NaN"
3545 inf = self._isinfinity()
3546 if inf == 1:
3547 return "+Infinity"
3548 if inf == -1:
3549 return "-Infinity"
3550 if self.is_zero():
3551 if self._sign:
3552 return "-Zero"
3553 else:
3554 return "+Zero"
3555 if context is None:
3556 context = getcontext()
3557 if self.is_subnormal(context=context):
3558 if self._sign:
3559 return "-Subnormal"
3560 else:
3561 return "+Subnormal"
3562 # just a normal, regular, boring number, :)
3563 if self._sign:
3564 return "-Normal"
3565 else:
3566 return "+Normal"
3567
3568 def radix(self):
3569 """Just returns 10, as this is Decimal, :)"""
3570 return Decimal(10)
3571
3572 def rotate(self, other, context=None):
3573 """Returns a rotated copy of self, value-of-other times."""
3574 if context is None:
3575 context = getcontext()
3576
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003577 other = _convert_other(other, raiseit=True)
3578
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003579 ans = self._check_nans(other, context)
3580 if ans:
3581 return ans
3582
3583 if other._exp != 0:
3584 return context._raise_error(InvalidOperation)
3585 if not (-context.prec <= int(other) <= context.prec):
3586 return context._raise_error(InvalidOperation)
3587
3588 if self._isinfinity():
3589 return Decimal(self)
3590
3591 # get values, pad if necessary
3592 torot = int(other)
3593 rotdig = self._int
3594 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003595 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003596 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003597 elif topad < 0:
3598 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003599
3600 # let's rotate!
3601 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003602 return _dec_from_triple(self._sign,
3603 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003604
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003605 def scaleb(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003606 """Returns self operand after adding the second value to its exp."""
3607 if context is None:
3608 context = getcontext()
3609
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003610 other = _convert_other(other, raiseit=True)
3611
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003612 ans = self._check_nans(other, context)
3613 if ans:
3614 return ans
3615
3616 if other._exp != 0:
3617 return context._raise_error(InvalidOperation)
3618 liminf = -2 * (context.Emax + context.prec)
3619 limsup = 2 * (context.Emax + context.prec)
3620 if not (liminf <= int(other) <= limsup):
3621 return context._raise_error(InvalidOperation)
3622
3623 if self._isinfinity():
3624 return Decimal(self)
3625
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003626 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003627 d = d._fix(context)
3628 return d
3629
3630 def shift(self, other, context=None):
3631 """Returns a shifted copy of self, value-of-other times."""
3632 if context is None:
3633 context = getcontext()
3634
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003635 other = _convert_other(other, raiseit=True)
3636
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003637 ans = self._check_nans(other, context)
3638 if ans:
3639 return ans
3640
3641 if other._exp != 0:
3642 return context._raise_error(InvalidOperation)
3643 if not (-context.prec <= int(other) <= context.prec):
3644 return context._raise_error(InvalidOperation)
3645
3646 if self._isinfinity():
3647 return Decimal(self)
3648
3649 # get values, pad if necessary
3650 torot = int(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003651 rotdig = self._int
3652 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003653 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003654 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003655 elif topad < 0:
3656 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003657
3658 # let's shift!
3659 if torot < 0:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003660 shifted = rotdig[:torot]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003661 else:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003662 shifted = rotdig + '0'*torot
3663 shifted = shifted[-context.prec:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003664
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003665 return _dec_from_triple(self._sign,
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003666 shifted.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003667
Guido van Rossumd8faa362007-04-27 19:54:29 +00003668 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003669 def __reduce__(self):
3670 return (self.__class__, (str(self),))
3671
3672 def __copy__(self):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003673 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003674 return self # I'm immutable; therefore I am my own clone
3675 return self.__class__(str(self))
3676
3677 def __deepcopy__(self, memo):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003678 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003679 return self # My components are also immutable
3680 return self.__class__(str(self))
3681
Mark Dickinson79f52032009-03-17 23:12:51 +00003682 # PEP 3101 support. the _localeconv keyword argument should be
3683 # considered private: it's provided for ease of testing only.
3684 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003685 """Format a Decimal instance according to the given specifier.
3686
3687 The specifier should be a standard format specifier, with the
3688 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003689 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3690 type is omitted it defaults to 'g' or 'G', depending on the
3691 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003692 """
3693
3694 # Note: PEP 3101 says that if the type is not present then
3695 # there should be at least one digit after the decimal point.
3696 # We take the liberty of ignoring this requirement for
3697 # Decimal---it's presumably there to make sure that
3698 # format(float, '') behaves similarly to str(float).
3699 if context is None:
3700 context = getcontext()
3701
Mark Dickinson79f52032009-03-17 23:12:51 +00003702 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003703
Mark Dickinson79f52032009-03-17 23:12:51 +00003704 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003705 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003706 sign = _format_sign(self._sign, spec)
3707 body = str(self.copy_abs())
3708 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003709
3710 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003711 if spec['type'] is None:
3712 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003713
3714 # if type is '%', adjust exponent of self accordingly
3715 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003716 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3717
3718 # round if necessary, taking rounding mode from the context
3719 rounding = context.rounding
3720 precision = spec['precision']
3721 if precision is not None:
3722 if spec['type'] in 'eE':
3723 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003724 elif spec['type'] in 'fF%':
3725 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003726 elif spec['type'] in 'gG' and len(self._int) > precision:
3727 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003728 # special case: zeros with a positive exponent can't be
3729 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003730 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003731 self = self._rescale(0, rounding)
3732
3733 # figure out placement of the decimal point
3734 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003735 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003736 if not self and precision is not None:
3737 dotplace = 1 - precision
3738 else:
3739 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003740 elif spec['type'] in 'fF%':
3741 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003742 elif spec['type'] in 'gG':
3743 if self._exp <= 0 and leftdigits > -6:
3744 dotplace = leftdigits
3745 else:
3746 dotplace = 1
3747
Mark Dickinson79f52032009-03-17 23:12:51 +00003748 # find digits before and after decimal point, and get exponent
3749 if dotplace < 0:
3750 intpart = '0'
3751 fracpart = '0'*(-dotplace) + self._int
3752 elif dotplace > len(self._int):
3753 intpart = self._int + '0'*(dotplace-len(self._int))
3754 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003755 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003756 intpart = self._int[:dotplace] or '0'
3757 fracpart = self._int[dotplace:]
3758 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003759
Mark Dickinson79f52032009-03-17 23:12:51 +00003760 # done with the decimal-specific stuff; hand over the rest
3761 # of the formatting to the _format_number function
3762 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003763
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003764def _dec_from_triple(sign, coefficient, exponent, special=False):
3765 """Create a decimal instance directly, without any validation,
3766 normalization (e.g. removal of leading zeros) or argument
3767 conversion.
3768
3769 This function is for *internal use only*.
3770 """
3771
3772 self = object.__new__(Decimal)
3773 self._sign = sign
3774 self._int = coefficient
3775 self._exp = exponent
3776 self._is_special = special
3777
3778 return self
3779
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003780# Register Decimal as a kind of Number (an abstract base class).
3781# However, do not register it as Real (because Decimals are not
3782# interoperable with floats).
3783_numbers.Number.register(Decimal)
3784
3785
Guido van Rossumd8faa362007-04-27 19:54:29 +00003786##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003787
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003788
3789# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003790rounding_functions = [name for name in Decimal.__dict__.keys()
3791 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003792for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003793 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003794 globalname = name[1:].upper()
3795 val = globals()[globalname]
3796 Decimal._pick_rounding_function[val] = name
3797
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003798del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003799
Thomas Wouters89f507f2006-12-13 04:49:30 +00003800class _ContextManager(object):
3801 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003802
Thomas Wouters89f507f2006-12-13 04:49:30 +00003803 Sets a copy of the supplied context in __enter__() and restores
3804 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003805 """
3806 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003807 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003808 def __enter__(self):
3809 self.saved_context = getcontext()
3810 setcontext(self.new_context)
3811 return self.new_context
3812 def __exit__(self, t, v, tb):
3813 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003814
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003815class Context(object):
3816 """Contains the context for a Decimal instance.
3817
3818 Contains:
3819 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003820 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003821 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003822 raised when it is caused. Otherwise, a value is
3823 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003824 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003825 (Whether or not the trap_enabler is set)
3826 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003827 Emin - Minimum exponent
3828 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003829 capitals - If 1, 1*10^1 is printed as 1E+1.
3830 If 0, printed as 1e1
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003831 clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003832 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003833
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003834 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003835 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003836 Emin=None, Emax=None,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003837 capitals=None, clamp=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003838 _ignored_flags=None):
3839 if flags is None:
3840 flags = []
3841 if _ignored_flags is None:
3842 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003843 if not isinstance(flags, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003844 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerbf440692004-07-10 14:14:37 +00003845 if traps is not None and not isinstance(traps, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003846 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003847 for name, val in locals().items():
3848 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003849 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003850 else:
3851 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003852 del self.self
3853
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003854 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003855 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003856 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003857 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003858 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d, '
3859 'clamp=%(clamp)d'
Guido van Rossumd8faa362007-04-27 19:54:29 +00003860 % vars(self))
3861 names = [f.__name__ for f, v in self.flags.items() if v]
3862 s.append('flags=[' + ', '.join(names) + ']')
3863 names = [t.__name__ for t, v in self.traps.items() if v]
3864 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003865 return ', '.join(s) + ')'
3866
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003867 def clear_flags(self):
3868 """Reset all flags to zero"""
3869 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003870 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003871
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003872 def _shallow_copy(self):
3873 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003874 nc = Context(self.prec, self.rounding, self.traps,
3875 self.flags, self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003876 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003877 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003878
3879 def copy(self):
3880 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003881 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003882 self.flags.copy(), self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003883 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003884 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003885 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003886
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003887 # _clamp is provided for backwards compatibility with third-party
3888 # code. May be removed in Python >= 3.3.
3889 def _get_clamp(self):
3890 "_clamp mirrors the clamp attribute. Its use is deprecated."
3891 import warnings
3892 warnings.warn('Use of the _clamp attribute is deprecated. '
3893 'Please use clamp instead.',
3894 DeprecationWarning)
3895 return self.clamp
3896
3897 def _set_clamp(self, clamp):
3898 "_clamp mirrors the clamp attribute. Its use is deprecated."
3899 import warnings
3900 warnings.warn('Use of the _clamp attribute is deprecated. '
3901 'Please use clamp instead.',
3902 DeprecationWarning)
3903 self.clamp = clamp
3904
3905 # don't bother with _del_clamp; no sane 3rd party code should
3906 # be deleting the _clamp attribute
3907 _clamp = property(_get_clamp, _set_clamp)
3908
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003909 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003910 """Handles an error
3911
3912 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003913 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah2eb4a072010-05-19 15:52:31 +00003914 trap_enabler is set, it reraises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003915 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003916 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003917 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003918 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003919 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003920 return error().handle(self, *args)
3921
Raymond Hettinger86173da2008-02-01 20:38:12 +00003922 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003923 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003924 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003925 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003926
3927 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003928 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003929 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003930
3931 def _ignore_all_flags(self):
3932 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003933 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003934
3935 def _ignore_flags(self, *flags):
3936 """Ignore the flags, if they are raised"""
3937 # Do not mutate-- This way, copies of a context leave the original
3938 # alone.
3939 self._ignored_flags = (self._ignored_flags + list(flags))
3940 return list(flags)
3941
3942 def _regard_flags(self, *flags):
3943 """Stop ignoring the flags, if they are raised"""
3944 if flags and isinstance(flags[0], (tuple,list)):
3945 flags = flags[0]
3946 for flag in flags:
3947 self._ignored_flags.remove(flag)
3948
Nick Coghland1abd252008-07-15 15:46:38 +00003949 # We inherit object.__hash__, so we must deny this explicitly
3950 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003951
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003952 def Etiny(self):
3953 """Returns Etiny (= Emin - prec + 1)"""
3954 return int(self.Emin - self.prec + 1)
3955
3956 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003957 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003958 return int(self.Emax - self.prec + 1)
3959
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003960 def _set_rounding(self, type):
3961 """Sets the rounding type.
3962
3963 Sets the rounding type, and returns the current (previous)
3964 rounding type. Often used like:
3965
3966 context = context.copy()
3967 # so you don't change the calling context
3968 # if an error occurs in the middle.
3969 rounding = context._set_rounding(ROUND_UP)
3970 val = self.__sub__(other, context=context)
3971 context._set_rounding(rounding)
3972
3973 This will make it round up for that operation.
3974 """
3975 rounding = self.rounding
3976 self.rounding= type
3977 return rounding
3978
Raymond Hettingerfed52962004-07-14 15:41:57 +00003979 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003980 """Creates a new Decimal instance but using self as context.
3981
3982 This method implements the to-number operation of the
3983 IBM Decimal specification."""
3984
3985 if isinstance(num, str) and num != num.strip():
3986 return self._raise_error(ConversionSyntax,
3987 "no trailing or leading whitespace is "
3988 "permitted.")
3989
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003990 d = Decimal(num, context=self)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003991 if d._isnan() and len(d._int) > self.prec - self.clamp:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003992 return self._raise_error(ConversionSyntax,
3993 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003994 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003995
Raymond Hettinger771ed762009-01-03 19:20:32 +00003996 def create_decimal_from_float(self, f):
3997 """Creates a new Decimal instance from a float but rounding using self
3998 as the context.
3999
4000 >>> context = Context(prec=5, rounding=ROUND_DOWN)
4001 >>> context.create_decimal_from_float(3.1415926535897932)
4002 Decimal('3.1415')
4003 >>> context = Context(prec=5, traps=[Inexact])
4004 >>> context.create_decimal_from_float(3.1415926535897932)
4005 Traceback (most recent call last):
4006 ...
4007 decimal.Inexact: None
4008
4009 """
4010 d = Decimal.from_float(f) # An exact conversion
4011 return d._fix(self) # Apply the context rounding
4012
Guido van Rossumd8faa362007-04-27 19:54:29 +00004013 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004014 def abs(self, a):
4015 """Returns the absolute value of the operand.
4016
4017 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00004018 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004019 the plus operation on the operand.
4020
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004021 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004022 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004023 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004024 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004025 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004026 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004027 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004028 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004029 >>> ExtendedContext.abs(-1)
4030 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004031 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004032 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004033 return a.__abs__(context=self)
4034
4035 def add(self, a, b):
4036 """Return the sum of the two operands.
4037
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004038 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004039 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004040 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004041 Decimal('1.02E+4')
Mark Dickinson84230a12010-02-18 14:49:50 +00004042 >>> ExtendedContext.add(1, Decimal(2))
4043 Decimal('3')
4044 >>> ExtendedContext.add(Decimal(8), 5)
4045 Decimal('13')
4046 >>> ExtendedContext.add(5, 5)
4047 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004048 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004049 a = _convert_other(a, raiseit=True)
4050 r = a.__add__(b, context=self)
4051 if r is NotImplemented:
4052 raise TypeError("Unable to convert %s to Decimal" % b)
4053 else:
4054 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004055
4056 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00004057 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004058
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004059 def canonical(self, a):
4060 """Returns the same Decimal object.
4061
4062 As we do not have different encodings for the same number, the
4063 received object already is in its canonical form.
4064
4065 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004066 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004067 """
4068 return a.canonical(context=self)
4069
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004070 def compare(self, a, b):
4071 """Compares values numerically.
4072
4073 If the signs of the operands differ, a value representing each operand
4074 ('-1' if the operand is less than zero, '0' if the operand is zero or
4075 negative zero, or '1' if the operand is greater than zero) is used in
4076 place of that operand for the comparison instead of the actual
4077 operand.
4078
4079 The comparison is then effected by subtracting the second operand from
4080 the first and then returning a value according to the result of the
4081 subtraction: '-1' if the result is less than zero, '0' if the result is
4082 zero or negative zero, or '1' if the result is greater than zero.
4083
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004084 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004085 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004086 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004087 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004088 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004089 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004090 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004091 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004092 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004093 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004094 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004095 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004096 >>> ExtendedContext.compare(1, 2)
4097 Decimal('-1')
4098 >>> ExtendedContext.compare(Decimal(1), 2)
4099 Decimal('-1')
4100 >>> ExtendedContext.compare(1, Decimal(2))
4101 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004102 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004103 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004104 return a.compare(b, context=self)
4105
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004106 def compare_signal(self, a, b):
4107 """Compares the values of the two operands numerically.
4108
4109 It's pretty much like compare(), but all NaNs signal, with signaling
4110 NaNs taking precedence over quiet NaNs.
4111
4112 >>> c = ExtendedContext
4113 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004114 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004115 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004116 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004117 >>> c.flags[InvalidOperation] = 0
4118 >>> print(c.flags[InvalidOperation])
4119 0
4120 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004121 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004122 >>> print(c.flags[InvalidOperation])
4123 1
4124 >>> c.flags[InvalidOperation] = 0
4125 >>> print(c.flags[InvalidOperation])
4126 0
4127 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004128 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004129 >>> print(c.flags[InvalidOperation])
4130 1
Mark Dickinson84230a12010-02-18 14:49:50 +00004131 >>> c.compare_signal(-1, 2)
4132 Decimal('-1')
4133 >>> c.compare_signal(Decimal(-1), 2)
4134 Decimal('-1')
4135 >>> c.compare_signal(-1, Decimal(2))
4136 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004137 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004138 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004139 return a.compare_signal(b, context=self)
4140
4141 def compare_total(self, a, b):
4142 """Compares two operands using their abstract representation.
4143
4144 This is not like the standard compare, which use their numerical
4145 value. Note that a total ordering is defined for all possible abstract
4146 representations.
4147
4148 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004149 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004150 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004151 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004152 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004153 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004154 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004155 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004156 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004157 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004158 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004159 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004160 >>> ExtendedContext.compare_total(1, 2)
4161 Decimal('-1')
4162 >>> ExtendedContext.compare_total(Decimal(1), 2)
4163 Decimal('-1')
4164 >>> ExtendedContext.compare_total(1, Decimal(2))
4165 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004166 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004167 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004168 return a.compare_total(b)
4169
4170 def compare_total_mag(self, a, b):
4171 """Compares two operands using their abstract representation ignoring sign.
4172
4173 Like compare_total, but with operand's sign ignored and assumed to be 0.
4174 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004175 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004176 return a.compare_total_mag(b)
4177
4178 def copy_abs(self, a):
4179 """Returns a copy of the operand with the sign set to 0.
4180
4181 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004182 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004183 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004184 Decimal('100')
Mark Dickinson84230a12010-02-18 14:49:50 +00004185 >>> ExtendedContext.copy_abs(-1)
4186 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004187 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004188 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004189 return a.copy_abs()
4190
4191 def copy_decimal(self, a):
Mark Dickinson84230a12010-02-18 14:49:50 +00004192 """Returns a copy of the decimal object.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004193
4194 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004195 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004196 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004197 Decimal('-1.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004198 >>> ExtendedContext.copy_decimal(1)
4199 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004200 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004201 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004202 return Decimal(a)
4203
4204 def copy_negate(self, a):
4205 """Returns a copy of the operand with the sign inverted.
4206
4207 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004208 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004209 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004210 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004211 >>> ExtendedContext.copy_negate(1)
4212 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004213 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004214 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004215 return a.copy_negate()
4216
4217 def copy_sign(self, a, b):
4218 """Copies the second operand's sign to the first one.
4219
4220 In detail, it returns a copy of the first operand with the sign
4221 equal to the sign of the second operand.
4222
4223 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004224 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004225 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004226 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004227 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004228 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004229 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004230 Decimal('-1.50')
Mark Dickinson84230a12010-02-18 14:49:50 +00004231 >>> ExtendedContext.copy_sign(1, -2)
4232 Decimal('-1')
4233 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4234 Decimal('-1')
4235 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4236 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004237 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004238 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004239 return a.copy_sign(b)
4240
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004241 def divide(self, a, b):
4242 """Decimal division in a specified context.
4243
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004244 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004245 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004246 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004247 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004248 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004249 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004250 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004251 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004252 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004253 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004254 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004255 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004256 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004257 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004258 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004259 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004260 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004261 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004262 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004263 Decimal('1.20E+6')
Mark Dickinson84230a12010-02-18 14:49:50 +00004264 >>> ExtendedContext.divide(5, 5)
4265 Decimal('1')
4266 >>> ExtendedContext.divide(Decimal(5), 5)
4267 Decimal('1')
4268 >>> ExtendedContext.divide(5, Decimal(5))
4269 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004270 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004271 a = _convert_other(a, raiseit=True)
4272 r = a.__truediv__(b, context=self)
4273 if r is NotImplemented:
4274 raise TypeError("Unable to convert %s to Decimal" % b)
4275 else:
4276 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004277
4278 def divide_int(self, a, b):
4279 """Divides two numbers and returns the integer part of the result.
4280
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004281 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004282 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004283 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004284 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004285 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004286 Decimal('3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004287 >>> ExtendedContext.divide_int(10, 3)
4288 Decimal('3')
4289 >>> ExtendedContext.divide_int(Decimal(10), 3)
4290 Decimal('3')
4291 >>> ExtendedContext.divide_int(10, Decimal(3))
4292 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004293 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004294 a = _convert_other(a, raiseit=True)
4295 r = a.__floordiv__(b, context=self)
4296 if r is NotImplemented:
4297 raise TypeError("Unable to convert %s to Decimal" % b)
4298 else:
4299 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004300
4301 def divmod(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004302 """Return (a // b, a % b).
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004303
4304 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4305 (Decimal('2'), Decimal('2'))
4306 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4307 (Decimal('2'), Decimal('0'))
Mark Dickinson84230a12010-02-18 14:49:50 +00004308 >>> ExtendedContext.divmod(8, 4)
4309 (Decimal('2'), Decimal('0'))
4310 >>> ExtendedContext.divmod(Decimal(8), 4)
4311 (Decimal('2'), Decimal('0'))
4312 >>> ExtendedContext.divmod(8, Decimal(4))
4313 (Decimal('2'), Decimal('0'))
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004314 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004315 a = _convert_other(a, raiseit=True)
4316 r = a.__divmod__(b, context=self)
4317 if r is NotImplemented:
4318 raise TypeError("Unable to convert %s to Decimal" % b)
4319 else:
4320 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004321
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004322 def exp(self, a):
4323 """Returns e ** a.
4324
4325 >>> c = ExtendedContext.copy()
4326 >>> c.Emin = -999
4327 >>> c.Emax = 999
4328 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004329 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004330 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004331 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004332 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004333 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004334 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004335 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004336 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004337 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004338 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004339 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004340 >>> c.exp(10)
4341 Decimal('22026.4658')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004342 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004343 a =_convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004344 return a.exp(context=self)
4345
4346 def fma(self, a, b, c):
4347 """Returns a multiplied by b, plus c.
4348
4349 The first two operands are multiplied together, using multiply,
4350 the third operand is then added to the result of that
4351 multiplication, using add, all with only one final rounding.
4352
4353 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004354 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004355 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004356 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004357 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004358 Decimal('1.38435736E+12')
Mark Dickinson84230a12010-02-18 14:49:50 +00004359 >>> ExtendedContext.fma(1, 3, 4)
4360 Decimal('7')
4361 >>> ExtendedContext.fma(1, Decimal(3), 4)
4362 Decimal('7')
4363 >>> ExtendedContext.fma(1, 3, Decimal(4))
4364 Decimal('7')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004365 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004366 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004367 return a.fma(b, c, context=self)
4368
4369 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004370 """Return True if the operand is canonical; otherwise return False.
4371
4372 Currently, the encoding of a Decimal instance is always
4373 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004374
4375 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004376 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004377 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004378 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004379
4380 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004381 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004382
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004383 A Decimal instance is considered finite if it is neither
4384 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004385
4386 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004387 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004388 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004389 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004390 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004391 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004392 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004393 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004394 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004395 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004396 >>> ExtendedContext.is_finite(1)
4397 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004398 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004399 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004400 return a.is_finite()
4401
4402 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004403 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004404
4405 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004406 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004407 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004408 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004409 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004410 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004411 >>> ExtendedContext.is_infinite(1)
4412 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004413 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004414 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004415 return a.is_infinite()
4416
4417 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004418 """Return True if the operand is a qNaN or sNaN;
4419 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004420
4421 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004422 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004423 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004424 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004425 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004426 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004427 >>> ExtendedContext.is_nan(1)
4428 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004429 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004430 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004431 return a.is_nan()
4432
4433 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004434 """Return True if the operand is a normal number;
4435 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004436
4437 >>> c = ExtendedContext.copy()
4438 >>> c.Emin = -999
4439 >>> c.Emax = 999
4440 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004441 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004442 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004443 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004444 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004445 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004446 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004447 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004448 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004449 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004450 >>> c.is_normal(1)
4451 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004452 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004453 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004454 return a.is_normal(context=self)
4455
4456 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004457 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004458
4459 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004460 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004461 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004462 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004463 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004464 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004465 >>> ExtendedContext.is_qnan(1)
4466 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004467 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004468 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004469 return a.is_qnan()
4470
4471 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004472 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004473
4474 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004475 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004476 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004477 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004478 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004479 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004480 >>> ExtendedContext.is_signed(8)
4481 False
4482 >>> ExtendedContext.is_signed(-8)
4483 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004484 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004485 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004486 return a.is_signed()
4487
4488 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004489 """Return True if the operand is a signaling NaN;
4490 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004491
4492 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004493 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004494 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004495 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004496 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004497 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004498 >>> ExtendedContext.is_snan(1)
4499 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004500 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004501 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004502 return a.is_snan()
4503
4504 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004505 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004506
4507 >>> c = ExtendedContext.copy()
4508 >>> c.Emin = -999
4509 >>> c.Emax = 999
4510 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004511 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004512 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004513 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004514 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004515 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004516 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004517 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004518 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004519 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004520 >>> c.is_subnormal(1)
4521 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004522 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004523 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004524 return a.is_subnormal(context=self)
4525
4526 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004527 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004528
4529 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004530 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004531 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004532 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004533 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004534 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004535 >>> ExtendedContext.is_zero(1)
4536 False
4537 >>> ExtendedContext.is_zero(0)
4538 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004539 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004540 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004541 return a.is_zero()
4542
4543 def ln(self, a):
4544 """Returns the natural (base e) logarithm of the operand.
4545
4546 >>> c = ExtendedContext.copy()
4547 >>> c.Emin = -999
4548 >>> c.Emax = 999
4549 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004550 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004551 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004552 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004553 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004554 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004555 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004556 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004557 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004558 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004559 >>> c.ln(1)
4560 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004561 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004562 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004563 return a.ln(context=self)
4564
4565 def log10(self, a):
4566 """Returns the base 10 logarithm of the operand.
4567
4568 >>> c = ExtendedContext.copy()
4569 >>> c.Emin = -999
4570 >>> c.Emax = 999
4571 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004572 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004573 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004574 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004575 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004576 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004577 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004578 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004579 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004580 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004581 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004582 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004583 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004584 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004585 >>> c.log10(0)
4586 Decimal('-Infinity')
4587 >>> c.log10(1)
4588 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004589 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004590 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004591 return a.log10(context=self)
4592
4593 def logb(self, a):
4594 """ Returns the exponent of the magnitude of the operand's MSD.
4595
4596 The result is the integer which is the exponent of the magnitude
4597 of the most significant digit of the operand (as though the
4598 operand were truncated to a single digit while maintaining the
4599 value of that digit and without limiting the resulting exponent).
4600
4601 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004602 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004603 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004604 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004605 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004606 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004607 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004608 Decimal('-Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004609 >>> ExtendedContext.logb(1)
4610 Decimal('0')
4611 >>> ExtendedContext.logb(10)
4612 Decimal('1')
4613 >>> ExtendedContext.logb(100)
4614 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004615 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004616 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004617 return a.logb(context=self)
4618
4619 def logical_and(self, a, b):
4620 """Applies the logical operation 'and' between each operand's digits.
4621
4622 The operands must be both logical numbers.
4623
4624 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004625 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004626 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004627 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004628 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004629 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004630 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004631 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004632 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004633 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004634 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004635 Decimal('10')
Mark Dickinson84230a12010-02-18 14:49:50 +00004636 >>> ExtendedContext.logical_and(110, 1101)
4637 Decimal('100')
4638 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4639 Decimal('100')
4640 >>> ExtendedContext.logical_and(110, Decimal(1101))
4641 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004642 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004643 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004644 return a.logical_and(b, context=self)
4645
4646 def logical_invert(self, a):
4647 """Invert all the digits in the operand.
4648
4649 The operand must be a logical number.
4650
4651 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004652 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004653 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004654 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004655 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004656 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004657 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004658 Decimal('10101010')
Mark Dickinson84230a12010-02-18 14:49:50 +00004659 >>> ExtendedContext.logical_invert(1101)
4660 Decimal('111110010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004661 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004662 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004663 return a.logical_invert(context=self)
4664
4665 def logical_or(self, a, b):
4666 """Applies the logical operation 'or' between each operand's digits.
4667
4668 The operands must be both logical numbers.
4669
4670 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004671 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004672 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004673 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004674 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004675 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004676 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004677 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004678 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004679 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004680 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004681 Decimal('1110')
Mark Dickinson84230a12010-02-18 14:49:50 +00004682 >>> ExtendedContext.logical_or(110, 1101)
4683 Decimal('1111')
4684 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4685 Decimal('1111')
4686 >>> ExtendedContext.logical_or(110, Decimal(1101))
4687 Decimal('1111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004688 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004689 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004690 return a.logical_or(b, context=self)
4691
4692 def logical_xor(self, a, b):
4693 """Applies the logical operation 'xor' between each operand's digits.
4694
4695 The operands must be both logical numbers.
4696
4697 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004698 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004699 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004700 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004701 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004702 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004703 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004704 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004705 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004706 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004707 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004708 Decimal('1101')
Mark Dickinson84230a12010-02-18 14:49:50 +00004709 >>> ExtendedContext.logical_xor(110, 1101)
4710 Decimal('1011')
4711 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4712 Decimal('1011')
4713 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4714 Decimal('1011')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004715 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004716 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004717 return a.logical_xor(b, context=self)
4718
Mark Dickinson84230a12010-02-18 14:49:50 +00004719 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004720 """max compares two values numerically and returns the maximum.
4721
4722 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004723 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004724 operation. If they are numerically equal then the left-hand operand
4725 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004726 infinity) of the two operands is chosen as the result.
4727
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004728 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004729 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004730 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004731 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004732 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004733 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004734 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004735 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004736 >>> ExtendedContext.max(1, 2)
4737 Decimal('2')
4738 >>> ExtendedContext.max(Decimal(1), 2)
4739 Decimal('2')
4740 >>> ExtendedContext.max(1, Decimal(2))
4741 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004742 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004743 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004744 return a.max(b, context=self)
4745
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004746 def max_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004747 """Compares the values numerically with their sign ignored.
4748
4749 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4750 Decimal('7')
4751 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4752 Decimal('-10')
4753 >>> ExtendedContext.max_mag(1, -2)
4754 Decimal('-2')
4755 >>> ExtendedContext.max_mag(Decimal(1), -2)
4756 Decimal('-2')
4757 >>> ExtendedContext.max_mag(1, Decimal(-2))
4758 Decimal('-2')
4759 """
4760 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004761 return a.max_mag(b, context=self)
4762
Mark Dickinson84230a12010-02-18 14:49:50 +00004763 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004764 """min compares two values numerically and returns the minimum.
4765
4766 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004767 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004768 operation. If they are numerically equal then the left-hand operand
4769 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004770 infinity) of the two operands is chosen as the result.
4771
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004772 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004773 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004774 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004775 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004776 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004777 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004778 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004779 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004780 >>> ExtendedContext.min(1, 2)
4781 Decimal('1')
4782 >>> ExtendedContext.min(Decimal(1), 2)
4783 Decimal('1')
4784 >>> ExtendedContext.min(1, Decimal(29))
4785 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004786 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004787 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004788 return a.min(b, context=self)
4789
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004790 def min_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004791 """Compares the values numerically with their sign ignored.
4792
4793 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4794 Decimal('-2')
4795 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4796 Decimal('-3')
4797 >>> ExtendedContext.min_mag(1, -2)
4798 Decimal('1')
4799 >>> ExtendedContext.min_mag(Decimal(1), -2)
4800 Decimal('1')
4801 >>> ExtendedContext.min_mag(1, Decimal(-2))
4802 Decimal('1')
4803 """
4804 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004805 return a.min_mag(b, context=self)
4806
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004807 def minus(self, a):
4808 """Minus corresponds to unary prefix minus in Python.
4809
4810 The operation is evaluated using the same rules as subtract; the
4811 operation minus(a) is calculated as subtract('0', a) where the '0'
4812 has the same exponent as the operand.
4813
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004814 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004815 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004816 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004817 Decimal('1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004818 >>> ExtendedContext.minus(1)
4819 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004820 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004821 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004822 return a.__neg__(context=self)
4823
4824 def multiply(self, a, b):
4825 """multiply multiplies two operands.
4826
4827 If either operand is a special value then the general rules apply.
Mark Dickinson84230a12010-02-18 14:49:50 +00004828 Otherwise, the operands are multiplied together
4829 ('long multiplication'), resulting in a number which may be as long as
4830 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004831
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004832 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004833 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004834 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004835 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004836 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004837 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004838 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004839 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004840 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004841 Decimal('4.28135971E+11')
Mark Dickinson84230a12010-02-18 14:49:50 +00004842 >>> ExtendedContext.multiply(7, 7)
4843 Decimal('49')
4844 >>> ExtendedContext.multiply(Decimal(7), 7)
4845 Decimal('49')
4846 >>> ExtendedContext.multiply(7, Decimal(7))
4847 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004848 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004849 a = _convert_other(a, raiseit=True)
4850 r = a.__mul__(b, context=self)
4851 if r is NotImplemented:
4852 raise TypeError("Unable to convert %s to Decimal" % b)
4853 else:
4854 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004855
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004856 def next_minus(self, a):
4857 """Returns the largest representable number smaller than a.
4858
4859 >>> c = ExtendedContext.copy()
4860 >>> c.Emin = -999
4861 >>> c.Emax = 999
4862 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004863 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004864 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004865 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004866 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004867 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004868 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004869 Decimal('9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004870 >>> c.next_minus(1)
4871 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004872 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004873 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004874 return a.next_minus(context=self)
4875
4876 def next_plus(self, a):
4877 """Returns the smallest representable number larger than a.
4878
4879 >>> c = ExtendedContext.copy()
4880 >>> c.Emin = -999
4881 >>> c.Emax = 999
4882 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004883 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004884 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004885 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004886 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004887 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004888 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004889 Decimal('-9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004890 >>> c.next_plus(1)
4891 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004892 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004893 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004894 return a.next_plus(context=self)
4895
4896 def next_toward(self, a, b):
4897 """Returns the number closest to a, in direction towards b.
4898
4899 The result is the closest representable number from the first
4900 operand (but not the first operand) that is in the direction
4901 towards the second operand, unless the operands have the same
4902 value.
4903
4904 >>> c = ExtendedContext.copy()
4905 >>> c.Emin = -999
4906 >>> c.Emax = 999
4907 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004908 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004909 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004910 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004911 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004912 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004913 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004914 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004915 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004916 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004917 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004918 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004919 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004920 Decimal('-0.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004921 >>> c.next_toward(0, 1)
4922 Decimal('1E-1007')
4923 >>> c.next_toward(Decimal(0), 1)
4924 Decimal('1E-1007')
4925 >>> c.next_toward(0, Decimal(1))
4926 Decimal('1E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004927 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004928 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004929 return a.next_toward(b, context=self)
4930
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004931 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004932 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004933
4934 Essentially a plus operation with all trailing zeros removed from the
4935 result.
4936
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004937 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004938 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004939 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004940 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004941 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004942 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004943 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004944 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004945 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004946 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004947 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004948 Decimal('0')
Mark Dickinson84230a12010-02-18 14:49:50 +00004949 >>> ExtendedContext.normalize(6)
4950 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004951 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004952 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004953 return a.normalize(context=self)
4954
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004955 def number_class(self, a):
4956 """Returns an indication of the class of the operand.
4957
4958 The class is one of the following strings:
4959 -sNaN
4960 -NaN
4961 -Infinity
4962 -Normal
4963 -Subnormal
4964 -Zero
4965 +Zero
4966 +Subnormal
4967 +Normal
4968 +Infinity
4969
4970 >>> c = Context(ExtendedContext)
4971 >>> c.Emin = -999
4972 >>> c.Emax = 999
4973 >>> c.number_class(Decimal('Infinity'))
4974 '+Infinity'
4975 >>> c.number_class(Decimal('1E-10'))
4976 '+Normal'
4977 >>> c.number_class(Decimal('2.50'))
4978 '+Normal'
4979 >>> c.number_class(Decimal('0.1E-999'))
4980 '+Subnormal'
4981 >>> c.number_class(Decimal('0'))
4982 '+Zero'
4983 >>> c.number_class(Decimal('-0'))
4984 '-Zero'
4985 >>> c.number_class(Decimal('-0.1E-999'))
4986 '-Subnormal'
4987 >>> c.number_class(Decimal('-1E-10'))
4988 '-Normal'
4989 >>> c.number_class(Decimal('-2.50'))
4990 '-Normal'
4991 >>> c.number_class(Decimal('-Infinity'))
4992 '-Infinity'
4993 >>> c.number_class(Decimal('NaN'))
4994 'NaN'
4995 >>> c.number_class(Decimal('-NaN'))
4996 'NaN'
4997 >>> c.number_class(Decimal('sNaN'))
4998 'sNaN'
Mark Dickinson84230a12010-02-18 14:49:50 +00004999 >>> c.number_class(123)
5000 '+Normal'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005001 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005002 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005003 return a.number_class(context=self)
5004
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005005 def plus(self, a):
5006 """Plus corresponds to unary prefix plus in Python.
5007
5008 The operation is evaluated using the same rules as add; the
5009 operation plus(a) is calculated as add('0', a) where the '0'
5010 has the same exponent as the operand.
5011
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005012 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005013 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005014 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005015 Decimal('-1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005016 >>> ExtendedContext.plus(-1)
5017 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005018 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005019 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005020 return a.__pos__(context=self)
5021
5022 def power(self, a, b, modulo=None):
5023 """Raises a to the power of b, to modulo if given.
5024
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005025 With two arguments, compute a**b. If a is negative then b
5026 must be integral. The result will be inexact unless b is
5027 integral and the result is finite and can be expressed exactly
5028 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005029
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005030 With three arguments, compute (a**b) % modulo. For the
5031 three argument form, the following restrictions on the
5032 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005033
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005034 - all three arguments must be integral
5035 - b must be nonnegative
5036 - at least one of a or b must be nonzero
5037 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005038
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005039 The result of pow(a, b, modulo) is identical to the result
5040 that would be obtained by computing (a**b) % modulo with
5041 unbounded precision, but is computed more efficiently. It is
5042 always exact.
5043
5044 >>> c = ExtendedContext.copy()
5045 >>> c.Emin = -999
5046 >>> c.Emax = 999
5047 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005048 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005049 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005050 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005051 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005052 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005053 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005054 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005055 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005056 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005057 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005058 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005059 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005060 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005061 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005062 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005063 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005064 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005065 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005066 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005067 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005068 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005069 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005070 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005071 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005072 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005073
5074 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005075 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005076 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005077 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005078 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005079 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005080 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005081 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005082 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005083 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005084 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005085 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005086 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005087 Decimal('1')
Mark Dickinson84230a12010-02-18 14:49:50 +00005088 >>> ExtendedContext.power(7, 7)
5089 Decimal('823543')
5090 >>> ExtendedContext.power(Decimal(7), 7)
5091 Decimal('823543')
5092 >>> ExtendedContext.power(7, Decimal(7), 2)
5093 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005094 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005095 a = _convert_other(a, raiseit=True)
5096 r = a.__pow__(b, modulo, context=self)
5097 if r is NotImplemented:
5098 raise TypeError("Unable to convert %s to Decimal" % b)
5099 else:
5100 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005101
5102 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005103 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005104
5105 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00005106 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005107 exponent is being increased), multiplied by a positive power of ten (if
5108 the exponent is being decreased), or is unchanged (if the exponent is
5109 already equal to that of the right-hand operand).
5110
5111 Unlike other operations, if the length of the coefficient after the
5112 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00005113 operation condition is raised. This guarantees that, unless there is
5114 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005115 equal to that of the right-hand operand.
5116
5117 Also unlike other operations, quantize will never raise Underflow, even
5118 if the result is subnormal and inexact.
5119
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005120 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005121 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005122 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005123 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005124 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005125 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005126 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005127 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005128 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005129 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005130 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005131 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005132 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005133 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005134 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005135 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005136 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005137 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005138 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005139 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005140 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005141 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005142 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005143 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005144 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005145 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005146 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005147 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005148 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005149 Decimal('2E+2')
Mark Dickinson84230a12010-02-18 14:49:50 +00005150 >>> ExtendedContext.quantize(1, 2)
5151 Decimal('1')
5152 >>> ExtendedContext.quantize(Decimal(1), 2)
5153 Decimal('1')
5154 >>> ExtendedContext.quantize(1, Decimal(2))
5155 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005156 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005157 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005158 return a.quantize(b, context=self)
5159
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005160 def radix(self):
5161 """Just returns 10, as this is Decimal, :)
5162
5163 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005164 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005165 """
5166 return Decimal(10)
5167
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005168 def remainder(self, a, b):
5169 """Returns the remainder from integer division.
5170
5171 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00005172 calculating integer division as described for divide-integer, rounded
5173 to precision digits if necessary. The sign of the result, if
5174 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005175
5176 This operation will fail under the same conditions as integer division
5177 (that is, if integer division on the same two operands would fail, the
5178 remainder cannot be calculated).
5179
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005180 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005181 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005182 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005183 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005184 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005185 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005186 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005187 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005188 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005189 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005190 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005191 Decimal('1.0')
Mark Dickinson84230a12010-02-18 14:49:50 +00005192 >>> ExtendedContext.remainder(22, 6)
5193 Decimal('4')
5194 >>> ExtendedContext.remainder(Decimal(22), 6)
5195 Decimal('4')
5196 >>> ExtendedContext.remainder(22, Decimal(6))
5197 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005198 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005199 a = _convert_other(a, raiseit=True)
5200 r = a.__mod__(b, context=self)
5201 if r is NotImplemented:
5202 raise TypeError("Unable to convert %s to Decimal" % b)
5203 else:
5204 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005205
5206 def remainder_near(self, a, b):
5207 """Returns to be "a - b * n", where n is the integer nearest the exact
5208 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00005209 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005210 sign of a.
5211
5212 This operation will fail under the same conditions as integer division
5213 (that is, if integer division on the same two operands would fail, the
5214 remainder cannot be calculated).
5215
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005216 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005217 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005218 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005219 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005220 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005221 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005222 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005223 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005224 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005225 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005226 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005227 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005228 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005229 Decimal('-0.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005230 >>> ExtendedContext.remainder_near(3, 11)
5231 Decimal('3')
5232 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5233 Decimal('3')
5234 >>> ExtendedContext.remainder_near(3, Decimal(11))
5235 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005236 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005237 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005238 return a.remainder_near(b, context=self)
5239
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005240 def rotate(self, a, b):
5241 """Returns a rotated copy of a, b times.
5242
5243 The coefficient of the result is a rotated copy of the digits in
5244 the coefficient of the first operand. The number of places of
5245 rotation is taken from the absolute value of the second operand,
5246 with the rotation being to the left if the second operand is
5247 positive or to the right otherwise.
5248
5249 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005250 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005251 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005252 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005253 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005254 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005255 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005256 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005257 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005258 Decimal('345678912')
Mark Dickinson84230a12010-02-18 14:49:50 +00005259 >>> ExtendedContext.rotate(1333333, 1)
5260 Decimal('13333330')
5261 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5262 Decimal('13333330')
5263 >>> ExtendedContext.rotate(1333333, Decimal(1))
5264 Decimal('13333330')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005265 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005266 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005267 return a.rotate(b, context=self)
5268
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005269 def same_quantum(self, a, b):
5270 """Returns True if the two operands have the same exponent.
5271
5272 The result is never affected by either the sign or the coefficient of
5273 either operand.
5274
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005275 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005276 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005277 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005278 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005279 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005280 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005281 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005282 True
Mark Dickinson84230a12010-02-18 14:49:50 +00005283 >>> ExtendedContext.same_quantum(10000, -1)
5284 True
5285 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5286 True
5287 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5288 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005289 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005290 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005291 return a.same_quantum(b)
5292
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005293 def scaleb (self, a, b):
5294 """Returns the first operand after adding the second value its exp.
5295
5296 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005297 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005298 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005299 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005300 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005301 Decimal('7.50E+3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005302 >>> ExtendedContext.scaleb(1, 4)
5303 Decimal('1E+4')
5304 >>> ExtendedContext.scaleb(Decimal(1), 4)
5305 Decimal('1E+4')
5306 >>> ExtendedContext.scaleb(1, Decimal(4))
5307 Decimal('1E+4')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005308 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005309 a = _convert_other(a, raiseit=True)
5310 return a.scaleb(b, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005311
5312 def shift(self, a, b):
5313 """Returns a shifted copy of a, b times.
5314
5315 The coefficient of the result is a shifted copy of the digits
5316 in the coefficient of the first operand. The number of places
5317 to shift is taken from the absolute value of the second operand,
5318 with the shift being to the left if the second operand is
5319 positive or to the right otherwise. Digits shifted into the
5320 coefficient are zeros.
5321
5322 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005323 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005324 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005325 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005326 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005327 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005328 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005329 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005330 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005331 Decimal('345678900')
Mark Dickinson84230a12010-02-18 14:49:50 +00005332 >>> ExtendedContext.shift(88888888, 2)
5333 Decimal('888888800')
5334 >>> ExtendedContext.shift(Decimal(88888888), 2)
5335 Decimal('888888800')
5336 >>> ExtendedContext.shift(88888888, Decimal(2))
5337 Decimal('888888800')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005338 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005339 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005340 return a.shift(b, context=self)
5341
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005342 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005343 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005344
5345 If the result must be inexact, it is rounded using the round-half-even
5346 algorithm.
5347
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005348 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005349 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005350 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005351 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005352 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005353 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005354 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005355 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005356 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005357 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005358 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005359 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005360 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005361 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005362 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005363 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005364 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005365 Decimal('3.16227766')
Mark Dickinson84230a12010-02-18 14:49:50 +00005366 >>> ExtendedContext.sqrt(2)
5367 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005368 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005369 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005370 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005371 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005372 return a.sqrt(context=self)
5373
5374 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005375 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005376
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005377 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005378 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005379 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005380 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005381 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005382 Decimal('-0.77')
Mark Dickinson84230a12010-02-18 14:49:50 +00005383 >>> ExtendedContext.subtract(8, 5)
5384 Decimal('3')
5385 >>> ExtendedContext.subtract(Decimal(8), 5)
5386 Decimal('3')
5387 >>> ExtendedContext.subtract(8, Decimal(5))
5388 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005389 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005390 a = _convert_other(a, raiseit=True)
5391 r = a.__sub__(b, context=self)
5392 if r is NotImplemented:
5393 raise TypeError("Unable to convert %s to Decimal" % b)
5394 else:
5395 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005396
5397 def to_eng_string(self, a):
5398 """Converts a number to a string, using scientific notation.
5399
5400 The operation is not affected by the context.
5401 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005402 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005403 return a.to_eng_string(context=self)
5404
5405 def to_sci_string(self, a):
5406 """Converts a number to a string, using scientific notation.
5407
5408 The operation is not affected by the context.
5409 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005410 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005411 return a.__str__(context=self)
5412
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005413 def to_integral_exact(self, a):
5414 """Rounds to an integer.
5415
5416 When the operand has a negative exponent, the result is the same
5417 as using the quantize() operation using the given operand as the
5418 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5419 of the operand as the precision setting; Inexact and Rounded flags
5420 are allowed in this operation. The rounding mode is taken from the
5421 context.
5422
5423 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005424 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005425 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005426 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005427 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005428 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005429 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005430 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005431 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005432 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005433 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005434 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005435 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005436 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005437 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005438 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005439 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005440 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005441 return a.to_integral_exact(context=self)
5442
5443 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005444 """Rounds to an integer.
5445
5446 When the operand has a negative exponent, the result is the same
5447 as using the quantize() operation using the given operand as the
5448 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5449 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00005450 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005451
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005452 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005453 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005454 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005455 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005456 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005457 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005458 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005459 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005460 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005461 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005462 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005463 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005464 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005465 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005466 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005467 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005468 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005469 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005470 return a.to_integral_value(context=self)
5471
5472 # the method name changed, but we provide also the old one, for compatibility
5473 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005474
5475class _WorkRep(object):
5476 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005477 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005478 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005479 # exp: None, int, or string
5480
5481 def __init__(self, value=None):
5482 if value is None:
5483 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005484 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005485 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005486 elif isinstance(value, Decimal):
5487 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005488 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005489 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005490 else:
5491 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005492 self.sign = value[0]
5493 self.int = value[1]
5494 self.exp = value[2]
5495
5496 def __repr__(self):
5497 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5498
5499 __str__ = __repr__
5500
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005501
5502
Christian Heimes2c181612007-12-17 20:04:13 +00005503def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005504 """Normalizes op1, op2 to have the same exp and length of coefficient.
5505
5506 Done during addition.
5507 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005508 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005509 tmp = op2
5510 other = op1
5511 else:
5512 tmp = op1
5513 other = op2
5514
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005515 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5516 # Then adding 10**exp to tmp has the same effect (after rounding)
5517 # as adding any positive quantity smaller than 10**exp; similarly
5518 # for subtraction. So if other is smaller than 10**exp we replace
5519 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00005520 tmp_len = len(str(tmp.int))
5521 other_len = len(str(other.int))
5522 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5523 if other_len + other.exp - 1 < exp:
5524 other.int = 1
5525 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005526
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005527 tmp.int *= 10 ** (tmp.exp - other.exp)
5528 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005529 return op1, op2
5530
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005531##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005532
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005533# This function from Tim Peters was taken from here:
5534# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5535# The correction being in the function definition is for speed, and
5536# the whole function is not resolved with math.log because of avoiding
5537# the use of floats.
5538def _nbits(n, correction = {
5539 '0': 4, '1': 3, '2': 2, '3': 2,
5540 '4': 1, '5': 1, '6': 1, '7': 1,
5541 '8': 0, '9': 0, 'a': 0, 'b': 0,
5542 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5543 """Number of bits in binary representation of the positive integer n,
5544 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005545 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005546 if n < 0:
5547 raise ValueError("The argument to _nbits should be nonnegative.")
5548 hex_n = "%x" % n
5549 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005550
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005551def _sqrt_nearest(n, a):
5552 """Closest integer to the square root of the positive integer n. a is
5553 an initial approximation to the square root. Any positive integer
5554 will do for a, but the closer a is to the square root of n the
5555 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005556
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005557 """
5558 if n <= 0 or a <= 0:
5559 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5560
5561 b=0
5562 while a != b:
5563 b, a = a, a--n//a>>1
5564 return a
5565
5566def _rshift_nearest(x, shift):
5567 """Given an integer x and a nonnegative integer shift, return closest
5568 integer to x / 2**shift; use round-to-even in case of a tie.
5569
5570 """
5571 b, q = 1 << shift, x >> shift
5572 return q + (2*(x & (b-1)) + (q&1) > b)
5573
5574def _div_nearest(a, b):
5575 """Closest integer to a/b, a and b positive integers; rounds to even
5576 in the case of a tie.
5577
5578 """
5579 q, r = divmod(a, b)
5580 return q + (2*r + (q&1) > b)
5581
5582def _ilog(x, M, L = 8):
5583 """Integer approximation to M*log(x/M), with absolute error boundable
5584 in terms only of x/M.
5585
5586 Given positive integers x and M, return an integer approximation to
5587 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5588 between the approximation and the exact result is at most 22. For
5589 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5590 both cases these are upper bounds on the error; it will usually be
5591 much smaller."""
5592
5593 # The basic algorithm is the following: let log1p be the function
5594 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5595 # the reduction
5596 #
5597 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5598 #
5599 # repeatedly until the argument to log1p is small (< 2**-L in
5600 # absolute value). For small y we can use the Taylor series
5601 # expansion
5602 #
5603 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5604 #
5605 # truncating at T such that y**T is small enough. The whole
5606 # computation is carried out in a form of fixed-point arithmetic,
5607 # with a real number z being represented by an integer
5608 # approximation to z*M. To avoid loss of precision, the y below
5609 # is actually an integer approximation to 2**R*y*M, where R is the
5610 # number of reductions performed so far.
5611
5612 y = x-M
5613 # argument reduction; R = number of reductions performed
5614 R = 0
5615 while (R <= L and abs(y) << L-R >= M or
5616 R > L and abs(y) >> R-L >= M):
5617 y = _div_nearest((M*y) << 1,
5618 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5619 R += 1
5620
5621 # Taylor series with T terms
5622 T = -int(-10*len(str(M))//(3*L))
5623 yshift = _rshift_nearest(y, R)
5624 w = _div_nearest(M, T)
5625 for k in range(T-1, 0, -1):
5626 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5627
5628 return _div_nearest(w*y, M)
5629
5630def _dlog10(c, e, p):
5631 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5632 approximation to 10**p * log10(c*10**e), with an absolute error of
5633 at most 1. Assumes that c*10**e is not exactly 1."""
5634
5635 # increase precision by 2; compensate for this by dividing
5636 # final result by 100
5637 p += 2
5638
5639 # write c*10**e as d*10**f with either:
5640 # f >= 0 and 1 <= d <= 10, or
5641 # f <= 0 and 0.1 <= d <= 1.
5642 # Thus for c*10**e close to 1, f = 0
5643 l = len(str(c))
5644 f = e+l - (e+l >= 1)
5645
5646 if p > 0:
5647 M = 10**p
5648 k = e+p-f
5649 if k >= 0:
5650 c *= 10**k
5651 else:
5652 c = _div_nearest(c, 10**-k)
5653
5654 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005655 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005656 log_d = _div_nearest(log_d*M, log_10)
5657 log_tenpower = f*M # exact
5658 else:
5659 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005660 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005661
5662 return _div_nearest(log_tenpower+log_d, 100)
5663
5664def _dlog(c, e, p):
5665 """Given integers c, e and p with c > 0, compute an integer
5666 approximation to 10**p * log(c*10**e), with an absolute error of
5667 at most 1. Assumes that c*10**e is not exactly 1."""
5668
5669 # Increase precision by 2. The precision increase is compensated
5670 # for at the end with a division by 100.
5671 p += 2
5672
5673 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5674 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5675 # as 10**p * log(d) + 10**p*f * log(10).
5676 l = len(str(c))
5677 f = e+l - (e+l >= 1)
5678
5679 # compute approximation to 10**p*log(d), with error < 27
5680 if p > 0:
5681 k = e+p-f
5682 if k >= 0:
5683 c *= 10**k
5684 else:
5685 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5686
5687 # _ilog magnifies existing error in c by a factor of at most 10
5688 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5689 else:
5690 # p <= 0: just approximate the whole thing by 0; error < 2.31
5691 log_d = 0
5692
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005693 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005694 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005695 extra = len(str(abs(f)))-1
5696 if p + extra >= 0:
5697 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5698 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5699 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005700 else:
5701 f_log_ten = 0
5702 else:
5703 f_log_ten = 0
5704
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005705 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005706 return _div_nearest(f_log_ten + log_d, 100)
5707
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005708class _Log10Memoize(object):
5709 """Class to compute, store, and allow retrieval of, digits of the
5710 constant log(10) = 2.302585.... This constant is needed by
5711 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5712 def __init__(self):
5713 self.digits = "23025850929940456840179914546843642076011014886"
5714
5715 def getdigits(self, p):
5716 """Given an integer p >= 0, return floor(10**p)*log(10).
5717
5718 For example, self.getdigits(3) returns 2302.
5719 """
5720 # digits are stored as a string, for quick conversion to
5721 # integer in the case that we've already computed enough
5722 # digits; the stored digits should always be correct
5723 # (truncated, not rounded to nearest).
5724 if p < 0:
5725 raise ValueError("p should be nonnegative")
5726
5727 if p >= len(self.digits):
5728 # compute p+3, p+6, p+9, ... digits; continue until at
5729 # least one of the extra digits is nonzero
5730 extra = 3
5731 while True:
5732 # compute p+extra digits, correct to within 1ulp
5733 M = 10**(p+extra+2)
5734 digits = str(_div_nearest(_ilog(10*M, M), 100))
5735 if digits[-extra:] != '0'*extra:
5736 break
5737 extra += 3
5738 # keep all reliable digits so far; remove trailing zeros
5739 # and next nonzero digit
5740 self.digits = digits.rstrip('0')[:-1]
5741 return int(self.digits[:p+1])
5742
5743_log10_digits = _Log10Memoize().getdigits
5744
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005745def _iexp(x, M, L=8):
5746 """Given integers x and M, M > 0, such that x/M is small in absolute
5747 value, compute an integer approximation to M*exp(x/M). For 0 <=
5748 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5749 is usually much smaller)."""
5750
5751 # Algorithm: to compute exp(z) for a real number z, first divide z
5752 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5753 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5754 # series
5755 #
5756 # expm1(x) = x + x**2/2! + x**3/3! + ...
5757 #
5758 # Now use the identity
5759 #
5760 # expm1(2x) = expm1(x)*(expm1(x)+2)
5761 #
5762 # R times to compute the sequence expm1(z/2**R),
5763 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5764
5765 # Find R such that x/2**R/M <= 2**-L
5766 R = _nbits((x<<L)//M)
5767
5768 # Taylor series. (2**L)**T > M
5769 T = -int(-10*len(str(M))//(3*L))
5770 y = _div_nearest(x, T)
5771 Mshift = M<<R
5772 for i in range(T-1, 0, -1):
5773 y = _div_nearest(x*(Mshift + y), Mshift * i)
5774
5775 # Expansion
5776 for k in range(R-1, -1, -1):
5777 Mshift = M<<(k+2)
5778 y = _div_nearest(y*(y+Mshift), Mshift)
5779
5780 return M+y
5781
5782def _dexp(c, e, p):
5783 """Compute an approximation to exp(c*10**e), with p decimal places of
5784 precision.
5785
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005786 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005787
5788 10**(p-1) <= d <= 10**p, and
5789 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5790
5791 In other words, d*10**f is an approximation to exp(c*10**e) with p
5792 digits of precision, and with an error in d of at most 1. This is
5793 almost, but not quite, the same as the error being < 1ulp: when d
5794 = 10**(p-1) the error could be up to 10 ulp."""
5795
5796 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5797 p += 2
5798
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005799 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005800 extra = max(0, e + len(str(c)) - 1)
5801 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005802
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005803 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005804 # rounding down
5805 shift = e+q
5806 if shift >= 0:
5807 cshift = c*10**shift
5808 else:
5809 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005810 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005811
5812 # reduce remainder back to original precision
5813 rem = _div_nearest(rem, 10**extra)
5814
5815 # error in result of _iexp < 120; error after division < 0.62
5816 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5817
5818def _dpower(xc, xe, yc, ye, p):
5819 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5820 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5821
5822 10**(p-1) <= c <= 10**p, and
5823 (c-1)*10**e < x**y < (c+1)*10**e
5824
5825 in other words, c*10**e is an approximation to x**y with p digits
5826 of precision, and with an error in c of at most 1. (This is
5827 almost, but not quite, the same as the error being < 1ulp: when c
5828 == 10**(p-1) we can only guarantee error < 10ulp.)
5829
5830 We assume that: x is positive and not equal to 1, and y is nonzero.
5831 """
5832
5833 # Find b such that 10**(b-1) <= |y| <= 10**b
5834 b = len(str(abs(yc))) + ye
5835
5836 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5837 lxc = _dlog(xc, xe, p+b+1)
5838
5839 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5840 shift = ye-b
5841 if shift >= 0:
5842 pc = lxc*yc*10**shift
5843 else:
5844 pc = _div_nearest(lxc*yc, 10**-shift)
5845
5846 if pc == 0:
5847 # we prefer a result that isn't exactly 1; this makes it
5848 # easier to compute a correctly rounded result in __pow__
5849 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5850 coeff, exp = 10**(p-1)+1, 1-p
5851 else:
5852 coeff, exp = 10**p-1, -p
5853 else:
5854 coeff, exp = _dexp(pc, -(p+1), p+1)
5855 coeff = _div_nearest(coeff, 10)
5856 exp += 1
5857
5858 return coeff, exp
5859
5860def _log10_lb(c, correction = {
5861 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5862 '6': 23, '7': 16, '8': 10, '9': 5}):
5863 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5864 if c <= 0:
5865 raise ValueError("The argument to _log10_lb should be nonnegative.")
5866 str_c = str(c)
5867 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005868
Guido van Rossumd8faa362007-04-27 19:54:29 +00005869##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005870
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005871def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005872 """Convert other to Decimal.
5873
5874 Verifies that it's ok to use in an implicit construction.
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005875 If allow_float is true, allow conversion from float; this
5876 is used in the comparison methods (__eq__ and friends).
5877
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005878 """
5879 if isinstance(other, Decimal):
5880 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005881 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005882 return Decimal(other)
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005883 if allow_float and isinstance(other, float):
5884 return Decimal.from_float(other)
5885
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005886 if raiseit:
5887 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005888 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005889
Guido van Rossumd8faa362007-04-27 19:54:29 +00005890##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005891
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005892# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005893# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005894
5895DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005896 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005897 traps=[DivisionByZero, Overflow, InvalidOperation],
5898 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005899 Emax=999999999,
5900 Emin=-999999999,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00005901 capitals=1,
5902 clamp=0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005903)
5904
5905# Pre-made alternate contexts offered by the specification
5906# Don't change these; the user should be able to select these
5907# contexts and be able to reproduce results from other implementations
5908# of the spec.
5909
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005910BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005911 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005912 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5913 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005914)
5915
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005916ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005917 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005918 traps=[],
5919 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005920)
5921
5922
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005923##### crud for parsing strings #############################################
Christian Heimes23daade2008-02-25 12:39:23 +00005924#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005925# Regular expression used for parsing numeric strings. Additional
5926# comments:
5927#
5928# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5929# whitespace. But note that the specification disallows whitespace in
5930# a numeric string.
5931#
5932# 2. For finite numbers (not infinities and NaNs) the body of the
5933# number between the optional sign and the optional exponent must have
5934# at least one decimal digit, possibly after the decimal point. The
Mark Dickinson345adc42009-08-02 10:14:23 +00005935# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005936
5937import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005938_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005939# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005940 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005941 (
Mark Dickinson345adc42009-08-02 10:14:23 +00005942 (?=\d|\.\d) # ...a number (with at least one digit)
5943 (?P<int>\d*) # having a (possibly empty) integer part
5944 (\.(?P<frac>\d*))? # followed by an optional fractional part
5945 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005946 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005947 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005948 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005949 (?P<signal>s)? # ...an (optionally signaling)
5950 NaN # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +00005951 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005952 )
5953# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005954 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005955""", re.VERBOSE | re.IGNORECASE).match
5956
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005957_all_zeros = re.compile('0*$').match
5958_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005959
5960##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005961# The functions in this section have little to do with the Decimal
5962# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005963# Python numeric classes that want to implement __format__
5964#
5965# A format specifier for Decimal looks like:
5966#
Mark Dickinson79f52032009-03-17 23:12:51 +00005967# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005968
5969_parse_format_specifier_regex = re.compile(r"""\A
5970(?:
5971 (?P<fill>.)?
5972 (?P<align>[<>=^])
5973)?
5974(?P<sign>[-+ ])?
5975(?P<zeropad>0)?
5976(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00005977(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005978(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00005979(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005980\Z
5981""", re.VERBOSE)
5982
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005983del re
5984
Mark Dickinson79f52032009-03-17 23:12:51 +00005985# The locale module is only needed for the 'n' format specifier. The
5986# rest of the PEP 3101 code functions quite happily without it, so we
5987# don't care too much if locale isn't present.
5988try:
5989 import locale as _locale
5990except ImportError:
5991 pass
5992
5993def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00005994 """Parse and validate a format specifier.
5995
5996 Turns a standard numeric format specifier into a dict, with the
5997 following entries:
5998
5999 fill: fill character to pad field to minimum width
6000 align: alignment type, either '<', '>', '=' or '^'
6001 sign: either '+', '-' or ' '
6002 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00006003 zeropad: boolean, indicating whether to pad with zeros
6004 thousands_sep: string to use as thousands separator, or ''
6005 grouping: grouping for thousands separators, in format
6006 used by localeconv
6007 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00006008 precision: nonnegative integer giving precision, or None
6009 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00006010
6011 """
6012 m = _parse_format_specifier_regex.match(format_spec)
6013 if m is None:
6014 raise ValueError("Invalid format specifier: " + format_spec)
6015
6016 # get the dictionary
6017 format_dict = m.groupdict()
6018
Mark Dickinson79f52032009-03-17 23:12:51 +00006019 # zeropad; defaults for fill and alignment. If zero padding
6020 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00006021 fill = format_dict['fill']
6022 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00006023 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
6024 if format_dict['zeropad']:
6025 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006026 raise ValueError("Fill character conflicts with '0'"
6027 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00006028 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006029 raise ValueError("Alignment conflicts with '0' in "
6030 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00006031 format_dict['fill'] = fill or ' '
Mark Dickinson46ab5d02009-09-08 20:22:46 +00006032 # PEP 3101 originally specified that the default alignment should
6033 # be left; it was later agreed that right-aligned makes more sense
6034 # for numeric types. See http://bugs.python.org/issue6857.
6035 format_dict['align'] = align or '>'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006036
Mark Dickinson79f52032009-03-17 23:12:51 +00006037 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00006038 if format_dict['sign'] is None:
6039 format_dict['sign'] = '-'
6040
Christian Heimesf16baeb2008-02-29 14:57:44 +00006041 # minimumwidth defaults to 0; precision remains None if not given
6042 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
6043 if format_dict['precision'] is not None:
6044 format_dict['precision'] = int(format_dict['precision'])
6045
6046 # if format type is 'g' or 'G' then a precision of 0 makes little
6047 # sense; convert it to 1. Same if format type is unspecified.
6048 if format_dict['precision'] == 0:
Mark Dickinson7718d2b2009-09-07 16:21:56 +00006049 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006050 format_dict['precision'] = 1
6051
Mark Dickinson79f52032009-03-17 23:12:51 +00006052 # determine thousands separator, grouping, and decimal separator, and
6053 # add appropriate entries to format_dict
6054 if format_dict['type'] == 'n':
6055 # apart from separators, 'n' behaves just like 'g'
6056 format_dict['type'] = 'g'
6057 if _localeconv is None:
6058 _localeconv = _locale.localeconv()
6059 if format_dict['thousands_sep'] is not None:
6060 raise ValueError("Explicit thousands separator conflicts with "
6061 "'n' type in format specifier: " + format_spec)
6062 format_dict['thousands_sep'] = _localeconv['thousands_sep']
6063 format_dict['grouping'] = _localeconv['grouping']
6064 format_dict['decimal_point'] = _localeconv['decimal_point']
6065 else:
6066 if format_dict['thousands_sep'] is None:
6067 format_dict['thousands_sep'] = ''
6068 format_dict['grouping'] = [3, 0]
6069 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006070
6071 return format_dict
6072
Mark Dickinson79f52032009-03-17 23:12:51 +00006073def _format_align(sign, body, spec):
6074 """Given an unpadded, non-aligned numeric string 'body' and sign
6075 string 'sign', add padding and aligment conforming to the given
6076 format specifier dictionary 'spec' (as produced by
6077 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00006078
6079 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00006080 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00006081 minimumwidth = spec['minimumwidth']
6082 fill = spec['fill']
6083 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00006084
Mark Dickinson79f52032009-03-17 23:12:51 +00006085 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00006086 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006087 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00006088 elif align == '>':
6089 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00006090 elif align == '=':
6091 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00006092 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006093 half = len(padding)//2
6094 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00006095 else:
6096 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00006097
Christian Heimesf16baeb2008-02-29 14:57:44 +00006098 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00006099
Mark Dickinson79f52032009-03-17 23:12:51 +00006100def _group_lengths(grouping):
6101 """Convert a localeconv-style grouping into a (possibly infinite)
6102 iterable of integers representing group lengths.
6103
6104 """
6105 # The result from localeconv()['grouping'], and the input to this
6106 # function, should be a list of integers in one of the
6107 # following three forms:
6108 #
6109 # (1) an empty list, or
6110 # (2) nonempty list of positive integers + [0]
6111 # (3) list of positive integers + [locale.CHAR_MAX], or
6112
6113 from itertools import chain, repeat
6114 if not grouping:
6115 return []
6116 elif grouping[-1] == 0 and len(grouping) >= 2:
6117 return chain(grouping[:-1], repeat(grouping[-2]))
6118 elif grouping[-1] == _locale.CHAR_MAX:
6119 return grouping[:-1]
6120 else:
6121 raise ValueError('unrecognised format for grouping')
6122
6123def _insert_thousands_sep(digits, spec, min_width=1):
6124 """Insert thousands separators into a digit string.
6125
6126 spec is a dictionary whose keys should include 'thousands_sep' and
6127 'grouping'; typically it's the result of parsing the format
6128 specifier using _parse_format_specifier.
6129
6130 The min_width keyword argument gives the minimum length of the
6131 result, which will be padded on the left with zeros if necessary.
6132
6133 If necessary, the zero padding adds an extra '0' on the left to
6134 avoid a leading thousands separator. For example, inserting
6135 commas every three digits in '123456', with min_width=8, gives
6136 '0,123,456', even though that has length 9.
6137
6138 """
6139
6140 sep = spec['thousands_sep']
6141 grouping = spec['grouping']
6142
6143 groups = []
6144 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00006145 if l <= 0:
6146 raise ValueError("group length should be positive")
6147 # max(..., 1) forces at least 1 digit to the left of a separator
6148 l = min(max(len(digits), min_width, 1), l)
6149 groups.append('0'*(l - len(digits)) + digits[-l:])
6150 digits = digits[:-l]
6151 min_width -= l
6152 if not digits and min_width <= 0:
6153 break
Mark Dickinson7303b592009-03-18 08:25:36 +00006154 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00006155 else:
6156 l = max(len(digits), min_width, 1)
6157 groups.append('0'*(l - len(digits)) + digits[-l:])
6158 return sep.join(reversed(groups))
6159
6160def _format_sign(is_negative, spec):
6161 """Determine sign character."""
6162
6163 if is_negative:
6164 return '-'
6165 elif spec['sign'] in ' +':
6166 return spec['sign']
6167 else:
6168 return ''
6169
6170def _format_number(is_negative, intpart, fracpart, exp, spec):
6171 """Format a number, given the following data:
6172
6173 is_negative: true if the number is negative, else false
6174 intpart: string of digits that must appear before the decimal point
6175 fracpart: string of digits that must come after the point
6176 exp: exponent, as an integer
6177 spec: dictionary resulting from parsing the format specifier
6178
6179 This function uses the information in spec to:
6180 insert separators (decimal separator and thousands separators)
6181 format the sign
6182 format the exponent
6183 add trailing '%' for the '%' type
6184 zero-pad if necessary
6185 fill and align if necessary
6186 """
6187
6188 sign = _format_sign(is_negative, spec)
6189
6190 if fracpart:
6191 fracpart = spec['decimal_point'] + fracpart
6192
6193 if exp != 0 or spec['type'] in 'eE':
6194 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6195 fracpart += "{0}{1:+}".format(echar, exp)
6196 if spec['type'] == '%':
6197 fracpart += '%'
6198
6199 if spec['zeropad']:
6200 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6201 else:
6202 min_width = 0
6203 intpart = _insert_thousands_sep(intpart, spec, min_width)
6204
6205 return _format_align(sign, intpart+fracpart, spec)
6206
6207
Guido van Rossumd8faa362007-04-27 19:54:29 +00006208##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006209
Guido van Rossumd8faa362007-04-27 19:54:29 +00006210# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006211_Infinity = Decimal('Inf')
6212_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00006213_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006214_Zero = Decimal(0)
6215_One = Decimal(1)
6216_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006217
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006218# _SignedInfinity[sign] is infinity w/ that sign
6219_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006220
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006221
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006222
6223if __name__ == '__main__':
6224 import doctest, sys
6225 doctest.testmod(sys.modules[__name__])