blob: c61b549c483d8a6031e1f82491ae85a35a2a5c31 [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 Krah395653e2010-05-19 15:54:54 +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 Dickinson8d238292009-08-02 10:16:33 +0000557 fracpart = m.group('frac') or ''
Christian Heimesd59c64c2007-11-30 19:27:20 +0000558 exp = int(m.group('exp') or '0')
Mark Dickinson8d238292009-08-02 10:16:33 +0000559 self._int = str(int(intpart+fracpart))
560 self._exp = exp - len(fracpart)
Christian Heimesd59c64c2007-11-30 19:27:20 +0000561 self._is_special = False
562 else:
563 diag = m.group('diag')
564 if diag is not None:
565 # NaN
Mark Dickinson8d238292009-08-02 10:16:33 +0000566 self._int = str(int(diag or '0')).lstrip('0')
Christian Heimesd59c64c2007-11-30 19:27:20 +0000567 if m.group('signal'):
568 self._exp = 'N'
569 else:
570 self._exp = 'n'
571 else:
572 # infinity
573 self._int = '0'
574 self._exp = 'F'
575 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000576 return self
577
578 # From an integer
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000579 if isinstance(value, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000580 if value >= 0:
581 self._sign = 0
582 else:
583 self._sign = 1
584 self._exp = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000585 self._int = str(abs(value))
Christian Heimesd59c64c2007-11-30 19:27:20 +0000586 self._is_special = False
587 return self
588
589 # From another decimal
590 if isinstance(value, Decimal):
591 self._exp = value._exp
592 self._sign = value._sign
593 self._int = value._int
594 self._is_special = value._is_special
595 return self
596
597 # From an internal working value
598 if isinstance(value, _WorkRep):
599 self._sign = value.sign
600 self._int = str(value.int)
601 self._exp = int(value.exp)
602 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000603 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000604
605 # tuple/list conversion (possibly from as_tuple())
606 if isinstance(value, (list,tuple)):
607 if len(value) != 3:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000608 raise ValueError('Invalid tuple size in creation of Decimal '
609 'from list or tuple. The list or tuple '
610 'should have exactly three elements.')
611 # process sign. The isinstance test rejects floats
612 if not (isinstance(value[0], int) and value[0] in (0,1)):
613 raise ValueError("Invalid sign. The first value in the tuple "
614 "should be an integer; either 0 for a "
615 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000616 self._sign = value[0]
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000617 if value[2] == 'F':
618 # infinity: value[1] is ignored
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000619 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000620 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000621 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000622 else:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000623 # process and validate the digits in value[1]
624 digits = []
625 for digit in value[1]:
626 if isinstance(digit, int) and 0 <= digit <= 9:
627 # skip leading zeros
628 if digits or digit != 0:
629 digits.append(digit)
630 else:
631 raise ValueError("The second value in the tuple must "
632 "be composed of integers in the range "
633 "0 through 9.")
634 if value[2] in ('n', 'N'):
635 # NaN: digits form the diagnostic
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000636 self._int = ''.join(map(str, digits))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000637 self._exp = value[2]
638 self._is_special = True
639 elif isinstance(value[2], int):
640 # finite number: digits give the coefficient
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000641 self._int = ''.join(map(str, digits or [0]))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000642 self._exp = value[2]
643 self._is_special = False
644 else:
645 raise ValueError("The third value in the tuple must "
646 "be an integer, or one of the "
647 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000648 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000649
Raymond Hettingerbf440692004-07-10 14:14:37 +0000650 if isinstance(value, float):
Benjamin Peterson23b9ef72010-02-03 02:43:37 +0000651 raise TypeError("Cannot convert float in Decimal constructor. "
652 "Use from_float class method.")
Raymond Hettingerbf440692004-07-10 14:14:37 +0000653
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000654 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000655
Mark Dickinsonba298e42009-01-04 21:17:43 +0000656 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
657 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000658 def from_float(cls, f):
659 """Converts a float to a decimal number, exactly.
660
661 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
662 Since 0.1 is not exactly representable in binary floating point, the
663 value is stored as the nearest representable value which is
664 0x1.999999999999ap-4. The exact equivalent of the value in decimal
665 is 0.1000000000000000055511151231257827021181583404541015625.
666
667 >>> Decimal.from_float(0.1)
668 Decimal('0.1000000000000000055511151231257827021181583404541015625')
669 >>> Decimal.from_float(float('nan'))
670 Decimal('NaN')
671 >>> Decimal.from_float(float('inf'))
672 Decimal('Infinity')
673 >>> Decimal.from_float(-float('inf'))
674 Decimal('-Infinity')
675 >>> Decimal.from_float(-0.0)
676 Decimal('-0')
677
678 """
679 if isinstance(f, int): # handle integer inputs
680 return cls(f)
681 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
682 return cls(repr(f))
Mark Dickinsonba298e42009-01-04 21:17:43 +0000683 if _math.copysign(1.0, f) == 1.0:
684 sign = 0
685 else:
686 sign = 1
Raymond Hettinger771ed762009-01-03 19:20:32 +0000687 n, d = abs(f).as_integer_ratio()
688 k = d.bit_length() - 1
689 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinsonba298e42009-01-04 21:17:43 +0000690 if cls is Decimal:
691 return result
692 else:
693 return cls(result)
694 from_float = classmethod(from_float)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000695
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000696 def _isnan(self):
697 """Returns whether the number is not actually one.
698
699 0 if a number
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000700 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000701 2 if sNaN
702 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000703 if self._is_special:
704 exp = self._exp
705 if exp == 'n':
706 return 1
707 elif exp == 'N':
708 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000709 return 0
710
711 def _isinfinity(self):
712 """Returns whether the number is infinite
713
714 0 if finite or not a number
715 1 if +INF
716 -1 if -INF
717 """
718 if self._exp == 'F':
719 if self._sign:
720 return -1
721 return 1
722 return 0
723
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000724 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000725 """Returns whether the number is not actually one.
726
727 if self, other are sNaN, signal
728 if self, other are NaN return nan
729 return 0
730
731 Done before operations.
732 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000733
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000734 self_is_nan = self._isnan()
735 if other is None:
736 other_is_nan = False
737 else:
738 other_is_nan = other._isnan()
739
740 if self_is_nan or other_is_nan:
741 if context is None:
742 context = getcontext()
743
744 if self_is_nan == 2:
745 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000746 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000747 if other_is_nan == 2:
748 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000749 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000750 if self_is_nan:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000751 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000752
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000753 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000754 return 0
755
Christian Heimes77c02eb2008-02-09 02:18:51 +0000756 def _compare_check_nans(self, other, context):
757 """Version of _check_nans used for the signaling comparisons
758 compare_signal, __le__, __lt__, __ge__, __gt__.
759
760 Signal InvalidOperation if either self or other is a (quiet
761 or signaling) NaN. Signaling NaNs take precedence over quiet
762 NaNs.
763
764 Return 0 if neither operand is a NaN.
765
766 """
767 if context is None:
768 context = getcontext()
769
770 if self._is_special or other._is_special:
771 if self.is_snan():
772 return context._raise_error(InvalidOperation,
773 'comparison involving sNaN',
774 self)
775 elif other.is_snan():
776 return context._raise_error(InvalidOperation,
777 'comparison involving sNaN',
778 other)
779 elif self.is_qnan():
780 return context._raise_error(InvalidOperation,
781 'comparison involving NaN',
782 self)
783 elif other.is_qnan():
784 return context._raise_error(InvalidOperation,
785 'comparison involving NaN',
786 other)
787 return 0
788
Jack Diederich4dafcc42006-11-28 19:15:13 +0000789 def __bool__(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000790 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000791
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000792 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000793 """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000794 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000795
Christian Heimes77c02eb2008-02-09 02:18:51 +0000796 def _cmp(self, other):
797 """Compare the two non-NaN decimal instances self and other.
798
799 Returns -1 if self < other, 0 if self == other and 1
800 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000801
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000802 if self._is_special or other._is_special:
Mark Dickinsone6aad752009-01-25 10:48:51 +0000803 self_inf = self._isinfinity()
804 other_inf = other._isinfinity()
805 if self_inf == other_inf:
806 return 0
807 elif self_inf < other_inf:
808 return -1
809 else:
810 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000811
Mark Dickinsone6aad752009-01-25 10:48:51 +0000812 # check for zeros; Decimal('0') == Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000813 if not self:
814 if not other:
815 return 0
816 else:
817 return -((-1)**other._sign)
818 if not other:
819 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000820
Guido van Rossumd8faa362007-04-27 19:54:29 +0000821 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000822 if other._sign < self._sign:
823 return -1
824 if self._sign < other._sign:
825 return 1
826
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000827 self_adjusted = self.adjusted()
828 other_adjusted = other.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000829 if self_adjusted == other_adjusted:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000830 self_padded = self._int + '0'*(self._exp - other._exp)
831 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone6aad752009-01-25 10:48:51 +0000832 if self_padded == other_padded:
833 return 0
834 elif self_padded < other_padded:
835 return -(-1)**self._sign
836 else:
837 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000838 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000839 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000840 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000841 return -((-1)**self._sign)
842
Christian Heimes77c02eb2008-02-09 02:18:51 +0000843 # Note: The Decimal standard doesn't cover rich comparisons for
844 # Decimals. In particular, the specification is silent on the
845 # subject of what should happen for a comparison involving a NaN.
846 # We take the following approach:
847 #
848 # == comparisons involving a NaN always return False
849 # != comparisons involving a NaN always return True
850 # <, >, <= and >= comparisons involving a (quiet or signaling)
851 # NaN signal InvalidOperation, and return False if the
Christian Heimes3feef612008-02-11 06:19:17 +0000852 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000853 #
854 # This behavior is designed to conform as closely as possible to
855 # that specified by IEEE 754.
856
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000857 def __eq__(self, other):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000858 other = _convert_other(other)
859 if other is NotImplemented:
860 return other
861 if self.is_nan() or other.is_nan():
862 return False
863 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000864
865 def __ne__(self, other):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000866 other = _convert_other(other)
867 if other is NotImplemented:
868 return other
869 if self.is_nan() or other.is_nan():
870 return True
871 return self._cmp(other) != 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000872
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000873
Christian Heimes77c02eb2008-02-09 02:18:51 +0000874 def __lt__(self, other, context=None):
875 other = _convert_other(other)
876 if other is NotImplemented:
877 return other
878 ans = self._compare_check_nans(other, context)
879 if ans:
880 return False
881 return self._cmp(other) < 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000882
Christian Heimes77c02eb2008-02-09 02:18:51 +0000883 def __le__(self, other, context=None):
884 other = _convert_other(other)
885 if other is NotImplemented:
886 return other
887 ans = self._compare_check_nans(other, context)
888 if ans:
889 return False
890 return self._cmp(other) <= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000891
Christian Heimes77c02eb2008-02-09 02:18:51 +0000892 def __gt__(self, other, context=None):
893 other = _convert_other(other)
894 if other is NotImplemented:
895 return other
896 ans = self._compare_check_nans(other, context)
897 if ans:
898 return False
899 return self._cmp(other) > 0
900
901 def __ge__(self, other, context=None):
902 other = _convert_other(other)
903 if other is NotImplemented:
904 return other
905 ans = self._compare_check_nans(other, context)
906 if ans:
907 return False
908 return self._cmp(other) >= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000909
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000910 def compare(self, other, context=None):
911 """Compares one to another.
912
913 -1 => a < b
914 0 => a = b
915 1 => a > b
916 NaN => one is NaN
917 Like __cmp__, but returns Decimal instances.
918 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000919 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000920
Guido van Rossumd8faa362007-04-27 19:54:29 +0000921 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000922 if (self._is_special or other and other._is_special):
923 ans = self._check_nans(other, context)
924 if ans:
925 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000926
Christian Heimes77c02eb2008-02-09 02:18:51 +0000927 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000928
929 def __hash__(self):
930 """x.__hash__() <==> hash(x)"""
931 # Decimal integers must hash the same as the ints
Christian Heimes2380ac72008-01-09 00:17:24 +0000932 #
933 # The hash of a nonspecial noninteger Decimal must depend only
934 # on the value of that Decimal, and not on its representation.
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000935 # For example: hash(Decimal('100E-1')) == hash(Decimal('10')).
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000936 if self._is_special:
937 if self._isnan():
938 raise TypeError('Cannot hash a NaN value.')
939 return hash(str(self))
Thomas Wouters8ce81f72007-09-20 18:22:40 +0000940 if not self:
941 return 0
942 if self._isinteger():
943 op = _WorkRep(self.to_integral_value())
944 # to make computation feasible for Decimals with large
945 # exponent, we use the fact that hash(n) == hash(m) for
946 # any two nonzero integers n and m such that (i) n and m
947 # have the same sign, and (ii) n is congruent to m modulo
948 # 2**64-1. So we can replace hash((-1)**s*c*10**e) with
949 # hash((-1)**s*c*pow(10, e, 2**64-1).
950 return hash((-1)**op.sign*op.int*pow(10, op.exp, 2**64-1))
Christian Heimes2380ac72008-01-09 00:17:24 +0000951 # The value of a nonzero nonspecial Decimal instance is
952 # faithfully represented by the triple consisting of its sign,
953 # its adjusted exponent, and its coefficient with trailing
954 # zeros removed.
955 return hash((self._sign,
956 self._exp+len(self._int),
957 self._int.rstrip('0')))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000958
959 def as_tuple(self):
960 """Represents the number as a triple tuple.
961
962 To show the internals exactly as they are.
963 """
Christian Heimes25bb7832008-01-11 16:17:00 +0000964 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000965
966 def __repr__(self):
967 """Represents the number as an instance of Decimal."""
968 # Invariant: eval(repr(d)) == d
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000969 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000970
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000971 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000972 """Return string representation of the number in scientific notation.
973
974 Captures all of the information in the underlying representation.
975 """
976
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000977 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000978 if self._is_special:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000979 if self._exp == 'F':
980 return sign + 'Infinity'
981 elif self._exp == 'n':
982 return sign + 'NaN' + self._int
983 else: # self._exp == 'N'
984 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000985
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000986 # number of digits of self._int to left of decimal point
987 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000988
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000989 # dotplace is number of digits of self._int to the left of the
990 # decimal point in the mantissa of the output string (that is,
991 # after adjusting the exponent)
992 if self._exp <= 0 and leftdigits > -6:
993 # no exponent required
994 dotplace = leftdigits
995 elif not eng:
996 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000997 dotplace = 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000998 elif self._int == '0':
999 # engineering notation, zero
1000 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001001 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001002 # engineering notation, nonzero
1003 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001004
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001005 if dotplace <= 0:
1006 intpart = '0'
1007 fracpart = '.' + '0'*(-dotplace) + self._int
1008 elif dotplace >= len(self._int):
1009 intpart = self._int+'0'*(dotplace-len(self._int))
1010 fracpart = ''
1011 else:
1012 intpart = self._int[:dotplace]
1013 fracpart = '.' + self._int[dotplace:]
1014 if leftdigits == dotplace:
1015 exp = ''
1016 else:
1017 if context is None:
1018 context = getcontext()
1019 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1020
1021 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001022
1023 def to_eng_string(self, context=None):
1024 """Convert to engineering-type string.
1025
1026 Engineering notation has an exponent which is a multiple of 3, so there
1027 are up to 3 digits left of the decimal place.
1028
1029 Same rules for when in exponential and when as a value as in __str__.
1030 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001031 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001032
1033 def __neg__(self, context=None):
1034 """Returns a copy with the sign switched.
1035
1036 Rounds, if it has reason.
1037 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001038 if self._is_special:
1039 ans = self._check_nans(context=context)
1040 if ans:
1041 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001042
1043 if not self:
1044 # -Decimal('0') is Decimal('0'), not Decimal('-0')
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001045 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001046 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001047 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001048
1049 if context is None:
1050 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001051 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001052
1053 def __pos__(self, context=None):
1054 """Returns a copy, unless it is a sNaN.
1055
1056 Rounds the number (if more then precision digits)
1057 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001058 if self._is_special:
1059 ans = self._check_nans(context=context)
1060 if ans:
1061 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001062
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001063 if not self:
1064 # + (-0) = 0
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001065 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001066 else:
1067 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001068
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001069 if context is None:
1070 context = getcontext()
Christian Heimes2c181612007-12-17 20:04:13 +00001071 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001072
Christian Heimes2c181612007-12-17 20:04:13 +00001073 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001074 """Returns the absolute value of self.
1075
Christian Heimes2c181612007-12-17 20:04:13 +00001076 If the keyword argument 'round' is false, do not round. The
1077 expression self.__abs__(round=False) is equivalent to
1078 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001079 """
Christian Heimes2c181612007-12-17 20:04:13 +00001080 if not round:
1081 return self.copy_abs()
1082
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001083 if self._is_special:
1084 ans = self._check_nans(context=context)
1085 if ans:
1086 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001087
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001088 if self._sign:
1089 ans = self.__neg__(context=context)
1090 else:
1091 ans = self.__pos__(context=context)
1092
1093 return ans
1094
1095 def __add__(self, other, context=None):
1096 """Returns self + other.
1097
1098 -INF + INF (or the reverse) cause InvalidOperation errors.
1099 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001100 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001101 if other is NotImplemented:
1102 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001103
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001104 if context is None:
1105 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001106
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001107 if self._is_special or other._is_special:
1108 ans = self._check_nans(other, context)
1109 if ans:
1110 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001111
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001112 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001113 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001114 if self._sign != other._sign and other._isinfinity():
1115 return context._raise_error(InvalidOperation, '-INF + INF')
1116 return Decimal(self)
1117 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001118 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001119
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001120 exp = min(self._exp, other._exp)
1121 negativezero = 0
1122 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001123 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001124 negativezero = 1
1125
1126 if not self and not other:
1127 sign = min(self._sign, other._sign)
1128 if negativezero:
1129 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001130 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001131 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001132 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001133 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001134 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001135 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001136 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001137 return ans
1138 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001139 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001140 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001141 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001142 return ans
1143
1144 op1 = _WorkRep(self)
1145 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001146 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001147
1148 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001149 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001150 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001151 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001152 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001153 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001154 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001155 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001156 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001157 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001158 if op1.sign == 1:
1159 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001160 op1.sign, op2.sign = op2.sign, op1.sign
1161 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001162 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001163 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001164 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001165 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001166 op1.sign, op2.sign = (0, 0)
1167 else:
1168 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001169 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001170
Raymond Hettinger17931de2004-10-27 06:21:46 +00001171 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001172 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001173 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001174 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001175
1176 result.exp = op1.exp
1177 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001178 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001179 return ans
1180
1181 __radd__ = __add__
1182
1183 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001184 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001185 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001186 if other is NotImplemented:
1187 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001188
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001189 if self._is_special or other._is_special:
1190 ans = self._check_nans(other, context=context)
1191 if ans:
1192 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001193
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001194 # self - other is computed as self + other.copy_negate()
1195 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001196
1197 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001198 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001199 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001200 if other is NotImplemented:
1201 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001202
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001203 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001205 def __mul__(self, other, context=None):
1206 """Return self * other.
1207
1208 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1209 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001210 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001211 if other is NotImplemented:
1212 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001213
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001214 if context is None:
1215 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001216
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001217 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001218
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001219 if self._is_special or other._is_special:
1220 ans = self._check_nans(other, context)
1221 if ans:
1222 return ans
1223
1224 if self._isinfinity():
1225 if not other:
1226 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001227 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001228
1229 if other._isinfinity():
1230 if not self:
1231 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001232 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001233
1234 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001235
1236 # Special case for multiplying by zero
1237 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001238 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001239 # Fixing in case the exponent is out of bounds
1240 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001241 return ans
1242
1243 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001244 if self._int == '1':
1245 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001246 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001247 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001248 if other._int == '1':
1249 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001250 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001251 return ans
1252
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001253 op1 = _WorkRep(self)
1254 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001255
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001256 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001257 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001258
1259 return ans
1260 __rmul__ = __mul__
1261
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001262 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001263 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001264 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001265 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001266 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001267
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001268 if context is None:
1269 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001270
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001271 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001272
1273 if self._is_special or other._is_special:
1274 ans = self._check_nans(other, context)
1275 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001276 return ans
1277
1278 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001279 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001280
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001281 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001282 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001283
1284 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001285 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001286 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001287
1288 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001289 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001290 if not self:
1291 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001292 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001293
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001294 if not self:
1295 exp = self._exp - other._exp
1296 coeff = 0
1297 else:
1298 # OK, so neither = 0, INF or NaN
1299 shift = len(other._int) - len(self._int) + context.prec + 1
1300 exp = self._exp - other._exp - shift
1301 op1 = _WorkRep(self)
1302 op2 = _WorkRep(other)
1303 if shift >= 0:
1304 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1305 else:
1306 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1307 if remainder:
1308 # result is not exact; adjust to ensure correct rounding
1309 if coeff % 5 == 0:
1310 coeff += 1
1311 else:
1312 # result is exact; get as close to ideal exponent as possible
1313 ideal_exp = self._exp - other._exp
1314 while exp < ideal_exp and coeff % 10 == 0:
1315 coeff //= 10
1316 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001317
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001318 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001319 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001320
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001321 def _divide(self, other, context):
1322 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001323
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001324 Assumes that neither self nor other is a NaN, that self is not
1325 infinite and that other is nonzero.
1326 """
1327 sign = self._sign ^ other._sign
1328 if other._isinfinity():
1329 ideal_exp = self._exp
1330 else:
1331 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001332
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001333 expdiff = self.adjusted() - other.adjusted()
1334 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001335 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001336 self._rescale(ideal_exp, context.rounding))
1337 if expdiff <= context.prec:
1338 op1 = _WorkRep(self)
1339 op2 = _WorkRep(other)
1340 if op1.exp >= op2.exp:
1341 op1.int *= 10**(op1.exp - op2.exp)
1342 else:
1343 op2.int *= 10**(op2.exp - op1.exp)
1344 q, r = divmod(op1.int, op2.int)
1345 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001346 return (_dec_from_triple(sign, str(q), 0),
1347 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001348
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001349 # Here the quotient is too large to be representable
1350 ans = context._raise_error(DivisionImpossible,
1351 'quotient too large in //, % or divmod')
1352 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001353
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001354 def __rtruediv__(self, other, context=None):
1355 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001356 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001357 if other is NotImplemented:
1358 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001359 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001360
1361 def __divmod__(self, other, context=None):
1362 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001363 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001364 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001365 other = _convert_other(other)
1366 if other is NotImplemented:
1367 return other
1368
1369 if context is None:
1370 context = getcontext()
1371
1372 ans = self._check_nans(other, context)
1373 if ans:
1374 return (ans, ans)
1375
1376 sign = self._sign ^ other._sign
1377 if self._isinfinity():
1378 if other._isinfinity():
1379 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1380 return ans, ans
1381 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001382 return (_SignedInfinity[sign],
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001383 context._raise_error(InvalidOperation, 'INF % x'))
1384
1385 if not other:
1386 if not self:
1387 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1388 return ans, ans
1389 else:
1390 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1391 context._raise_error(InvalidOperation, 'x % 0'))
1392
1393 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001394 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001395 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001396
1397 def __rdivmod__(self, other, context=None):
1398 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001399 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001400 if other is NotImplemented:
1401 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001402 return other.__divmod__(self, context=context)
1403
1404 def __mod__(self, other, context=None):
1405 """
1406 self % other
1407 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001408 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001409 if other is NotImplemented:
1410 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001411
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001412 if context is None:
1413 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001414
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001415 ans = self._check_nans(other, context)
1416 if ans:
1417 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001418
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001419 if self._isinfinity():
1420 return context._raise_error(InvalidOperation, 'INF % x')
1421 elif not other:
1422 if self:
1423 return context._raise_error(InvalidOperation, 'x % 0')
1424 else:
1425 return context._raise_error(DivisionUndefined, '0 % 0')
1426
1427 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001428 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001429 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001430
1431 def __rmod__(self, other, context=None):
1432 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001433 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001434 if other is NotImplemented:
1435 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001436 return other.__mod__(self, context=context)
1437
1438 def remainder_near(self, other, context=None):
1439 """
1440 Remainder nearest to 0- abs(remainder-near) <= other/2
1441 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001442 if context is None:
1443 context = getcontext()
1444
1445 other = _convert_other(other, raiseit=True)
1446
1447 ans = self._check_nans(other, context)
1448 if ans:
1449 return ans
1450
1451 # self == +/-infinity -> InvalidOperation
1452 if self._isinfinity():
1453 return context._raise_error(InvalidOperation,
1454 'remainder_near(infinity, x)')
1455
1456 # other == 0 -> either InvalidOperation or DivisionUndefined
1457 if not other:
1458 if self:
1459 return context._raise_error(InvalidOperation,
1460 'remainder_near(x, 0)')
1461 else:
1462 return context._raise_error(DivisionUndefined,
1463 'remainder_near(0, 0)')
1464
1465 # other = +/-infinity -> remainder = self
1466 if other._isinfinity():
1467 ans = Decimal(self)
1468 return ans._fix(context)
1469
1470 # self = 0 -> remainder = self, with ideal exponent
1471 ideal_exponent = min(self._exp, other._exp)
1472 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001473 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001474 return ans._fix(context)
1475
1476 # catch most cases of large or small quotient
1477 expdiff = self.adjusted() - other.adjusted()
1478 if expdiff >= context.prec + 1:
1479 # expdiff >= prec+1 => abs(self/other) > 10**prec
1480 return context._raise_error(DivisionImpossible)
1481 if expdiff <= -2:
1482 # expdiff <= -2 => abs(self/other) < 0.1
1483 ans = self._rescale(ideal_exponent, context.rounding)
1484 return ans._fix(context)
1485
1486 # adjust both arguments to have the same exponent, then divide
1487 op1 = _WorkRep(self)
1488 op2 = _WorkRep(other)
1489 if op1.exp >= op2.exp:
1490 op1.int *= 10**(op1.exp - op2.exp)
1491 else:
1492 op2.int *= 10**(op2.exp - op1.exp)
1493 q, r = divmod(op1.int, op2.int)
1494 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1495 # 10**ideal_exponent. Apply correction to ensure that
1496 # abs(remainder) <= abs(other)/2
1497 if 2*r + (q&1) > op2.int:
1498 r -= op2.int
1499 q += 1
1500
1501 if q >= 10**context.prec:
1502 return context._raise_error(DivisionImpossible)
1503
1504 # result has same sign as self unless r is negative
1505 sign = self._sign
1506 if r < 0:
1507 sign = 1-sign
1508 r = -r
1509
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001510 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001511 return ans._fix(context)
1512
1513 def __floordiv__(self, other, context=None):
1514 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001515 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001516 if other is NotImplemented:
1517 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001518
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001519 if context is None:
1520 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001521
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001522 ans = self._check_nans(other, context)
1523 if ans:
1524 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001525
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001526 if self._isinfinity():
1527 if other._isinfinity():
1528 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001529 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001530 return _SignedInfinity[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001531
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001532 if not other:
1533 if self:
1534 return context._raise_error(DivisionByZero, 'x // 0',
1535 self._sign ^ other._sign)
1536 else:
1537 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001538
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001539 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001540
1541 def __rfloordiv__(self, other, context=None):
1542 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001543 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001544 if other is NotImplemented:
1545 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001546 return other.__floordiv__(self, context=context)
1547
1548 def __float__(self):
1549 """Float representation."""
1550 return float(str(self))
1551
1552 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001553 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001554 if self._is_special:
1555 if self._isnan():
Mark Dickinson8fde3da2009-09-08 19:23:44 +00001556 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001557 elif self._isinfinity():
Mark Dickinson8fde3da2009-09-08 19:23:44 +00001558 raise OverflowError("Cannot convert infinity to integer")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001559 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001560 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001561 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001562 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001563 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001564
Christian Heimes969fe572008-01-25 11:23:10 +00001565 __trunc__ = __int__
1566
Christian Heimes0bd4e112008-02-12 22:59:25 +00001567 def real(self):
1568 return self
Mark Dickinson315a20a2009-01-04 21:34:18 +00001569 real = property(real)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001570
Christian Heimes0bd4e112008-02-12 22:59:25 +00001571 def imag(self):
1572 return Decimal(0)
Mark Dickinson315a20a2009-01-04 21:34:18 +00001573 imag = property(imag)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001574
1575 def conjugate(self):
1576 return self
1577
1578 def __complex__(self):
1579 return complex(float(self))
1580
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001581 def _fix_nan(self, context):
1582 """Decapitate the payload of a NaN to fit the context"""
1583 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001584
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001585 # maximum length of payload is precision if _clamp=0,
1586 # precision-1 if _clamp=1.
1587 max_payload_len = context.prec - context._clamp
1588 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001589 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1590 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001591 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001592
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001593 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001594 """Round if it is necessary to keep self within prec precision.
1595
1596 Rounds and fixes the exponent. Does not raise on a sNaN.
1597
1598 Arguments:
1599 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001600 context - context used.
1601 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001602
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001603 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001604 if self._isnan():
1605 # decapitate payload if necessary
1606 return self._fix_nan(context)
1607 else:
1608 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001609 return Decimal(self)
1610
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001611 # if self is zero then exponent should be between Etiny and
1612 # Emax if _clamp==0, and between Etiny and Etop if _clamp==1.
1613 Etiny = context.Etiny()
1614 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001615 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001616 exp_max = [context.Emax, Etop][context._clamp]
1617 new_exp = min(max(self._exp, Etiny), exp_max)
1618 if new_exp != self._exp:
1619 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001620 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001621 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001622 return Decimal(self)
1623
1624 # exp_min is the smallest allowable exponent of the result,
1625 # equal to max(self.adjusted()-context.prec+1, Etiny)
1626 exp_min = len(self._int) + self._exp - context.prec
1627 if exp_min > Etop:
1628 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinsonece06972010-05-04 14:37:14 +00001629 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001630 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001631 context._raise_error(Rounded)
Mark Dickinsonece06972010-05-04 14:37:14 +00001632 return ans
1633
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001634 self_is_subnormal = exp_min < Etiny
1635 if self_is_subnormal:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001636 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001637
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001638 # round if self has too many digits
1639 if self._exp < exp_min:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001640 digits = len(self._int) + self._exp - exp_min
1641 if digits < 0:
1642 self = _dec_from_triple(self._sign, '1', exp_min-1)
1643 digits = 0
Mark Dickinsonece06972010-05-04 14:37:14 +00001644 rounding_method = self._pick_rounding_function[context.rounding]
1645 changed = getattr(self, rounding_method)(digits)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001646 coeff = self._int[:digits] or '0'
Mark Dickinsonece06972010-05-04 14:37:14 +00001647 if changed > 0:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001648 coeff = str(int(coeff)+1)
Mark Dickinsonece06972010-05-04 14:37:14 +00001649 if len(coeff) > context.prec:
1650 coeff = coeff[:-1]
1651 exp_min += 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001652
Mark Dickinsonece06972010-05-04 14:37:14 +00001653 # check whether the rounding pushed the exponent out of range
1654 if exp_min > Etop:
1655 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1656 else:
1657 ans = _dec_from_triple(self._sign, coeff, exp_min)
1658
1659 # raise the appropriate signals, taking care to respect
1660 # the precedence described in the specification
1661 if changed and self_is_subnormal:
1662 context._raise_error(Underflow)
1663 if self_is_subnormal:
1664 context._raise_error(Subnormal)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001665 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001666 context._raise_error(Inexact)
Mark Dickinsonece06972010-05-04 14:37:14 +00001667 context._raise_error(Rounded)
1668 if not ans:
1669 # raise Clamped on underflow to 0
1670 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001671 return ans
1672
Mark Dickinsonece06972010-05-04 14:37:14 +00001673 if self_is_subnormal:
1674 context._raise_error(Subnormal)
1675
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001676 # fold down if _clamp == 1 and self has too few digits
1677 if context._clamp == 1 and self._exp > Etop:
1678 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001679 self_padded = self._int + '0'*(self._exp - Etop)
1680 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001681
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001682 # here self was representable to begin with; return unchanged
1683 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001684
1685 _pick_rounding_function = {}
1686
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001687 # for each of the rounding functions below:
1688 # self is a finite, nonzero Decimal
1689 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001690 #
1691 # each function returns either -1, 0, or 1, as follows:
1692 # 1 indicates that self should be rounded up (away from zero)
1693 # 0 indicates that self should be truncated, and that all the
1694 # digits to be truncated are zeros (so the value is unchanged)
1695 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001696
1697 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001698 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001699 if _all_zeros(self._int, prec):
1700 return 0
1701 else:
1702 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001703
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001704 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001705 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001706 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001707
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001708 def _round_half_up(self, prec):
1709 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001710 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001711 return 1
1712 elif _all_zeros(self._int, prec):
1713 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001714 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001715 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001716
1717 def _round_half_down(self, prec):
1718 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001719 if _exact_half(self._int, prec):
1720 return -1
1721 else:
1722 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001723
1724 def _round_half_even(self, prec):
1725 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001726 if _exact_half(self._int, prec) and \
1727 (prec == 0 or self._int[prec-1] in '02468'):
1728 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001729 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001730 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001731
1732 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001733 """Rounds up (not away from 0 if negative.)"""
1734 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001735 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001736 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001737 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001738
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001739 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001740 """Rounds down (not towards 0 if negative)"""
1741 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001742 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001743 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001744 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001745
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001746 def _round_05up(self, prec):
1747 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001748 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001749 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001750 else:
1751 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001752
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001753 def __round__(self, n=None):
1754 """Round self to the nearest integer, or to a given precision.
1755
1756 If only one argument is supplied, round a finite Decimal
1757 instance self to the nearest integer. If self is infinite or
1758 a NaN then a Python exception is raised. If self is finite
1759 and lies exactly halfway between two integers then it is
1760 rounded to the integer with even last digit.
1761
1762 >>> round(Decimal('123.456'))
1763 123
1764 >>> round(Decimal('-456.789'))
1765 -457
1766 >>> round(Decimal('-3.0'))
1767 -3
1768 >>> round(Decimal('2.5'))
1769 2
1770 >>> round(Decimal('3.5'))
1771 4
1772 >>> round(Decimal('Inf'))
1773 Traceback (most recent call last):
1774 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001775 OverflowError: cannot round an infinity
1776 >>> round(Decimal('NaN'))
1777 Traceback (most recent call last):
1778 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001779 ValueError: cannot round a NaN
1780
1781 If a second argument n is supplied, self is rounded to n
1782 decimal places using the rounding mode for the current
1783 context.
1784
1785 For an integer n, round(self, -n) is exactly equivalent to
1786 self.quantize(Decimal('1En')).
1787
1788 >>> round(Decimal('123.456'), 0)
1789 Decimal('123')
1790 >>> round(Decimal('123.456'), 2)
1791 Decimal('123.46')
1792 >>> round(Decimal('123.456'), -2)
1793 Decimal('1E+2')
1794 >>> round(Decimal('-Infinity'), 37)
1795 Decimal('NaN')
1796 >>> round(Decimal('sNaN123'), 0)
1797 Decimal('NaN123')
1798
1799 """
1800 if n is not None:
1801 # two-argument form: use the equivalent quantize call
1802 if not isinstance(n, int):
1803 raise TypeError('Second argument to round should be integral')
1804 exp = _dec_from_triple(0, '1', -n)
1805 return self.quantize(exp)
1806
1807 # one-argument form
1808 if self._is_special:
1809 if self.is_nan():
1810 raise ValueError("cannot round a NaN")
1811 else:
1812 raise OverflowError("cannot round an infinity")
1813 return int(self._rescale(0, ROUND_HALF_EVEN))
1814
1815 def __floor__(self):
1816 """Return the floor of self, as an integer.
1817
1818 For a finite Decimal instance self, return the greatest
1819 integer n such that n <= self. If self is infinite or a NaN
1820 then a Python exception is raised.
1821
1822 """
1823 if self._is_special:
1824 if self.is_nan():
1825 raise ValueError("cannot round a NaN")
1826 else:
1827 raise OverflowError("cannot round an infinity")
1828 return int(self._rescale(0, ROUND_FLOOR))
1829
1830 def __ceil__(self):
1831 """Return the ceiling of self, as an integer.
1832
1833 For a finite Decimal instance self, return the least integer n
1834 such that n >= self. If self is infinite or a NaN then a
1835 Python exception is raised.
1836
1837 """
1838 if self._is_special:
1839 if self.is_nan():
1840 raise ValueError("cannot round a NaN")
1841 else:
1842 raise OverflowError("cannot round an infinity")
1843 return int(self._rescale(0, ROUND_CEILING))
1844
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001845 def fma(self, other, third, context=None):
1846 """Fused multiply-add.
1847
1848 Returns self*other+third with no rounding of the intermediate
1849 product self*other.
1850
1851 self and other are multiplied together, with no rounding of
1852 the result. The third operand is then added to the result,
1853 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001854 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001855
1856 other = _convert_other(other, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001857
1858 # compute product; raise InvalidOperation if either operand is
1859 # a signaling NaN or if the product is zero times infinity.
1860 if self._is_special or other._is_special:
1861 if context is None:
1862 context = getcontext()
1863 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001864 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001865 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001866 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001867 if self._exp == 'n':
1868 product = self
1869 elif other._exp == 'n':
1870 product = other
1871 elif self._exp == 'F':
1872 if not other:
1873 return context._raise_error(InvalidOperation,
1874 'INF * 0 in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001875 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001876 elif other._exp == 'F':
1877 if not self:
1878 return context._raise_error(InvalidOperation,
1879 '0 * INF in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001880 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001881 else:
1882 product = _dec_from_triple(self._sign ^ other._sign,
1883 str(int(self._int) * int(other._int)),
1884 self._exp + other._exp)
1885
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001886 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001887 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001888
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001889 def _power_modulo(self, other, modulo, context=None):
1890 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001891
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001892 # if can't convert other and modulo to Decimal, raise
1893 # TypeError; there's no point returning NotImplemented (no
1894 # equivalent of __rpow__ for three argument pow)
1895 other = _convert_other(other, raiseit=True)
1896 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001897
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001898 if context is None:
1899 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001900
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001901 # deal with NaNs: if there are any sNaNs then first one wins,
1902 # (i.e. behaviour for NaNs is identical to that of fma)
1903 self_is_nan = self._isnan()
1904 other_is_nan = other._isnan()
1905 modulo_is_nan = modulo._isnan()
1906 if self_is_nan or other_is_nan or modulo_is_nan:
1907 if self_is_nan == 2:
1908 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001909 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001910 if other_is_nan == 2:
1911 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001912 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001913 if modulo_is_nan == 2:
1914 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001915 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001916 if self_is_nan:
1917 return self._fix_nan(context)
1918 if other_is_nan:
1919 return other._fix_nan(context)
1920 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001921
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001922 # check inputs: we apply same restrictions as Python's pow()
1923 if not (self._isinteger() and
1924 other._isinteger() and
1925 modulo._isinteger()):
1926 return context._raise_error(InvalidOperation,
1927 'pow() 3rd argument not allowed '
1928 'unless all arguments are integers')
1929 if other < 0:
1930 return context._raise_error(InvalidOperation,
1931 'pow() 2nd argument cannot be '
1932 'negative when 3rd argument specified')
1933 if not modulo:
1934 return context._raise_error(InvalidOperation,
1935 'pow() 3rd argument cannot be 0')
1936
1937 # additional restriction for decimal: the modulus must be less
1938 # than 10**prec in absolute value
1939 if modulo.adjusted() >= context.prec:
1940 return context._raise_error(InvalidOperation,
1941 'insufficient precision: pow() 3rd '
1942 'argument must not have more than '
1943 'precision digits')
1944
1945 # define 0**0 == NaN, for consistency with two-argument pow
1946 # (even though it hurts!)
1947 if not other and not self:
1948 return context._raise_error(InvalidOperation,
1949 'at least one of pow() 1st argument '
1950 'and 2nd argument must be nonzero ;'
1951 '0**0 is not defined')
1952
1953 # compute sign of result
1954 if other._iseven():
1955 sign = 0
1956 else:
1957 sign = self._sign
1958
1959 # convert modulo to a Python integer, and self and other to
1960 # Decimal integers (i.e. force their exponents to be >= 0)
1961 modulo = abs(int(modulo))
1962 base = _WorkRep(self.to_integral_value())
1963 exponent = _WorkRep(other.to_integral_value())
1964
1965 # compute result using integer pow()
1966 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1967 for i in range(exponent.exp):
1968 base = pow(base, 10, modulo)
1969 base = pow(base, exponent.int, modulo)
1970
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001971 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001972
1973 def _power_exact(self, other, p):
1974 """Attempt to compute self**other exactly.
1975
1976 Given Decimals self and other and an integer p, attempt to
1977 compute an exact result for the power self**other, with p
1978 digits of precision. Return None if self**other is not
1979 exactly representable in p digits.
1980
1981 Assumes that elimination of special cases has already been
1982 performed: self and other must both be nonspecial; self must
1983 be positive and not numerically equal to 1; other must be
1984 nonzero. For efficiency, other._exp should not be too large,
1985 so that 10**abs(other._exp) is a feasible calculation."""
1986
1987 # In the comments below, we write x for the value of self and
1988 # y for the value of other. Write x = xc*10**xe and y =
1989 # yc*10**ye.
1990
1991 # The main purpose of this method is to identify the *failure*
1992 # of x**y to be exactly representable with as little effort as
1993 # possible. So we look for cheap and easy tests that
1994 # eliminate the possibility of x**y being exact. Only if all
1995 # these tests are passed do we go on to actually compute x**y.
1996
1997 # Here's the main idea. First normalize both x and y. We
1998 # express y as a rational m/n, with m and n relatively prime
1999 # and n>0. Then for x**y to be exactly representable (at
2000 # *any* precision), xc must be the nth power of a positive
2001 # integer and xe must be divisible by n. If m is negative
2002 # then additionally xc must be a power of either 2 or 5, hence
2003 # a power of 2**n or 5**n.
2004 #
2005 # There's a limit to how small |y| can be: if y=m/n as above
2006 # then:
2007 #
2008 # (1) if xc != 1 then for the result to be representable we
2009 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
2010 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
2011 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
2012 # representable.
2013 #
2014 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
2015 # |y| < 1/|xe| then the result is not representable.
2016 #
2017 # Note that since x is not equal to 1, at least one of (1) and
2018 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
2019 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
2020 #
2021 # There's also a limit to how large y can be, at least if it's
2022 # positive: the normalized result will have coefficient xc**y,
2023 # so if it's representable then xc**y < 10**p, and y <
2024 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
2025 # not exactly representable.
2026
2027 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
2028 # so |y| < 1/xe and the result is not representable.
2029 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
2030 # < 1/nbits(xc).
2031
2032 x = _WorkRep(self)
2033 xc, xe = x.int, x.exp
2034 while xc % 10 == 0:
2035 xc //= 10
2036 xe += 1
2037
2038 y = _WorkRep(other)
2039 yc, ye = y.int, y.exp
2040 while yc % 10 == 0:
2041 yc //= 10
2042 ye += 1
2043
2044 # case where xc == 1: result is 10**(xe*y), with xe*y
2045 # required to be an integer
2046 if xc == 1:
Mark Dickinson0390f502010-07-08 19:21:59 +00002047 xe *= yc
2048 # result is now 10**(xe * 10**ye); xe * 10**ye must be integral
2049 while xe % 10 == 0:
2050 xe //= 10
2051 ye += 1
2052 if ye < 0:
2053 return None
2054 exponent = xe * 10**ye
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002055 if y.sign == 1:
2056 exponent = -exponent
2057 # if other is a nonnegative integer, use ideal exponent
2058 if other._isinteger() and other._sign == 0:
2059 ideal_exponent = self._exp*int(other)
2060 zeros = min(exponent-ideal_exponent, p-1)
2061 else:
2062 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002063 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002064
2065 # case where y is negative: xc must be either a power
2066 # of 2 or a power of 5.
2067 if y.sign == 1:
2068 last_digit = xc % 10
2069 if last_digit in (2,4,6,8):
2070 # quick test for power of 2
2071 if xc & -xc != xc:
2072 return None
2073 # now xc is a power of 2; e is its exponent
2074 e = _nbits(xc)-1
2075 # find e*y and xe*y; both must be integers
2076 if ye >= 0:
2077 y_as_int = yc*10**ye
2078 e = e*y_as_int
2079 xe = xe*y_as_int
2080 else:
2081 ten_pow = 10**-ye
2082 e, remainder = divmod(e*yc, ten_pow)
2083 if remainder:
2084 return None
2085 xe, remainder = divmod(xe*yc, ten_pow)
2086 if remainder:
2087 return None
2088
2089 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2090 return None
2091 xc = 5**e
2092
2093 elif last_digit == 5:
2094 # e >= log_5(xc) if xc is a power of 5; we have
2095 # equality all the way up to xc=5**2658
2096 e = _nbits(xc)*28//65
2097 xc, remainder = divmod(5**e, xc)
2098 if remainder:
2099 return None
2100 while xc % 5 == 0:
2101 xc //= 5
2102 e -= 1
2103 if ye >= 0:
2104 y_as_integer = yc*10**ye
2105 e = e*y_as_integer
2106 xe = xe*y_as_integer
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 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2116 return None
2117 xc = 2**e
2118 else:
2119 return None
2120
2121 if xc >= 10**p:
2122 return None
2123 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002124 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002125
2126 # now y is positive; find m and n such that y = m/n
2127 if ye >= 0:
2128 m, n = yc*10**ye, 1
2129 else:
2130 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2131 return None
2132 xc_bits = _nbits(xc)
2133 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2134 return None
2135 m, n = yc, 10**(-ye)
2136 while m % 2 == n % 2 == 0:
2137 m //= 2
2138 n //= 2
2139 while m % 5 == n % 5 == 0:
2140 m //= 5
2141 n //= 5
2142
2143 # compute nth root of xc*10**xe
2144 if n > 1:
2145 # if 1 < xc < 2**n then xc isn't an nth power
2146 if xc != 1 and xc_bits <= n:
2147 return None
2148
2149 xe, rem = divmod(xe, n)
2150 if rem != 0:
2151 return None
2152
2153 # compute nth root of xc using Newton's method
2154 a = 1 << -(-_nbits(xc)//n) # initial estimate
2155 while True:
2156 q, r = divmod(xc, a**(n-1))
2157 if a <= q:
2158 break
2159 else:
2160 a = (a*(n-1) + q)//n
2161 if not (a == q and r == 0):
2162 return None
2163 xc = a
2164
2165 # now xc*10**xe is the nth root of the original xc*10**xe
2166 # compute mth power of xc*10**xe
2167
2168 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2169 # 10**p and the result is not representable.
2170 if xc > 1 and m > p*100//_log10_lb(xc):
2171 return None
2172 xc = xc**m
2173 xe *= m
2174 if xc > 10**p:
2175 return None
2176
2177 # by this point the result *is* exactly representable
2178 # adjust the exponent to get as close as possible to the ideal
2179 # exponent, if necessary
2180 str_xc = str(xc)
2181 if other._isinteger() and other._sign == 0:
2182 ideal_exponent = self._exp*int(other)
2183 zeros = min(xe-ideal_exponent, p-len(str_xc))
2184 else:
2185 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002186 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002187
2188 def __pow__(self, other, modulo=None, context=None):
2189 """Return self ** other [ % modulo].
2190
2191 With two arguments, compute self**other.
2192
2193 With three arguments, compute (self**other) % modulo. For the
2194 three argument form, the following restrictions on the
2195 arguments hold:
2196
2197 - all three arguments must be integral
2198 - other must be nonnegative
2199 - either self or other (or both) must be nonzero
2200 - modulo must be nonzero and must have at most p digits,
2201 where p is the context precision.
2202
2203 If any of these restrictions is violated the InvalidOperation
2204 flag is raised.
2205
2206 The result of pow(self, other, modulo) is identical to the
2207 result that would be obtained by computing (self**other) %
2208 modulo with unbounded precision, but is computed more
2209 efficiently. It is always exact.
2210 """
2211
2212 if modulo is not None:
2213 return self._power_modulo(other, modulo, context)
2214
2215 other = _convert_other(other)
2216 if other is NotImplemented:
2217 return other
2218
2219 if context is None:
2220 context = getcontext()
2221
2222 # either argument is a NaN => result is NaN
2223 ans = self._check_nans(other, context)
2224 if ans:
2225 return ans
2226
2227 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2228 if not other:
2229 if not self:
2230 return context._raise_error(InvalidOperation, '0 ** 0')
2231 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002232 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002233
2234 # result has sign 1 iff self._sign is 1 and other is an odd integer
2235 result_sign = 0
2236 if self._sign == 1:
2237 if other._isinteger():
2238 if not other._iseven():
2239 result_sign = 1
2240 else:
2241 # -ve**noninteger = NaN
2242 # (-0)**noninteger = 0**noninteger
2243 if self:
2244 return context._raise_error(InvalidOperation,
2245 'x ** y with x negative and y not an integer')
2246 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002247 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002248
2249 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2250 if not self:
2251 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002252 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002253 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002254 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002255
2256 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002257 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002258 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002259 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002260 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002261 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002262
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002263 # 1**other = 1, but the choice of exponent and the flags
2264 # depend on the exponent of self, and on whether other is a
2265 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002266 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002267 if other._isinteger():
2268 # exp = max(self._exp*max(int(other), 0),
2269 # 1-context.prec) but evaluating int(other) directly
2270 # is dangerous until we know other is small (other
2271 # could be 1e999999999)
2272 if other._sign == 1:
2273 multiplier = 0
2274 elif other > context.prec:
2275 multiplier = context.prec
2276 else:
2277 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002278
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002279 exp = self._exp * multiplier
2280 if exp < 1-context.prec:
2281 exp = 1-context.prec
2282 context._raise_error(Rounded)
2283 else:
2284 context._raise_error(Inexact)
2285 context._raise_error(Rounded)
2286 exp = 1-context.prec
2287
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002288 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002289
2290 # compute adjusted exponent of self
2291 self_adj = self.adjusted()
2292
2293 # self ** infinity is infinity if self > 1, 0 if self < 1
2294 # self ** -infinity is infinity if self < 1, 0 if self > 1
2295 if other._isinfinity():
2296 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002297 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002298 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002299 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002300
2301 # from here on, the result always goes through the call
2302 # to _fix at the end of this function.
2303 ans = None
Mark Dickinsonece06972010-05-04 14:37:14 +00002304 exact = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002305
2306 # crude test to catch cases of extreme overflow/underflow. If
2307 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2308 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2309 # self**other >= 10**(Emax+1), so overflow occurs. The test
2310 # for underflow is similar.
2311 bound = self._log10_exp_bound() + other.adjusted()
2312 if (self_adj >= 0) == (other._sign == 0):
2313 # self > 1 and other +ve, or self < 1 and other -ve
2314 # possibility of overflow
2315 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002316 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002317 else:
2318 # self > 1 and other -ve, or self < 1 and other +ve
2319 # possibility of underflow to 0
2320 Etiny = context.Etiny()
2321 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002322 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002323
2324 # try for an exact result with precision +1
2325 if ans is None:
2326 ans = self._power_exact(other, context.prec + 1)
Mark Dickinson0390f502010-07-08 19:21:59 +00002327 if ans is not None:
2328 if result_sign == 1:
2329 ans = _dec_from_triple(1, ans._int, ans._exp)
2330 exact = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002331
2332 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2333 if ans is None:
2334 p = context.prec
2335 x = _WorkRep(self)
2336 xc, xe = x.int, x.exp
2337 y = _WorkRep(other)
2338 yc, ye = y.int, y.exp
2339 if y.sign == 1:
2340 yc = -yc
2341
2342 # compute correctly rounded result: start with precision +3,
2343 # then increase precision until result is unambiguously roundable
2344 extra = 3
2345 while True:
2346 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2347 if coeff % (5*10**(len(str(coeff))-p-1)):
2348 break
2349 extra += 3
2350
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002351 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002352
Mark Dickinsonece06972010-05-04 14:37:14 +00002353 # unlike exp, ln and log10, the power function respects the
2354 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2355
2356 # There's a difficulty here when 'other' is not an integer and
2357 # the result is exact. In this case, the specification
2358 # requires that the Inexact flag be raised (in spite of
2359 # exactness), but since the result is exact _fix won't do this
2360 # for us. (Correspondingly, the Underflow signal should also
2361 # be raised for subnormal results.) We can't directly raise
2362 # these signals either before or after calling _fix, since
2363 # that would violate the precedence for signals. So we wrap
2364 # the ._fix call in a temporary context, and reraise
2365 # afterwards.
2366 if exact and not other._isinteger():
2367 # pad with zeros up to length context.prec+1 if necessary; this
2368 # ensures that the Rounded signal will be raised.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002369 if len(ans._int) <= context.prec:
Mark Dickinsonece06972010-05-04 14:37:14 +00002370 expdiff = context.prec + 1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002371 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2372 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002373
Mark Dickinsonece06972010-05-04 14:37:14 +00002374 # create a copy of the current context, with cleared flags/traps
2375 newcontext = context.copy()
2376 newcontext.clear_flags()
2377 for exception in _signals:
2378 newcontext.traps[exception] = 0
2379
2380 # round in the new context
2381 ans = ans._fix(newcontext)
2382
2383 # raise Inexact, and if necessary, Underflow
2384 newcontext._raise_error(Inexact)
2385 if newcontext.flags[Subnormal]:
2386 newcontext._raise_error(Underflow)
2387
2388 # propagate signals to the original context; _fix could
2389 # have raised any of Overflow, Underflow, Subnormal,
2390 # Inexact, Rounded, Clamped. Overflow needs the correct
2391 # arguments. Note that the order of the exceptions is
2392 # important here.
2393 if newcontext.flags[Overflow]:
2394 context._raise_error(Overflow, 'above Emax', ans._sign)
2395 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2396 if newcontext.flags[exception]:
2397 context._raise_error(exception)
2398
2399 else:
2400 ans = ans._fix(context)
2401
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002402 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002403
2404 def __rpow__(self, other, context=None):
2405 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002406 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002407 if other is NotImplemented:
2408 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002409 return other.__pow__(self, context=context)
2410
2411 def normalize(self, context=None):
2412 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002413
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002414 if context is None:
2415 context = getcontext()
2416
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002417 if self._is_special:
2418 ans = self._check_nans(context=context)
2419 if ans:
2420 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002421
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002422 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002423 if dup._isinfinity():
2424 return dup
2425
2426 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002427 return _dec_from_triple(dup._sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002428 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002429 end = len(dup._int)
2430 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002431 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002432 exp += 1
2433 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002434 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002435
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002436 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002437 """Quantize self so its exponent is the same as that of exp.
2438
2439 Similar to self._rescale(exp._exp) but with error checking.
2440 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002441 exp = _convert_other(exp, raiseit=True)
2442
2443 if context is None:
2444 context = getcontext()
2445 if rounding is None:
2446 rounding = context.rounding
2447
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002448 if self._is_special or exp._is_special:
2449 ans = self._check_nans(exp, context)
2450 if ans:
2451 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002452
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002453 if exp._isinfinity() or self._isinfinity():
2454 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002455 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002456 return context._raise_error(InvalidOperation,
2457 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002458
2459 # if we're not watching exponents, do a simple rescale
2460 if not watchexp:
2461 ans = self._rescale(exp._exp, rounding)
2462 # raise Inexact and Rounded where appropriate
2463 if ans._exp > self._exp:
2464 context._raise_error(Rounded)
2465 if ans != self:
2466 context._raise_error(Inexact)
2467 return ans
2468
2469 # exp._exp should be between Etiny and Emax
2470 if not (context.Etiny() <= exp._exp <= context.Emax):
2471 return context._raise_error(InvalidOperation,
2472 'target exponent out of bounds in quantize')
2473
2474 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002475 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002476 return ans._fix(context)
2477
2478 self_adjusted = self.adjusted()
2479 if self_adjusted > context.Emax:
2480 return context._raise_error(InvalidOperation,
2481 'exponent of quantize result too large for current context')
2482 if self_adjusted - exp._exp + 1 > context.prec:
2483 return context._raise_error(InvalidOperation,
2484 'quantize result has too many digits for current context')
2485
2486 ans = self._rescale(exp._exp, rounding)
2487 if ans.adjusted() > context.Emax:
2488 return context._raise_error(InvalidOperation,
2489 'exponent of quantize result too large for current context')
2490 if len(ans._int) > context.prec:
2491 return context._raise_error(InvalidOperation,
2492 'quantize result has too many digits for current context')
2493
2494 # raise appropriate flags
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002495 if ans and ans.adjusted() < context.Emin:
2496 context._raise_error(Subnormal)
Mark Dickinsonece06972010-05-04 14:37:14 +00002497 if ans._exp > self._exp:
2498 if ans != self:
2499 context._raise_error(Inexact)
2500 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002501
Mark Dickinsonece06972010-05-04 14:37:14 +00002502 # call to fix takes care of any necessary folddown, and
2503 # signals Clamped if necessary
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002504 ans = ans._fix(context)
2505 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002506
2507 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002508 """Return True if self and other have the same exponent; otherwise
2509 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002510
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002511 If either operand is a special value, the following rules are used:
2512 * return True if both operands are infinities
2513 * return True if both operands are NaNs
2514 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002515 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002516 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002517 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002518 return (self.is_nan() and other.is_nan() or
2519 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002520 return self._exp == other._exp
2521
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002522 def _rescale(self, exp, rounding):
2523 """Rescale self so that the exponent is exp, either by padding with zeros
2524 or by truncating digits, using the given rounding mode.
2525
2526 Specials are returned without change. This operation is
2527 quiet: it raises no flags, and uses no information from the
2528 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002529
2530 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002531 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002532 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002533 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002534 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002535 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002536 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002537
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002538 if self._exp >= exp:
2539 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002540 return _dec_from_triple(self._sign,
2541 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002542
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002543 # too many digits; round and lose data. If self.adjusted() <
2544 # exp-1, replace self by 10**(exp-1) before rounding
2545 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002546 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002547 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002548 digits = 0
2549 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002550 changed = this_function(digits)
2551 coeff = self._int[:digits] or '0'
2552 if changed == 1:
2553 coeff = str(int(coeff)+1)
2554 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002555
Christian Heimesf16baeb2008-02-29 14:57:44 +00002556 def _round(self, places, rounding):
2557 """Round a nonzero, nonspecial Decimal to a fixed number of
2558 significant figures, using the given rounding mode.
2559
2560 Infinities, NaNs and zeros are returned unaltered.
2561
2562 This operation is quiet: it raises no flags, and uses no
2563 information from the context.
2564
2565 """
2566 if places <= 0:
2567 raise ValueError("argument should be at least 1 in _round")
2568 if self._is_special or not self:
2569 return Decimal(self)
2570 ans = self._rescale(self.adjusted()+1-places, rounding)
2571 # it can happen that the rescale alters the adjusted exponent;
2572 # for example when rounding 99.97 to 3 significant figures.
2573 # When this happens we end up with an extra 0 at the end of
2574 # the number; a second rescale fixes this.
2575 if ans.adjusted() != self.adjusted():
2576 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2577 return ans
2578
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002579 def to_integral_exact(self, rounding=None, context=None):
2580 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002581
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002582 If no rounding mode is specified, take the rounding mode from
2583 the context. This method raises the Rounded and Inexact flags
2584 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002585
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002586 See also: to_integral_value, which does exactly the same as
2587 this method except that it doesn't raise Inexact or Rounded.
2588 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002589 if self._is_special:
2590 ans = self._check_nans(context=context)
2591 if ans:
2592 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002593 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002594 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002595 return Decimal(self)
2596 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002597 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002598 if context is None:
2599 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002600 if rounding is None:
2601 rounding = context.rounding
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002602 ans = self._rescale(0, rounding)
2603 if ans != self:
2604 context._raise_error(Inexact)
Mark Dickinsonece06972010-05-04 14:37:14 +00002605 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002606 return ans
2607
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002608 def to_integral_value(self, rounding=None, context=None):
2609 """Rounds to the nearest integer, without raising inexact, rounded."""
2610 if context is None:
2611 context = getcontext()
2612 if rounding is None:
2613 rounding = context.rounding
2614 if self._is_special:
2615 ans = self._check_nans(context=context)
2616 if ans:
2617 return ans
2618 return Decimal(self)
2619 if self._exp >= 0:
2620 return Decimal(self)
2621 else:
2622 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002623
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002624 # the method name changed, but we provide also the old one, for compatibility
2625 to_integral = to_integral_value
2626
2627 def sqrt(self, context=None):
2628 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002629 if context is None:
2630 context = getcontext()
2631
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002632 if self._is_special:
2633 ans = self._check_nans(context=context)
2634 if ans:
2635 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002636
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002637 if self._isinfinity() and self._sign == 0:
2638 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002639
2640 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002641 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002642 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002643 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002644
2645 if self._sign == 1:
2646 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2647
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002648 # At this point self represents a positive number. Let p be
2649 # the desired precision and express self in the form c*100**e
2650 # with c a positive real number and e an integer, c and e
2651 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2652 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2653 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2654 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2655 # the closest integer to sqrt(c) with the even integer chosen
2656 # in the case of a tie.
2657 #
2658 # To ensure correct rounding in all cases, we use the
2659 # following trick: we compute the square root to an extra
2660 # place (precision p+1 instead of precision p), rounding down.
2661 # Then, if the result is inexact and its last digit is 0 or 5,
2662 # we increase the last digit to 1 or 6 respectively; if it's
2663 # exact we leave the last digit alone. Now the final round to
2664 # p places (or fewer in the case of underflow) will round
2665 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002666
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002667 # use an extra digit of precision
2668 prec = context.prec+1
2669
2670 # write argument in the form c*100**e where e = self._exp//2
2671 # is the 'ideal' exponent, to be used if the square root is
2672 # exactly representable. l is the number of 'digits' of c in
2673 # base 100, so that 100**(l-1) <= c < 100**l.
2674 op = _WorkRep(self)
2675 e = op.exp >> 1
2676 if op.exp & 1:
2677 c = op.int * 10
2678 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002679 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002680 c = op.int
2681 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002682
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002683 # rescale so that c has exactly prec base 100 'digits'
2684 shift = prec-l
2685 if shift >= 0:
2686 c *= 100**shift
2687 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002688 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002689 c, remainder = divmod(c, 100**-shift)
2690 exact = not remainder
2691 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002692
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002693 # find n = floor(sqrt(c)) using Newton's method
2694 n = 10**prec
2695 while True:
2696 q = c//n
2697 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002698 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002699 else:
2700 n = n + q >> 1
2701 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002702
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002703 if exact:
2704 # result is exact; rescale to use ideal exponent e
2705 if shift >= 0:
2706 # assert n % 10**shift == 0
2707 n //= 10**shift
2708 else:
2709 n *= 10**-shift
2710 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002711 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002712 # result is not exact; fix last digit as described above
2713 if n % 5 == 0:
2714 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002715
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002716 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002717
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002718 # round, and fit to current context
2719 context = context._shallow_copy()
2720 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002721 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002722 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002723
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002724 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002725
2726 def max(self, other, context=None):
2727 """Returns the larger value.
2728
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002729 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002730 NaN (and signals if one is sNaN). Also rounds.
2731 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002732 other = _convert_other(other, raiseit=True)
2733
2734 if context is None:
2735 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002736
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002737 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002738 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002739 # number is always returned
2740 sn = self._isnan()
2741 on = other._isnan()
2742 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002743 if on == 1 and sn == 0:
2744 return self._fix(context)
2745 if sn == 1 and on == 0:
2746 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002747 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002748
Christian Heimes77c02eb2008-02-09 02:18:51 +00002749 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002750 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002751 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002752 # then an ordering is applied:
2753 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002754 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002755 # positive sign and min returns the operand with the negative sign
2756 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002757 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002758 # the result. This is exactly the ordering used in compare_total.
2759 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002760
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002761 if c == -1:
2762 ans = other
2763 else:
2764 ans = self
2765
Christian Heimes2c181612007-12-17 20:04:13 +00002766 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002767
2768 def min(self, other, context=None):
2769 """Returns the smaller value.
2770
Guido van Rossumd8faa362007-04-27 19:54:29 +00002771 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002772 NaN (and signals if one is sNaN). Also rounds.
2773 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002774 other = _convert_other(other, raiseit=True)
2775
2776 if context is None:
2777 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002778
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002779 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002780 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002781 # number is always returned
2782 sn = self._isnan()
2783 on = other._isnan()
2784 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002785 if on == 1 and sn == 0:
2786 return self._fix(context)
2787 if sn == 1 and on == 0:
2788 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002789 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002790
Christian Heimes77c02eb2008-02-09 02:18:51 +00002791 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002792 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002793 c = self.compare_total(other)
2794
2795 if c == -1:
2796 ans = self
2797 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002798 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002799
Christian Heimes2c181612007-12-17 20:04:13 +00002800 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002801
2802 def _isinteger(self):
2803 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002804 if self._is_special:
2805 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002806 if self._exp >= 0:
2807 return True
2808 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002809 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002810
2811 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002812 """Returns True if self is even. Assumes self is an integer."""
2813 if not self or self._exp > 0:
2814 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002815 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002816
2817 def adjusted(self):
2818 """Return the adjusted exponent of self"""
2819 try:
2820 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002821 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002822 except TypeError:
2823 return 0
2824
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002825 def canonical(self, context=None):
2826 """Returns the same Decimal object.
2827
2828 As we do not have different encodings for the same number, the
2829 received object already is in its canonical form.
2830 """
2831 return self
2832
2833 def compare_signal(self, other, context=None):
2834 """Compares self to the other operand numerically.
2835
2836 It's pretty much like compare(), but all NaNs signal, with signaling
2837 NaNs taking precedence over quiet NaNs.
2838 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002839 other = _convert_other(other, raiseit = True)
2840 ans = self._compare_check_nans(other, context)
2841 if ans:
2842 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002843 return self.compare(other, context=context)
2844
2845 def compare_total(self, other):
2846 """Compares self to other using the abstract representations.
2847
2848 This is not like the standard compare, which use their numerical
2849 value. Note that a total ordering is defined for all possible abstract
2850 representations.
2851 """
Mark Dickinson9050bb22009-10-29 12:25:07 +00002852 other = _convert_other(other, raiseit=True)
2853
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002854 # if one is negative and the other is positive, it's easy
2855 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002856 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002857 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002858 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002859 sign = self._sign
2860
2861 # let's handle both NaN types
2862 self_nan = self._isnan()
2863 other_nan = other._isnan()
2864 if self_nan or other_nan:
2865 if self_nan == other_nan:
Mark Dickinson7a6bcce2009-08-28 13:44:35 +00002866 # compare payloads as though they're integers
2867 self_key = len(self._int), self._int
2868 other_key = len(other._int), other._int
2869 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002870 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002871 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002872 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002873 return _NegativeOne
Mark Dickinson7a6bcce2009-08-28 13:44:35 +00002874 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002875 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002876 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002877 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002878 return _One
2879 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002880
2881 if sign:
2882 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002883 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002884 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002885 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002886 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002887 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002888 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002889 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002890 else:
2891 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002892 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002893 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002894 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002895 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002896 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002897 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002898 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002899
2900 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002901 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002902 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002903 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002904
2905 if self._exp < other._exp:
2906 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002907 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002908 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002909 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002910 if self._exp > other._exp:
2911 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002912 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002913 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002914 return _One
2915 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002916
2917
2918 def compare_total_mag(self, other):
2919 """Compares self to other using abstract repr., ignoring sign.
2920
2921 Like compare_total, but with operand's sign ignored and assumed to be 0.
2922 """
Mark Dickinson9050bb22009-10-29 12:25:07 +00002923 other = _convert_other(other, raiseit=True)
2924
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002925 s = self.copy_abs()
2926 o = other.copy_abs()
2927 return s.compare_total(o)
2928
2929 def copy_abs(self):
2930 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002931 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002932
2933 def copy_negate(self):
2934 """Returns a copy with the sign inverted."""
2935 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002936 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002937 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002938 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002939
2940 def copy_sign(self, other):
2941 """Returns self with the sign of other."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002942 return _dec_from_triple(other._sign, self._int,
2943 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002944
2945 def exp(self, context=None):
2946 """Returns e ** self."""
2947
2948 if context is None:
2949 context = getcontext()
2950
2951 # exp(NaN) = NaN
2952 ans = self._check_nans(context=context)
2953 if ans:
2954 return ans
2955
2956 # exp(-Infinity) = 0
2957 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002958 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002959
2960 # exp(0) = 1
2961 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002962 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002963
2964 # exp(Infinity) = Infinity
2965 if self._isinfinity() == 1:
2966 return Decimal(self)
2967
2968 # the result is now guaranteed to be inexact (the true
2969 # mathematical result is transcendental). There's no need to
2970 # raise Rounded and Inexact here---they'll always be raised as
2971 # a result of the call to _fix.
2972 p = context.prec
2973 adj = self.adjusted()
2974
2975 # we only need to do any computation for quite a small range
2976 # of adjusted exponents---for example, -29 <= adj <= 10 for
2977 # the default context. For smaller exponent the result is
2978 # indistinguishable from 1 at the given precision, while for
2979 # larger exponent the result either overflows or underflows.
2980 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2981 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002982 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002983 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2984 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002985 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002986 elif self._sign == 0 and adj < -p:
2987 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002988 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002989 elif self._sign == 1 and adj < -p-1:
2990 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002991 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002992 # general case
2993 else:
2994 op = _WorkRep(self)
2995 c, e = op.int, op.exp
2996 if op.sign == 1:
2997 c = -c
2998
2999 # compute correctly rounded result: increase precision by
3000 # 3 digits at a time until we get an unambiguously
3001 # roundable result
3002 extra = 3
3003 while True:
3004 coeff, exp = _dexp(c, e, p+extra)
3005 if coeff % (5*10**(len(str(coeff))-p-1)):
3006 break
3007 extra += 3
3008
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003009 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003010
3011 # at this stage, ans should round correctly with *any*
3012 # rounding mode, not just with ROUND_HALF_EVEN
3013 context = context._shallow_copy()
3014 rounding = context._set_rounding(ROUND_HALF_EVEN)
3015 ans = ans._fix(context)
3016 context.rounding = rounding
3017
3018 return ans
3019
3020 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003021 """Return True if self is canonical; otherwise return False.
3022
3023 Currently, the encoding of a Decimal instance is always
3024 canonical, so this method returns True for any Decimal.
3025 """
3026 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003027
3028 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003029 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003030
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003031 A Decimal instance is considered finite if it is neither
3032 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003033 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003034 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003035
3036 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003037 """Return True if self is infinite; otherwise return False."""
3038 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003039
3040 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003041 """Return True if self is a qNaN or sNaN; otherwise return False."""
3042 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003043
3044 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003045 """Return True if self is a normal number; otherwise return False."""
3046 if self._is_special or not self:
3047 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003048 if context is None:
3049 context = getcontext()
Mark Dickinson2d4fce22009-10-20 13:40:25 +00003050 return context.Emin <= self.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003051
3052 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003053 """Return True if self is a quiet NaN; otherwise return False."""
3054 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003055
3056 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003057 """Return True if self is negative; otherwise return False."""
3058 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003059
3060 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003061 """Return True if self is a signaling NaN; otherwise return False."""
3062 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003063
3064 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003065 """Return True if self is subnormal; otherwise return False."""
3066 if self._is_special or not self:
3067 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003068 if context is None:
3069 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003070 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003071
3072 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003073 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003074 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003075
3076 def _ln_exp_bound(self):
3077 """Compute a lower bound for the adjusted exponent of self.ln().
3078 In other words, compute r such that self.ln() >= 10**r. Assumes
3079 that self is finite and positive and that self != 1.
3080 """
3081
3082 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3083 adj = self._exp + len(self._int) - 1
3084 if adj >= 1:
3085 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3086 return len(str(adj*23//10)) - 1
3087 if adj <= -2:
3088 # argument <= 0.1
3089 return len(str((-1-adj)*23//10)) - 1
3090 op = _WorkRep(self)
3091 c, e = op.int, op.exp
3092 if adj == 0:
3093 # 1 < self < 10
3094 num = str(c-10**-e)
3095 den = str(c)
3096 return len(num) - len(den) - (num < den)
3097 # adj == -1, 0.1 <= self < 1
3098 return e + len(str(10**-e - c)) - 1
3099
3100
3101 def ln(self, context=None):
3102 """Returns the natural (base e) logarithm of self."""
3103
3104 if context is None:
3105 context = getcontext()
3106
3107 # ln(NaN) = NaN
3108 ans = self._check_nans(context=context)
3109 if ans:
3110 return ans
3111
3112 # ln(0.0) == -Infinity
3113 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003114 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003115
3116 # ln(Infinity) = Infinity
3117 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003118 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003119
3120 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003121 if self == _One:
3122 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003123
3124 # ln(negative) raises InvalidOperation
3125 if self._sign == 1:
3126 return context._raise_error(InvalidOperation,
3127 'ln of a negative value')
3128
3129 # result is irrational, so necessarily inexact
3130 op = _WorkRep(self)
3131 c, e = op.int, op.exp
3132 p = context.prec
3133
3134 # correctly rounded result: repeatedly increase precision by 3
3135 # until we get an unambiguously roundable result
3136 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3137 while True:
3138 coeff = _dlog(c, e, places)
3139 # assert len(str(abs(coeff)))-p >= 1
3140 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3141 break
3142 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003143 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003144
3145 context = context._shallow_copy()
3146 rounding = context._set_rounding(ROUND_HALF_EVEN)
3147 ans = ans._fix(context)
3148 context.rounding = rounding
3149 return ans
3150
3151 def _log10_exp_bound(self):
3152 """Compute a lower bound for the adjusted exponent of self.log10().
3153 In other words, find r such that self.log10() >= 10**r.
3154 Assumes that self is finite and positive and that self != 1.
3155 """
3156
3157 # For x >= 10 or x < 0.1 we only need a bound on the integer
3158 # part of log10(self), and this comes directly from the
3159 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3160 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3161 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3162
3163 adj = self._exp + len(self._int) - 1
3164 if adj >= 1:
3165 # self >= 10
3166 return len(str(adj))-1
3167 if adj <= -2:
3168 # self < 0.1
3169 return len(str(-1-adj))-1
3170 op = _WorkRep(self)
3171 c, e = op.int, op.exp
3172 if adj == 0:
3173 # 1 < self < 10
3174 num = str(c-10**-e)
3175 den = str(231*c)
3176 return len(num) - len(den) - (num < den) + 2
3177 # adj == -1, 0.1 <= self < 1
3178 num = str(10**-e-c)
3179 return len(num) + e - (num < "231") - 1
3180
3181 def log10(self, context=None):
3182 """Returns the base 10 logarithm of self."""
3183
3184 if context is None:
3185 context = getcontext()
3186
3187 # log10(NaN) = NaN
3188 ans = self._check_nans(context=context)
3189 if ans:
3190 return ans
3191
3192 # log10(0.0) == -Infinity
3193 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003194 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003195
3196 # log10(Infinity) = Infinity
3197 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003198 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003199
3200 # log10(negative or -Infinity) raises InvalidOperation
3201 if self._sign == 1:
3202 return context._raise_error(InvalidOperation,
3203 'log10 of a negative value')
3204
3205 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003206 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003207 # answer may need rounding
3208 ans = Decimal(self._exp + len(self._int) - 1)
3209 else:
3210 # result is irrational, so necessarily inexact
3211 op = _WorkRep(self)
3212 c, e = op.int, op.exp
3213 p = context.prec
3214
3215 # correctly rounded result: repeatedly increase precision
3216 # until result is unambiguously roundable
3217 places = p-self._log10_exp_bound()+2
3218 while True:
3219 coeff = _dlog10(c, e, places)
3220 # assert len(str(abs(coeff)))-p >= 1
3221 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3222 break
3223 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003224 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003225
3226 context = context._shallow_copy()
3227 rounding = context._set_rounding(ROUND_HALF_EVEN)
3228 ans = ans._fix(context)
3229 context.rounding = rounding
3230 return ans
3231
3232 def logb(self, context=None):
3233 """ Returns the exponent of the magnitude of self's MSD.
3234
3235 The result is the integer which is the exponent of the magnitude
3236 of the most significant digit of self (as though it were truncated
3237 to a single digit while maintaining the value of that digit and
3238 without limiting the resulting exponent).
3239 """
3240 # logb(NaN) = NaN
3241 ans = self._check_nans(context=context)
3242 if ans:
3243 return ans
3244
3245 if context is None:
3246 context = getcontext()
3247
3248 # logb(+/-Inf) = +Inf
3249 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003250 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003251
3252 # logb(0) = -Inf, DivisionByZero
3253 if not self:
3254 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3255
3256 # otherwise, simply return the adjusted exponent of self, as a
3257 # Decimal. Note that no attempt is made to fit the result
3258 # into the current context.
Mark Dickinsonb0907612009-10-07 19:24:43 +00003259 ans = Decimal(self.adjusted())
3260 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003261
3262 def _islogical(self):
3263 """Return True if self is a logical operand.
3264
Christian Heimes679db4a2008-01-18 09:56:22 +00003265 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003266 an exponent of 0, and a coefficient whose digits must all be
3267 either 0 or 1.
3268 """
3269 if self._sign != 0 or self._exp != 0:
3270 return False
3271 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003272 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003273 return False
3274 return True
3275
3276 def _fill_logical(self, context, opa, opb):
3277 dif = context.prec - len(opa)
3278 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003279 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003280 elif dif < 0:
3281 opa = opa[-context.prec:]
3282 dif = context.prec - len(opb)
3283 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003284 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003285 elif dif < 0:
3286 opb = opb[-context.prec:]
3287 return opa, opb
3288
3289 def logical_and(self, other, context=None):
3290 """Applies an 'and' operation between self and other's digits."""
3291 if context is None:
3292 context = getcontext()
Mark Dickinson9050bb22009-10-29 12:25:07 +00003293
3294 other = _convert_other(other, raiseit=True)
3295
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003296 if not self._islogical() or not other._islogical():
3297 return context._raise_error(InvalidOperation)
3298
3299 # fill to context.prec
3300 (opa, opb) = self._fill_logical(context, self._int, other._int)
3301
3302 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003303 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3304 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003305
3306 def logical_invert(self, context=None):
3307 """Invert all its digits."""
3308 if context is None:
3309 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003310 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3311 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003312
3313 def logical_or(self, other, context=None):
3314 """Applies an 'or' operation between self and other's digits."""
3315 if context is None:
3316 context = getcontext()
Mark Dickinson9050bb22009-10-29 12:25:07 +00003317
3318 other = _convert_other(other, raiseit=True)
3319
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003320 if not self._islogical() or not other._islogical():
3321 return context._raise_error(InvalidOperation)
3322
3323 # fill to context.prec
3324 (opa, opb) = self._fill_logical(context, self._int, other._int)
3325
3326 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003327 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003328 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003329
3330 def logical_xor(self, other, context=None):
3331 """Applies an 'xor' operation between self and other's digits."""
3332 if context is None:
3333 context = getcontext()
Mark Dickinson9050bb22009-10-29 12:25:07 +00003334
3335 other = _convert_other(other, raiseit=True)
3336
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003337 if not self._islogical() or not other._islogical():
3338 return context._raise_error(InvalidOperation)
3339
3340 # fill to context.prec
3341 (opa, opb) = self._fill_logical(context, self._int, other._int)
3342
3343 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003344 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003345 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003346
3347 def max_mag(self, other, context=None):
3348 """Compares the values numerically with their sign ignored."""
3349 other = _convert_other(other, raiseit=True)
3350
3351 if context is None:
3352 context = getcontext()
3353
3354 if self._is_special or other._is_special:
3355 # If one operand is a quiet NaN and the other is number, then the
3356 # number is always returned
3357 sn = self._isnan()
3358 on = other._isnan()
3359 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003360 if on == 1 and sn == 0:
3361 return self._fix(context)
3362 if sn == 1 and on == 0:
3363 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003364 return self._check_nans(other, context)
3365
Christian Heimes77c02eb2008-02-09 02:18:51 +00003366 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003367 if c == 0:
3368 c = self.compare_total(other)
3369
3370 if c == -1:
3371 ans = other
3372 else:
3373 ans = self
3374
Christian Heimes2c181612007-12-17 20:04:13 +00003375 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003376
3377 def min_mag(self, other, context=None):
3378 """Compares the values numerically with their sign ignored."""
3379 other = _convert_other(other, raiseit=True)
3380
3381 if context is None:
3382 context = getcontext()
3383
3384 if self._is_special or other._is_special:
3385 # If one operand is a quiet NaN and the other is number, then the
3386 # number is always returned
3387 sn = self._isnan()
3388 on = other._isnan()
3389 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003390 if on == 1 and sn == 0:
3391 return self._fix(context)
3392 if sn == 1 and on == 0:
3393 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003394 return self._check_nans(other, context)
3395
Christian Heimes77c02eb2008-02-09 02:18:51 +00003396 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003397 if c == 0:
3398 c = self.compare_total(other)
3399
3400 if c == -1:
3401 ans = self
3402 else:
3403 ans = other
3404
Christian Heimes2c181612007-12-17 20:04:13 +00003405 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003406
3407 def next_minus(self, context=None):
3408 """Returns the largest representable number smaller than itself."""
3409 if context is None:
3410 context = getcontext()
3411
3412 ans = self._check_nans(context=context)
3413 if ans:
3414 return ans
3415
3416 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003417 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003418 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003419 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003420
3421 context = context.copy()
3422 context._set_rounding(ROUND_FLOOR)
3423 context._ignore_all_flags()
3424 new_self = self._fix(context)
3425 if new_self != self:
3426 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003427 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3428 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003429
3430 def next_plus(self, context=None):
3431 """Returns the smallest representable number larger than itself."""
3432 if context is None:
3433 context = getcontext()
3434
3435 ans = self._check_nans(context=context)
3436 if ans:
3437 return ans
3438
3439 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003440 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003441 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003442 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003443
3444 context = context.copy()
3445 context._set_rounding(ROUND_CEILING)
3446 context._ignore_all_flags()
3447 new_self = self._fix(context)
3448 if new_self != self:
3449 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003450 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3451 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003452
3453 def next_toward(self, other, context=None):
3454 """Returns the number closest to self, in the direction towards other.
3455
3456 The result is the closest representable number to self
3457 (excluding self) that is in the direction towards other,
3458 unless both have the same value. If the two operands are
3459 numerically equal, then the result is a copy of self with the
3460 sign set to be the same as the sign of other.
3461 """
3462 other = _convert_other(other, raiseit=True)
3463
3464 if context is None:
3465 context = getcontext()
3466
3467 ans = self._check_nans(other, context)
3468 if ans:
3469 return ans
3470
Christian Heimes77c02eb2008-02-09 02:18:51 +00003471 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003472 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003473 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003474
3475 if comparison == -1:
3476 ans = self.next_plus(context)
3477 else: # comparison == 1
3478 ans = self.next_minus(context)
3479
3480 # decide which flags to raise using value of ans
3481 if ans._isinfinity():
3482 context._raise_error(Overflow,
3483 'Infinite result from next_toward',
3484 ans._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003485 context._raise_error(Inexact)
Mark Dickinsonece06972010-05-04 14:37:14 +00003486 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003487 elif ans.adjusted() < context.Emin:
3488 context._raise_error(Underflow)
3489 context._raise_error(Subnormal)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003490 context._raise_error(Inexact)
Mark Dickinsonece06972010-05-04 14:37:14 +00003491 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003492 # if precision == 1 then we don't raise Clamped for a
3493 # result 0E-Etiny.
3494 if not ans:
3495 context._raise_error(Clamped)
3496
3497 return ans
3498
3499 def number_class(self, context=None):
3500 """Returns an indication of the class of self.
3501
3502 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003503 sNaN
3504 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003505 -Infinity
3506 -Normal
3507 -Subnormal
3508 -Zero
3509 +Zero
3510 +Subnormal
3511 +Normal
3512 +Infinity
3513 """
3514 if self.is_snan():
3515 return "sNaN"
3516 if self.is_qnan():
3517 return "NaN"
3518 inf = self._isinfinity()
3519 if inf == 1:
3520 return "+Infinity"
3521 if inf == -1:
3522 return "-Infinity"
3523 if self.is_zero():
3524 if self._sign:
3525 return "-Zero"
3526 else:
3527 return "+Zero"
3528 if context is None:
3529 context = getcontext()
3530 if self.is_subnormal(context=context):
3531 if self._sign:
3532 return "-Subnormal"
3533 else:
3534 return "+Subnormal"
3535 # just a normal, regular, boring number, :)
3536 if self._sign:
3537 return "-Normal"
3538 else:
3539 return "+Normal"
3540
3541 def radix(self):
3542 """Just returns 10, as this is Decimal, :)"""
3543 return Decimal(10)
3544
3545 def rotate(self, other, context=None):
3546 """Returns a rotated copy of self, value-of-other times."""
3547 if context is None:
3548 context = getcontext()
3549
Mark Dickinson9050bb22009-10-29 12:25:07 +00003550 other = _convert_other(other, raiseit=True)
3551
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003552 ans = self._check_nans(other, context)
3553 if ans:
3554 return ans
3555
3556 if other._exp != 0:
3557 return context._raise_error(InvalidOperation)
3558 if not (-context.prec <= int(other) <= context.prec):
3559 return context._raise_error(InvalidOperation)
3560
3561 if self._isinfinity():
3562 return Decimal(self)
3563
3564 # get values, pad if necessary
3565 torot = int(other)
3566 rotdig = self._int
3567 topad = context.prec - len(rotdig)
Mark Dickinson9050bb22009-10-29 12:25:07 +00003568 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003569 rotdig = '0'*topad + rotdig
Mark Dickinson9050bb22009-10-29 12:25:07 +00003570 elif topad < 0:
3571 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003572
3573 # let's rotate!
3574 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003575 return _dec_from_triple(self._sign,
3576 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003577
Mark Dickinson9050bb22009-10-29 12:25:07 +00003578 def scaleb(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003579 """Returns self operand after adding the second value to its exp."""
3580 if context is None:
3581 context = getcontext()
3582
Mark Dickinson9050bb22009-10-29 12:25:07 +00003583 other = _convert_other(other, raiseit=True)
3584
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003585 ans = self._check_nans(other, context)
3586 if ans:
3587 return ans
3588
3589 if other._exp != 0:
3590 return context._raise_error(InvalidOperation)
3591 liminf = -2 * (context.Emax + context.prec)
3592 limsup = 2 * (context.Emax + context.prec)
3593 if not (liminf <= int(other) <= limsup):
3594 return context._raise_error(InvalidOperation)
3595
3596 if self._isinfinity():
3597 return Decimal(self)
3598
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003599 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003600 d = d._fix(context)
3601 return d
3602
3603 def shift(self, other, context=None):
3604 """Returns a shifted copy of self, value-of-other times."""
3605 if context is None:
3606 context = getcontext()
3607
Mark Dickinson9050bb22009-10-29 12:25:07 +00003608 other = _convert_other(other, raiseit=True)
3609
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003610 ans = self._check_nans(other, context)
3611 if ans:
3612 return ans
3613
3614 if other._exp != 0:
3615 return context._raise_error(InvalidOperation)
3616 if not (-context.prec <= int(other) <= context.prec):
3617 return context._raise_error(InvalidOperation)
3618
3619 if self._isinfinity():
3620 return Decimal(self)
3621
3622 # get values, pad if necessary
3623 torot = int(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003624 rotdig = self._int
3625 topad = context.prec - len(rotdig)
Mark Dickinson9050bb22009-10-29 12:25:07 +00003626 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003627 rotdig = '0'*topad + rotdig
Mark Dickinson9050bb22009-10-29 12:25:07 +00003628 elif topad < 0:
3629 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003630
3631 # let's shift!
3632 if torot < 0:
Mark Dickinson9050bb22009-10-29 12:25:07 +00003633 shifted = rotdig[:torot]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003634 else:
Mark Dickinson9050bb22009-10-29 12:25:07 +00003635 shifted = rotdig + '0'*torot
3636 shifted = shifted[-context.prec:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003637
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003638 return _dec_from_triple(self._sign,
Mark Dickinson9050bb22009-10-29 12:25:07 +00003639 shifted.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003640
Guido van Rossumd8faa362007-04-27 19:54:29 +00003641 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003642 def __reduce__(self):
3643 return (self.__class__, (str(self),))
3644
3645 def __copy__(self):
3646 if type(self) == Decimal:
3647 return self # I'm immutable; therefore I am my own clone
3648 return self.__class__(str(self))
3649
3650 def __deepcopy__(self, memo):
3651 if type(self) == Decimal:
3652 return self # My components are also immutable
3653 return self.__class__(str(self))
3654
Mark Dickinson79f52032009-03-17 23:12:51 +00003655 # PEP 3101 support. the _localeconv keyword argument should be
3656 # considered private: it's provided for ease of testing only.
3657 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003658 """Format a Decimal instance according to the given specifier.
3659
3660 The specifier should be a standard format specifier, with the
3661 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003662 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3663 type is omitted it defaults to 'g' or 'G', depending on the
3664 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003665 """
3666
3667 # Note: PEP 3101 says that if the type is not present then
3668 # there should be at least one digit after the decimal point.
3669 # We take the liberty of ignoring this requirement for
3670 # Decimal---it's presumably there to make sure that
3671 # format(float, '') behaves similarly to str(float).
3672 if context is None:
3673 context = getcontext()
3674
Mark Dickinson79f52032009-03-17 23:12:51 +00003675 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003676
Mark Dickinson79f52032009-03-17 23:12:51 +00003677 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003678 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003679 sign = _format_sign(self._sign, spec)
3680 body = str(self.copy_abs())
3681 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003682
3683 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003684 if spec['type'] is None:
3685 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003686
3687 # if type is '%', adjust exponent of self accordingly
3688 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003689 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3690
3691 # round if necessary, taking rounding mode from the context
3692 rounding = context.rounding
3693 precision = spec['precision']
3694 if precision is not None:
3695 if spec['type'] in 'eE':
3696 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003697 elif spec['type'] in 'fF%':
3698 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003699 elif spec['type'] in 'gG' and len(self._int) > precision:
3700 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003701 # special case: zeros with a positive exponent can't be
3702 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003703 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003704 self = self._rescale(0, rounding)
3705
3706 # figure out placement of the decimal point
3707 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003708 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003709 if not self and precision is not None:
3710 dotplace = 1 - precision
3711 else:
3712 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003713 elif spec['type'] in 'fF%':
3714 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003715 elif spec['type'] in 'gG':
3716 if self._exp <= 0 and leftdigits > -6:
3717 dotplace = leftdigits
3718 else:
3719 dotplace = 1
3720
Mark Dickinson79f52032009-03-17 23:12:51 +00003721 # find digits before and after decimal point, and get exponent
3722 if dotplace < 0:
3723 intpart = '0'
3724 fracpart = '0'*(-dotplace) + self._int
3725 elif dotplace > len(self._int):
3726 intpart = self._int + '0'*(dotplace-len(self._int))
3727 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003728 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003729 intpart = self._int[:dotplace] or '0'
3730 fracpart = self._int[dotplace:]
3731 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003732
Mark Dickinson79f52032009-03-17 23:12:51 +00003733 # done with the decimal-specific stuff; hand over the rest
3734 # of the formatting to the _format_number function
3735 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003736
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003737def _dec_from_triple(sign, coefficient, exponent, special=False):
3738 """Create a decimal instance directly, without any validation,
3739 normalization (e.g. removal of leading zeros) or argument
3740 conversion.
3741
3742 This function is for *internal use only*.
3743 """
3744
3745 self = object.__new__(Decimal)
3746 self._sign = sign
3747 self._int = coefficient
3748 self._exp = exponent
3749 self._is_special = special
3750
3751 return self
3752
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003753# Register Decimal as a kind of Number (an abstract base class).
3754# However, do not register it as Real (because Decimals are not
3755# interoperable with floats).
3756_numbers.Number.register(Decimal)
3757
3758
Guido van Rossumd8faa362007-04-27 19:54:29 +00003759##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003760
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003761
3762# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003763rounding_functions = [name for name in Decimal.__dict__.keys()
3764 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003765for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003766 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003767 globalname = name[1:].upper()
3768 val = globals()[globalname]
3769 Decimal._pick_rounding_function[val] = name
3770
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003771del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003772
Thomas Wouters89f507f2006-12-13 04:49:30 +00003773class _ContextManager(object):
3774 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003775
Thomas Wouters89f507f2006-12-13 04:49:30 +00003776 Sets a copy of the supplied context in __enter__() and restores
3777 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003778 """
3779 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003780 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003781 def __enter__(self):
3782 self.saved_context = getcontext()
3783 setcontext(self.new_context)
3784 return self.new_context
3785 def __exit__(self, t, v, tb):
3786 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003787
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003788class Context(object):
3789 """Contains the context for a Decimal instance.
3790
3791 Contains:
3792 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003793 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003794 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003795 raised when it is caused. Otherwise, a value is
3796 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003797 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003798 (Whether or not the trap_enabler is set)
3799 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003800 Emin - Minimum exponent
3801 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003802 capitals - If 1, 1*10^1 is printed as 1E+1.
3803 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003804 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003805 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003806
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003807 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003808 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003809 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003810 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003811 _ignored_flags=None):
Mark Dickinson921d30d2010-07-08 21:18:21 +00003812 # Set defaults; for everything except flags and _ignored_flags,
3813 # inherit from DefaultContext.
3814 try:
3815 dc = DefaultContext
3816 except NameError:
3817 pass
3818
3819 self.prec = prec if prec is not None else dc.prec
3820 self.rounding = rounding if rounding is not None else dc.rounding
3821 self.Emin = Emin if Emin is not None else dc.Emin
3822 self.Emax = Emax if Emax is not None else dc.Emax
3823 self.capitals = capitals if capitals is not None else dc.capitals
3824 self._clamp = _clamp if _clamp is not None else dc._clamp
3825
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003826 if _ignored_flags is None:
Mark Dickinson921d30d2010-07-08 21:18:21 +00003827 self._ignored_flags = []
3828 else:
3829 self._ignored_flags = _ignored_flags
3830
3831 if traps is None:
3832 self.traps = dc.traps.copy()
3833 elif not isinstance(traps, dict):
3834 self.traps = dict((s, int(s in traps)) for s in _signals)
3835 else:
3836 self.traps = traps
3837
3838 if flags is None:
3839 self.flags = dict.fromkeys(_signals, 0)
3840 elif not isinstance(flags, dict):
3841 self.flags = dict((s, int(s in flags)) for s in _signals)
3842 else:
3843 self.flags = flags
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003844
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003845 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003846 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003847 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003848 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3849 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3850 % vars(self))
3851 names = [f.__name__ for f, v in self.flags.items() if v]
3852 s.append('flags=[' + ', '.join(names) + ']')
3853 names = [t.__name__ for t, v in self.traps.items() if v]
3854 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003855 return ', '.join(s) + ')'
3856
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003857 def clear_flags(self):
3858 """Reset all flags to zero"""
3859 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003860 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003861
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003862 def _shallow_copy(self):
3863 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003864 nc = Context(self.prec, self.rounding, self.traps,
3865 self.flags, self.Emin, self.Emax,
3866 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003867 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003868
3869 def copy(self):
3870 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003871 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003872 self.flags.copy(), self.Emin, self.Emax,
3873 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003874 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003875 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003876
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003877 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003878 """Handles an error
3879
3880 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003881 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah395653e2010-05-19 15:54:54 +00003882 trap_enabler is set, it reraises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003883 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003884 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003885 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003886 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003887 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003888 return error().handle(self, *args)
3889
Raymond Hettinger86173da2008-02-01 20:38:12 +00003890 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003891 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003892 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003893 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003894
3895 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003896 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003897 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003898
3899 def _ignore_all_flags(self):
3900 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003901 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003902
3903 def _ignore_flags(self, *flags):
3904 """Ignore the flags, if they are raised"""
3905 # Do not mutate-- This way, copies of a context leave the original
3906 # alone.
3907 self._ignored_flags = (self._ignored_flags + list(flags))
3908 return list(flags)
3909
3910 def _regard_flags(self, *flags):
3911 """Stop ignoring the flags, if they are raised"""
3912 if flags and isinstance(flags[0], (tuple,list)):
3913 flags = flags[0]
3914 for flag in flags:
3915 self._ignored_flags.remove(flag)
3916
Nick Coghland1abd252008-07-15 15:46:38 +00003917 # We inherit object.__hash__, so we must deny this explicitly
3918 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003919
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003920 def Etiny(self):
3921 """Returns Etiny (= Emin - prec + 1)"""
3922 return int(self.Emin - self.prec + 1)
3923
3924 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003925 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003926 return int(self.Emax - self.prec + 1)
3927
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003928 def _set_rounding(self, type):
3929 """Sets the rounding type.
3930
3931 Sets the rounding type, and returns the current (previous)
3932 rounding type. Often used like:
3933
3934 context = context.copy()
3935 # so you don't change the calling context
3936 # if an error occurs in the middle.
3937 rounding = context._set_rounding(ROUND_UP)
3938 val = self.__sub__(other, context=context)
3939 context._set_rounding(rounding)
3940
3941 This will make it round up for that operation.
3942 """
3943 rounding = self.rounding
3944 self.rounding= type
3945 return rounding
3946
Raymond Hettingerfed52962004-07-14 15:41:57 +00003947 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003948 """Creates a new Decimal instance but using self as context.
3949
3950 This method implements the to-number operation of the
3951 IBM Decimal specification."""
3952
3953 if isinstance(num, str) and num != num.strip():
3954 return self._raise_error(ConversionSyntax,
3955 "no trailing or leading whitespace is "
3956 "permitted.")
3957
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003958 d = Decimal(num, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003959 if d._isnan() and len(d._int) > self.prec - self._clamp:
3960 return self._raise_error(ConversionSyntax,
3961 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003962 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003963
Raymond Hettinger771ed762009-01-03 19:20:32 +00003964 def create_decimal_from_float(self, f):
3965 """Creates a new Decimal instance from a float but rounding using self
3966 as the context.
3967
3968 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3969 >>> context.create_decimal_from_float(3.1415926535897932)
3970 Decimal('3.1415')
3971 >>> context = Context(prec=5, traps=[Inexact])
3972 >>> context.create_decimal_from_float(3.1415926535897932)
3973 Traceback (most recent call last):
3974 ...
3975 decimal.Inexact: None
3976
3977 """
3978 d = Decimal.from_float(f) # An exact conversion
3979 return d._fix(self) # Apply the context rounding
3980
Guido van Rossumd8faa362007-04-27 19:54:29 +00003981 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003982 def abs(self, a):
3983 """Returns the absolute value of the operand.
3984
3985 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00003986 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003987 the plus operation on the operand.
3988
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003989 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003990 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003991 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003992 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003993 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003994 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003995 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003996 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003997 """
3998 return a.__abs__(context=self)
3999
4000 def add(self, a, b):
4001 """Return the sum of the two operands.
4002
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004003 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004004 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004005 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004006 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004007 """
4008 return a.__add__(b, context=self)
4009
4010 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00004011 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004012
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004013 def canonical(self, a):
4014 """Returns the same Decimal object.
4015
4016 As we do not have different encodings for the same number, the
4017 received object already is in its canonical form.
4018
4019 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004020 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004021 """
4022 return a.canonical(context=self)
4023
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004024 def compare(self, a, b):
4025 """Compares values numerically.
4026
4027 If the signs of the operands differ, a value representing each operand
4028 ('-1' if the operand is less than zero, '0' if the operand is zero or
4029 negative zero, or '1' if the operand is greater than zero) is used in
4030 place of that operand for the comparison instead of the actual
4031 operand.
4032
4033 The comparison is then effected by subtracting the second operand from
4034 the first and then returning a value according to the result of the
4035 subtraction: '-1' if the result is less than zero, '0' if the result is
4036 zero or negative zero, or '1' if the result is greater than zero.
4037
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004038 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004039 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004040 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004041 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004042 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004043 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004044 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004045 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004046 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004047 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004048 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004049 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004050 """
4051 return a.compare(b, context=self)
4052
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004053 def compare_signal(self, a, b):
4054 """Compares the values of the two operands numerically.
4055
4056 It's pretty much like compare(), but all NaNs signal, with signaling
4057 NaNs taking precedence over quiet NaNs.
4058
4059 >>> c = ExtendedContext
4060 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004061 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004062 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004063 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004064 >>> c.flags[InvalidOperation] = 0
4065 >>> print(c.flags[InvalidOperation])
4066 0
4067 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004068 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004069 >>> print(c.flags[InvalidOperation])
4070 1
4071 >>> c.flags[InvalidOperation] = 0
4072 >>> print(c.flags[InvalidOperation])
4073 0
4074 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004075 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004076 >>> print(c.flags[InvalidOperation])
4077 1
4078 """
4079 return a.compare_signal(b, context=self)
4080
4081 def compare_total(self, a, b):
4082 """Compares two operands using their abstract representation.
4083
4084 This is not like the standard compare, which use their numerical
4085 value. Note that a total ordering is defined for all possible abstract
4086 representations.
4087
4088 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004089 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004090 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004091 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004092 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004093 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004094 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004095 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004096 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004097 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004098 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004099 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004100 """
4101 return a.compare_total(b)
4102
4103 def compare_total_mag(self, a, b):
4104 """Compares two operands using their abstract representation ignoring sign.
4105
4106 Like compare_total, but with operand's sign ignored and assumed to be 0.
4107 """
4108 return a.compare_total_mag(b)
4109
4110 def copy_abs(self, a):
4111 """Returns a copy of the operand with the sign set to 0.
4112
4113 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004114 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004115 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004116 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004117 """
4118 return a.copy_abs()
4119
4120 def copy_decimal(self, a):
4121 """Returns a copy of the decimal objet.
4122
4123 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004124 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004125 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004126 Decimal('-1.00')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004127 """
4128 return Decimal(a)
4129
4130 def copy_negate(self, a):
4131 """Returns a copy of the operand with the sign inverted.
4132
4133 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004134 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004135 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004136 Decimal('101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004137 """
4138 return a.copy_negate()
4139
4140 def copy_sign(self, a, b):
4141 """Copies the second operand's sign to the first one.
4142
4143 In detail, it returns a copy of the first operand with the sign
4144 equal to the sign of the second operand.
4145
4146 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004147 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004148 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004149 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004150 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004151 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004152 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004153 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004154 """
4155 return a.copy_sign(b)
4156
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004157 def divide(self, a, b):
4158 """Decimal division in a specified context.
4159
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004160 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004161 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004162 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004163 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004164 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004165 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004166 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004167 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004168 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004169 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004170 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004171 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004172 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004173 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004174 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004175 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004176 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004177 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004178 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004179 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004180 """
Neal Norwitzbcc0db82006-03-24 08:14:36 +00004181 return a.__truediv__(b, context=self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004182
4183 def divide_int(self, a, b):
4184 """Divides two numbers and returns the integer part of the result.
4185
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004186 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004187 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004188 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004189 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004190 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004191 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004192 """
4193 return a.__floordiv__(b, context=self)
4194
4195 def divmod(self, a, b):
Mark Dickinson875e1e72010-01-06 16:23:13 +00004196 """Return (a // b, a % b)
4197
4198 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4199 (Decimal('2'), Decimal('2'))
4200 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4201 (Decimal('2'), Decimal('0'))
4202 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004203 return a.__divmod__(b, context=self)
4204
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004205 def exp(self, a):
4206 """Returns e ** a.
4207
4208 >>> c = ExtendedContext.copy()
4209 >>> c.Emin = -999
4210 >>> c.Emax = 999
4211 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004212 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004213 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004214 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004215 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004216 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004217 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004218 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004219 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004220 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004221 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004222 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004223 """
4224 return a.exp(context=self)
4225
4226 def fma(self, a, b, c):
4227 """Returns a multiplied by b, plus c.
4228
4229 The first two operands are multiplied together, using multiply,
4230 the third operand is then added to the result of that
4231 multiplication, using add, all with only one final rounding.
4232
4233 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004234 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004235 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004236 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004237 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004238 Decimal('1.38435736E+12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004239 """
4240 return a.fma(b, c, context=self)
4241
4242 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004243 """Return True if the operand is canonical; otherwise return False.
4244
4245 Currently, the encoding of a Decimal instance is always
4246 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004247
4248 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004249 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004250 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004251 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004252
4253 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004254 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004255
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004256 A Decimal instance is considered finite if it is neither
4257 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004258
4259 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004260 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004261 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004262 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004263 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004264 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004265 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004266 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004267 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004268 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004269 """
4270 return a.is_finite()
4271
4272 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004273 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004274
4275 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004276 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004277 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004278 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004279 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004280 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004281 """
4282 return a.is_infinite()
4283
4284 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004285 """Return True if the operand is a qNaN or sNaN;
4286 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004287
4288 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004289 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004290 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004291 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004292 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004293 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004294 """
4295 return a.is_nan()
4296
4297 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004298 """Return True if the operand is a normal number;
4299 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004300
4301 >>> c = ExtendedContext.copy()
4302 >>> c.Emin = -999
4303 >>> c.Emax = 999
4304 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004305 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004306 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004307 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004308 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004309 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004310 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004311 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004312 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004313 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004314 """
4315 return a.is_normal(context=self)
4316
4317 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004318 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004319
4320 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004321 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004322 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004323 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004324 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004325 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004326 """
4327 return a.is_qnan()
4328
4329 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004330 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004331
4332 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004333 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004334 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004335 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004336 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004337 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004338 """
4339 return a.is_signed()
4340
4341 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004342 """Return True if the operand is a signaling NaN;
4343 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004344
4345 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004346 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004347 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004348 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004349 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004350 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004351 """
4352 return a.is_snan()
4353
4354 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004355 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004356
4357 >>> c = ExtendedContext.copy()
4358 >>> c.Emin = -999
4359 >>> c.Emax = 999
4360 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004361 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004362 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004363 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004364 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004365 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004366 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004367 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004368 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004369 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004370 """
4371 return a.is_subnormal(context=self)
4372
4373 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004374 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004375
4376 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004377 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004378 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004379 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004380 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004381 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004382 """
4383 return a.is_zero()
4384
4385 def ln(self, a):
4386 """Returns the natural (base e) logarithm of the operand.
4387
4388 >>> c = ExtendedContext.copy()
4389 >>> c.Emin = -999
4390 >>> c.Emax = 999
4391 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004392 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004393 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004394 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004395 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004396 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004397 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004398 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004399 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004400 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004401 """
4402 return a.ln(context=self)
4403
4404 def log10(self, a):
4405 """Returns the base 10 logarithm of the operand.
4406
4407 >>> c = ExtendedContext.copy()
4408 >>> c.Emin = -999
4409 >>> c.Emax = 999
4410 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004411 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004412 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004413 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004414 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004415 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004416 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004417 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004418 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004419 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004420 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004421 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004422 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004423 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004424 """
4425 return a.log10(context=self)
4426
4427 def logb(self, a):
4428 """ Returns the exponent of the magnitude of the operand's MSD.
4429
4430 The result is the integer which is the exponent of the magnitude
4431 of the most significant digit of the operand (as though the
4432 operand were truncated to a single digit while maintaining the
4433 value of that digit and without limiting the resulting exponent).
4434
4435 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004436 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004437 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004438 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004439 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004440 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004441 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004442 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004443 """
4444 return a.logb(context=self)
4445
4446 def logical_and(self, a, b):
4447 """Applies the logical operation 'and' between each operand's digits.
4448
4449 The operands must be both logical numbers.
4450
4451 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004452 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004453 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004454 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004455 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004456 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004457 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004458 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004459 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004460 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004461 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004462 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004463 """
4464 return a.logical_and(b, context=self)
4465
4466 def logical_invert(self, a):
4467 """Invert all the digits in the operand.
4468
4469 The operand must be a logical number.
4470
4471 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004472 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004473 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004474 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004475 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004476 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004477 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004478 Decimal('10101010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004479 """
4480 return a.logical_invert(context=self)
4481
4482 def logical_or(self, a, b):
4483 """Applies the logical operation 'or' between each operand's digits.
4484
4485 The operands must be both logical numbers.
4486
4487 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004488 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004489 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004490 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004491 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004492 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004493 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004494 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004495 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004496 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004497 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004498 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004499 """
4500 return a.logical_or(b, context=self)
4501
4502 def logical_xor(self, a, b):
4503 """Applies the logical operation 'xor' between each operand's digits.
4504
4505 The operands must be both logical numbers.
4506
4507 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004508 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004509 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004510 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004511 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004512 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004513 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004514 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004515 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004516 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004517 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004518 Decimal('1101')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004519 """
4520 return a.logical_xor(b, context=self)
4521
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004522 def max(self, a,b):
4523 """max compares two values numerically and returns the maximum.
4524
4525 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004526 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004527 operation. If they are numerically equal then the left-hand operand
4528 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004529 infinity) of the two operands is chosen as the result.
4530
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004531 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004532 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004533 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004534 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004535 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004536 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004537 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004538 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004539 """
4540 return a.max(b, context=self)
4541
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004542 def max_mag(self, a, b):
4543 """Compares the values numerically with their sign ignored."""
4544 return a.max_mag(b, context=self)
4545
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004546 def min(self, a,b):
4547 """min compares two values numerically and returns the minimum.
4548
4549 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004550 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004551 operation. If they are numerically equal then the left-hand operand
4552 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004553 infinity) of the two operands is chosen as the result.
4554
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004555 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004556 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004557 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004558 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004559 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004560 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004561 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004562 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004563 """
4564 return a.min(b, context=self)
4565
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004566 def min_mag(self, a, b):
4567 """Compares the values numerically with their sign ignored."""
4568 return a.min_mag(b, context=self)
4569
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004570 def minus(self, a):
4571 """Minus corresponds to unary prefix minus in Python.
4572
4573 The operation is evaluated using the same rules as subtract; the
4574 operation minus(a) is calculated as subtract('0', a) where the '0'
4575 has the same exponent as the operand.
4576
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004577 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004578 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004579 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004580 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004581 """
4582 return a.__neg__(context=self)
4583
4584 def multiply(self, a, b):
4585 """multiply multiplies two operands.
4586
4587 If either operand is a special value then the general rules apply.
4588 Otherwise, the operands are multiplied together ('long multiplication'),
4589 resulting in a number which may be as long as the sum of the lengths
4590 of the two operands.
4591
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004592 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004593 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004594 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004595 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004596 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004597 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004598 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004599 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004600 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004601 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004602 """
4603 return a.__mul__(b, context=self)
4604
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004605 def next_minus(self, a):
4606 """Returns the largest representable number smaller than a.
4607
4608 >>> c = ExtendedContext.copy()
4609 >>> c.Emin = -999
4610 >>> c.Emax = 999
4611 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004612 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004613 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004614 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004615 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004616 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004617 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004618 Decimal('9.99999999E+999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004619 """
4620 return a.next_minus(context=self)
4621
4622 def next_plus(self, a):
4623 """Returns the smallest representable number larger than a.
4624
4625 >>> c = ExtendedContext.copy()
4626 >>> c.Emin = -999
4627 >>> c.Emax = 999
4628 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004629 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004630 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004631 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004632 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004633 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004634 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004635 Decimal('-9.99999999E+999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004636 """
4637 return a.next_plus(context=self)
4638
4639 def next_toward(self, a, b):
4640 """Returns the number closest to a, in direction towards b.
4641
4642 The result is the closest representable number from the first
4643 operand (but not the first operand) that is in the direction
4644 towards the second operand, unless the operands have the same
4645 value.
4646
4647 >>> c = ExtendedContext.copy()
4648 >>> c.Emin = -999
4649 >>> c.Emax = 999
4650 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004651 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004652 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004653 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004654 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004655 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004656 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004657 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004658 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004659 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004660 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004661 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004662 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004663 Decimal('-0.00')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004664 """
4665 return a.next_toward(b, context=self)
4666
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004667 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004668 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004669
4670 Essentially a plus operation with all trailing zeros removed from the
4671 result.
4672
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004673 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004674 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004675 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004676 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004677 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004678 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004679 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004680 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004681 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004682 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004683 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004684 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004685 """
4686 return a.normalize(context=self)
4687
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004688 def number_class(self, a):
4689 """Returns an indication of the class of the operand.
4690
4691 The class is one of the following strings:
4692 -sNaN
4693 -NaN
4694 -Infinity
4695 -Normal
4696 -Subnormal
4697 -Zero
4698 +Zero
4699 +Subnormal
4700 +Normal
4701 +Infinity
4702
4703 >>> c = Context(ExtendedContext)
4704 >>> c.Emin = -999
4705 >>> c.Emax = 999
4706 >>> c.number_class(Decimal('Infinity'))
4707 '+Infinity'
4708 >>> c.number_class(Decimal('1E-10'))
4709 '+Normal'
4710 >>> c.number_class(Decimal('2.50'))
4711 '+Normal'
4712 >>> c.number_class(Decimal('0.1E-999'))
4713 '+Subnormal'
4714 >>> c.number_class(Decimal('0'))
4715 '+Zero'
4716 >>> c.number_class(Decimal('-0'))
4717 '-Zero'
4718 >>> c.number_class(Decimal('-0.1E-999'))
4719 '-Subnormal'
4720 >>> c.number_class(Decimal('-1E-10'))
4721 '-Normal'
4722 >>> c.number_class(Decimal('-2.50'))
4723 '-Normal'
4724 >>> c.number_class(Decimal('-Infinity'))
4725 '-Infinity'
4726 >>> c.number_class(Decimal('NaN'))
4727 'NaN'
4728 >>> c.number_class(Decimal('-NaN'))
4729 'NaN'
4730 >>> c.number_class(Decimal('sNaN'))
4731 'sNaN'
4732 """
4733 return a.number_class(context=self)
4734
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004735 def plus(self, a):
4736 """Plus corresponds to unary prefix plus in Python.
4737
4738 The operation is evaluated using the same rules as add; the
4739 operation plus(a) is calculated as add('0', a) where the '0'
4740 has the same exponent as the operand.
4741
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004742 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004743 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004744 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004745 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004746 """
4747 return a.__pos__(context=self)
4748
4749 def power(self, a, b, modulo=None):
4750 """Raises a to the power of b, to modulo if given.
4751
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004752 With two arguments, compute a**b. If a is negative then b
4753 must be integral. The result will be inexact unless b is
4754 integral and the result is finite and can be expressed exactly
4755 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004756
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004757 With three arguments, compute (a**b) % modulo. For the
4758 three argument form, the following restrictions on the
4759 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004760
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004761 - all three arguments must be integral
4762 - b must be nonnegative
4763 - at least one of a or b must be nonzero
4764 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004765
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004766 The result of pow(a, b, modulo) is identical to the result
4767 that would be obtained by computing (a**b) % modulo with
4768 unbounded precision, but is computed more efficiently. It is
4769 always exact.
4770
4771 >>> c = ExtendedContext.copy()
4772 >>> c.Emin = -999
4773 >>> c.Emax = 999
4774 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004775 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004776 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004777 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004778 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004779 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004780 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004781 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004782 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004783 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004784 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004785 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004786 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004787 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004788 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004789 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004790 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004791 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004792 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004793 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004794 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004795 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004796 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004797 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004798 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004799 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004800
4801 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004802 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004803 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004804 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004805 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004806 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004807 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004808 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004809 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004810 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004811 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004812 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004813 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004814 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004815 """
4816 return a.__pow__(b, modulo, context=self)
4817
4818 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00004819 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004820
4821 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00004822 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004823 exponent is being increased), multiplied by a positive power of ten (if
4824 the exponent is being decreased), or is unchanged (if the exponent is
4825 already equal to that of the right-hand operand).
4826
4827 Unlike other operations, if the length of the coefficient after the
4828 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00004829 operation condition is raised. This guarantees that, unless there is
4830 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004831 equal to that of the right-hand operand.
4832
4833 Also unlike other operations, quantize will never raise Underflow, even
4834 if the result is subnormal and inexact.
4835
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004836 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004837 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004838 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004839 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004840 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004841 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004842 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004843 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004844 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004845 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004846 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004847 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004848 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004849 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004850 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004851 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004852 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004853 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004854 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004855 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004856 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004857 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004858 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004859 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004860 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004861 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004862 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004863 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004864 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004865 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004866 """
4867 return a.quantize(b, context=self)
4868
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004869 def radix(self):
4870 """Just returns 10, as this is Decimal, :)
4871
4872 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004873 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004874 """
4875 return Decimal(10)
4876
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004877 def remainder(self, a, b):
4878 """Returns the remainder from integer division.
4879
4880 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00004881 calculating integer division as described for divide-integer, rounded
4882 to precision digits if necessary. The sign of the result, if
4883 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004884
4885 This operation will fail under the same conditions as integer division
4886 (that is, if integer division on the same two operands would fail, the
4887 remainder cannot be calculated).
4888
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004889 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004890 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004891 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004892 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004893 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004894 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004895 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004896 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004897 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004898 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004899 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004900 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004901 """
4902 return a.__mod__(b, context=self)
4903
4904 def remainder_near(self, a, b):
4905 """Returns to be "a - b * n", where n is the integer nearest the exact
4906 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00004907 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004908 sign of a.
4909
4910 This operation will fail under the same conditions as integer division
4911 (that is, if integer division on the same two operands would fail, the
4912 remainder cannot be calculated).
4913
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004914 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004915 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004916 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004917 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004918 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004919 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004920 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004921 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004922 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004923 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004924 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004925 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004926 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004927 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004928 """
4929 return a.remainder_near(b, context=self)
4930
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004931 def rotate(self, a, b):
4932 """Returns a rotated copy of a, b times.
4933
4934 The coefficient of the result is a rotated copy of the digits in
4935 the coefficient of the first operand. The number of places of
4936 rotation is taken from the absolute value of the second operand,
4937 with the rotation being to the left if the second operand is
4938 positive or to the right otherwise.
4939
4940 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004941 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004942 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004943 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004944 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004945 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004946 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004947 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004948 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004949 Decimal('345678912')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004950 """
4951 return a.rotate(b, context=self)
4952
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004953 def same_quantum(self, a, b):
4954 """Returns True if the two operands have the same exponent.
4955
4956 The result is never affected by either the sign or the coefficient of
4957 either operand.
4958
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004959 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004960 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004961 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004962 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004963 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004964 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004965 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004966 True
4967 """
4968 return a.same_quantum(b)
4969
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004970 def scaleb (self, a, b):
4971 """Returns the first operand after adding the second value its exp.
4972
4973 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004974 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004975 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004976 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004977 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004978 Decimal('7.50E+3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004979 """
4980 return a.scaleb (b, context=self)
4981
4982 def shift(self, a, b):
4983 """Returns a shifted copy of a, b times.
4984
4985 The coefficient of the result is a shifted copy of the digits
4986 in the coefficient of the first operand. The number of places
4987 to shift is taken from the absolute value of the second operand,
4988 with the shift being to the left if the second operand is
4989 positive or to the right otherwise. Digits shifted into the
4990 coefficient are zeros.
4991
4992 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004993 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004994 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004995 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004996 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004997 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004998 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004999 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005000 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005001 Decimal('345678900')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005002 """
5003 return a.shift(b, context=self)
5004
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005005 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005006 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005007
5008 If the result must be inexact, it is rounded using the round-half-even
5009 algorithm.
5010
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005011 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005012 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005013 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005014 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005015 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005016 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005017 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005018 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005019 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005020 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005021 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005022 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005023 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005024 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005025 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005026 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005027 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005028 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005029 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005030 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005031 """
5032 return a.sqrt(context=self)
5033
5034 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005035 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005036
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005037 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005038 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005039 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005040 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005041 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005042 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005043 """
5044 return a.__sub__(b, context=self)
5045
5046 def to_eng_string(self, a):
5047 """Converts a number to a string, using scientific notation.
5048
5049 The operation is not affected by the context.
5050 """
5051 return a.to_eng_string(context=self)
5052
5053 def to_sci_string(self, a):
5054 """Converts a number to a string, using scientific notation.
5055
5056 The operation is not affected by the context.
5057 """
5058 return a.__str__(context=self)
5059
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005060 def to_integral_exact(self, a):
5061 """Rounds to an integer.
5062
5063 When the operand has a negative exponent, the result is the same
5064 as using the quantize() operation using the given operand as the
5065 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5066 of the operand as the precision setting; Inexact and Rounded flags
5067 are allowed in this operation. The rounding mode is taken from the
5068 context.
5069
5070 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005071 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005072 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005073 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005074 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005075 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005076 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005077 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005078 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005079 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005080 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005081 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005082 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005083 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005084 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005085 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005086 """
5087 return a.to_integral_exact(context=self)
5088
5089 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005090 """Rounds to an integer.
5091
5092 When the operand has a negative exponent, the result is the same
5093 as using the quantize() operation using the given operand as the
5094 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5095 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00005096 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005097
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005098 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005099 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005100 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005101 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005102 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005103 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005104 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005105 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005106 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005107 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005108 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005109 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005110 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005111 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005112 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005113 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005114 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005115 return a.to_integral_value(context=self)
5116
5117 # the method name changed, but we provide also the old one, for compatibility
5118 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005119
5120class _WorkRep(object):
5121 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005122 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005123 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005124 # exp: None, int, or string
5125
5126 def __init__(self, value=None):
5127 if value is None:
5128 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005129 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005130 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005131 elif isinstance(value, Decimal):
5132 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005133 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005134 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005135 else:
5136 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005137 self.sign = value[0]
5138 self.int = value[1]
5139 self.exp = value[2]
5140
5141 def __repr__(self):
5142 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5143
5144 __str__ = __repr__
5145
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005146
5147
Christian Heimes2c181612007-12-17 20:04:13 +00005148def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005149 """Normalizes op1, op2 to have the same exp and length of coefficient.
5150
5151 Done during addition.
5152 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005153 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005154 tmp = op2
5155 other = op1
5156 else:
5157 tmp = op1
5158 other = op2
5159
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005160 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5161 # Then adding 10**exp to tmp has the same effect (after rounding)
5162 # as adding any positive quantity smaller than 10**exp; similarly
5163 # for subtraction. So if other is smaller than 10**exp we replace
5164 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00005165 tmp_len = len(str(tmp.int))
5166 other_len = len(str(other.int))
5167 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5168 if other_len + other.exp - 1 < exp:
5169 other.int = 1
5170 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005171
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005172 tmp.int *= 10 ** (tmp.exp - other.exp)
5173 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005174 return op1, op2
5175
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005176##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005177
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005178# This function from Tim Peters was taken from here:
5179# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5180# The correction being in the function definition is for speed, and
5181# the whole function is not resolved with math.log because of avoiding
5182# the use of floats.
5183def _nbits(n, correction = {
5184 '0': 4, '1': 3, '2': 2, '3': 2,
5185 '4': 1, '5': 1, '6': 1, '7': 1,
5186 '8': 0, '9': 0, 'a': 0, 'b': 0,
5187 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5188 """Number of bits in binary representation of the positive integer n,
5189 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005190 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005191 if n < 0:
5192 raise ValueError("The argument to _nbits should be nonnegative.")
5193 hex_n = "%x" % n
5194 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005195
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005196def _sqrt_nearest(n, a):
5197 """Closest integer to the square root of the positive integer n. a is
5198 an initial approximation to the square root. Any positive integer
5199 will do for a, but the closer a is to the square root of n the
5200 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005201
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005202 """
5203 if n <= 0 or a <= 0:
5204 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5205
5206 b=0
5207 while a != b:
5208 b, a = a, a--n//a>>1
5209 return a
5210
5211def _rshift_nearest(x, shift):
5212 """Given an integer x and a nonnegative integer shift, return closest
5213 integer to x / 2**shift; use round-to-even in case of a tie.
5214
5215 """
5216 b, q = 1 << shift, x >> shift
5217 return q + (2*(x & (b-1)) + (q&1) > b)
5218
5219def _div_nearest(a, b):
5220 """Closest integer to a/b, a and b positive integers; rounds to even
5221 in the case of a tie.
5222
5223 """
5224 q, r = divmod(a, b)
5225 return q + (2*r + (q&1) > b)
5226
5227def _ilog(x, M, L = 8):
5228 """Integer approximation to M*log(x/M), with absolute error boundable
5229 in terms only of x/M.
5230
5231 Given positive integers x and M, return an integer approximation to
5232 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5233 between the approximation and the exact result is at most 22. For
5234 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5235 both cases these are upper bounds on the error; it will usually be
5236 much smaller."""
5237
5238 # The basic algorithm is the following: let log1p be the function
5239 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5240 # the reduction
5241 #
5242 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5243 #
5244 # repeatedly until the argument to log1p is small (< 2**-L in
5245 # absolute value). For small y we can use the Taylor series
5246 # expansion
5247 #
5248 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5249 #
5250 # truncating at T such that y**T is small enough. The whole
5251 # computation is carried out in a form of fixed-point arithmetic,
5252 # with a real number z being represented by an integer
5253 # approximation to z*M. To avoid loss of precision, the y below
5254 # is actually an integer approximation to 2**R*y*M, where R is the
5255 # number of reductions performed so far.
5256
5257 y = x-M
5258 # argument reduction; R = number of reductions performed
5259 R = 0
5260 while (R <= L and abs(y) << L-R >= M or
5261 R > L and abs(y) >> R-L >= M):
5262 y = _div_nearest((M*y) << 1,
5263 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5264 R += 1
5265
5266 # Taylor series with T terms
5267 T = -int(-10*len(str(M))//(3*L))
5268 yshift = _rshift_nearest(y, R)
5269 w = _div_nearest(M, T)
5270 for k in range(T-1, 0, -1):
5271 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5272
5273 return _div_nearest(w*y, M)
5274
5275def _dlog10(c, e, p):
5276 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5277 approximation to 10**p * log10(c*10**e), with an absolute error of
5278 at most 1. Assumes that c*10**e is not exactly 1."""
5279
5280 # increase precision by 2; compensate for this by dividing
5281 # final result by 100
5282 p += 2
5283
5284 # write c*10**e as d*10**f with either:
5285 # f >= 0 and 1 <= d <= 10, or
5286 # f <= 0 and 0.1 <= d <= 1.
5287 # Thus for c*10**e close to 1, f = 0
5288 l = len(str(c))
5289 f = e+l - (e+l >= 1)
5290
5291 if p > 0:
5292 M = 10**p
5293 k = e+p-f
5294 if k >= 0:
5295 c *= 10**k
5296 else:
5297 c = _div_nearest(c, 10**-k)
5298
5299 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005300 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005301 log_d = _div_nearest(log_d*M, log_10)
5302 log_tenpower = f*M # exact
5303 else:
5304 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005305 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005306
5307 return _div_nearest(log_tenpower+log_d, 100)
5308
5309def _dlog(c, e, p):
5310 """Given integers c, e and p with c > 0, compute an integer
5311 approximation to 10**p * log(c*10**e), with an absolute error of
5312 at most 1. Assumes that c*10**e is not exactly 1."""
5313
5314 # Increase precision by 2. The precision increase is compensated
5315 # for at the end with a division by 100.
5316 p += 2
5317
5318 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5319 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5320 # as 10**p * log(d) + 10**p*f * log(10).
5321 l = len(str(c))
5322 f = e+l - (e+l >= 1)
5323
5324 # compute approximation to 10**p*log(d), with error < 27
5325 if p > 0:
5326 k = e+p-f
5327 if k >= 0:
5328 c *= 10**k
5329 else:
5330 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5331
5332 # _ilog magnifies existing error in c by a factor of at most 10
5333 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5334 else:
5335 # p <= 0: just approximate the whole thing by 0; error < 2.31
5336 log_d = 0
5337
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005338 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005339 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005340 extra = len(str(abs(f)))-1
5341 if p + extra >= 0:
5342 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5343 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5344 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005345 else:
5346 f_log_ten = 0
5347 else:
5348 f_log_ten = 0
5349
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005350 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005351 return _div_nearest(f_log_ten + log_d, 100)
5352
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005353class _Log10Memoize(object):
5354 """Class to compute, store, and allow retrieval of, digits of the
5355 constant log(10) = 2.302585.... This constant is needed by
5356 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5357 def __init__(self):
5358 self.digits = "23025850929940456840179914546843642076011014886"
5359
5360 def getdigits(self, p):
5361 """Given an integer p >= 0, return floor(10**p)*log(10).
5362
5363 For example, self.getdigits(3) returns 2302.
5364 """
5365 # digits are stored as a string, for quick conversion to
5366 # integer in the case that we've already computed enough
5367 # digits; the stored digits should always be correct
5368 # (truncated, not rounded to nearest).
5369 if p < 0:
5370 raise ValueError("p should be nonnegative")
5371
5372 if p >= len(self.digits):
5373 # compute p+3, p+6, p+9, ... digits; continue until at
5374 # least one of the extra digits is nonzero
5375 extra = 3
5376 while True:
5377 # compute p+extra digits, correct to within 1ulp
5378 M = 10**(p+extra+2)
5379 digits = str(_div_nearest(_ilog(10*M, M), 100))
5380 if digits[-extra:] != '0'*extra:
5381 break
5382 extra += 3
5383 # keep all reliable digits so far; remove trailing zeros
5384 # and next nonzero digit
5385 self.digits = digits.rstrip('0')[:-1]
5386 return int(self.digits[:p+1])
5387
5388_log10_digits = _Log10Memoize().getdigits
5389
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005390def _iexp(x, M, L=8):
5391 """Given integers x and M, M > 0, such that x/M is small in absolute
5392 value, compute an integer approximation to M*exp(x/M). For 0 <=
5393 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5394 is usually much smaller)."""
5395
5396 # Algorithm: to compute exp(z) for a real number z, first divide z
5397 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5398 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5399 # series
5400 #
5401 # expm1(x) = x + x**2/2! + x**3/3! + ...
5402 #
5403 # Now use the identity
5404 #
5405 # expm1(2x) = expm1(x)*(expm1(x)+2)
5406 #
5407 # R times to compute the sequence expm1(z/2**R),
5408 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5409
5410 # Find R such that x/2**R/M <= 2**-L
5411 R = _nbits((x<<L)//M)
5412
5413 # Taylor series. (2**L)**T > M
5414 T = -int(-10*len(str(M))//(3*L))
5415 y = _div_nearest(x, T)
5416 Mshift = M<<R
5417 for i in range(T-1, 0, -1):
5418 y = _div_nearest(x*(Mshift + y), Mshift * i)
5419
5420 # Expansion
5421 for k in range(R-1, -1, -1):
5422 Mshift = M<<(k+2)
5423 y = _div_nearest(y*(y+Mshift), Mshift)
5424
5425 return M+y
5426
5427def _dexp(c, e, p):
5428 """Compute an approximation to exp(c*10**e), with p decimal places of
5429 precision.
5430
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005431 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005432
5433 10**(p-1) <= d <= 10**p, and
5434 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5435
5436 In other words, d*10**f is an approximation to exp(c*10**e) with p
5437 digits of precision, and with an error in d of at most 1. This is
5438 almost, but not quite, the same as the error being < 1ulp: when d
5439 = 10**(p-1) the error could be up to 10 ulp."""
5440
5441 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5442 p += 2
5443
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005444 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005445 extra = max(0, e + len(str(c)) - 1)
5446 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005447
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005448 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005449 # rounding down
5450 shift = e+q
5451 if shift >= 0:
5452 cshift = c*10**shift
5453 else:
5454 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005455 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005456
5457 # reduce remainder back to original precision
5458 rem = _div_nearest(rem, 10**extra)
5459
5460 # error in result of _iexp < 120; error after division < 0.62
5461 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5462
5463def _dpower(xc, xe, yc, ye, p):
5464 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5465 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5466
5467 10**(p-1) <= c <= 10**p, and
5468 (c-1)*10**e < x**y < (c+1)*10**e
5469
5470 in other words, c*10**e is an approximation to x**y with p digits
5471 of precision, and with an error in c of at most 1. (This is
5472 almost, but not quite, the same as the error being < 1ulp: when c
5473 == 10**(p-1) we can only guarantee error < 10ulp.)
5474
5475 We assume that: x is positive and not equal to 1, and y is nonzero.
5476 """
5477
5478 # Find b such that 10**(b-1) <= |y| <= 10**b
5479 b = len(str(abs(yc))) + ye
5480
5481 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5482 lxc = _dlog(xc, xe, p+b+1)
5483
5484 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5485 shift = ye-b
5486 if shift >= 0:
5487 pc = lxc*yc*10**shift
5488 else:
5489 pc = _div_nearest(lxc*yc, 10**-shift)
5490
5491 if pc == 0:
5492 # we prefer a result that isn't exactly 1; this makes it
5493 # easier to compute a correctly rounded result in __pow__
5494 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5495 coeff, exp = 10**(p-1)+1, 1-p
5496 else:
5497 coeff, exp = 10**p-1, -p
5498 else:
5499 coeff, exp = _dexp(pc, -(p+1), p+1)
5500 coeff = _div_nearest(coeff, 10)
5501 exp += 1
5502
5503 return coeff, exp
5504
5505def _log10_lb(c, correction = {
5506 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5507 '6': 23, '7': 16, '8': 10, '9': 5}):
5508 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5509 if c <= 0:
5510 raise ValueError("The argument to _log10_lb should be nonnegative.")
5511 str_c = str(c)
5512 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005513
Guido van Rossumd8faa362007-04-27 19:54:29 +00005514##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005515
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005516def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005517 """Convert other to Decimal.
5518
5519 Verifies that it's ok to use in an implicit construction.
5520 """
5521 if isinstance(other, Decimal):
5522 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005523 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005524 return Decimal(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005525 if raiseit:
5526 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005527 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005528
Guido van Rossumd8faa362007-04-27 19:54:29 +00005529##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005530
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005531# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005532# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005533
5534DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005535 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005536 traps=[DivisionByZero, Overflow, InvalidOperation],
5537 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005538 Emax=999999999,
5539 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005540 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005541)
5542
5543# Pre-made alternate contexts offered by the specification
5544# Don't change these; the user should be able to select these
5545# contexts and be able to reproduce results from other implementations
5546# of the spec.
5547
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005548BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005549 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005550 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5551 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005552)
5553
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005554ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005555 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005556 traps=[],
5557 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005558)
5559
5560
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005561##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005562#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005563# Regular expression used for parsing numeric strings. Additional
5564# comments:
5565#
5566# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5567# whitespace. But note that the specification disallows whitespace in
5568# a numeric string.
5569#
5570# 2. For finite numbers (not infinities and NaNs) the body of the
5571# number between the optional sign and the optional exponent must have
5572# at least one decimal digit, possibly after the decimal point. The
Mark Dickinson8d238292009-08-02 10:16:33 +00005573# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005574
5575import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005576_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005577# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005578 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005579 (
Mark Dickinson8d238292009-08-02 10:16:33 +00005580 (?=\d|\.\d) # ...a number (with at least one digit)
5581 (?P<int>\d*) # having a (possibly empty) integer part
5582 (\.(?P<frac>\d*))? # followed by an optional fractional part
5583 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005584 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005585 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005586 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005587 (?P<signal>s)? # ...an (optionally signaling)
5588 NaN # NaN
Mark Dickinson8d238292009-08-02 10:16:33 +00005589 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005590 )
5591# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005592 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005593""", re.VERBOSE | re.IGNORECASE).match
5594
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005595_all_zeros = re.compile('0*$').match
5596_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005597
5598##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005599# The functions in this section have little to do with the Decimal
5600# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005601# Python numeric classes that want to implement __format__
5602#
5603# A format specifier for Decimal looks like:
5604#
Mark Dickinson79f52032009-03-17 23:12:51 +00005605# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005606
5607_parse_format_specifier_regex = re.compile(r"""\A
5608(?:
5609 (?P<fill>.)?
5610 (?P<align>[<>=^])
5611)?
5612(?P<sign>[-+ ])?
5613(?P<zeropad>0)?
5614(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00005615(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005616(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00005617(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005618\Z
5619""", re.VERBOSE)
5620
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005621del re
5622
Mark Dickinson79f52032009-03-17 23:12:51 +00005623# The locale module is only needed for the 'n' format specifier. The
5624# rest of the PEP 3101 code functions quite happily without it, so we
5625# don't care too much if locale isn't present.
5626try:
5627 import locale as _locale
5628except ImportError:
5629 pass
5630
5631def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00005632 """Parse and validate a format specifier.
5633
5634 Turns a standard numeric format specifier into a dict, with the
5635 following entries:
5636
5637 fill: fill character to pad field to minimum width
5638 align: alignment type, either '<', '>', '=' or '^'
5639 sign: either '+', '-' or ' '
5640 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00005641 zeropad: boolean, indicating whether to pad with zeros
5642 thousands_sep: string to use as thousands separator, or ''
5643 grouping: grouping for thousands separators, in format
5644 used by localeconv
5645 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00005646 precision: nonnegative integer giving precision, or None
5647 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00005648
5649 """
5650 m = _parse_format_specifier_regex.match(format_spec)
5651 if m is None:
5652 raise ValueError("Invalid format specifier: " + format_spec)
5653
5654 # get the dictionary
5655 format_dict = m.groupdict()
5656
Mark Dickinson79f52032009-03-17 23:12:51 +00005657 # zeropad; defaults for fill and alignment. If zero padding
5658 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00005659 fill = format_dict['fill']
5660 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00005661 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5662 if format_dict['zeropad']:
5663 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005664 raise ValueError("Fill character conflicts with '0'"
5665 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00005666 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005667 raise ValueError("Alignment conflicts with '0' in "
5668 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00005669 format_dict['fill'] = fill or ' '
5670 format_dict['align'] = align or '<'
5671
Mark Dickinson79f52032009-03-17 23:12:51 +00005672 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00005673 if format_dict['sign'] is None:
5674 format_dict['sign'] = '-'
5675
Christian Heimesf16baeb2008-02-29 14:57:44 +00005676 # minimumwidth defaults to 0; precision remains None if not given
5677 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5678 if format_dict['precision'] is not None:
5679 format_dict['precision'] = int(format_dict['precision'])
5680
5681 # if format type is 'g' or 'G' then a precision of 0 makes little
5682 # sense; convert it to 1. Same if format type is unspecified.
5683 if format_dict['precision'] == 0:
Mark Dickinsond496d302009-09-07 16:23:26 +00005684 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005685 format_dict['precision'] = 1
5686
Mark Dickinson79f52032009-03-17 23:12:51 +00005687 # determine thousands separator, grouping, and decimal separator, and
5688 # add appropriate entries to format_dict
5689 if format_dict['type'] == 'n':
5690 # apart from separators, 'n' behaves just like 'g'
5691 format_dict['type'] = 'g'
5692 if _localeconv is None:
5693 _localeconv = _locale.localeconv()
5694 if format_dict['thousands_sep'] is not None:
5695 raise ValueError("Explicit thousands separator conflicts with "
5696 "'n' type in format specifier: " + format_spec)
5697 format_dict['thousands_sep'] = _localeconv['thousands_sep']
5698 format_dict['grouping'] = _localeconv['grouping']
5699 format_dict['decimal_point'] = _localeconv['decimal_point']
5700 else:
5701 if format_dict['thousands_sep'] is None:
5702 format_dict['thousands_sep'] = ''
5703 format_dict['grouping'] = [3, 0]
5704 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00005705
5706 return format_dict
5707
Mark Dickinson79f52032009-03-17 23:12:51 +00005708def _format_align(sign, body, spec):
5709 """Given an unpadded, non-aligned numeric string 'body' and sign
5710 string 'sign', add padding and aligment conforming to the given
5711 format specifier dictionary 'spec' (as produced by
5712 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00005713
5714 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00005715 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00005716 minimumwidth = spec['minimumwidth']
5717 fill = spec['fill']
5718 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00005719
Mark Dickinson79f52032009-03-17 23:12:51 +00005720 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00005721 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005722 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00005723 elif align == '>':
5724 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00005725 elif align == '=':
5726 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00005727 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005728 half = len(padding)//2
5729 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00005730 else:
5731 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00005732
Christian Heimesf16baeb2008-02-29 14:57:44 +00005733 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005734
Mark Dickinson79f52032009-03-17 23:12:51 +00005735def _group_lengths(grouping):
5736 """Convert a localeconv-style grouping into a (possibly infinite)
5737 iterable of integers representing group lengths.
5738
5739 """
5740 # The result from localeconv()['grouping'], and the input to this
5741 # function, should be a list of integers in one of the
5742 # following three forms:
5743 #
5744 # (1) an empty list, or
5745 # (2) nonempty list of positive integers + [0]
5746 # (3) list of positive integers + [locale.CHAR_MAX], or
5747
5748 from itertools import chain, repeat
5749 if not grouping:
5750 return []
5751 elif grouping[-1] == 0 and len(grouping) >= 2:
5752 return chain(grouping[:-1], repeat(grouping[-2]))
5753 elif grouping[-1] == _locale.CHAR_MAX:
5754 return grouping[:-1]
5755 else:
5756 raise ValueError('unrecognised format for grouping')
5757
5758def _insert_thousands_sep(digits, spec, min_width=1):
5759 """Insert thousands separators into a digit string.
5760
5761 spec is a dictionary whose keys should include 'thousands_sep' and
5762 'grouping'; typically it's the result of parsing the format
5763 specifier using _parse_format_specifier.
5764
5765 The min_width keyword argument gives the minimum length of the
5766 result, which will be padded on the left with zeros if necessary.
5767
5768 If necessary, the zero padding adds an extra '0' on the left to
5769 avoid a leading thousands separator. For example, inserting
5770 commas every three digits in '123456', with min_width=8, gives
5771 '0,123,456', even though that has length 9.
5772
5773 """
5774
5775 sep = spec['thousands_sep']
5776 grouping = spec['grouping']
5777
5778 groups = []
5779 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00005780 if l <= 0:
5781 raise ValueError("group length should be positive")
5782 # max(..., 1) forces at least 1 digit to the left of a separator
5783 l = min(max(len(digits), min_width, 1), l)
5784 groups.append('0'*(l - len(digits)) + digits[-l:])
5785 digits = digits[:-l]
5786 min_width -= l
5787 if not digits and min_width <= 0:
5788 break
Mark Dickinson7303b592009-03-18 08:25:36 +00005789 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00005790 else:
5791 l = max(len(digits), min_width, 1)
5792 groups.append('0'*(l - len(digits)) + digits[-l:])
5793 return sep.join(reversed(groups))
5794
5795def _format_sign(is_negative, spec):
5796 """Determine sign character."""
5797
5798 if is_negative:
5799 return '-'
5800 elif spec['sign'] in ' +':
5801 return spec['sign']
5802 else:
5803 return ''
5804
5805def _format_number(is_negative, intpart, fracpart, exp, spec):
5806 """Format a number, given the following data:
5807
5808 is_negative: true if the number is negative, else false
5809 intpart: string of digits that must appear before the decimal point
5810 fracpart: string of digits that must come after the point
5811 exp: exponent, as an integer
5812 spec: dictionary resulting from parsing the format specifier
5813
5814 This function uses the information in spec to:
5815 insert separators (decimal separator and thousands separators)
5816 format the sign
5817 format the exponent
5818 add trailing '%' for the '%' type
5819 zero-pad if necessary
5820 fill and align if necessary
5821 """
5822
5823 sign = _format_sign(is_negative, spec)
5824
5825 if fracpart:
5826 fracpart = spec['decimal_point'] + fracpart
5827
5828 if exp != 0 or spec['type'] in 'eE':
5829 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
5830 fracpart += "{0}{1:+}".format(echar, exp)
5831 if spec['type'] == '%':
5832 fracpart += '%'
5833
5834 if spec['zeropad']:
5835 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
5836 else:
5837 min_width = 0
5838 intpart = _insert_thousands_sep(intpart, spec, min_width)
5839
5840 return _format_align(sign, intpart+fracpart, spec)
5841
5842
Guido van Rossumd8faa362007-04-27 19:54:29 +00005843##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005844
Guido van Rossumd8faa362007-04-27 19:54:29 +00005845# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005846_Infinity = Decimal('Inf')
5847_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00005848_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005849_Zero = Decimal(0)
5850_One = Decimal(1)
5851_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005852
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005853# _SignedInfinity[sign] is infinity w/ that sign
5854_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005855
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005856
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005857
5858if __name__ == '__main__':
5859 import doctest, sys
5860 doctest.testmod(sys.modules[__name__])