blob: ecf0cd523e5d023f6ef7a902b0cab469739509e0 [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:
2047 if ye >= 0:
2048 exponent = xe*yc*10**ye
2049 else:
2050 exponent, remainder = divmod(xe*yc, 10**-ye)
2051 if remainder:
2052 return None
2053 if y.sign == 1:
2054 exponent = -exponent
2055 # if other is a nonnegative integer, use ideal exponent
2056 if other._isinteger() and other._sign == 0:
2057 ideal_exponent = self._exp*int(other)
2058 zeros = min(exponent-ideal_exponent, p-1)
2059 else:
2060 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002061 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002062
2063 # case where y is negative: xc must be either a power
2064 # of 2 or a power of 5.
2065 if y.sign == 1:
2066 last_digit = xc % 10
2067 if last_digit in (2,4,6,8):
2068 # quick test for power of 2
2069 if xc & -xc != xc:
2070 return None
2071 # now xc is a power of 2; e is its exponent
2072 e = _nbits(xc)-1
2073 # find e*y and xe*y; both must be integers
2074 if ye >= 0:
2075 y_as_int = yc*10**ye
2076 e = e*y_as_int
2077 xe = xe*y_as_int
2078 else:
2079 ten_pow = 10**-ye
2080 e, remainder = divmod(e*yc, ten_pow)
2081 if remainder:
2082 return None
2083 xe, remainder = divmod(xe*yc, ten_pow)
2084 if remainder:
2085 return None
2086
2087 if e*65 >= p*93: # 93/65 > log(10)/log(5)
2088 return None
2089 xc = 5**e
2090
2091 elif last_digit == 5:
2092 # e >= log_5(xc) if xc is a power of 5; we have
2093 # equality all the way up to xc=5**2658
2094 e = _nbits(xc)*28//65
2095 xc, remainder = divmod(5**e, xc)
2096 if remainder:
2097 return None
2098 while xc % 5 == 0:
2099 xc //= 5
2100 e -= 1
2101 if ye >= 0:
2102 y_as_integer = yc*10**ye
2103 e = e*y_as_integer
2104 xe = xe*y_as_integer
2105 else:
2106 ten_pow = 10**-ye
2107 e, remainder = divmod(e*yc, ten_pow)
2108 if remainder:
2109 return None
2110 xe, remainder = divmod(xe*yc, ten_pow)
2111 if remainder:
2112 return None
2113 if e*3 >= p*10: # 10/3 > log(10)/log(2)
2114 return None
2115 xc = 2**e
2116 else:
2117 return None
2118
2119 if xc >= 10**p:
2120 return None
2121 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002122 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002123
2124 # now y is positive; find m and n such that y = m/n
2125 if ye >= 0:
2126 m, n = yc*10**ye, 1
2127 else:
2128 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2129 return None
2130 xc_bits = _nbits(xc)
2131 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2132 return None
2133 m, n = yc, 10**(-ye)
2134 while m % 2 == n % 2 == 0:
2135 m //= 2
2136 n //= 2
2137 while m % 5 == n % 5 == 0:
2138 m //= 5
2139 n //= 5
2140
2141 # compute nth root of xc*10**xe
2142 if n > 1:
2143 # if 1 < xc < 2**n then xc isn't an nth power
2144 if xc != 1 and xc_bits <= n:
2145 return None
2146
2147 xe, rem = divmod(xe, n)
2148 if rem != 0:
2149 return None
2150
2151 # compute nth root of xc using Newton's method
2152 a = 1 << -(-_nbits(xc)//n) # initial estimate
2153 while True:
2154 q, r = divmod(xc, a**(n-1))
2155 if a <= q:
2156 break
2157 else:
2158 a = (a*(n-1) + q)//n
2159 if not (a == q and r == 0):
2160 return None
2161 xc = a
2162
2163 # now xc*10**xe is the nth root of the original xc*10**xe
2164 # compute mth power of xc*10**xe
2165
2166 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2167 # 10**p and the result is not representable.
2168 if xc > 1 and m > p*100//_log10_lb(xc):
2169 return None
2170 xc = xc**m
2171 xe *= m
2172 if xc > 10**p:
2173 return None
2174
2175 # by this point the result *is* exactly representable
2176 # adjust the exponent to get as close as possible to the ideal
2177 # exponent, if necessary
2178 str_xc = str(xc)
2179 if other._isinteger() and other._sign == 0:
2180 ideal_exponent = self._exp*int(other)
2181 zeros = min(xe-ideal_exponent, p-len(str_xc))
2182 else:
2183 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002184 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002185
2186 def __pow__(self, other, modulo=None, context=None):
2187 """Return self ** other [ % modulo].
2188
2189 With two arguments, compute self**other.
2190
2191 With three arguments, compute (self**other) % modulo. For the
2192 three argument form, the following restrictions on the
2193 arguments hold:
2194
2195 - all three arguments must be integral
2196 - other must be nonnegative
2197 - either self or other (or both) must be nonzero
2198 - modulo must be nonzero and must have at most p digits,
2199 where p is the context precision.
2200
2201 If any of these restrictions is violated the InvalidOperation
2202 flag is raised.
2203
2204 The result of pow(self, other, modulo) is identical to the
2205 result that would be obtained by computing (self**other) %
2206 modulo with unbounded precision, but is computed more
2207 efficiently. It is always exact.
2208 """
2209
2210 if modulo is not None:
2211 return self._power_modulo(other, modulo, context)
2212
2213 other = _convert_other(other)
2214 if other is NotImplemented:
2215 return other
2216
2217 if context is None:
2218 context = getcontext()
2219
2220 # either argument is a NaN => result is NaN
2221 ans = self._check_nans(other, context)
2222 if ans:
2223 return ans
2224
2225 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2226 if not other:
2227 if not self:
2228 return context._raise_error(InvalidOperation, '0 ** 0')
2229 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002230 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002231
2232 # result has sign 1 iff self._sign is 1 and other is an odd integer
2233 result_sign = 0
2234 if self._sign == 1:
2235 if other._isinteger():
2236 if not other._iseven():
2237 result_sign = 1
2238 else:
2239 # -ve**noninteger = NaN
2240 # (-0)**noninteger = 0**noninteger
2241 if self:
2242 return context._raise_error(InvalidOperation,
2243 'x ** y with x negative and y not an integer')
2244 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002245 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002246
2247 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2248 if not self:
2249 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002250 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002251 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002252 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002253
2254 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002255 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002256 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002257 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002258 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002259 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002260
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002261 # 1**other = 1, but the choice of exponent and the flags
2262 # depend on the exponent of self, and on whether other is a
2263 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002264 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002265 if other._isinteger():
2266 # exp = max(self._exp*max(int(other), 0),
2267 # 1-context.prec) but evaluating int(other) directly
2268 # is dangerous until we know other is small (other
2269 # could be 1e999999999)
2270 if other._sign == 1:
2271 multiplier = 0
2272 elif other > context.prec:
2273 multiplier = context.prec
2274 else:
2275 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002276
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002277 exp = self._exp * multiplier
2278 if exp < 1-context.prec:
2279 exp = 1-context.prec
2280 context._raise_error(Rounded)
2281 else:
2282 context._raise_error(Inexact)
2283 context._raise_error(Rounded)
2284 exp = 1-context.prec
2285
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002286 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002287
2288 # compute adjusted exponent of self
2289 self_adj = self.adjusted()
2290
2291 # self ** infinity is infinity if self > 1, 0 if self < 1
2292 # self ** -infinity is infinity if self < 1, 0 if self > 1
2293 if other._isinfinity():
2294 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002295 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002296 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002297 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002298
2299 # from here on, the result always goes through the call
2300 # to _fix at the end of this function.
2301 ans = None
Mark Dickinsonece06972010-05-04 14:37:14 +00002302 exact = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002303
2304 # crude test to catch cases of extreme overflow/underflow. If
2305 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2306 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2307 # self**other >= 10**(Emax+1), so overflow occurs. The test
2308 # for underflow is similar.
2309 bound = self._log10_exp_bound() + other.adjusted()
2310 if (self_adj >= 0) == (other._sign == 0):
2311 # self > 1 and other +ve, or self < 1 and other -ve
2312 # possibility of overflow
2313 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002314 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002315 else:
2316 # self > 1 and other -ve, or self < 1 and other +ve
2317 # possibility of underflow to 0
2318 Etiny = context.Etiny()
2319 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002320 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002321
2322 # try for an exact result with precision +1
2323 if ans is None:
2324 ans = self._power_exact(other, context.prec + 1)
2325 if ans is not None and result_sign == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002326 ans = _dec_from_triple(1, ans._int, ans._exp)
Mark Dickinsonece06972010-05-04 14:37:14 +00002327 exact = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002328
2329 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2330 if ans is None:
2331 p = context.prec
2332 x = _WorkRep(self)
2333 xc, xe = x.int, x.exp
2334 y = _WorkRep(other)
2335 yc, ye = y.int, y.exp
2336 if y.sign == 1:
2337 yc = -yc
2338
2339 # compute correctly rounded result: start with precision +3,
2340 # then increase precision until result is unambiguously roundable
2341 extra = 3
2342 while True:
2343 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2344 if coeff % (5*10**(len(str(coeff))-p-1)):
2345 break
2346 extra += 3
2347
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002348 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002349
Mark Dickinsonece06972010-05-04 14:37:14 +00002350 # unlike exp, ln and log10, the power function respects the
2351 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2352
2353 # There's a difficulty here when 'other' is not an integer and
2354 # the result is exact. In this case, the specification
2355 # requires that the Inexact flag be raised (in spite of
2356 # exactness), but since the result is exact _fix won't do this
2357 # for us. (Correspondingly, the Underflow signal should also
2358 # be raised for subnormal results.) We can't directly raise
2359 # these signals either before or after calling _fix, since
2360 # that would violate the precedence for signals. So we wrap
2361 # the ._fix call in a temporary context, and reraise
2362 # afterwards.
2363 if exact and not other._isinteger():
2364 # pad with zeros up to length context.prec+1 if necessary; this
2365 # ensures that the Rounded signal will be raised.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002366 if len(ans._int) <= context.prec:
Mark Dickinsonece06972010-05-04 14:37:14 +00002367 expdiff = context.prec + 1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002368 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2369 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002370
Mark Dickinsonece06972010-05-04 14:37:14 +00002371 # create a copy of the current context, with cleared flags/traps
2372 newcontext = context.copy()
2373 newcontext.clear_flags()
2374 for exception in _signals:
2375 newcontext.traps[exception] = 0
2376
2377 # round in the new context
2378 ans = ans._fix(newcontext)
2379
2380 # raise Inexact, and if necessary, Underflow
2381 newcontext._raise_error(Inexact)
2382 if newcontext.flags[Subnormal]:
2383 newcontext._raise_error(Underflow)
2384
2385 # propagate signals to the original context; _fix could
2386 # have raised any of Overflow, Underflow, Subnormal,
2387 # Inexact, Rounded, Clamped. Overflow needs the correct
2388 # arguments. Note that the order of the exceptions is
2389 # important here.
2390 if newcontext.flags[Overflow]:
2391 context._raise_error(Overflow, 'above Emax', ans._sign)
2392 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2393 if newcontext.flags[exception]:
2394 context._raise_error(exception)
2395
2396 else:
2397 ans = ans._fix(context)
2398
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002399 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002400
2401 def __rpow__(self, other, context=None):
2402 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002403 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002404 if other is NotImplemented:
2405 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002406 return other.__pow__(self, context=context)
2407
2408 def normalize(self, context=None):
2409 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002410
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002411 if context is None:
2412 context = getcontext()
2413
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002414 if self._is_special:
2415 ans = self._check_nans(context=context)
2416 if ans:
2417 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002418
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002419 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002420 if dup._isinfinity():
2421 return dup
2422
2423 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002424 return _dec_from_triple(dup._sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002425 exp_max = [context.Emax, context.Etop()][context._clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002426 end = len(dup._int)
2427 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002428 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002429 exp += 1
2430 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002431 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002432
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002433 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002434 """Quantize self so its exponent is the same as that of exp.
2435
2436 Similar to self._rescale(exp._exp) but with error checking.
2437 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002438 exp = _convert_other(exp, raiseit=True)
2439
2440 if context is None:
2441 context = getcontext()
2442 if rounding is None:
2443 rounding = context.rounding
2444
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002445 if self._is_special or exp._is_special:
2446 ans = self._check_nans(exp, context)
2447 if ans:
2448 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002449
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002450 if exp._isinfinity() or self._isinfinity():
2451 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002452 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002453 return context._raise_error(InvalidOperation,
2454 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002455
2456 # if we're not watching exponents, do a simple rescale
2457 if not watchexp:
2458 ans = self._rescale(exp._exp, rounding)
2459 # raise Inexact and Rounded where appropriate
2460 if ans._exp > self._exp:
2461 context._raise_error(Rounded)
2462 if ans != self:
2463 context._raise_error(Inexact)
2464 return ans
2465
2466 # exp._exp should be between Etiny and Emax
2467 if not (context.Etiny() <= exp._exp <= context.Emax):
2468 return context._raise_error(InvalidOperation,
2469 'target exponent out of bounds in quantize')
2470
2471 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002472 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002473 return ans._fix(context)
2474
2475 self_adjusted = self.adjusted()
2476 if self_adjusted > context.Emax:
2477 return context._raise_error(InvalidOperation,
2478 'exponent of quantize result too large for current context')
2479 if self_adjusted - exp._exp + 1 > context.prec:
2480 return context._raise_error(InvalidOperation,
2481 'quantize result has too many digits for current context')
2482
2483 ans = self._rescale(exp._exp, rounding)
2484 if ans.adjusted() > context.Emax:
2485 return context._raise_error(InvalidOperation,
2486 'exponent of quantize result too large for current context')
2487 if len(ans._int) > context.prec:
2488 return context._raise_error(InvalidOperation,
2489 'quantize result has too many digits for current context')
2490
2491 # raise appropriate flags
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002492 if ans and ans.adjusted() < context.Emin:
2493 context._raise_error(Subnormal)
Mark Dickinsonece06972010-05-04 14:37:14 +00002494 if ans._exp > self._exp:
2495 if ans != self:
2496 context._raise_error(Inexact)
2497 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002498
Mark Dickinsonece06972010-05-04 14:37:14 +00002499 # call to fix takes care of any necessary folddown, and
2500 # signals Clamped if necessary
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002501 ans = ans._fix(context)
2502 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002503
2504 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002505 """Return True if self and other have the same exponent; otherwise
2506 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002507
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002508 If either operand is a special value, the following rules are used:
2509 * return True if both operands are infinities
2510 * return True if both operands are NaNs
2511 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002512 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002513 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002514 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002515 return (self.is_nan() and other.is_nan() or
2516 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002517 return self._exp == other._exp
2518
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002519 def _rescale(self, exp, rounding):
2520 """Rescale self so that the exponent is exp, either by padding with zeros
2521 or by truncating digits, using the given rounding mode.
2522
2523 Specials are returned without change. This operation is
2524 quiet: it raises no flags, and uses no information from the
2525 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002526
2527 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002528 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002529 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002530 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002531 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002532 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002533 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002534
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002535 if self._exp >= exp:
2536 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002537 return _dec_from_triple(self._sign,
2538 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002539
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002540 # too many digits; round and lose data. If self.adjusted() <
2541 # exp-1, replace self by 10**(exp-1) before rounding
2542 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002543 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002544 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002545 digits = 0
2546 this_function = getattr(self, self._pick_rounding_function[rounding])
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002547 changed = this_function(digits)
2548 coeff = self._int[:digits] or '0'
2549 if changed == 1:
2550 coeff = str(int(coeff)+1)
2551 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002552
Christian Heimesf16baeb2008-02-29 14:57:44 +00002553 def _round(self, places, rounding):
2554 """Round a nonzero, nonspecial Decimal to a fixed number of
2555 significant figures, using the given rounding mode.
2556
2557 Infinities, NaNs and zeros are returned unaltered.
2558
2559 This operation is quiet: it raises no flags, and uses no
2560 information from the context.
2561
2562 """
2563 if places <= 0:
2564 raise ValueError("argument should be at least 1 in _round")
2565 if self._is_special or not self:
2566 return Decimal(self)
2567 ans = self._rescale(self.adjusted()+1-places, rounding)
2568 # it can happen that the rescale alters the adjusted exponent;
2569 # for example when rounding 99.97 to 3 significant figures.
2570 # When this happens we end up with an extra 0 at the end of
2571 # the number; a second rescale fixes this.
2572 if ans.adjusted() != self.adjusted():
2573 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2574 return ans
2575
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002576 def to_integral_exact(self, rounding=None, context=None):
2577 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002578
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002579 If no rounding mode is specified, take the rounding mode from
2580 the context. This method raises the Rounded and Inexact flags
2581 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002582
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002583 See also: to_integral_value, which does exactly the same as
2584 this method except that it doesn't raise Inexact or Rounded.
2585 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002586 if self._is_special:
2587 ans = self._check_nans(context=context)
2588 if ans:
2589 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002590 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002591 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002592 return Decimal(self)
2593 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002594 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002595 if context is None:
2596 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002597 if rounding is None:
2598 rounding = context.rounding
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002599 ans = self._rescale(0, rounding)
2600 if ans != self:
2601 context._raise_error(Inexact)
Mark Dickinsonece06972010-05-04 14:37:14 +00002602 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002603 return ans
2604
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002605 def to_integral_value(self, rounding=None, context=None):
2606 """Rounds to the nearest integer, without raising inexact, rounded."""
2607 if context is None:
2608 context = getcontext()
2609 if rounding is None:
2610 rounding = context.rounding
2611 if self._is_special:
2612 ans = self._check_nans(context=context)
2613 if ans:
2614 return ans
2615 return Decimal(self)
2616 if self._exp >= 0:
2617 return Decimal(self)
2618 else:
2619 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002620
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002621 # the method name changed, but we provide also the old one, for compatibility
2622 to_integral = to_integral_value
2623
2624 def sqrt(self, context=None):
2625 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002626 if context is None:
2627 context = getcontext()
2628
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002629 if self._is_special:
2630 ans = self._check_nans(context=context)
2631 if ans:
2632 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002633
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002634 if self._isinfinity() and self._sign == 0:
2635 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002636
2637 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002638 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002639 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002640 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002641
2642 if self._sign == 1:
2643 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2644
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002645 # At this point self represents a positive number. Let p be
2646 # the desired precision and express self in the form c*100**e
2647 # with c a positive real number and e an integer, c and e
2648 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2649 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2650 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2651 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2652 # the closest integer to sqrt(c) with the even integer chosen
2653 # in the case of a tie.
2654 #
2655 # To ensure correct rounding in all cases, we use the
2656 # following trick: we compute the square root to an extra
2657 # place (precision p+1 instead of precision p), rounding down.
2658 # Then, if the result is inexact and its last digit is 0 or 5,
2659 # we increase the last digit to 1 or 6 respectively; if it's
2660 # exact we leave the last digit alone. Now the final round to
2661 # p places (or fewer in the case of underflow) will round
2662 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002663
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002664 # use an extra digit of precision
2665 prec = context.prec+1
2666
2667 # write argument in the form c*100**e where e = self._exp//2
2668 # is the 'ideal' exponent, to be used if the square root is
2669 # exactly representable. l is the number of 'digits' of c in
2670 # base 100, so that 100**(l-1) <= c < 100**l.
2671 op = _WorkRep(self)
2672 e = op.exp >> 1
2673 if op.exp & 1:
2674 c = op.int * 10
2675 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002676 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002677 c = op.int
2678 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002679
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002680 # rescale so that c has exactly prec base 100 'digits'
2681 shift = prec-l
2682 if shift >= 0:
2683 c *= 100**shift
2684 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002685 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002686 c, remainder = divmod(c, 100**-shift)
2687 exact = not remainder
2688 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002689
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002690 # find n = floor(sqrt(c)) using Newton's method
2691 n = 10**prec
2692 while True:
2693 q = c//n
2694 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002695 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002696 else:
2697 n = n + q >> 1
2698 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002699
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002700 if exact:
2701 # result is exact; rescale to use ideal exponent e
2702 if shift >= 0:
2703 # assert n % 10**shift == 0
2704 n //= 10**shift
2705 else:
2706 n *= 10**-shift
2707 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002708 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002709 # result is not exact; fix last digit as described above
2710 if n % 5 == 0:
2711 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002712
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002713 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002714
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002715 # round, and fit to current context
2716 context = context._shallow_copy()
2717 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002718 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002719 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002720
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002721 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002722
2723 def max(self, other, context=None):
2724 """Returns the larger value.
2725
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002726 Like max(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002727 NaN (and signals if one is sNaN). Also rounds.
2728 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002729 other = _convert_other(other, raiseit=True)
2730
2731 if context is None:
2732 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002733
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002734 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002735 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002736 # number is always returned
2737 sn = self._isnan()
2738 on = other._isnan()
2739 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002740 if on == 1 and sn == 0:
2741 return self._fix(context)
2742 if sn == 1 and on == 0:
2743 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002744 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002745
Christian Heimes77c02eb2008-02-09 02:18:51 +00002746 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002747 if c == 0:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002748 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002749 # then an ordering is applied:
2750 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002751 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002752 # positive sign and min returns the operand with the negative sign
2753 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002754 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002755 # the result. This is exactly the ordering used in compare_total.
2756 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002757
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002758 if c == -1:
2759 ans = other
2760 else:
2761 ans = self
2762
Christian Heimes2c181612007-12-17 20:04:13 +00002763 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002764
2765 def min(self, other, context=None):
2766 """Returns the smaller value.
2767
Guido van Rossumd8faa362007-04-27 19:54:29 +00002768 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002769 NaN (and signals if one is sNaN). Also rounds.
2770 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002771 other = _convert_other(other, raiseit=True)
2772
2773 if context is None:
2774 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002775
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002776 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002777 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002778 # number is always returned
2779 sn = self._isnan()
2780 on = other._isnan()
2781 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002782 if on == 1 and sn == 0:
2783 return self._fix(context)
2784 if sn == 1 and on == 0:
2785 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002786 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002787
Christian Heimes77c02eb2008-02-09 02:18:51 +00002788 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002789 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002790 c = self.compare_total(other)
2791
2792 if c == -1:
2793 ans = self
2794 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002795 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002796
Christian Heimes2c181612007-12-17 20:04:13 +00002797 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002798
2799 def _isinteger(self):
2800 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002801 if self._is_special:
2802 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002803 if self._exp >= 0:
2804 return True
2805 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002806 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002807
2808 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002809 """Returns True if self is even. Assumes self is an integer."""
2810 if not self or self._exp > 0:
2811 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002812 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002813
2814 def adjusted(self):
2815 """Return the adjusted exponent of self"""
2816 try:
2817 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002818 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002819 except TypeError:
2820 return 0
2821
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002822 def canonical(self, context=None):
2823 """Returns the same Decimal object.
2824
2825 As we do not have different encodings for the same number, the
2826 received object already is in its canonical form.
2827 """
2828 return self
2829
2830 def compare_signal(self, other, context=None):
2831 """Compares self to the other operand numerically.
2832
2833 It's pretty much like compare(), but all NaNs signal, with signaling
2834 NaNs taking precedence over quiet NaNs.
2835 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002836 other = _convert_other(other, raiseit = True)
2837 ans = self._compare_check_nans(other, context)
2838 if ans:
2839 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002840 return self.compare(other, context=context)
2841
2842 def compare_total(self, other):
2843 """Compares self to other using the abstract representations.
2844
2845 This is not like the standard compare, which use their numerical
2846 value. Note that a total ordering is defined for all possible abstract
2847 representations.
2848 """
Mark Dickinson9050bb22009-10-29 12:25:07 +00002849 other = _convert_other(other, raiseit=True)
2850
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002851 # if one is negative and the other is positive, it's easy
2852 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002853 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002854 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002855 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002856 sign = self._sign
2857
2858 # let's handle both NaN types
2859 self_nan = self._isnan()
2860 other_nan = other._isnan()
2861 if self_nan or other_nan:
2862 if self_nan == other_nan:
Mark Dickinson7a6bcce2009-08-28 13:44:35 +00002863 # compare payloads as though they're integers
2864 self_key = len(self._int), self._int
2865 other_key = len(other._int), other._int
2866 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002867 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002868 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002869 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002870 return _NegativeOne
Mark Dickinson7a6bcce2009-08-28 13:44:35 +00002871 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002872 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002873 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002874 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002875 return _One
2876 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002877
2878 if sign:
2879 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002880 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002881 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002882 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002883 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002884 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002885 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002886 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002887 else:
2888 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002889 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002890 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002891 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002892 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002893 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002894 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002895 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002896
2897 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002898 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002899 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002900 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002901
2902 if self._exp < other._exp:
2903 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002904 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002905 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002906 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002907 if self._exp > other._exp:
2908 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002909 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002910 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002911 return _One
2912 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002913
2914
2915 def compare_total_mag(self, other):
2916 """Compares self to other using abstract repr., ignoring sign.
2917
2918 Like compare_total, but with operand's sign ignored and assumed to be 0.
2919 """
Mark Dickinson9050bb22009-10-29 12:25:07 +00002920 other = _convert_other(other, raiseit=True)
2921
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002922 s = self.copy_abs()
2923 o = other.copy_abs()
2924 return s.compare_total(o)
2925
2926 def copy_abs(self):
2927 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002928 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002929
2930 def copy_negate(self):
2931 """Returns a copy with the sign inverted."""
2932 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002933 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002934 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002935 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002936
2937 def copy_sign(self, other):
2938 """Returns self with the sign of other."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002939 return _dec_from_triple(other._sign, self._int,
2940 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002941
2942 def exp(self, context=None):
2943 """Returns e ** self."""
2944
2945 if context is None:
2946 context = getcontext()
2947
2948 # exp(NaN) = NaN
2949 ans = self._check_nans(context=context)
2950 if ans:
2951 return ans
2952
2953 # exp(-Infinity) = 0
2954 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002955 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002956
2957 # exp(0) = 1
2958 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002959 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002960
2961 # exp(Infinity) = Infinity
2962 if self._isinfinity() == 1:
2963 return Decimal(self)
2964
2965 # the result is now guaranteed to be inexact (the true
2966 # mathematical result is transcendental). There's no need to
2967 # raise Rounded and Inexact here---they'll always be raised as
2968 # a result of the call to _fix.
2969 p = context.prec
2970 adj = self.adjusted()
2971
2972 # we only need to do any computation for quite a small range
2973 # of adjusted exponents---for example, -29 <= adj <= 10 for
2974 # the default context. For smaller exponent the result is
2975 # indistinguishable from 1 at the given precision, while for
2976 # larger exponent the result either overflows or underflows.
2977 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
2978 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002979 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002980 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
2981 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002982 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002983 elif self._sign == 0 and adj < -p:
2984 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002985 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002986 elif self._sign == 1 and adj < -p-1:
2987 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002988 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002989 # general case
2990 else:
2991 op = _WorkRep(self)
2992 c, e = op.int, op.exp
2993 if op.sign == 1:
2994 c = -c
2995
2996 # compute correctly rounded result: increase precision by
2997 # 3 digits at a time until we get an unambiguously
2998 # roundable result
2999 extra = 3
3000 while True:
3001 coeff, exp = _dexp(c, e, p+extra)
3002 if coeff % (5*10**(len(str(coeff))-p-1)):
3003 break
3004 extra += 3
3005
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003006 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003007
3008 # at this stage, ans should round correctly with *any*
3009 # rounding mode, not just with ROUND_HALF_EVEN
3010 context = context._shallow_copy()
3011 rounding = context._set_rounding(ROUND_HALF_EVEN)
3012 ans = ans._fix(context)
3013 context.rounding = rounding
3014
3015 return ans
3016
3017 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003018 """Return True if self is canonical; otherwise return False.
3019
3020 Currently, the encoding of a Decimal instance is always
3021 canonical, so this method returns True for any Decimal.
3022 """
3023 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003024
3025 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003026 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003027
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003028 A Decimal instance is considered finite if it is neither
3029 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003030 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003031 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003032
3033 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003034 """Return True if self is infinite; otherwise return False."""
3035 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003036
3037 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003038 """Return True if self is a qNaN or sNaN; otherwise return False."""
3039 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003040
3041 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003042 """Return True if self is a normal number; otherwise return False."""
3043 if self._is_special or not self:
3044 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003045 if context is None:
3046 context = getcontext()
Mark Dickinson2d4fce22009-10-20 13:40:25 +00003047 return context.Emin <= self.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003048
3049 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003050 """Return True if self is a quiet NaN; otherwise return False."""
3051 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003052
3053 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003054 """Return True if self is negative; otherwise return False."""
3055 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003056
3057 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003058 """Return True if self is a signaling NaN; otherwise return False."""
3059 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003060
3061 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003062 """Return True if self is subnormal; otherwise return False."""
3063 if self._is_special or not self:
3064 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003065 if context is None:
3066 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003067 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003068
3069 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003070 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003071 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003072
3073 def _ln_exp_bound(self):
3074 """Compute a lower bound for the adjusted exponent of self.ln().
3075 In other words, compute r such that self.ln() >= 10**r. Assumes
3076 that self is finite and positive and that self != 1.
3077 """
3078
3079 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3080 adj = self._exp + len(self._int) - 1
3081 if adj >= 1:
3082 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3083 return len(str(adj*23//10)) - 1
3084 if adj <= -2:
3085 # argument <= 0.1
3086 return len(str((-1-adj)*23//10)) - 1
3087 op = _WorkRep(self)
3088 c, e = op.int, op.exp
3089 if adj == 0:
3090 # 1 < self < 10
3091 num = str(c-10**-e)
3092 den = str(c)
3093 return len(num) - len(den) - (num < den)
3094 # adj == -1, 0.1 <= self < 1
3095 return e + len(str(10**-e - c)) - 1
3096
3097
3098 def ln(self, context=None):
3099 """Returns the natural (base e) logarithm of self."""
3100
3101 if context is None:
3102 context = getcontext()
3103
3104 # ln(NaN) = NaN
3105 ans = self._check_nans(context=context)
3106 if ans:
3107 return ans
3108
3109 # ln(0.0) == -Infinity
3110 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003111 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003112
3113 # ln(Infinity) = Infinity
3114 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003115 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003116
3117 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003118 if self == _One:
3119 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003120
3121 # ln(negative) raises InvalidOperation
3122 if self._sign == 1:
3123 return context._raise_error(InvalidOperation,
3124 'ln of a negative value')
3125
3126 # result is irrational, so necessarily inexact
3127 op = _WorkRep(self)
3128 c, e = op.int, op.exp
3129 p = context.prec
3130
3131 # correctly rounded result: repeatedly increase precision by 3
3132 # until we get an unambiguously roundable result
3133 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3134 while True:
3135 coeff = _dlog(c, e, places)
3136 # assert len(str(abs(coeff)))-p >= 1
3137 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3138 break
3139 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003140 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003141
3142 context = context._shallow_copy()
3143 rounding = context._set_rounding(ROUND_HALF_EVEN)
3144 ans = ans._fix(context)
3145 context.rounding = rounding
3146 return ans
3147
3148 def _log10_exp_bound(self):
3149 """Compute a lower bound for the adjusted exponent of self.log10().
3150 In other words, find r such that self.log10() >= 10**r.
3151 Assumes that self is finite and positive and that self != 1.
3152 """
3153
3154 # For x >= 10 or x < 0.1 we only need a bound on the integer
3155 # part of log10(self), and this comes directly from the
3156 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3157 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3158 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3159
3160 adj = self._exp + len(self._int) - 1
3161 if adj >= 1:
3162 # self >= 10
3163 return len(str(adj))-1
3164 if adj <= -2:
3165 # self < 0.1
3166 return len(str(-1-adj))-1
3167 op = _WorkRep(self)
3168 c, e = op.int, op.exp
3169 if adj == 0:
3170 # 1 < self < 10
3171 num = str(c-10**-e)
3172 den = str(231*c)
3173 return len(num) - len(den) - (num < den) + 2
3174 # adj == -1, 0.1 <= self < 1
3175 num = str(10**-e-c)
3176 return len(num) + e - (num < "231") - 1
3177
3178 def log10(self, context=None):
3179 """Returns the base 10 logarithm of self."""
3180
3181 if context is None:
3182 context = getcontext()
3183
3184 # log10(NaN) = NaN
3185 ans = self._check_nans(context=context)
3186 if ans:
3187 return ans
3188
3189 # log10(0.0) == -Infinity
3190 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003191 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003192
3193 # log10(Infinity) = Infinity
3194 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003195 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003196
3197 # log10(negative or -Infinity) raises InvalidOperation
3198 if self._sign == 1:
3199 return context._raise_error(InvalidOperation,
3200 'log10 of a negative value')
3201
3202 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003203 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003204 # answer may need rounding
3205 ans = Decimal(self._exp + len(self._int) - 1)
3206 else:
3207 # result is irrational, so necessarily inexact
3208 op = _WorkRep(self)
3209 c, e = op.int, op.exp
3210 p = context.prec
3211
3212 # correctly rounded result: repeatedly increase precision
3213 # until result is unambiguously roundable
3214 places = p-self._log10_exp_bound()+2
3215 while True:
3216 coeff = _dlog10(c, e, places)
3217 # assert len(str(abs(coeff)))-p >= 1
3218 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3219 break
3220 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003221 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003222
3223 context = context._shallow_copy()
3224 rounding = context._set_rounding(ROUND_HALF_EVEN)
3225 ans = ans._fix(context)
3226 context.rounding = rounding
3227 return ans
3228
3229 def logb(self, context=None):
3230 """ Returns the exponent of the magnitude of self's MSD.
3231
3232 The result is the integer which is the exponent of the magnitude
3233 of the most significant digit of self (as though it were truncated
3234 to a single digit while maintaining the value of that digit and
3235 without limiting the resulting exponent).
3236 """
3237 # logb(NaN) = NaN
3238 ans = self._check_nans(context=context)
3239 if ans:
3240 return ans
3241
3242 if context is None:
3243 context = getcontext()
3244
3245 # logb(+/-Inf) = +Inf
3246 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003247 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003248
3249 # logb(0) = -Inf, DivisionByZero
3250 if not self:
3251 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3252
3253 # otherwise, simply return the adjusted exponent of self, as a
3254 # Decimal. Note that no attempt is made to fit the result
3255 # into the current context.
Mark Dickinsonb0907612009-10-07 19:24:43 +00003256 ans = Decimal(self.adjusted())
3257 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003258
3259 def _islogical(self):
3260 """Return True if self is a logical operand.
3261
Christian Heimes679db4a2008-01-18 09:56:22 +00003262 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003263 an exponent of 0, and a coefficient whose digits must all be
3264 either 0 or 1.
3265 """
3266 if self._sign != 0 or self._exp != 0:
3267 return False
3268 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003269 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003270 return False
3271 return True
3272
3273 def _fill_logical(self, context, opa, opb):
3274 dif = context.prec - len(opa)
3275 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003276 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003277 elif dif < 0:
3278 opa = opa[-context.prec:]
3279 dif = context.prec - len(opb)
3280 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003281 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003282 elif dif < 0:
3283 opb = opb[-context.prec:]
3284 return opa, opb
3285
3286 def logical_and(self, other, context=None):
3287 """Applies an 'and' operation between self and other's digits."""
3288 if context is None:
3289 context = getcontext()
Mark Dickinson9050bb22009-10-29 12:25:07 +00003290
3291 other = _convert_other(other, raiseit=True)
3292
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003293 if not self._islogical() or not other._islogical():
3294 return context._raise_error(InvalidOperation)
3295
3296 # fill to context.prec
3297 (opa, opb) = self._fill_logical(context, self._int, other._int)
3298
3299 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003300 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3301 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003302
3303 def logical_invert(self, context=None):
3304 """Invert all its digits."""
3305 if context is None:
3306 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003307 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3308 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003309
3310 def logical_or(self, other, context=None):
3311 """Applies an 'or' operation between self and other's digits."""
3312 if context is None:
3313 context = getcontext()
Mark Dickinson9050bb22009-10-29 12:25:07 +00003314
3315 other = _convert_other(other, raiseit=True)
3316
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003317 if not self._islogical() or not other._islogical():
3318 return context._raise_error(InvalidOperation)
3319
3320 # fill to context.prec
3321 (opa, opb) = self._fill_logical(context, self._int, other._int)
3322
3323 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003324 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003325 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003326
3327 def logical_xor(self, other, context=None):
3328 """Applies an 'xor' operation between self and other's digits."""
3329 if context is None:
3330 context = getcontext()
Mark Dickinson9050bb22009-10-29 12:25:07 +00003331
3332 other = _convert_other(other, raiseit=True)
3333
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003334 if not self._islogical() or not other._islogical():
3335 return context._raise_error(InvalidOperation)
3336
3337 # fill to context.prec
3338 (opa, opb) = self._fill_logical(context, self._int, other._int)
3339
3340 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003341 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003342 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003343
3344 def max_mag(self, other, context=None):
3345 """Compares the values numerically with their sign ignored."""
3346 other = _convert_other(other, raiseit=True)
3347
3348 if context is None:
3349 context = getcontext()
3350
3351 if self._is_special or other._is_special:
3352 # If one operand is a quiet NaN and the other is number, then the
3353 # number is always returned
3354 sn = self._isnan()
3355 on = other._isnan()
3356 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003357 if on == 1 and sn == 0:
3358 return self._fix(context)
3359 if sn == 1 and on == 0:
3360 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003361 return self._check_nans(other, context)
3362
Christian Heimes77c02eb2008-02-09 02:18:51 +00003363 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003364 if c == 0:
3365 c = self.compare_total(other)
3366
3367 if c == -1:
3368 ans = other
3369 else:
3370 ans = self
3371
Christian Heimes2c181612007-12-17 20:04:13 +00003372 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003373
3374 def min_mag(self, other, context=None):
3375 """Compares the values numerically with their sign ignored."""
3376 other = _convert_other(other, raiseit=True)
3377
3378 if context is None:
3379 context = getcontext()
3380
3381 if self._is_special or other._is_special:
3382 # If one operand is a quiet NaN and the other is number, then the
3383 # number is always returned
3384 sn = self._isnan()
3385 on = other._isnan()
3386 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003387 if on == 1 and sn == 0:
3388 return self._fix(context)
3389 if sn == 1 and on == 0:
3390 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003391 return self._check_nans(other, context)
3392
Christian Heimes77c02eb2008-02-09 02:18:51 +00003393 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003394 if c == 0:
3395 c = self.compare_total(other)
3396
3397 if c == -1:
3398 ans = self
3399 else:
3400 ans = other
3401
Christian Heimes2c181612007-12-17 20:04:13 +00003402 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003403
3404 def next_minus(self, context=None):
3405 """Returns the largest representable number smaller than itself."""
3406 if context is None:
3407 context = getcontext()
3408
3409 ans = self._check_nans(context=context)
3410 if ans:
3411 return ans
3412
3413 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003414 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003415 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003416 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003417
3418 context = context.copy()
3419 context._set_rounding(ROUND_FLOOR)
3420 context._ignore_all_flags()
3421 new_self = self._fix(context)
3422 if new_self != self:
3423 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003424 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3425 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003426
3427 def next_plus(self, context=None):
3428 """Returns the smallest representable number larger than itself."""
3429 if context is None:
3430 context = getcontext()
3431
3432 ans = self._check_nans(context=context)
3433 if ans:
3434 return ans
3435
3436 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003437 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003438 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003439 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003440
3441 context = context.copy()
3442 context._set_rounding(ROUND_CEILING)
3443 context._ignore_all_flags()
3444 new_self = self._fix(context)
3445 if new_self != self:
3446 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003447 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3448 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003449
3450 def next_toward(self, other, context=None):
3451 """Returns the number closest to self, in the direction towards other.
3452
3453 The result is the closest representable number to self
3454 (excluding self) that is in the direction towards other,
3455 unless both have the same value. If the two operands are
3456 numerically equal, then the result is a copy of self with the
3457 sign set to be the same as the sign of other.
3458 """
3459 other = _convert_other(other, raiseit=True)
3460
3461 if context is None:
3462 context = getcontext()
3463
3464 ans = self._check_nans(other, context)
3465 if ans:
3466 return ans
3467
Christian Heimes77c02eb2008-02-09 02:18:51 +00003468 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003469 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003470 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003471
3472 if comparison == -1:
3473 ans = self.next_plus(context)
3474 else: # comparison == 1
3475 ans = self.next_minus(context)
3476
3477 # decide which flags to raise using value of ans
3478 if ans._isinfinity():
3479 context._raise_error(Overflow,
3480 'Infinite result from next_toward',
3481 ans._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003482 context._raise_error(Inexact)
Mark Dickinsonece06972010-05-04 14:37:14 +00003483 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003484 elif ans.adjusted() < context.Emin:
3485 context._raise_error(Underflow)
3486 context._raise_error(Subnormal)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003487 context._raise_error(Inexact)
Mark Dickinsonece06972010-05-04 14:37:14 +00003488 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003489 # if precision == 1 then we don't raise Clamped for a
3490 # result 0E-Etiny.
3491 if not ans:
3492 context._raise_error(Clamped)
3493
3494 return ans
3495
3496 def number_class(self, context=None):
3497 """Returns an indication of the class of self.
3498
3499 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003500 sNaN
3501 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003502 -Infinity
3503 -Normal
3504 -Subnormal
3505 -Zero
3506 +Zero
3507 +Subnormal
3508 +Normal
3509 +Infinity
3510 """
3511 if self.is_snan():
3512 return "sNaN"
3513 if self.is_qnan():
3514 return "NaN"
3515 inf = self._isinfinity()
3516 if inf == 1:
3517 return "+Infinity"
3518 if inf == -1:
3519 return "-Infinity"
3520 if self.is_zero():
3521 if self._sign:
3522 return "-Zero"
3523 else:
3524 return "+Zero"
3525 if context is None:
3526 context = getcontext()
3527 if self.is_subnormal(context=context):
3528 if self._sign:
3529 return "-Subnormal"
3530 else:
3531 return "+Subnormal"
3532 # just a normal, regular, boring number, :)
3533 if self._sign:
3534 return "-Normal"
3535 else:
3536 return "+Normal"
3537
3538 def radix(self):
3539 """Just returns 10, as this is Decimal, :)"""
3540 return Decimal(10)
3541
3542 def rotate(self, other, context=None):
3543 """Returns a rotated copy of self, value-of-other times."""
3544 if context is None:
3545 context = getcontext()
3546
Mark Dickinson9050bb22009-10-29 12:25:07 +00003547 other = _convert_other(other, raiseit=True)
3548
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003549 ans = self._check_nans(other, context)
3550 if ans:
3551 return ans
3552
3553 if other._exp != 0:
3554 return context._raise_error(InvalidOperation)
3555 if not (-context.prec <= int(other) <= context.prec):
3556 return context._raise_error(InvalidOperation)
3557
3558 if self._isinfinity():
3559 return Decimal(self)
3560
3561 # get values, pad if necessary
3562 torot = int(other)
3563 rotdig = self._int
3564 topad = context.prec - len(rotdig)
Mark Dickinson9050bb22009-10-29 12:25:07 +00003565 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003566 rotdig = '0'*topad + rotdig
Mark Dickinson9050bb22009-10-29 12:25:07 +00003567 elif topad < 0:
3568 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003569
3570 # let's rotate!
3571 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003572 return _dec_from_triple(self._sign,
3573 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003574
Mark Dickinson9050bb22009-10-29 12:25:07 +00003575 def scaleb(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003576 """Returns self operand after adding the second value to its exp."""
3577 if context is None:
3578 context = getcontext()
3579
Mark Dickinson9050bb22009-10-29 12:25:07 +00003580 other = _convert_other(other, raiseit=True)
3581
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003582 ans = self._check_nans(other, context)
3583 if ans:
3584 return ans
3585
3586 if other._exp != 0:
3587 return context._raise_error(InvalidOperation)
3588 liminf = -2 * (context.Emax + context.prec)
3589 limsup = 2 * (context.Emax + context.prec)
3590 if not (liminf <= int(other) <= limsup):
3591 return context._raise_error(InvalidOperation)
3592
3593 if self._isinfinity():
3594 return Decimal(self)
3595
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003596 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003597 d = d._fix(context)
3598 return d
3599
3600 def shift(self, other, context=None):
3601 """Returns a shifted copy of self, value-of-other times."""
3602 if context is None:
3603 context = getcontext()
3604
Mark Dickinson9050bb22009-10-29 12:25:07 +00003605 other = _convert_other(other, raiseit=True)
3606
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003607 ans = self._check_nans(other, context)
3608 if ans:
3609 return ans
3610
3611 if other._exp != 0:
3612 return context._raise_error(InvalidOperation)
3613 if not (-context.prec <= int(other) <= context.prec):
3614 return context._raise_error(InvalidOperation)
3615
3616 if self._isinfinity():
3617 return Decimal(self)
3618
3619 # get values, pad if necessary
3620 torot = int(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003621 rotdig = self._int
3622 topad = context.prec - len(rotdig)
Mark Dickinson9050bb22009-10-29 12:25:07 +00003623 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003624 rotdig = '0'*topad + rotdig
Mark Dickinson9050bb22009-10-29 12:25:07 +00003625 elif topad < 0:
3626 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003627
3628 # let's shift!
3629 if torot < 0:
Mark Dickinson9050bb22009-10-29 12:25:07 +00003630 shifted = rotdig[:torot]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003631 else:
Mark Dickinson9050bb22009-10-29 12:25:07 +00003632 shifted = rotdig + '0'*torot
3633 shifted = shifted[-context.prec:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003634
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003635 return _dec_from_triple(self._sign,
Mark Dickinson9050bb22009-10-29 12:25:07 +00003636 shifted.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003637
Guido van Rossumd8faa362007-04-27 19:54:29 +00003638 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003639 def __reduce__(self):
3640 return (self.__class__, (str(self),))
3641
3642 def __copy__(self):
3643 if type(self) == Decimal:
3644 return self # I'm immutable; therefore I am my own clone
3645 return self.__class__(str(self))
3646
3647 def __deepcopy__(self, memo):
3648 if type(self) == Decimal:
3649 return self # My components are also immutable
3650 return self.__class__(str(self))
3651
Mark Dickinson79f52032009-03-17 23:12:51 +00003652 # PEP 3101 support. the _localeconv keyword argument should be
3653 # considered private: it's provided for ease of testing only.
3654 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003655 """Format a Decimal instance according to the given specifier.
3656
3657 The specifier should be a standard format specifier, with the
3658 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003659 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3660 type is omitted it defaults to 'g' or 'G', depending on the
3661 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003662 """
3663
3664 # Note: PEP 3101 says that if the type is not present then
3665 # there should be at least one digit after the decimal point.
3666 # We take the liberty of ignoring this requirement for
3667 # Decimal---it's presumably there to make sure that
3668 # format(float, '') behaves similarly to str(float).
3669 if context is None:
3670 context = getcontext()
3671
Mark Dickinson79f52032009-03-17 23:12:51 +00003672 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003673
Mark Dickinson79f52032009-03-17 23:12:51 +00003674 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003675 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003676 sign = _format_sign(self._sign, spec)
3677 body = str(self.copy_abs())
3678 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003679
3680 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003681 if spec['type'] is None:
3682 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003683
3684 # if type is '%', adjust exponent of self accordingly
3685 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003686 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3687
3688 # round if necessary, taking rounding mode from the context
3689 rounding = context.rounding
3690 precision = spec['precision']
3691 if precision is not None:
3692 if spec['type'] in 'eE':
3693 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003694 elif spec['type'] in 'fF%':
3695 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003696 elif spec['type'] in 'gG' and len(self._int) > precision:
3697 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003698 # special case: zeros with a positive exponent can't be
3699 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003700 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003701 self = self._rescale(0, rounding)
3702
3703 # figure out placement of the decimal point
3704 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003705 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003706 if not self and precision is not None:
3707 dotplace = 1 - precision
3708 else:
3709 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003710 elif spec['type'] in 'fF%':
3711 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003712 elif spec['type'] in 'gG':
3713 if self._exp <= 0 and leftdigits > -6:
3714 dotplace = leftdigits
3715 else:
3716 dotplace = 1
3717
Mark Dickinson79f52032009-03-17 23:12:51 +00003718 # find digits before and after decimal point, and get exponent
3719 if dotplace < 0:
3720 intpart = '0'
3721 fracpart = '0'*(-dotplace) + self._int
3722 elif dotplace > len(self._int):
3723 intpart = self._int + '0'*(dotplace-len(self._int))
3724 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003725 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003726 intpart = self._int[:dotplace] or '0'
3727 fracpart = self._int[dotplace:]
3728 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003729
Mark Dickinson79f52032009-03-17 23:12:51 +00003730 # done with the decimal-specific stuff; hand over the rest
3731 # of the formatting to the _format_number function
3732 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003733
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003734def _dec_from_triple(sign, coefficient, exponent, special=False):
3735 """Create a decimal instance directly, without any validation,
3736 normalization (e.g. removal of leading zeros) or argument
3737 conversion.
3738
3739 This function is for *internal use only*.
3740 """
3741
3742 self = object.__new__(Decimal)
3743 self._sign = sign
3744 self._int = coefficient
3745 self._exp = exponent
3746 self._is_special = special
3747
3748 return self
3749
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003750# Register Decimal as a kind of Number (an abstract base class).
3751# However, do not register it as Real (because Decimals are not
3752# interoperable with floats).
3753_numbers.Number.register(Decimal)
3754
3755
Guido van Rossumd8faa362007-04-27 19:54:29 +00003756##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003757
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003758
3759# get rounding method function:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003760rounding_functions = [name for name in Decimal.__dict__.keys()
3761 if name.startswith('_round_')]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003762for name in rounding_functions:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003763 # name is like _round_half_even, goes to the global ROUND_HALF_EVEN value.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003764 globalname = name[1:].upper()
3765 val = globals()[globalname]
3766 Decimal._pick_rounding_function[val] = name
3767
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003768del name, val, globalname, rounding_functions
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003769
Thomas Wouters89f507f2006-12-13 04:49:30 +00003770class _ContextManager(object):
3771 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003772
Thomas Wouters89f507f2006-12-13 04:49:30 +00003773 Sets a copy of the supplied context in __enter__() and restores
3774 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003775 """
3776 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003777 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003778 def __enter__(self):
3779 self.saved_context = getcontext()
3780 setcontext(self.new_context)
3781 return self.new_context
3782 def __exit__(self, t, v, tb):
3783 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003784
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003785class Context(object):
3786 """Contains the context for a Decimal instance.
3787
3788 Contains:
3789 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003790 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003791 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003792 raised when it is caused. Otherwise, a value is
3793 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003794 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003795 (Whether or not the trap_enabler is set)
3796 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003797 Emin - Minimum exponent
3798 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003799 capitals - If 1, 1*10^1 is printed as 1E+1.
3800 If 0, printed as 1e1
Raymond Hettingere0f15812004-07-05 05:36:39 +00003801 _clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003802 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003803
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003804 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003805 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003806 Emin=None, Emax=None,
Raymond Hettingere0f15812004-07-05 05:36:39 +00003807 capitals=None, _clamp=0,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003808 _ignored_flags=None):
3809 if flags is None:
3810 flags = []
3811 if _ignored_flags is None:
3812 _ignored_flags = []
Raymond Hettingerbf440692004-07-10 14:14:37 +00003813 if not isinstance(flags, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003814 flags = dict([(s, int(s in flags)) for s in _signals])
Raymond Hettingerbf440692004-07-10 14:14:37 +00003815 if traps is not None and not isinstance(traps, dict):
Christian Heimes81ee3ef2008-05-04 22:42:01 +00003816 traps = dict([(s, int(s in traps)) for s in _signals])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003817 for name, val in locals().items():
3818 if val is None:
Raymond Hettingereb260842005-06-07 18:52:34 +00003819 setattr(self, name, _copy.copy(getattr(DefaultContext, name)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003820 else:
3821 setattr(self, name, val)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003822 del self.self
3823
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003824 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003825 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003826 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003827 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
3828 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d'
3829 % vars(self))
3830 names = [f.__name__ for f, v in self.flags.items() if v]
3831 s.append('flags=[' + ', '.join(names) + ']')
3832 names = [t.__name__ for t, v in self.traps.items() if v]
3833 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003834 return ', '.join(s) + ')'
3835
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003836 def clear_flags(self):
3837 """Reset all flags to zero"""
3838 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003839 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003840
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003841 def _shallow_copy(self):
3842 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003843 nc = Context(self.prec, self.rounding, self.traps,
3844 self.flags, self.Emin, self.Emax,
3845 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003846 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003847
3848 def copy(self):
3849 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003850 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003851 self.flags.copy(), self.Emin, self.Emax,
3852 self.capitals, self._clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003853 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003854 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003855
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003856 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003857 """Handles an error
3858
3859 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003860 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah395653e2010-05-19 15:54:54 +00003861 trap_enabler is set, it reraises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003862 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003863 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003864 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003865 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003866 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003867 return error().handle(self, *args)
3868
Raymond Hettinger86173da2008-02-01 20:38:12 +00003869 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003870 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003871 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003872 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003873
3874 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003875 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003876 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003877
3878 def _ignore_all_flags(self):
3879 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003880 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003881
3882 def _ignore_flags(self, *flags):
3883 """Ignore the flags, if they are raised"""
3884 # Do not mutate-- This way, copies of a context leave the original
3885 # alone.
3886 self._ignored_flags = (self._ignored_flags + list(flags))
3887 return list(flags)
3888
3889 def _regard_flags(self, *flags):
3890 """Stop ignoring the flags, if they are raised"""
3891 if flags and isinstance(flags[0], (tuple,list)):
3892 flags = flags[0]
3893 for flag in flags:
3894 self._ignored_flags.remove(flag)
3895
Nick Coghland1abd252008-07-15 15:46:38 +00003896 # We inherit object.__hash__, so we must deny this explicitly
3897 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003898
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003899 def Etiny(self):
3900 """Returns Etiny (= Emin - prec + 1)"""
3901 return int(self.Emin - self.prec + 1)
3902
3903 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003904 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003905 return int(self.Emax - self.prec + 1)
3906
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003907 def _set_rounding(self, type):
3908 """Sets the rounding type.
3909
3910 Sets the rounding type, and returns the current (previous)
3911 rounding type. Often used like:
3912
3913 context = context.copy()
3914 # so you don't change the calling context
3915 # if an error occurs in the middle.
3916 rounding = context._set_rounding(ROUND_UP)
3917 val = self.__sub__(other, context=context)
3918 context._set_rounding(rounding)
3919
3920 This will make it round up for that operation.
3921 """
3922 rounding = self.rounding
3923 self.rounding= type
3924 return rounding
3925
Raymond Hettingerfed52962004-07-14 15:41:57 +00003926 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003927 """Creates a new Decimal instance but using self as context.
3928
3929 This method implements the to-number operation of the
3930 IBM Decimal specification."""
3931
3932 if isinstance(num, str) and num != num.strip():
3933 return self._raise_error(ConversionSyntax,
3934 "no trailing or leading whitespace is "
3935 "permitted.")
3936
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003937 d = Decimal(num, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003938 if d._isnan() and len(d._int) > self.prec - self._clamp:
3939 return self._raise_error(ConversionSyntax,
3940 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003941 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003942
Raymond Hettinger771ed762009-01-03 19:20:32 +00003943 def create_decimal_from_float(self, f):
3944 """Creates a new Decimal instance from a float but rounding using self
3945 as the context.
3946
3947 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3948 >>> context.create_decimal_from_float(3.1415926535897932)
3949 Decimal('3.1415')
3950 >>> context = Context(prec=5, traps=[Inexact])
3951 >>> context.create_decimal_from_float(3.1415926535897932)
3952 Traceback (most recent call last):
3953 ...
3954 decimal.Inexact: None
3955
3956 """
3957 d = Decimal.from_float(f) # An exact conversion
3958 return d._fix(self) # Apply the context rounding
3959
Guido van Rossumd8faa362007-04-27 19:54:29 +00003960 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003961 def abs(self, a):
3962 """Returns the absolute value of the operand.
3963
3964 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00003965 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003966 the plus operation on the operand.
3967
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003968 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003969 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003970 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003971 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003972 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003973 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003974 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003975 Decimal('101.5')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003976 """
3977 return a.__abs__(context=self)
3978
3979 def add(self, a, b):
3980 """Return the sum of the two operands.
3981
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003982 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003983 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003984 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003985 Decimal('1.02E+4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003986 """
3987 return a.__add__(b, context=self)
3988
3989 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003990 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003991
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003992 def canonical(self, a):
3993 """Returns the same Decimal object.
3994
3995 As we do not have different encodings for the same number, the
3996 received object already is in its canonical form.
3997
3998 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00003999 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004000 """
4001 return a.canonical(context=self)
4002
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004003 def compare(self, a, b):
4004 """Compares values numerically.
4005
4006 If the signs of the operands differ, a value representing each operand
4007 ('-1' if the operand is less than zero, '0' if the operand is zero or
4008 negative zero, or '1' if the operand is greater than zero) is used in
4009 place of that operand for the comparison instead of the actual
4010 operand.
4011
4012 The comparison is then effected by subtracting the second operand from
4013 the first and then returning a value according to the result of the
4014 subtraction: '-1' if the result is less than zero, '0' if the result is
4015 zero or negative zero, or '1' if the result is greater than zero.
4016
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004017 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004018 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004019 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004020 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004021 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004022 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004023 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004024 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004025 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004026 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004027 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004028 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004029 """
4030 return a.compare(b, context=self)
4031
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004032 def compare_signal(self, a, b):
4033 """Compares the values of the two operands numerically.
4034
4035 It's pretty much like compare(), but all NaNs signal, with signaling
4036 NaNs taking precedence over quiet NaNs.
4037
4038 >>> c = ExtendedContext
4039 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004040 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004041 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004042 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004043 >>> c.flags[InvalidOperation] = 0
4044 >>> print(c.flags[InvalidOperation])
4045 0
4046 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004047 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004048 >>> print(c.flags[InvalidOperation])
4049 1
4050 >>> c.flags[InvalidOperation] = 0
4051 >>> print(c.flags[InvalidOperation])
4052 0
4053 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004054 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004055 >>> print(c.flags[InvalidOperation])
4056 1
4057 """
4058 return a.compare_signal(b, context=self)
4059
4060 def compare_total(self, a, b):
4061 """Compares two operands using their abstract representation.
4062
4063 This is not like the standard compare, which use their numerical
4064 value. Note that a total ordering is defined for all possible abstract
4065 representations.
4066
4067 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004068 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004069 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004070 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004071 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004072 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004073 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004074 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004075 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004076 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004077 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004078 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004079 """
4080 return a.compare_total(b)
4081
4082 def compare_total_mag(self, a, b):
4083 """Compares two operands using their abstract representation ignoring sign.
4084
4085 Like compare_total, but with operand's sign ignored and assumed to be 0.
4086 """
4087 return a.compare_total_mag(b)
4088
4089 def copy_abs(self, a):
4090 """Returns a copy of the operand with the sign set to 0.
4091
4092 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004093 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004094 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004095 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004096 """
4097 return a.copy_abs()
4098
4099 def copy_decimal(self, a):
4100 """Returns a copy of the decimal objet.
4101
4102 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004103 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004104 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004105 Decimal('-1.00')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004106 """
4107 return Decimal(a)
4108
4109 def copy_negate(self, a):
4110 """Returns a copy of the operand with the sign inverted.
4111
4112 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004113 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004114 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004115 Decimal('101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004116 """
4117 return a.copy_negate()
4118
4119 def copy_sign(self, a, b):
4120 """Copies the second operand's sign to the first one.
4121
4122 In detail, it returns a copy of the first operand with the sign
4123 equal to the sign of the second operand.
4124
4125 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004126 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004127 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004128 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004129 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004130 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004131 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004132 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004133 """
4134 return a.copy_sign(b)
4135
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004136 def divide(self, a, b):
4137 """Decimal division in a specified context.
4138
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004139 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004140 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004141 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004142 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004143 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004144 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004145 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004146 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004147 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004148 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004149 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004150 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004151 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004152 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004153 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004154 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004155 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004156 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004157 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004158 Decimal('1.20E+6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004159 """
Neal Norwitzbcc0db82006-03-24 08:14:36 +00004160 return a.__truediv__(b, context=self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004161
4162 def divide_int(self, a, b):
4163 """Divides two numbers and returns the integer part of the result.
4164
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004165 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004166 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004167 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004168 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004169 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004170 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004171 """
4172 return a.__floordiv__(b, context=self)
4173
4174 def divmod(self, a, b):
Mark Dickinson875e1e72010-01-06 16:23:13 +00004175 """Return (a // b, a % b)
4176
4177 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4178 (Decimal('2'), Decimal('2'))
4179 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4180 (Decimal('2'), Decimal('0'))
4181 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004182 return a.__divmod__(b, context=self)
4183
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004184 def exp(self, a):
4185 """Returns e ** a.
4186
4187 >>> c = ExtendedContext.copy()
4188 >>> c.Emin = -999
4189 >>> c.Emax = 999
4190 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004191 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004192 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004193 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004194 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004195 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004196 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004197 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004198 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004199 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004200 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004201 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004202 """
4203 return a.exp(context=self)
4204
4205 def fma(self, a, b, c):
4206 """Returns a multiplied by b, plus c.
4207
4208 The first two operands are multiplied together, using multiply,
4209 the third operand is then added to the result of that
4210 multiplication, using add, all with only one final rounding.
4211
4212 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004213 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004214 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004215 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004216 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004217 Decimal('1.38435736E+12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004218 """
4219 return a.fma(b, c, context=self)
4220
4221 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004222 """Return True if the operand is canonical; otherwise return False.
4223
4224 Currently, the encoding of a Decimal instance is always
4225 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004226
4227 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004228 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004229 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004230 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004231
4232 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004233 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004234
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004235 A Decimal instance is considered finite if it is neither
4236 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004237
4238 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004239 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004240 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004241 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004242 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004243 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004244 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004245 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004246 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004247 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004248 """
4249 return a.is_finite()
4250
4251 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004252 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004253
4254 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004255 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004256 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004257 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004258 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004259 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004260 """
4261 return a.is_infinite()
4262
4263 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004264 """Return True if the operand is a qNaN or sNaN;
4265 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004266
4267 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004268 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004269 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004270 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004271 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004272 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004273 """
4274 return a.is_nan()
4275
4276 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004277 """Return True if the operand is a normal number;
4278 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004279
4280 >>> c = ExtendedContext.copy()
4281 >>> c.Emin = -999
4282 >>> c.Emax = 999
4283 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004284 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004285 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004286 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004287 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004288 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004289 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004290 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004291 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004292 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004293 """
4294 return a.is_normal(context=self)
4295
4296 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004297 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004298
4299 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004300 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004301 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004302 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004303 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004304 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004305 """
4306 return a.is_qnan()
4307
4308 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004309 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004310
4311 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004312 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004313 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004314 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004315 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004316 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004317 """
4318 return a.is_signed()
4319
4320 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004321 """Return True if the operand is a signaling NaN;
4322 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004323
4324 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004325 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004326 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004327 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004328 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004329 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004330 """
4331 return a.is_snan()
4332
4333 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004334 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004335
4336 >>> c = ExtendedContext.copy()
4337 >>> c.Emin = -999
4338 >>> c.Emax = 999
4339 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004340 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004341 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004342 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004343 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004344 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004345 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004346 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004347 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004348 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004349 """
4350 return a.is_subnormal(context=self)
4351
4352 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004353 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004354
4355 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004356 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004357 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004358 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004359 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004360 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004361 """
4362 return a.is_zero()
4363
4364 def ln(self, a):
4365 """Returns the natural (base e) logarithm of the operand.
4366
4367 >>> c = ExtendedContext.copy()
4368 >>> c.Emin = -999
4369 >>> c.Emax = 999
4370 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004371 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004372 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004373 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004374 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004375 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004376 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004377 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004378 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004379 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004380 """
4381 return a.ln(context=self)
4382
4383 def log10(self, a):
4384 """Returns the base 10 logarithm of the operand.
4385
4386 >>> c = ExtendedContext.copy()
4387 >>> c.Emin = -999
4388 >>> c.Emax = 999
4389 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004390 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004391 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004392 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004393 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004394 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004395 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004396 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004397 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004398 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004399 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004400 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004401 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004402 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004403 """
4404 return a.log10(context=self)
4405
4406 def logb(self, a):
4407 """ Returns the exponent of the magnitude of the operand's MSD.
4408
4409 The result is the integer which is the exponent of the magnitude
4410 of the most significant digit of the operand (as though the
4411 operand were truncated to a single digit while maintaining the
4412 value of that digit and without limiting the resulting exponent).
4413
4414 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004415 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004416 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004417 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004418 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004419 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004420 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004421 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004422 """
4423 return a.logb(context=self)
4424
4425 def logical_and(self, a, b):
4426 """Applies the logical operation 'and' between each operand's digits.
4427
4428 The operands must be both logical numbers.
4429
4430 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004431 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004432 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004433 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004434 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004435 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004436 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004437 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004438 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004439 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004440 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004441 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004442 """
4443 return a.logical_and(b, context=self)
4444
4445 def logical_invert(self, a):
4446 """Invert all the digits in the operand.
4447
4448 The operand must be a logical number.
4449
4450 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004451 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004452 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004453 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004454 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004455 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004456 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004457 Decimal('10101010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004458 """
4459 return a.logical_invert(context=self)
4460
4461 def logical_or(self, a, b):
4462 """Applies the logical operation 'or' between each operand's digits.
4463
4464 The operands must be both logical numbers.
4465
4466 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004467 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004468 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004469 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004470 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004471 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004472 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004473 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004474 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004475 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004476 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004477 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004478 """
4479 return a.logical_or(b, context=self)
4480
4481 def logical_xor(self, a, b):
4482 """Applies the logical operation 'xor' between each operand's digits.
4483
4484 The operands must be both logical numbers.
4485
4486 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004487 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004488 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004489 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004490 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004491 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004492 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004493 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004494 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004495 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004496 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004497 Decimal('1101')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004498 """
4499 return a.logical_xor(b, context=self)
4500
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004501 def max(self, a,b):
4502 """max compares two values numerically and returns the maximum.
4503
4504 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004505 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004506 operation. If they are numerically equal then the left-hand operand
4507 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004508 infinity) of the two operands is chosen as the result.
4509
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004510 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004511 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004512 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004513 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004514 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004515 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004516 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004517 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004518 """
4519 return a.max(b, context=self)
4520
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004521 def max_mag(self, a, b):
4522 """Compares the values numerically with their sign ignored."""
4523 return a.max_mag(b, context=self)
4524
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004525 def min(self, a,b):
4526 """min compares two values numerically and returns the minimum.
4527
4528 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004529 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004530 operation. If they are numerically equal then the left-hand operand
4531 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004532 infinity) of the two operands is chosen as the result.
4533
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004534 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004535 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004536 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004537 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004538 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004539 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004540 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004541 Decimal('7')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004542 """
4543 return a.min(b, context=self)
4544
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004545 def min_mag(self, a, b):
4546 """Compares the values numerically with their sign ignored."""
4547 return a.min_mag(b, context=self)
4548
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004549 def minus(self, a):
4550 """Minus corresponds to unary prefix minus in Python.
4551
4552 The operation is evaluated using the same rules as subtract; the
4553 operation minus(a) is calculated as subtract('0', a) where the '0'
4554 has the same exponent as the operand.
4555
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004556 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004557 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004558 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004559 Decimal('1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004560 """
4561 return a.__neg__(context=self)
4562
4563 def multiply(self, a, b):
4564 """multiply multiplies two operands.
4565
4566 If either operand is a special value then the general rules apply.
4567 Otherwise, the operands are multiplied together ('long multiplication'),
4568 resulting in a number which may be as long as the sum of the lengths
4569 of the two operands.
4570
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004571 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004572 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004573 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004574 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004575 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004576 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004577 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004578 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004579 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004580 Decimal('4.28135971E+11')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004581 """
4582 return a.__mul__(b, context=self)
4583
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004584 def next_minus(self, a):
4585 """Returns the largest representable number smaller than a.
4586
4587 >>> c = ExtendedContext.copy()
4588 >>> c.Emin = -999
4589 >>> c.Emax = 999
4590 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004591 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004592 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004593 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004594 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004595 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004596 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004597 Decimal('9.99999999E+999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004598 """
4599 return a.next_minus(context=self)
4600
4601 def next_plus(self, a):
4602 """Returns the smallest representable number larger than a.
4603
4604 >>> c = ExtendedContext.copy()
4605 >>> c.Emin = -999
4606 >>> c.Emax = 999
4607 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004608 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004609 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004610 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004611 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004612 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004613 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004614 Decimal('-9.99999999E+999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004615 """
4616 return a.next_plus(context=self)
4617
4618 def next_toward(self, a, b):
4619 """Returns the number closest to a, in direction towards b.
4620
4621 The result is the closest representable number from the first
4622 operand (but not the first operand) that is in the direction
4623 towards the second operand, unless the operands have the same
4624 value.
4625
4626 >>> c = ExtendedContext.copy()
4627 >>> c.Emin = -999
4628 >>> c.Emax = 999
4629 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004630 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004631 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004632 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004633 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004634 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004635 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004636 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004637 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004638 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004639 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004640 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004641 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004642 Decimal('-0.00')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004643 """
4644 return a.next_toward(b, context=self)
4645
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004646 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004647 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004648
4649 Essentially a plus operation with all trailing zeros removed from the
4650 result.
4651
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004652 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004653 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004654 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004655 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004656 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004657 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004658 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004659 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004660 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004661 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004662 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004663 Decimal('0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004664 """
4665 return a.normalize(context=self)
4666
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004667 def number_class(self, a):
4668 """Returns an indication of the class of the operand.
4669
4670 The class is one of the following strings:
4671 -sNaN
4672 -NaN
4673 -Infinity
4674 -Normal
4675 -Subnormal
4676 -Zero
4677 +Zero
4678 +Subnormal
4679 +Normal
4680 +Infinity
4681
4682 >>> c = Context(ExtendedContext)
4683 >>> c.Emin = -999
4684 >>> c.Emax = 999
4685 >>> c.number_class(Decimal('Infinity'))
4686 '+Infinity'
4687 >>> c.number_class(Decimal('1E-10'))
4688 '+Normal'
4689 >>> c.number_class(Decimal('2.50'))
4690 '+Normal'
4691 >>> c.number_class(Decimal('0.1E-999'))
4692 '+Subnormal'
4693 >>> c.number_class(Decimal('0'))
4694 '+Zero'
4695 >>> c.number_class(Decimal('-0'))
4696 '-Zero'
4697 >>> c.number_class(Decimal('-0.1E-999'))
4698 '-Subnormal'
4699 >>> c.number_class(Decimal('-1E-10'))
4700 '-Normal'
4701 >>> c.number_class(Decimal('-2.50'))
4702 '-Normal'
4703 >>> c.number_class(Decimal('-Infinity'))
4704 '-Infinity'
4705 >>> c.number_class(Decimal('NaN'))
4706 'NaN'
4707 >>> c.number_class(Decimal('-NaN'))
4708 'NaN'
4709 >>> c.number_class(Decimal('sNaN'))
4710 'sNaN'
4711 """
4712 return a.number_class(context=self)
4713
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004714 def plus(self, a):
4715 """Plus corresponds to unary prefix plus in Python.
4716
4717 The operation is evaluated using the same rules as add; the
4718 operation plus(a) is calculated as add('0', a) where the '0'
4719 has the same exponent as the operand.
4720
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004721 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004722 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004723 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004724 Decimal('-1.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004725 """
4726 return a.__pos__(context=self)
4727
4728 def power(self, a, b, modulo=None):
4729 """Raises a to the power of b, to modulo if given.
4730
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004731 With two arguments, compute a**b. If a is negative then b
4732 must be integral. The result will be inexact unless b is
4733 integral and the result is finite and can be expressed exactly
4734 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004735
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004736 With three arguments, compute (a**b) % modulo. For the
4737 three argument form, the following restrictions on the
4738 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004739
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004740 - all three arguments must be integral
4741 - b must be nonnegative
4742 - at least one of a or b must be nonzero
4743 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004744
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004745 The result of pow(a, b, modulo) is identical to the result
4746 that would be obtained by computing (a**b) % modulo with
4747 unbounded precision, but is computed more efficiently. It is
4748 always exact.
4749
4750 >>> c = ExtendedContext.copy()
4751 >>> c.Emin = -999
4752 >>> c.Emax = 999
4753 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004754 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004755 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004756 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004757 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004758 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004759 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004760 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004761 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004762 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004763 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004764 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004765 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004766 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004767 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004768 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004769 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004770 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004771 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004772 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004773 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004774 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004775 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004776 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004777 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004778 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004779
4780 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004781 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004782 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004783 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004784 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004785 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004786 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004787 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004788 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004789 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004790 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004791 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004792 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004793 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004794 """
4795 return a.__pow__(b, modulo, context=self)
4796
4797 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00004798 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004799
4800 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00004801 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004802 exponent is being increased), multiplied by a positive power of ten (if
4803 the exponent is being decreased), or is unchanged (if the exponent is
4804 already equal to that of the right-hand operand).
4805
4806 Unlike other operations, if the length of the coefficient after the
4807 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00004808 operation condition is raised. This guarantees that, unless there is
4809 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004810 equal to that of the right-hand operand.
4811
4812 Also unlike other operations, quantize will never raise Underflow, even
4813 if the result is subnormal and inexact.
4814
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004815 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004816 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004817 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004818 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004819 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004820 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004821 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004822 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004823 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004824 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004825 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004826 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004827 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004828 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004829 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004830 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004831 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004832 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004833 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004834 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004835 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004836 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004837 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004838 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004839 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004840 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004841 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004842 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004843 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004844 Decimal('2E+2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004845 """
4846 return a.quantize(b, context=self)
4847
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004848 def radix(self):
4849 """Just returns 10, as this is Decimal, :)
4850
4851 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004852 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004853 """
4854 return Decimal(10)
4855
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004856 def remainder(self, a, b):
4857 """Returns the remainder from integer division.
4858
4859 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00004860 calculating integer division as described for divide-integer, rounded
4861 to precision digits if necessary. The sign of the result, if
4862 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004863
4864 This operation will fail under the same conditions as integer division
4865 (that is, if integer division on the same two operands would fail, the
4866 remainder cannot be calculated).
4867
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004868 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004869 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004870 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004871 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004872 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004873 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004874 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004875 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004876 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004877 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004878 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004879 Decimal('1.0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004880 """
4881 return a.__mod__(b, context=self)
4882
4883 def remainder_near(self, a, b):
4884 """Returns to be "a - b * n", where n is the integer nearest the exact
4885 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00004886 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004887 sign of a.
4888
4889 This operation will fail under the same conditions as integer division
4890 (that is, if integer division on the same two operands would fail, the
4891 remainder cannot be calculated).
4892
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004893 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004894 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004895 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004896 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004897 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004898 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004899 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004900 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004901 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004902 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004903 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004904 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004905 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004906 Decimal('-0.3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004907 """
4908 return a.remainder_near(b, context=self)
4909
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004910 def rotate(self, a, b):
4911 """Returns a rotated copy of a, b times.
4912
4913 The coefficient of the result is a rotated copy of the digits in
4914 the coefficient of the first operand. The number of places of
4915 rotation is taken from the absolute value of the second operand,
4916 with the rotation being to the left if the second operand is
4917 positive or to the right otherwise.
4918
4919 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004920 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004921 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004922 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004923 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004924 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004925 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004926 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004927 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004928 Decimal('345678912')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004929 """
4930 return a.rotate(b, context=self)
4931
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004932 def same_quantum(self, a, b):
4933 """Returns True if the two operands have the same exponent.
4934
4935 The result is never affected by either the sign or the coefficient of
4936 either operand.
4937
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004938 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004939 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004940 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004941 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004942 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004943 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004944 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004945 True
4946 """
4947 return a.same_quantum(b)
4948
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004949 def scaleb (self, a, b):
4950 """Returns the first operand after adding the second value its exp.
4951
4952 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004953 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004954 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004955 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004956 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004957 Decimal('7.50E+3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004958 """
4959 return a.scaleb (b, context=self)
4960
4961 def shift(self, a, b):
4962 """Returns a shifted copy of a, b times.
4963
4964 The coefficient of the result is a shifted copy of the digits
4965 in the coefficient of the first operand. The number of places
4966 to shift is taken from the absolute value of the second operand,
4967 with the shift being to the left if the second operand is
4968 positive or to the right otherwise. Digits shifted into the
4969 coefficient are zeros.
4970
4971 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004972 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004973 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004974 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004975 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004976 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004977 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004978 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004979 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004980 Decimal('345678900')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004981 """
4982 return a.shift(b, context=self)
4983
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004984 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00004985 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004986
4987 If the result must be inexact, it is rounded using the round-half-even
4988 algorithm.
4989
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004990 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004991 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004992 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004993 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004994 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004995 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004996 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004997 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004998 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004999 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005000 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005001 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005002 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005003 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005004 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005005 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005006 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005007 Decimal('3.16227766')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005008 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005009 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005010 """
5011 return a.sqrt(context=self)
5012
5013 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005014 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005015
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005016 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005017 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005018 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005019 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005020 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005021 Decimal('-0.77')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005022 """
5023 return a.__sub__(b, context=self)
5024
5025 def to_eng_string(self, a):
5026 """Converts a number to a string, using scientific notation.
5027
5028 The operation is not affected by the context.
5029 """
5030 return a.to_eng_string(context=self)
5031
5032 def to_sci_string(self, a):
5033 """Converts a number to a string, using scientific notation.
5034
5035 The operation is not affected by the context.
5036 """
5037 return a.__str__(context=self)
5038
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005039 def to_integral_exact(self, a):
5040 """Rounds to an integer.
5041
5042 When the operand has a negative exponent, the result is the same
5043 as using the quantize() operation using the given operand as the
5044 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5045 of the operand as the precision setting; Inexact and Rounded flags
5046 are allowed in this operation. The rounding mode is taken from the
5047 context.
5048
5049 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005050 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005051 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005052 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005053 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005054 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005055 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005056 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005057 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005058 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005059 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005060 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005061 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005062 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005063 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005064 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005065 """
5066 return a.to_integral_exact(context=self)
5067
5068 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005069 """Rounds to an integer.
5070
5071 When the operand has a negative exponent, the result is the same
5072 as using the quantize() operation using the given operand as the
5073 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5074 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00005075 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005076
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005077 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005078 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005079 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005080 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005081 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005082 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005083 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005084 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005085 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005086 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005087 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005088 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005089 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005090 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005091 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005092 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005093 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005094 return a.to_integral_value(context=self)
5095
5096 # the method name changed, but we provide also the old one, for compatibility
5097 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005098
5099class _WorkRep(object):
5100 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005101 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005102 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005103 # exp: None, int, or string
5104
5105 def __init__(self, value=None):
5106 if value is None:
5107 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005108 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005109 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005110 elif isinstance(value, Decimal):
5111 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005112 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005113 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005114 else:
5115 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005116 self.sign = value[0]
5117 self.int = value[1]
5118 self.exp = value[2]
5119
5120 def __repr__(self):
5121 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5122
5123 __str__ = __repr__
5124
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005125
5126
Christian Heimes2c181612007-12-17 20:04:13 +00005127def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005128 """Normalizes op1, op2 to have the same exp and length of coefficient.
5129
5130 Done during addition.
5131 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005132 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005133 tmp = op2
5134 other = op1
5135 else:
5136 tmp = op1
5137 other = op2
5138
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005139 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5140 # Then adding 10**exp to tmp has the same effect (after rounding)
5141 # as adding any positive quantity smaller than 10**exp; similarly
5142 # for subtraction. So if other is smaller than 10**exp we replace
5143 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00005144 tmp_len = len(str(tmp.int))
5145 other_len = len(str(other.int))
5146 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5147 if other_len + other.exp - 1 < exp:
5148 other.int = 1
5149 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005150
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005151 tmp.int *= 10 ** (tmp.exp - other.exp)
5152 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005153 return op1, op2
5154
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005155##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005156
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005157# This function from Tim Peters was taken from here:
5158# http://mail.python.org/pipermail/python-list/1999-July/007758.html
5159# The correction being in the function definition is for speed, and
5160# the whole function is not resolved with math.log because of avoiding
5161# the use of floats.
5162def _nbits(n, correction = {
5163 '0': 4, '1': 3, '2': 2, '3': 2,
5164 '4': 1, '5': 1, '6': 1, '7': 1,
5165 '8': 0, '9': 0, 'a': 0, 'b': 0,
5166 'c': 0, 'd': 0, 'e': 0, 'f': 0}):
5167 """Number of bits in binary representation of the positive integer n,
5168 or 0 if n == 0.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005169 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005170 if n < 0:
5171 raise ValueError("The argument to _nbits should be nonnegative.")
5172 hex_n = "%x" % n
5173 return 4*len(hex_n) - correction[hex_n[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005174
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005175def _sqrt_nearest(n, a):
5176 """Closest integer to the square root of the positive integer n. a is
5177 an initial approximation to the square root. Any positive integer
5178 will do for a, but the closer a is to the square root of n the
5179 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005180
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005181 """
5182 if n <= 0 or a <= 0:
5183 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5184
5185 b=0
5186 while a != b:
5187 b, a = a, a--n//a>>1
5188 return a
5189
5190def _rshift_nearest(x, shift):
5191 """Given an integer x and a nonnegative integer shift, return closest
5192 integer to x / 2**shift; use round-to-even in case of a tie.
5193
5194 """
5195 b, q = 1 << shift, x >> shift
5196 return q + (2*(x & (b-1)) + (q&1) > b)
5197
5198def _div_nearest(a, b):
5199 """Closest integer to a/b, a and b positive integers; rounds to even
5200 in the case of a tie.
5201
5202 """
5203 q, r = divmod(a, b)
5204 return q + (2*r + (q&1) > b)
5205
5206def _ilog(x, M, L = 8):
5207 """Integer approximation to M*log(x/M), with absolute error boundable
5208 in terms only of x/M.
5209
5210 Given positive integers x and M, return an integer approximation to
5211 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5212 between the approximation and the exact result is at most 22. For
5213 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5214 both cases these are upper bounds on the error; it will usually be
5215 much smaller."""
5216
5217 # The basic algorithm is the following: let log1p be the function
5218 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5219 # the reduction
5220 #
5221 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5222 #
5223 # repeatedly until the argument to log1p is small (< 2**-L in
5224 # absolute value). For small y we can use the Taylor series
5225 # expansion
5226 #
5227 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5228 #
5229 # truncating at T such that y**T is small enough. The whole
5230 # computation is carried out in a form of fixed-point arithmetic,
5231 # with a real number z being represented by an integer
5232 # approximation to z*M. To avoid loss of precision, the y below
5233 # is actually an integer approximation to 2**R*y*M, where R is the
5234 # number of reductions performed so far.
5235
5236 y = x-M
5237 # argument reduction; R = number of reductions performed
5238 R = 0
5239 while (R <= L and abs(y) << L-R >= M or
5240 R > L and abs(y) >> R-L >= M):
5241 y = _div_nearest((M*y) << 1,
5242 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5243 R += 1
5244
5245 # Taylor series with T terms
5246 T = -int(-10*len(str(M))//(3*L))
5247 yshift = _rshift_nearest(y, R)
5248 w = _div_nearest(M, T)
5249 for k in range(T-1, 0, -1):
5250 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5251
5252 return _div_nearest(w*y, M)
5253
5254def _dlog10(c, e, p):
5255 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5256 approximation to 10**p * log10(c*10**e), with an absolute error of
5257 at most 1. Assumes that c*10**e is not exactly 1."""
5258
5259 # increase precision by 2; compensate for this by dividing
5260 # final result by 100
5261 p += 2
5262
5263 # write c*10**e as d*10**f with either:
5264 # f >= 0 and 1 <= d <= 10, or
5265 # f <= 0 and 0.1 <= d <= 1.
5266 # Thus for c*10**e close to 1, f = 0
5267 l = len(str(c))
5268 f = e+l - (e+l >= 1)
5269
5270 if p > 0:
5271 M = 10**p
5272 k = e+p-f
5273 if k >= 0:
5274 c *= 10**k
5275 else:
5276 c = _div_nearest(c, 10**-k)
5277
5278 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005279 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005280 log_d = _div_nearest(log_d*M, log_10)
5281 log_tenpower = f*M # exact
5282 else:
5283 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005284 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005285
5286 return _div_nearest(log_tenpower+log_d, 100)
5287
5288def _dlog(c, e, p):
5289 """Given integers c, e and p with c > 0, compute an integer
5290 approximation to 10**p * log(c*10**e), with an absolute error of
5291 at most 1. Assumes that c*10**e is not exactly 1."""
5292
5293 # Increase precision by 2. The precision increase is compensated
5294 # for at the end with a division by 100.
5295 p += 2
5296
5297 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5298 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5299 # as 10**p * log(d) + 10**p*f * log(10).
5300 l = len(str(c))
5301 f = e+l - (e+l >= 1)
5302
5303 # compute approximation to 10**p*log(d), with error < 27
5304 if p > 0:
5305 k = e+p-f
5306 if k >= 0:
5307 c *= 10**k
5308 else:
5309 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5310
5311 # _ilog magnifies existing error in c by a factor of at most 10
5312 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5313 else:
5314 # p <= 0: just approximate the whole thing by 0; error < 2.31
5315 log_d = 0
5316
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005317 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005318 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005319 extra = len(str(abs(f)))-1
5320 if p + extra >= 0:
5321 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5322 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5323 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005324 else:
5325 f_log_ten = 0
5326 else:
5327 f_log_ten = 0
5328
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005329 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005330 return _div_nearest(f_log_ten + log_d, 100)
5331
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005332class _Log10Memoize(object):
5333 """Class to compute, store, and allow retrieval of, digits of the
5334 constant log(10) = 2.302585.... This constant is needed by
5335 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5336 def __init__(self):
5337 self.digits = "23025850929940456840179914546843642076011014886"
5338
5339 def getdigits(self, p):
5340 """Given an integer p >= 0, return floor(10**p)*log(10).
5341
5342 For example, self.getdigits(3) returns 2302.
5343 """
5344 # digits are stored as a string, for quick conversion to
5345 # integer in the case that we've already computed enough
5346 # digits; the stored digits should always be correct
5347 # (truncated, not rounded to nearest).
5348 if p < 0:
5349 raise ValueError("p should be nonnegative")
5350
5351 if p >= len(self.digits):
5352 # compute p+3, p+6, p+9, ... digits; continue until at
5353 # least one of the extra digits is nonzero
5354 extra = 3
5355 while True:
5356 # compute p+extra digits, correct to within 1ulp
5357 M = 10**(p+extra+2)
5358 digits = str(_div_nearest(_ilog(10*M, M), 100))
5359 if digits[-extra:] != '0'*extra:
5360 break
5361 extra += 3
5362 # keep all reliable digits so far; remove trailing zeros
5363 # and next nonzero digit
5364 self.digits = digits.rstrip('0')[:-1]
5365 return int(self.digits[:p+1])
5366
5367_log10_digits = _Log10Memoize().getdigits
5368
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005369def _iexp(x, M, L=8):
5370 """Given integers x and M, M > 0, such that x/M is small in absolute
5371 value, compute an integer approximation to M*exp(x/M). For 0 <=
5372 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5373 is usually much smaller)."""
5374
5375 # Algorithm: to compute exp(z) for a real number z, first divide z
5376 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5377 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5378 # series
5379 #
5380 # expm1(x) = x + x**2/2! + x**3/3! + ...
5381 #
5382 # Now use the identity
5383 #
5384 # expm1(2x) = expm1(x)*(expm1(x)+2)
5385 #
5386 # R times to compute the sequence expm1(z/2**R),
5387 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5388
5389 # Find R such that x/2**R/M <= 2**-L
5390 R = _nbits((x<<L)//M)
5391
5392 # Taylor series. (2**L)**T > M
5393 T = -int(-10*len(str(M))//(3*L))
5394 y = _div_nearest(x, T)
5395 Mshift = M<<R
5396 for i in range(T-1, 0, -1):
5397 y = _div_nearest(x*(Mshift + y), Mshift * i)
5398
5399 # Expansion
5400 for k in range(R-1, -1, -1):
5401 Mshift = M<<(k+2)
5402 y = _div_nearest(y*(y+Mshift), Mshift)
5403
5404 return M+y
5405
5406def _dexp(c, e, p):
5407 """Compute an approximation to exp(c*10**e), with p decimal places of
5408 precision.
5409
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005410 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005411
5412 10**(p-1) <= d <= 10**p, and
5413 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5414
5415 In other words, d*10**f is an approximation to exp(c*10**e) with p
5416 digits of precision, and with an error in d of at most 1. This is
5417 almost, but not quite, the same as the error being < 1ulp: when d
5418 = 10**(p-1) the error could be up to 10 ulp."""
5419
5420 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5421 p += 2
5422
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005423 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005424 extra = max(0, e + len(str(c)) - 1)
5425 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005426
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005427 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005428 # rounding down
5429 shift = e+q
5430 if shift >= 0:
5431 cshift = c*10**shift
5432 else:
5433 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005434 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005435
5436 # reduce remainder back to original precision
5437 rem = _div_nearest(rem, 10**extra)
5438
5439 # error in result of _iexp < 120; error after division < 0.62
5440 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5441
5442def _dpower(xc, xe, yc, ye, p):
5443 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5444 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5445
5446 10**(p-1) <= c <= 10**p, and
5447 (c-1)*10**e < x**y < (c+1)*10**e
5448
5449 in other words, c*10**e is an approximation to x**y with p digits
5450 of precision, and with an error in c of at most 1. (This is
5451 almost, but not quite, the same as the error being < 1ulp: when c
5452 == 10**(p-1) we can only guarantee error < 10ulp.)
5453
5454 We assume that: x is positive and not equal to 1, and y is nonzero.
5455 """
5456
5457 # Find b such that 10**(b-1) <= |y| <= 10**b
5458 b = len(str(abs(yc))) + ye
5459
5460 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5461 lxc = _dlog(xc, xe, p+b+1)
5462
5463 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5464 shift = ye-b
5465 if shift >= 0:
5466 pc = lxc*yc*10**shift
5467 else:
5468 pc = _div_nearest(lxc*yc, 10**-shift)
5469
5470 if pc == 0:
5471 # we prefer a result that isn't exactly 1; this makes it
5472 # easier to compute a correctly rounded result in __pow__
5473 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5474 coeff, exp = 10**(p-1)+1, 1-p
5475 else:
5476 coeff, exp = 10**p-1, -p
5477 else:
5478 coeff, exp = _dexp(pc, -(p+1), p+1)
5479 coeff = _div_nearest(coeff, 10)
5480 exp += 1
5481
5482 return coeff, exp
5483
5484def _log10_lb(c, correction = {
5485 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5486 '6': 23, '7': 16, '8': 10, '9': 5}):
5487 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5488 if c <= 0:
5489 raise ValueError("The argument to _log10_lb should be nonnegative.")
5490 str_c = str(c)
5491 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005492
Guido van Rossumd8faa362007-04-27 19:54:29 +00005493##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005494
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005495def _convert_other(other, raiseit=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005496 """Convert other to Decimal.
5497
5498 Verifies that it's ok to use in an implicit construction.
5499 """
5500 if isinstance(other, Decimal):
5501 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005502 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005503 return Decimal(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005504 if raiseit:
5505 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005506 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005507
Guido van Rossumd8faa362007-04-27 19:54:29 +00005508##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005509
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005510# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005511# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005512
5513DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005514 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005515 traps=[DivisionByZero, Overflow, InvalidOperation],
5516 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005517 Emax=999999999,
5518 Emin=-999999999,
Raymond Hettingere0f15812004-07-05 05:36:39 +00005519 capitals=1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005520)
5521
5522# Pre-made alternate contexts offered by the specification
5523# Don't change these; the user should be able to select these
5524# contexts and be able to reproduce results from other implementations
5525# of the spec.
5526
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005527BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005528 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005529 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5530 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005531)
5532
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005533ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005534 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005535 traps=[],
5536 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005537)
5538
5539
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005540##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005541#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005542# Regular expression used for parsing numeric strings. Additional
5543# comments:
5544#
5545# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5546# whitespace. But note that the specification disallows whitespace in
5547# a numeric string.
5548#
5549# 2. For finite numbers (not infinities and NaNs) the body of the
5550# number between the optional sign and the optional exponent must have
5551# at least one decimal digit, possibly after the decimal point. The
Mark Dickinson8d238292009-08-02 10:16:33 +00005552# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005553
5554import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005555_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005556# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005557 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005558 (
Mark Dickinson8d238292009-08-02 10:16:33 +00005559 (?=\d|\.\d) # ...a number (with at least one digit)
5560 (?P<int>\d*) # having a (possibly empty) integer part
5561 (\.(?P<frac>\d*))? # followed by an optional fractional part
5562 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005563 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005564 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005565 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005566 (?P<signal>s)? # ...an (optionally signaling)
5567 NaN # NaN
Mark Dickinson8d238292009-08-02 10:16:33 +00005568 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005569 )
5570# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005571 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005572""", re.VERBOSE | re.IGNORECASE).match
5573
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005574_all_zeros = re.compile('0*$').match
5575_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005576
5577##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005578# The functions in this section have little to do with the Decimal
5579# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005580# Python numeric classes that want to implement __format__
5581#
5582# A format specifier for Decimal looks like:
5583#
Mark Dickinson79f52032009-03-17 23:12:51 +00005584# [[fill]align][sign][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00005585
5586_parse_format_specifier_regex = re.compile(r"""\A
5587(?:
5588 (?P<fill>.)?
5589 (?P<align>[<>=^])
5590)?
5591(?P<sign>[-+ ])?
5592(?P<zeropad>0)?
5593(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00005594(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005595(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00005596(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00005597\Z
5598""", re.VERBOSE)
5599
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005600del re
5601
Mark Dickinson79f52032009-03-17 23:12:51 +00005602# The locale module is only needed for the 'n' format specifier. The
5603# rest of the PEP 3101 code functions quite happily without it, so we
5604# don't care too much if locale isn't present.
5605try:
5606 import locale as _locale
5607except ImportError:
5608 pass
5609
5610def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00005611 """Parse and validate a format specifier.
5612
5613 Turns a standard numeric format specifier into a dict, with the
5614 following entries:
5615
5616 fill: fill character to pad field to minimum width
5617 align: alignment type, either '<', '>', '=' or '^'
5618 sign: either '+', '-' or ' '
5619 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00005620 zeropad: boolean, indicating whether to pad with zeros
5621 thousands_sep: string to use as thousands separator, or ''
5622 grouping: grouping for thousands separators, in format
5623 used by localeconv
5624 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00005625 precision: nonnegative integer giving precision, or None
5626 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00005627
5628 """
5629 m = _parse_format_specifier_regex.match(format_spec)
5630 if m is None:
5631 raise ValueError("Invalid format specifier: " + format_spec)
5632
5633 # get the dictionary
5634 format_dict = m.groupdict()
5635
Mark Dickinson79f52032009-03-17 23:12:51 +00005636 # zeropad; defaults for fill and alignment. If zero padding
5637 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00005638 fill = format_dict['fill']
5639 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00005640 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
5641 if format_dict['zeropad']:
5642 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005643 raise ValueError("Fill character conflicts with '0'"
5644 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00005645 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00005646 raise ValueError("Alignment conflicts with '0' in "
5647 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00005648 format_dict['fill'] = fill or ' '
5649 format_dict['align'] = align or '<'
5650
Mark Dickinson79f52032009-03-17 23:12:51 +00005651 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00005652 if format_dict['sign'] is None:
5653 format_dict['sign'] = '-'
5654
Christian Heimesf16baeb2008-02-29 14:57:44 +00005655 # minimumwidth defaults to 0; precision remains None if not given
5656 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
5657 if format_dict['precision'] is not None:
5658 format_dict['precision'] = int(format_dict['precision'])
5659
5660 # if format type is 'g' or 'G' then a precision of 0 makes little
5661 # sense; convert it to 1. Same if format type is unspecified.
5662 if format_dict['precision'] == 0:
Mark Dickinsond496d302009-09-07 16:23:26 +00005663 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005664 format_dict['precision'] = 1
5665
Mark Dickinson79f52032009-03-17 23:12:51 +00005666 # determine thousands separator, grouping, and decimal separator, and
5667 # add appropriate entries to format_dict
5668 if format_dict['type'] == 'n':
5669 # apart from separators, 'n' behaves just like 'g'
5670 format_dict['type'] = 'g'
5671 if _localeconv is None:
5672 _localeconv = _locale.localeconv()
5673 if format_dict['thousands_sep'] is not None:
5674 raise ValueError("Explicit thousands separator conflicts with "
5675 "'n' type in format specifier: " + format_spec)
5676 format_dict['thousands_sep'] = _localeconv['thousands_sep']
5677 format_dict['grouping'] = _localeconv['grouping']
5678 format_dict['decimal_point'] = _localeconv['decimal_point']
5679 else:
5680 if format_dict['thousands_sep'] is None:
5681 format_dict['thousands_sep'] = ''
5682 format_dict['grouping'] = [3, 0]
5683 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00005684
5685 return format_dict
5686
Mark Dickinson79f52032009-03-17 23:12:51 +00005687def _format_align(sign, body, spec):
5688 """Given an unpadded, non-aligned numeric string 'body' and sign
5689 string 'sign', add padding and aligment conforming to the given
5690 format specifier dictionary 'spec' (as produced by
5691 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00005692
5693 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00005694 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00005695 minimumwidth = spec['minimumwidth']
5696 fill = spec['fill']
5697 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00005698
Mark Dickinson79f52032009-03-17 23:12:51 +00005699 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00005700 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005701 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00005702 elif align == '>':
5703 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00005704 elif align == '=':
5705 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00005706 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00005707 half = len(padding)//2
5708 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00005709 else:
5710 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00005711
Christian Heimesf16baeb2008-02-29 14:57:44 +00005712 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005713
Mark Dickinson79f52032009-03-17 23:12:51 +00005714def _group_lengths(grouping):
5715 """Convert a localeconv-style grouping into a (possibly infinite)
5716 iterable of integers representing group lengths.
5717
5718 """
5719 # The result from localeconv()['grouping'], and the input to this
5720 # function, should be a list of integers in one of the
5721 # following three forms:
5722 #
5723 # (1) an empty list, or
5724 # (2) nonempty list of positive integers + [0]
5725 # (3) list of positive integers + [locale.CHAR_MAX], or
5726
5727 from itertools import chain, repeat
5728 if not grouping:
5729 return []
5730 elif grouping[-1] == 0 and len(grouping) >= 2:
5731 return chain(grouping[:-1], repeat(grouping[-2]))
5732 elif grouping[-1] == _locale.CHAR_MAX:
5733 return grouping[:-1]
5734 else:
5735 raise ValueError('unrecognised format for grouping')
5736
5737def _insert_thousands_sep(digits, spec, min_width=1):
5738 """Insert thousands separators into a digit string.
5739
5740 spec is a dictionary whose keys should include 'thousands_sep' and
5741 'grouping'; typically it's the result of parsing the format
5742 specifier using _parse_format_specifier.
5743
5744 The min_width keyword argument gives the minimum length of the
5745 result, which will be padded on the left with zeros if necessary.
5746
5747 If necessary, the zero padding adds an extra '0' on the left to
5748 avoid a leading thousands separator. For example, inserting
5749 commas every three digits in '123456', with min_width=8, gives
5750 '0,123,456', even though that has length 9.
5751
5752 """
5753
5754 sep = spec['thousands_sep']
5755 grouping = spec['grouping']
5756
5757 groups = []
5758 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00005759 if l <= 0:
5760 raise ValueError("group length should be positive")
5761 # max(..., 1) forces at least 1 digit to the left of a separator
5762 l = min(max(len(digits), min_width, 1), l)
5763 groups.append('0'*(l - len(digits)) + digits[-l:])
5764 digits = digits[:-l]
5765 min_width -= l
5766 if not digits and min_width <= 0:
5767 break
Mark Dickinson7303b592009-03-18 08:25:36 +00005768 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00005769 else:
5770 l = max(len(digits), min_width, 1)
5771 groups.append('0'*(l - len(digits)) + digits[-l:])
5772 return sep.join(reversed(groups))
5773
5774def _format_sign(is_negative, spec):
5775 """Determine sign character."""
5776
5777 if is_negative:
5778 return '-'
5779 elif spec['sign'] in ' +':
5780 return spec['sign']
5781 else:
5782 return ''
5783
5784def _format_number(is_negative, intpart, fracpart, exp, spec):
5785 """Format a number, given the following data:
5786
5787 is_negative: true if the number is negative, else false
5788 intpart: string of digits that must appear before the decimal point
5789 fracpart: string of digits that must come after the point
5790 exp: exponent, as an integer
5791 spec: dictionary resulting from parsing the format specifier
5792
5793 This function uses the information in spec to:
5794 insert separators (decimal separator and thousands separators)
5795 format the sign
5796 format the exponent
5797 add trailing '%' for the '%' type
5798 zero-pad if necessary
5799 fill and align if necessary
5800 """
5801
5802 sign = _format_sign(is_negative, spec)
5803
5804 if fracpart:
5805 fracpart = spec['decimal_point'] + fracpart
5806
5807 if exp != 0 or spec['type'] in 'eE':
5808 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
5809 fracpart += "{0}{1:+}".format(echar, exp)
5810 if spec['type'] == '%':
5811 fracpart += '%'
5812
5813 if spec['zeropad']:
5814 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
5815 else:
5816 min_width = 0
5817 intpart = _insert_thousands_sep(intpart, spec, min_width)
5818
5819 return _format_align(sign, intpart+fracpart, spec)
5820
5821
Guido van Rossumd8faa362007-04-27 19:54:29 +00005822##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005823
Guido van Rossumd8faa362007-04-27 19:54:29 +00005824# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005825_Infinity = Decimal('Inf')
5826_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00005827_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005828_Zero = Decimal(0)
5829_One = Decimal(1)
5830_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005831
Mark Dickinson627cf6a2009-01-03 12:11:47 +00005832# _SignedInfinity[sign] is infinity w/ that sign
5833_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005834
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005835
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005836
5837if __name__ == '__main__':
5838 import doctest, sys
5839 doctest.testmod(sys.modules[__name__])