blob: e9461824eb5fd57e6f61697b43f68252403af7ce [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
Mark Dickinsonaa63c4d2010-06-12 16:37:53 +000034of 0.0; Decimal('1.00') % Decimal('0.1') returns the expected
35Decimal('0.00')).
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000036
37Here are some examples of using the decimal module:
38
39>>> from decimal import *
Raymond Hettingerbd7f76d2004-07-08 00:49:18 +000040>>> setcontext(ExtendedContext)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000041>>> Decimal(0)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000042Decimal('0')
43>>> Decimal('1')
44Decimal('1')
45>>> Decimal('-.0123')
46Decimal('-0.0123')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000047>>> Decimal(123456)
Christian Heimes68f5fbe2008-02-14 08:27:37 +000048Decimal('123456')
49>>> Decimal('123.45e12345678901234567890')
50Decimal('1.2345E+12345678901234567892')
51>>> Decimal('1.33') + Decimal('1.27')
52Decimal('2.60')
53>>> Decimal('12.34') + Decimal('3.87') - Decimal('18.41')
54Decimal('-2.20')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000055>>> dig = Decimal(1)
Guido van Rossum7131f842007-02-09 20:13:25 +000056>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000570.333333333
58>>> getcontext().prec = 18
Guido van Rossum7131f842007-02-09 20:13:25 +000059>>> print(dig / Decimal(3))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000600.333333333333333333
Guido van Rossum7131f842007-02-09 20:13:25 +000061>>> print(dig.sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000621
Guido van Rossum7131f842007-02-09 20:13:25 +000063>>> print(Decimal(3).sqrt())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000641.73205080756887729
Guido van Rossum7131f842007-02-09 20:13:25 +000065>>> print(Decimal(3) ** 123)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000664.85192780976896427E+58
67>>> inf = Decimal(1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000068>>> print(inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000069Infinity
70>>> neginf = Decimal(-1) / Decimal(0)
Guido van Rossum7131f842007-02-09 20:13:25 +000071>>> print(neginf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000072-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000073>>> print(neginf + inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000074NaN
Guido van Rossum7131f842007-02-09 20:13:25 +000075>>> print(neginf * inf)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000076-Infinity
Guido van Rossum7131f842007-02-09 20:13:25 +000077>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000078Infinity
Raymond Hettingerbf440692004-07-10 14:14:37 +000079>>> getcontext().traps[DivisionByZero] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000080>>> print(dig / 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000081Traceback (most recent call last):
82 ...
83 ...
84 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +000085decimal.DivisionByZero: x / 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000086>>> c = Context()
Raymond Hettingerbf440692004-07-10 14:14:37 +000087>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000088>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000890
90>>> c.divide(Decimal(0), Decimal(0))
Christian Heimes68f5fbe2008-02-14 08:27:37 +000091Decimal('NaN')
Raymond Hettingerbf440692004-07-10 14:14:37 +000092>>> c.traps[InvalidOperation] = 1
Guido van Rossum7131f842007-02-09 20:13:25 +000093>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000941
Raymond Hettinger5aa478b2004-07-09 10:02:53 +000095>>> c.flags[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +000096>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000970
Guido van Rossum7131f842007-02-09 20:13:25 +000098>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +000099Traceback (most recent call last):
100 ...
101 ...
102 ...
Guido van Rossum6a2a2a02006-08-26 20:37:44 +0000103decimal.InvalidOperation: 0 / 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000104>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001051
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000106>>> c.flags[InvalidOperation] = 0
Raymond Hettingerbf440692004-07-10 14:14:37 +0000107>>> c.traps[InvalidOperation] = 0
Guido van Rossum7131f842007-02-09 20:13:25 +0000108>>> print(c.divide(Decimal(0), Decimal(0)))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000109NaN
Guido van Rossum7131f842007-02-09 20:13:25 +0000110>>> print(c.flags[InvalidOperation])
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001111
112>>>
113"""
114
115__all__ = [
116 # Two major classes
117 'Decimal', 'Context',
118
119 # Contexts
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +0000120 'DefaultContext', 'BasicContext', 'ExtendedContext',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000121
122 # Exceptions
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +0000123 'DecimalException', 'Clamped', 'InvalidOperation', 'DivisionByZero',
124 'Inexact', 'Rounded', 'Subnormal', 'Overflow', 'Underflow',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000125
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000126 # Constants for use in setting up contexts
127 'ROUND_DOWN', 'ROUND_HALF_UP', 'ROUND_HALF_EVEN', 'ROUND_CEILING',
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000128 'ROUND_FLOOR', 'ROUND_UP', 'ROUND_HALF_DOWN', 'ROUND_05UP',
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000129
130 # Functions for manipulating contexts
Thomas Wouters89f507f2006-12-13 04:49:30 +0000131 'setcontext', 'getcontext', 'localcontext'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000132]
133
Raymond Hettinger960dc362009-04-21 03:43:15 +0000134__version__ = '1.70' # Highest version of the spec this complies with
Raymond Hettinger697ce952010-11-30 20:32:59 +0000135 # See http://speleotrove.com/decimal/
Raymond Hettinger960dc362009-04-21 03:43:15 +0000136
Raymond Hettingereb260842005-06-07 18:52:34 +0000137import copy as _copy
Raymond Hettinger771ed762009-01-03 19:20:32 +0000138import math as _math
Raymond Hettinger82417ca2009-02-03 03:54:28 +0000139import numbers as _numbers
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000140
Christian Heimes25bb7832008-01-11 16:17:00 +0000141try:
142 from collections import namedtuple as _namedtuple
143 DecimalTuple = _namedtuple('DecimalTuple', 'sign digits exponent')
144except ImportError:
145 DecimalTuple = lambda *args: args
146
Guido van Rossumd8faa362007-04-27 19:54:29 +0000147# Rounding
Raymond Hettinger0ea241e2004-07-04 13:53:24 +0000148ROUND_DOWN = 'ROUND_DOWN'
149ROUND_HALF_UP = 'ROUND_HALF_UP'
150ROUND_HALF_EVEN = 'ROUND_HALF_EVEN'
151ROUND_CEILING = 'ROUND_CEILING'
152ROUND_FLOOR = 'ROUND_FLOOR'
153ROUND_UP = 'ROUND_UP'
154ROUND_HALF_DOWN = 'ROUND_HALF_DOWN'
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000155ROUND_05UP = 'ROUND_05UP'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000156
Guido van Rossumd8faa362007-04-27 19:54:29 +0000157# Errors
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000158
159class DecimalException(ArithmeticError):
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000160 """Base exception class.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000161
162 Used exceptions derive from this.
163 If an exception derives from another exception besides this (such as
164 Underflow (Inexact, Rounded, Subnormal) that indicates that it is only
165 called if the others are present. This isn't actually used for
166 anything, though.
167
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000168 handle -- Called when context._raise_error is called and the
Stefan Krah2eb4a072010-05-19 15:52:31 +0000169 trap_enabler is not set. First argument is self, second is the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000170 context. More arguments can be given, those being after
171 the explanation in _raise_error (For example,
172 context._raise_error(NewError, '(-x)!', self._sign) would
173 call NewError().handle(context, self._sign).)
174
175 To define a new exception, it should be sufficient to have it derive
176 from DecimalException.
177 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000178 def handle(self, context, *args):
179 pass
180
181
182class Clamped(DecimalException):
183 """Exponent of a 0 changed to fit bounds.
184
185 This occurs and signals clamped if the exponent of a result has been
186 altered in order to fit the constraints of a specific concrete
Guido van Rossumd8faa362007-04-27 19:54:29 +0000187 representation. This may occur when the exponent of a zero result would
188 be outside the bounds of a representation, or when a large normal
189 number would have an encoded exponent that cannot be represented. In
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000190 this latter case, the exponent is reduced to fit and the corresponding
191 number of zero digits are appended to the coefficient ("fold-down").
192 """
193
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000194class InvalidOperation(DecimalException):
195 """An invalid operation was performed.
196
197 Various bad things cause this:
198
199 Something creates a signaling NaN
200 -INF + INF
Guido van Rossumd8faa362007-04-27 19:54:29 +0000201 0 * (+-)INF
202 (+-)INF / (+-)INF
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000203 x % 0
204 (+-)INF % x
205 x._rescale( non-integer )
206 sqrt(-x) , x > 0
207 0 ** 0
208 x ** (non-integer)
209 x ** (+-)INF
210 An operand is invalid
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000211
212 The result of the operation after these is a quiet positive NaN,
213 except when the cause is a signaling NaN, in which case the result is
214 also a quiet NaN, but with the original sign, and an optional
215 diagnostic information.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000216 """
217 def handle(self, context, *args):
218 if args:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000219 ans = _dec_from_triple(args[0]._sign, args[0]._int, 'n', True)
220 return ans._fix_nan(context)
Mark Dickinsonf9236412009-01-02 23:23:21 +0000221 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000222
223class ConversionSyntax(InvalidOperation):
224 """Trying to convert badly formed string.
225
226 This occurs and signals invalid-operation if an string is being
227 converted to a number and it does not conform to the numeric string
Guido van Rossumd8faa362007-04-27 19:54:29 +0000228 syntax. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000229 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000230 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000231 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000232
233class DivisionByZero(DecimalException, ZeroDivisionError):
234 """Division by 0.
235
236 This occurs and signals division-by-zero if division of a finite number
237 by zero was attempted (during a divide-integer or divide operation, or a
238 power operation with negative right-hand operand), and the dividend was
239 not zero.
240
241 The result of the operation is [sign,inf], where sign is the exclusive
242 or of the signs of the operands for divide, or is 1 for an odd power of
243 -0, for power.
244 """
245
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000246 def handle(self, context, sign, *args):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000247 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000248
249class DivisionImpossible(InvalidOperation):
250 """Cannot perform the division adequately.
251
252 This occurs and signals invalid-operation if the integer result of a
253 divide-integer or remainder operation had too many digits (would be
Guido van Rossumd8faa362007-04-27 19:54:29 +0000254 longer than precision). The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000255 """
256
257 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000258 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000259
260class DivisionUndefined(InvalidOperation, ZeroDivisionError):
261 """Undefined result of division.
262
263 This occurs and signals invalid-operation if division by zero was
264 attempted (during a divide-integer, divide, or remainder operation), and
Guido van Rossumd8faa362007-04-27 19:54:29 +0000265 the dividend is also zero. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000266 """
267
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000268 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000269 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000270
271class Inexact(DecimalException):
272 """Had to round, losing information.
273
274 This occurs and signals inexact whenever the result of an operation is
275 not exact (that is, it needed to be rounded and any discarded digits
Guido van Rossumd8faa362007-04-27 19:54:29 +0000276 were non-zero), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000277 result in all cases is unchanged.
278
279 The inexact signal may be tested (or trapped) to determine if a given
280 operation (or sequence of operations) was inexact.
281 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000282
283class InvalidContext(InvalidOperation):
284 """Invalid context. Unknown rounding, for example.
285
286 This occurs and signals invalid-operation if an invalid context was
Guido van Rossumd8faa362007-04-27 19:54:29 +0000287 detected during an operation. This can occur if contexts are not checked
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000288 on creation and either the precision exceeds the capability of the
289 underlying concrete representation or an unknown or unsupported rounding
Guido van Rossumd8faa362007-04-27 19:54:29 +0000290 was specified. These aspects of the context need only be checked when
291 the values are required to be used. The result is [0,qNaN].
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000292 """
293
294 def handle(self, context, *args):
Mark Dickinsonf9236412009-01-02 23:23:21 +0000295 return _NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000296
297class Rounded(DecimalException):
298 """Number got rounded (not necessarily changed during rounding).
299
300 This occurs and signals rounded whenever the result of an operation is
301 rounded (that is, some zero or non-zero digits were discarded from the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000302 coefficient), or if an overflow or underflow condition occurs. The
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000303 result in all cases is unchanged.
304
305 The rounded signal may be tested (or trapped) to determine if a given
306 operation (or sequence of operations) caused a loss of precision.
307 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000308
309class Subnormal(DecimalException):
310 """Exponent < Emin before rounding.
311
312 This occurs and signals subnormal whenever the result of a conversion or
313 operation is subnormal (that is, its adjusted exponent is less than
Guido van Rossumd8faa362007-04-27 19:54:29 +0000314 Emin, before any rounding). The result in all cases is unchanged.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000315
316 The subnormal signal may be tested (or trapped) to determine if a given
317 or operation (or sequence of operations) yielded a subnormal result.
318 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000319
320class Overflow(Inexact, Rounded):
321 """Numerical overflow.
322
323 This occurs and signals overflow if the adjusted exponent of a result
324 (from a conversion or from an operation that is not an attempt to divide
325 by zero), after rounding, would be greater than the largest value that
326 can be handled by the implementation (the value Emax).
327
328 The result depends on the rounding mode:
329
330 For round-half-up and round-half-even (and for round-half-down and
331 round-up, if implemented), the result of the operation is [sign,inf],
Guido van Rossumd8faa362007-04-27 19:54:29 +0000332 where sign is the sign of the intermediate result. For round-down, the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000333 result is the largest finite number that can be represented in the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000334 current precision, with the sign of the intermediate result. For
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000335 round-ceiling, the result is the same as for round-down if the sign of
Guido van Rossumd8faa362007-04-27 19:54:29 +0000336 the intermediate result is 1, or is [0,inf] otherwise. For round-floor,
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000337 the result is the same as for round-down if the sign of the intermediate
Guido van Rossumd8faa362007-04-27 19:54:29 +0000338 result is 0, or is [1,inf] otherwise. In all cases, Inexact and Rounded
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000339 will also be raised.
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000340 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000341
342 def handle(self, context, sign, *args):
343 if context.rounding in (ROUND_HALF_UP, ROUND_HALF_EVEN,
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000344 ROUND_HALF_DOWN, ROUND_UP):
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000345 return _SignedInfinity[sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000346 if sign == 0:
347 if context.rounding == ROUND_CEILING:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000348 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000349 return _dec_from_triple(sign, '9'*context.prec,
350 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000351 if sign == 1:
352 if context.rounding == ROUND_FLOOR:
Mark Dickinson627cf6a2009-01-03 12:11:47 +0000353 return _SignedInfinity[sign]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000354 return _dec_from_triple(sign, '9'*context.prec,
355 context.Emax-context.prec+1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000356
357
358class Underflow(Inexact, Rounded, Subnormal):
359 """Numerical underflow with result rounded to 0.
360
361 This occurs and signals underflow if a result is inexact and the
362 adjusted exponent of the result would be smaller (more negative) than
363 the smallest value that can be handled by the implementation (the value
Guido van Rossumd8faa362007-04-27 19:54:29 +0000364 Emin). That is, the result is both inexact and subnormal.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000365
366 The result after an underflow will be a subnormal number rounded, if
Guido van Rossumd8faa362007-04-27 19:54:29 +0000367 necessary, so that its exponent is not less than Etiny. This may result
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000368 in 0 with the sign of the intermediate result and an exponent of Etiny.
369
370 In all cases, Inexact, Rounded, and Subnormal will also be raised.
371 """
372
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000373# List of public traps and flags
Raymond Hettingerfed52962004-07-14 15:41:57 +0000374_signals = [Clamped, DivisionByZero, Inexact, Overflow, Rounded,
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000375 Underflow, InvalidOperation, Subnormal]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000376
Raymond Hettinger5aa478b2004-07-09 10:02:53 +0000377# Map conditions (per the spec) to signals
378_condition_map = {ConversionSyntax:InvalidOperation,
379 DivisionImpossible:InvalidOperation,
380 DivisionUndefined:InvalidOperation,
381 InvalidContext:InvalidOperation}
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000382
Guido van Rossumd8faa362007-04-27 19:54:29 +0000383##### Context Functions ##################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000384
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000385# The getcontext() and setcontext() function manage access to a thread-local
386# current context. Py2.4 offers direct support for thread locals. If that
Georg Brandlf9926402008-06-13 06:32:25 +0000387# is not available, use threading.current_thread() which is slower but will
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000388# work for older Pythons. If threads are not part of the build, create a
389# mock threading object with threading.local() returning the module namespace.
390
391try:
392 import threading
393except ImportError:
394 # Python was compiled without threads; create a mock object instead
395 import sys
Guido van Rossumd8faa362007-04-27 19:54:29 +0000396 class MockThreading(object):
Raymond Hettinger7e71fa52004-12-18 19:07:19 +0000397 def local(self, sys=sys):
398 return sys.modules[__name__]
399 threading = MockThreading()
400 del sys, MockThreading
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000401
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000402try:
403 threading.local
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000404
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000405except AttributeError:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000406
Guido van Rossumd8faa362007-04-27 19:54:29 +0000407 # To fix reloading, force it to create a new context
408 # Old contexts have different exceptions in their dicts, making problems.
Georg Brandlf9926402008-06-13 06:32:25 +0000409 if hasattr(threading.current_thread(), '__decimal_context__'):
410 del threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000411
412 def setcontext(context):
413 """Set this thread's context to context."""
414 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000415 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000416 context.clear_flags()
Georg Brandlf9926402008-06-13 06:32:25 +0000417 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000418
419 def getcontext():
420 """Returns this thread's context.
421
422 If this thread does not yet have a context, returns
423 a new context and sets this thread's context.
424 New contexts are copies of DefaultContext.
425 """
426 try:
Georg Brandlf9926402008-06-13 06:32:25 +0000427 return threading.current_thread().__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000428 except AttributeError:
429 context = Context()
Georg Brandlf9926402008-06-13 06:32:25 +0000430 threading.current_thread().__decimal_context__ = context
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000431 return context
432
433else:
434
435 local = threading.local()
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000436 if hasattr(local, '__decimal_context__'):
437 del local.__decimal_context__
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000438
439 def getcontext(_local=local):
440 """Returns this thread's context.
441
442 If this thread does not yet have a context, returns
443 a new context and sets this thread's context.
444 New contexts are copies of DefaultContext.
445 """
446 try:
447 return _local.__decimal_context__
448 except AttributeError:
449 context = Context()
450 _local.__decimal_context__ = context
451 return context
452
453 def setcontext(context, _local=local):
454 """Set this thread's context to context."""
455 if context in (DefaultContext, BasicContext, ExtendedContext):
Raymond Hettinger9fce44b2004-08-08 04:03:24 +0000456 context = context.copy()
Raymond Hettinger61992ef2004-08-06 23:42:16 +0000457 context.clear_flags()
Raymond Hettingeref66deb2004-07-14 21:04:27 +0000458 _local.__decimal_context__ = context
459
460 del threading, local # Don't contaminate the namespace
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000461
Thomas Wouters89f507f2006-12-13 04:49:30 +0000462def localcontext(ctx=None):
463 """Return a context manager for a copy of the supplied context
464
465 Uses a copy of the current context if no context is specified
466 The returned context manager creates a local decimal context
467 in a with statement:
468 def sin(x):
469 with localcontext() as ctx:
470 ctx.prec += 2
471 # Rest of sin calculation algorithm
472 # uses a precision 2 greater than normal
Guido van Rossumd8faa362007-04-27 19:54:29 +0000473 return +s # Convert result to normal precision
Thomas Wouters89f507f2006-12-13 04:49:30 +0000474
475 def sin(x):
476 with localcontext(ExtendedContext):
477 # Rest of sin calculation algorithm
478 # uses the Extended Context from the
479 # General Decimal Arithmetic Specification
Guido van Rossumd8faa362007-04-27 19:54:29 +0000480 return +s # Convert result to normal context
Thomas Wouters89f507f2006-12-13 04:49:30 +0000481
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000482 >>> setcontext(DefaultContext)
Guido van Rossum7131f842007-02-09 20:13:25 +0000483 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000484 28
485 >>> with localcontext():
486 ... ctx = getcontext()
Thomas Wouterscf297e42007-02-23 15:07:44 +0000487 ... ctx.prec += 2
Guido van Rossum7131f842007-02-09 20:13:25 +0000488 ... print(ctx.prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000489 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000490 30
491 >>> with localcontext(ExtendedContext):
Guido van Rossum7131f842007-02-09 20:13:25 +0000492 ... print(getcontext().prec)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000493 ...
Thomas Wouters89f507f2006-12-13 04:49:30 +0000494 9
Guido van Rossum7131f842007-02-09 20:13:25 +0000495 >>> print(getcontext().prec)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000496 28
497 """
498 if ctx is None: ctx = getcontext()
499 return _ContextManager(ctx)
500
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000501
Guido van Rossumd8faa362007-04-27 19:54:29 +0000502##### Decimal class #######################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000503
Raymond Hettingera0fd8882009-01-20 07:24:44 +0000504# Do not subclass Decimal from numbers.Real and do not register it as such
505# (because Decimals are not interoperable with floats). See the notes in
506# numbers.py for more detail.
507
508class Decimal(object):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000509 """Floating point class for decimal arithmetic."""
510
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000511 __slots__ = ('_exp','_int','_sign', '_is_special')
512 # Generally, the value of the Decimal instance is given by
513 # (-1)**_sign * _int * 10**_exp
514 # Special values are signified by _is_special == True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000515
Raymond Hettingerdab988d2004-10-09 07:10:44 +0000516 # We're immutable, so use __new__ not __init__
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000517 def __new__(cls, value="0", context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000518 """Create a decimal point instance.
519
520 >>> Decimal('3.14') # string input
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000521 Decimal('3.14')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000522 >>> Decimal((0, (3, 1, 4), -2)) # tuple (sign, digit_tuple, exponent)
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000523 Decimal('3.14')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000524 >>> Decimal(314) # int
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000525 Decimal('314')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000526 >>> Decimal(Decimal(314)) # another decimal instance
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000527 Decimal('314')
Christian Heimesa62da1d2008-01-12 19:39:10 +0000528 >>> Decimal(' 3.14 \\n') # leading and trailing whitespace okay
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000529 Decimal('3.14')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000530 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000531
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000532 # Note that the coefficient, self._int, is actually stored as
533 # a string rather than as a tuple of digits. This speeds up
534 # the "digits to integer" and "integer to digits" conversions
535 # that are used in almost every arithmetic operation on
536 # Decimals. This is an internal detail: the as_tuple function
537 # and the Decimal constructor still deal with tuples of
538 # digits.
539
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000540 self = object.__new__(cls)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000541
Christian Heimesd59c64c2007-11-30 19:27:20 +0000542 # From a string
543 # REs insist on real strings, so we can too.
544 if isinstance(value, str):
Christian Heimesa62da1d2008-01-12 19:39:10 +0000545 m = _parser(value.strip())
Christian Heimesd59c64c2007-11-30 19:27:20 +0000546 if m is None:
547 if context is None:
548 context = getcontext()
549 return context._raise_error(ConversionSyntax,
550 "Invalid literal for Decimal: %r" % value)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000551
Christian Heimesd59c64c2007-11-30 19:27:20 +0000552 if m.group('sign') == "-":
553 self._sign = 1
554 else:
555 self._sign = 0
556 intpart = m.group('int')
557 if intpart is not None:
558 # finite number
Mark Dickinson345adc42009-08-02 10:14:23 +0000559 fracpart = m.group('frac') or ''
Christian Heimesd59c64c2007-11-30 19:27:20 +0000560 exp = int(m.group('exp') or '0')
Mark Dickinson345adc42009-08-02 10:14:23 +0000561 self._int = str(int(intpart+fracpart))
562 self._exp = exp - len(fracpart)
Christian Heimesd59c64c2007-11-30 19:27:20 +0000563 self._is_special = False
564 else:
565 diag = m.group('diag')
566 if diag is not None:
567 # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +0000568 self._int = str(int(diag or '0')).lstrip('0')
Christian Heimesd59c64c2007-11-30 19:27:20 +0000569 if m.group('signal'):
570 self._exp = 'N'
571 else:
572 self._exp = 'n'
573 else:
574 # infinity
575 self._int = '0'
576 self._exp = 'F'
577 self._is_special = True
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000578 return self
579
580 # From an integer
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000581 if isinstance(value, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000582 if value >= 0:
583 self._sign = 0
584 else:
585 self._sign = 1
586 self._exp = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000587 self._int = str(abs(value))
Christian Heimesd59c64c2007-11-30 19:27:20 +0000588 self._is_special = False
589 return self
590
591 # From another decimal
592 if isinstance(value, Decimal):
593 self._exp = value._exp
594 self._sign = value._sign
595 self._int = value._int
596 self._is_special = value._is_special
597 return self
598
599 # From an internal working value
600 if isinstance(value, _WorkRep):
601 self._sign = value.sign
602 self._int = str(value.int)
603 self._exp = int(value.exp)
604 self._is_special = False
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000605 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000606
607 # tuple/list conversion (possibly from as_tuple())
608 if isinstance(value, (list,tuple)):
609 if len(value) != 3:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000610 raise ValueError('Invalid tuple size in creation of Decimal '
611 'from list or tuple. The list or tuple '
612 'should have exactly three elements.')
613 # process sign. The isinstance test rejects floats
614 if not (isinstance(value[0], int) and value[0] in (0,1)):
615 raise ValueError("Invalid sign. The first value in the tuple "
616 "should be an integer; either 0 for a "
617 "positive number or 1 for a negative number.")
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000618 self._sign = value[0]
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000619 if value[2] == 'F':
620 # infinity: value[1] is ignored
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000621 self._int = '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000622 self._exp = value[2]
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000623 self._is_special = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000624 else:
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000625 # process and validate the digits in value[1]
626 digits = []
627 for digit in value[1]:
628 if isinstance(digit, int) and 0 <= digit <= 9:
629 # skip leading zeros
630 if digits or digit != 0:
631 digits.append(digit)
632 else:
633 raise ValueError("The second value in the tuple must "
634 "be composed of integers in the range "
635 "0 through 9.")
636 if value[2] in ('n', 'N'):
637 # NaN: digits form the diagnostic
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000638 self._int = ''.join(map(str, digits))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000639 self._exp = value[2]
640 self._is_special = True
641 elif isinstance(value[2], int):
642 # finite number: digits give the coefficient
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000643 self._int = ''.join(map(str, digits or [0]))
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000644 self._exp = value[2]
645 self._is_special = False
646 else:
647 raise ValueError("The third value in the tuple must "
648 "be an integer, or one of the "
649 "strings 'F', 'n', 'N'.")
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000650 return self
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000651
Raymond Hettingerbf440692004-07-10 14:14:37 +0000652 if isinstance(value, float):
Raymond Hettinger96798592010-04-02 16:58:27 +0000653 value = Decimal.from_float(value)
654 self._exp = value._exp
655 self._sign = value._sign
656 self._int = value._int
657 self._is_special = value._is_special
658 return self
Raymond Hettingerbf440692004-07-10 14:14:37 +0000659
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000660 raise TypeError("Cannot convert %r to Decimal" % value)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000661
Mark Dickinsonba298e42009-01-04 21:17:43 +0000662 # @classmethod, but @decorator is not valid Python 2.3 syntax, so
663 # don't use it (see notes on Py2.3 compatibility at top of file)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000664 def from_float(cls, f):
665 """Converts a float to a decimal number, exactly.
666
667 Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
668 Since 0.1 is not exactly representable in binary floating point, the
669 value is stored as the nearest representable value which is
670 0x1.999999999999ap-4. The exact equivalent of the value in decimal
671 is 0.1000000000000000055511151231257827021181583404541015625.
672
673 >>> Decimal.from_float(0.1)
674 Decimal('0.1000000000000000055511151231257827021181583404541015625')
675 >>> Decimal.from_float(float('nan'))
676 Decimal('NaN')
677 >>> Decimal.from_float(float('inf'))
678 Decimal('Infinity')
679 >>> Decimal.from_float(-float('inf'))
680 Decimal('-Infinity')
681 >>> Decimal.from_float(-0.0)
682 Decimal('-0')
683
684 """
685 if isinstance(f, int): # handle integer inputs
686 return cls(f)
687 if _math.isinf(f) or _math.isnan(f): # raises TypeError if not a float
688 return cls(repr(f))
Mark Dickinsonba298e42009-01-04 21:17:43 +0000689 if _math.copysign(1.0, f) == 1.0:
690 sign = 0
691 else:
692 sign = 1
Raymond Hettinger771ed762009-01-03 19:20:32 +0000693 n, d = abs(f).as_integer_ratio()
694 k = d.bit_length() - 1
695 result = _dec_from_triple(sign, str(n*5**k), -k)
Mark Dickinsonba298e42009-01-04 21:17:43 +0000696 if cls is Decimal:
697 return result
698 else:
699 return cls(result)
700 from_float = classmethod(from_float)
Raymond Hettinger771ed762009-01-03 19:20:32 +0000701
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000702 def _isnan(self):
703 """Returns whether the number is not actually one.
704
705 0 if a number
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000706 1 if NaN
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000707 2 if sNaN
708 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000709 if self._is_special:
710 exp = self._exp
711 if exp == 'n':
712 return 1
713 elif exp == 'N':
714 return 2
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000715 return 0
716
717 def _isinfinity(self):
718 """Returns whether the number is infinite
719
720 0 if finite or not a number
721 1 if +INF
722 -1 if -INF
723 """
724 if self._exp == 'F':
725 if self._sign:
726 return -1
727 return 1
728 return 0
729
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000730 def _check_nans(self, other=None, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000731 """Returns whether the number is not actually one.
732
733 if self, other are sNaN, signal
734 if self, other are NaN return nan
735 return 0
736
737 Done before operations.
738 """
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000739
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000740 self_is_nan = self._isnan()
741 if other is None:
742 other_is_nan = False
743 else:
744 other_is_nan = other._isnan()
745
746 if self_is_nan or other_is_nan:
747 if context is None:
748 context = getcontext()
749
750 if self_is_nan == 2:
751 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000752 self)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000753 if other_is_nan == 2:
754 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000755 other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000756 if self_is_nan:
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000757 return self._fix_nan(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000758
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000759 return other._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000760 return 0
761
Christian Heimes77c02eb2008-02-09 02:18:51 +0000762 def _compare_check_nans(self, other, context):
763 """Version of _check_nans used for the signaling comparisons
764 compare_signal, __le__, __lt__, __ge__, __gt__.
765
766 Signal InvalidOperation if either self or other is a (quiet
767 or signaling) NaN. Signaling NaNs take precedence over quiet
768 NaNs.
769
770 Return 0 if neither operand is a NaN.
771
772 """
773 if context is None:
774 context = getcontext()
775
776 if self._is_special or other._is_special:
777 if self.is_snan():
778 return context._raise_error(InvalidOperation,
779 'comparison involving sNaN',
780 self)
781 elif other.is_snan():
782 return context._raise_error(InvalidOperation,
783 'comparison involving sNaN',
784 other)
785 elif self.is_qnan():
786 return context._raise_error(InvalidOperation,
787 'comparison involving NaN',
788 self)
789 elif other.is_qnan():
790 return context._raise_error(InvalidOperation,
791 'comparison involving NaN',
792 other)
793 return 0
794
Jack Diederich4dafcc42006-11-28 19:15:13 +0000795 def __bool__(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000796 """Return True if self is nonzero; otherwise return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000797
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000798 NaNs and infinities are considered nonzero.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000799 """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000800 return self._is_special or self._int != '0'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000801
Christian Heimes77c02eb2008-02-09 02:18:51 +0000802 def _cmp(self, other):
803 """Compare the two non-NaN decimal instances self and other.
804
805 Returns -1 if self < other, 0 if self == other and 1
806 if self > other. This routine is for internal use only."""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000807
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000808 if self._is_special or other._is_special:
Mark Dickinsone6aad752009-01-25 10:48:51 +0000809 self_inf = self._isinfinity()
810 other_inf = other._isinfinity()
811 if self_inf == other_inf:
812 return 0
813 elif self_inf < other_inf:
814 return -1
815 else:
816 return 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000817
Mark Dickinsone6aad752009-01-25 10:48:51 +0000818 # check for zeros; Decimal('0') == Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000819 if not self:
820 if not other:
821 return 0
822 else:
823 return -((-1)**other._sign)
824 if not other:
825 return (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000826
Guido van Rossumd8faa362007-04-27 19:54:29 +0000827 # If different signs, neg one is less
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000828 if other._sign < self._sign:
829 return -1
830 if self._sign < other._sign:
831 return 1
832
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000833 self_adjusted = self.adjusted()
834 other_adjusted = other.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000835 if self_adjusted == other_adjusted:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +0000836 self_padded = self._int + '0'*(self._exp - other._exp)
837 other_padded = other._int + '0'*(other._exp - self._exp)
Mark Dickinsone6aad752009-01-25 10:48:51 +0000838 if self_padded == other_padded:
839 return 0
840 elif self_padded < other_padded:
841 return -(-1)**self._sign
842 else:
843 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000844 elif self_adjusted > other_adjusted:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000845 return (-1)**self._sign
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000846 else: # self_adjusted < other_adjusted
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000847 return -((-1)**self._sign)
848
Christian Heimes77c02eb2008-02-09 02:18:51 +0000849 # Note: The Decimal standard doesn't cover rich comparisons for
850 # Decimals. In particular, the specification is silent on the
851 # subject of what should happen for a comparison involving a NaN.
852 # We take the following approach:
853 #
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000854 # == comparisons involving a quiet NaN always return False
855 # != comparisons involving a quiet NaN always return True
856 # == or != comparisons involving a signaling NaN signal
857 # InvalidOperation, and return False or True as above if the
858 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000859 # <, >, <= and >= comparisons involving a (quiet or signaling)
860 # NaN signal InvalidOperation, and return False if the
Christian Heimes3feef612008-02-11 06:19:17 +0000861 # InvalidOperation is not trapped.
Christian Heimes77c02eb2008-02-09 02:18:51 +0000862 #
863 # This behavior is designed to conform as closely as possible to
864 # that specified by IEEE 754.
865
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000866 def __eq__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000867 self, other = _convert_for_comparison(self, other, equality_op=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000868 if other is NotImplemented:
869 return other
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000870 if self._check_nans(other, context):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000871 return False
872 return self._cmp(other) == 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000873
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000874 def __ne__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000875 self, other = _convert_for_comparison(self, other, equality_op=True)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000876 if other is NotImplemented:
877 return other
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000878 if self._check_nans(other, context):
Christian Heimes77c02eb2008-02-09 02:18:51 +0000879 return True
880 return self._cmp(other) != 0
Raymond Hettinger0aeac102004-07-05 22:53:03 +0000881
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000882
Christian Heimes77c02eb2008-02-09 02:18:51 +0000883 def __lt__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000884 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000885 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 __le__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000893 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000894 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
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000900
Christian Heimes77c02eb2008-02-09 02:18:51 +0000901 def __gt__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000902 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000903 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
909
910 def __ge__(self, other, context=None):
Mark Dickinson08ade6f2010-06-11 10:44:52 +0000911 self, other = _convert_for_comparison(self, other)
Christian Heimes77c02eb2008-02-09 02:18:51 +0000912 if other is NotImplemented:
913 return other
914 ans = self._compare_check_nans(other, context)
915 if ans:
916 return False
917 return self._cmp(other) >= 0
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000918
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000919 def compare(self, other, context=None):
920 """Compares one to another.
921
922 -1 => a < b
923 0 => a = b
924 1 => a > b
925 NaN => one is NaN
926 Like __cmp__, but returns Decimal instances.
927 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000928 other = _convert_other(other, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000929
Guido van Rossumd8faa362007-04-27 19:54:29 +0000930 # Compare(NaN, NaN) = NaN
Raymond Hettinger636a6b12004-09-19 01:54:09 +0000931 if (self._is_special or other and other._is_special):
932 ans = self._check_nans(other, context)
933 if ans:
934 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000935
Christian Heimes77c02eb2008-02-09 02:18:51 +0000936 return Decimal(self._cmp(other))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000937
938 def __hash__(self):
939 """x.__hash__() <==> hash(x)"""
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000940
Mark Dickinsondc787d22010-05-23 13:33:13 +0000941 # In order to make sure that the hash of a Decimal instance
942 # agrees with the hash of a numerically equal integer, float
943 # or Fraction, we follow the rules for numeric hashes outlined
944 # in the documentation. (See library docs, 'Built-in Types').
Raymond Hettingerbea3f6f2005-03-15 04:59:17 +0000945 if self._is_special:
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000946 if self.is_snan():
Raymond Hettingerd325c4b2010-11-21 04:08:28 +0000947 raise TypeError('Cannot hash a signaling NaN value.')
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000948 elif self.is_nan():
Mark Dickinsondc787d22010-05-23 13:33:13 +0000949 return _PyHASH_NAN
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000950 else:
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000951 if self._sign:
Mark Dickinsondc787d22010-05-23 13:33:13 +0000952 return -_PyHASH_INF
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000953 else:
Mark Dickinsondc787d22010-05-23 13:33:13 +0000954 return _PyHASH_INF
Mark Dickinsonac256ab2010-04-03 11:08:14 +0000955
Mark Dickinsondc787d22010-05-23 13:33:13 +0000956 if self._exp >= 0:
957 exp_hash = pow(10, self._exp, _PyHASH_MODULUS)
958 else:
959 exp_hash = pow(_PyHASH_10INV, -self._exp, _PyHASH_MODULUS)
960 hash_ = int(self._int) * exp_hash % _PyHASH_MODULUS
Stefan Krahdc817b22010-11-17 11:16:34 +0000961 ans = hash_ if self >= 0 else -hash_
962 return -2 if ans == -1 else ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000963
964 def as_tuple(self):
965 """Represents the number as a triple tuple.
966
967 To show the internals exactly as they are.
968 """
Christian Heimes25bb7832008-01-11 16:17:00 +0000969 return DecimalTuple(self._sign, tuple(map(int, self._int)), self._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000970
971 def __repr__(self):
972 """Represents the number as an instance of Decimal."""
973 # Invariant: eval(repr(d)) == d
Christian Heimes68f5fbe2008-02-14 08:27:37 +0000974 return "Decimal('%s')" % str(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000975
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000976 def __str__(self, eng=False, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000977 """Return string representation of the number in scientific notation.
978
979 Captures all of the information in the underlying representation.
980 """
981
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000982 sign = ['', '-'][self._sign]
Raymond Hettingere5a0a962005-06-20 09:49:42 +0000983 if self._is_special:
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000984 if self._exp == 'F':
985 return sign + 'Infinity'
986 elif self._exp == 'n':
987 return sign + 'NaN' + self._int
988 else: # self._exp == 'N'
989 return sign + 'sNaN' + self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000990
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000991 # number of digits of self._int to left of decimal point
992 leftdigits = self._exp + len(self._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +0000993
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000994 # dotplace is number of digits of self._int to the left of the
995 # decimal point in the mantissa of the output string (that is,
996 # after adjusting the exponent)
997 if self._exp <= 0 and leftdigits > -6:
998 # no exponent required
999 dotplace = leftdigits
1000 elif not eng:
1001 # usual scientific notation: 1 digit on left of the point
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001002 dotplace = 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001003 elif self._int == '0':
1004 # engineering notation, zero
1005 dotplace = (leftdigits + 1) % 3 - 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001006 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001007 # engineering notation, nonzero
1008 dotplace = (leftdigits - 1) % 3 + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001009
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001010 if dotplace <= 0:
1011 intpart = '0'
1012 fracpart = '.' + '0'*(-dotplace) + self._int
1013 elif dotplace >= len(self._int):
1014 intpart = self._int+'0'*(dotplace-len(self._int))
1015 fracpart = ''
1016 else:
1017 intpart = self._int[:dotplace]
1018 fracpart = '.' + self._int[dotplace:]
1019 if leftdigits == dotplace:
1020 exp = ''
1021 else:
1022 if context is None:
1023 context = getcontext()
1024 exp = ['e', 'E'][context.capitals] + "%+d" % (leftdigits-dotplace)
1025
1026 return sign + intpart + fracpart + exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001027
1028 def to_eng_string(self, context=None):
1029 """Convert to engineering-type string.
1030
1031 Engineering notation has an exponent which is a multiple of 3, so there
1032 are up to 3 digits left of the decimal place.
1033
1034 Same rules for when in exponential and when as a value as in __str__.
1035 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001036 return self.__str__(eng=True, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001037
1038 def __neg__(self, context=None):
1039 """Returns a copy with the sign switched.
1040
1041 Rounds, if it has reason.
1042 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001043 if self._is_special:
1044 ans = self._check_nans(context=context)
1045 if ans:
1046 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001047
Mark Dickinson37a79fb2011-03-12 11:12:52 +00001048 if context is None:
1049 context = getcontext()
1050
1051 if not self and context.rounding != ROUND_FLOOR:
1052 # -Decimal('0') is Decimal('0'), not Decimal('-0'), except
1053 # in ROUND_FLOOR rounding mode.
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001054 ans = self.copy_abs()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001055 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001056 ans = self.copy_negate()
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001057
Christian Heimes2c181612007-12-17 20:04:13 +00001058 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001059
1060 def __pos__(self, context=None):
1061 """Returns a copy, unless it is a sNaN.
1062
1063 Rounds the number (if more then precision digits)
1064 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001065 if self._is_special:
1066 ans = self._check_nans(context=context)
1067 if ans:
1068 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001069
Mark Dickinson37a79fb2011-03-12 11:12:52 +00001070 if context is None:
1071 context = getcontext()
1072
1073 if not self and context.rounding != ROUND_FLOOR:
1074 # + (-0) = 0, except in ROUND_FLOOR rounding mode.
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001075 ans = self.copy_abs()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001076 else:
1077 ans = Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001078
Christian Heimes2c181612007-12-17 20:04:13 +00001079 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001080
Christian Heimes2c181612007-12-17 20:04:13 +00001081 def __abs__(self, round=True, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001082 """Returns the absolute value of self.
1083
Christian Heimes2c181612007-12-17 20:04:13 +00001084 If the keyword argument 'round' is false, do not round. The
1085 expression self.__abs__(round=False) is equivalent to
1086 self.copy_abs().
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001087 """
Christian Heimes2c181612007-12-17 20:04:13 +00001088 if not round:
1089 return self.copy_abs()
1090
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001091 if self._is_special:
1092 ans = self._check_nans(context=context)
1093 if ans:
1094 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001095
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001096 if self._sign:
1097 ans = self.__neg__(context=context)
1098 else:
1099 ans = self.__pos__(context=context)
1100
1101 return ans
1102
1103 def __add__(self, other, context=None):
1104 """Returns self + other.
1105
1106 -INF + INF (or the reverse) cause InvalidOperation errors.
1107 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001108 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001109 if other is NotImplemented:
1110 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001111
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001112 if context is None:
1113 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001114
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001115 if self._is_special or other._is_special:
1116 ans = self._check_nans(other, context)
1117 if ans:
1118 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001119
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001120 if self._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001121 # If both INF, same sign => same as both, opposite => error.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001122 if self._sign != other._sign and other._isinfinity():
1123 return context._raise_error(InvalidOperation, '-INF + INF')
1124 return Decimal(self)
1125 if other._isinfinity():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001126 return Decimal(other) # Can't both be infinity here
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001127
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001128 exp = min(self._exp, other._exp)
1129 negativezero = 0
1130 if context.rounding == ROUND_FLOOR and self._sign != other._sign:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001131 # If the answer is 0, the sign should be negative, in this case.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001132 negativezero = 1
1133
1134 if not self and not other:
1135 sign = min(self._sign, other._sign)
1136 if negativezero:
1137 sign = 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001138 ans = _dec_from_triple(sign, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001139 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001140 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001141 if not self:
Facundo Batista99b55482004-10-26 23:38:46 +00001142 exp = max(exp, other._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001143 ans = other._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001144 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001145 return ans
1146 if not other:
Facundo Batista99b55482004-10-26 23:38:46 +00001147 exp = max(exp, self._exp - context.prec-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001148 ans = self._rescale(exp, context.rounding)
Christian Heimes2c181612007-12-17 20:04:13 +00001149 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001150 return ans
1151
1152 op1 = _WorkRep(self)
1153 op2 = _WorkRep(other)
Christian Heimes2c181612007-12-17 20:04:13 +00001154 op1, op2 = _normalize(op1, op2, context.prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001155
1156 result = _WorkRep()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001157 if op1.sign != op2.sign:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001158 # Equal and opposite
Raymond Hettinger17931de2004-10-27 06:21:46 +00001159 if op1.int == op2.int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001160 ans = _dec_from_triple(negativezero, '0', exp)
Christian Heimes2c181612007-12-17 20:04:13 +00001161 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001162 return ans
Raymond Hettinger17931de2004-10-27 06:21:46 +00001163 if op1.int < op2.int:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001164 op1, op2 = op2, op1
Guido van Rossumd8faa362007-04-27 19:54:29 +00001165 # OK, now abs(op1) > abs(op2)
Raymond Hettinger17931de2004-10-27 06:21:46 +00001166 if op1.sign == 1:
1167 result.sign = 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001168 op1.sign, op2.sign = op2.sign, op1.sign
1169 else:
Raymond Hettinger17931de2004-10-27 06:21:46 +00001170 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001171 # So we know the sign, and op1 > 0.
Raymond Hettinger17931de2004-10-27 06:21:46 +00001172 elif op1.sign == 1:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001173 result.sign = 1
Raymond Hettinger17931de2004-10-27 06:21:46 +00001174 op1.sign, op2.sign = (0, 0)
1175 else:
1176 result.sign = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +00001177 # Now, op1 > abs(op2) > 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001178
Raymond Hettinger17931de2004-10-27 06:21:46 +00001179 if op2.sign == 0:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001180 result.int = op1.int + op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001181 else:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001182 result.int = op1.int - op2.int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001183
1184 result.exp = op1.exp
1185 ans = Decimal(result)
Christian Heimes2c181612007-12-17 20:04:13 +00001186 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001187 return ans
1188
1189 __radd__ = __add__
1190
1191 def __sub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001192 """Return self - other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001193 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001194 if other is NotImplemented:
1195 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001196
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001197 if self._is_special or other._is_special:
1198 ans = self._check_nans(other, context=context)
1199 if ans:
1200 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001201
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001202 # self - other is computed as self + other.copy_negate()
1203 return self.__add__(other.copy_negate(), context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001204
1205 def __rsub__(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001206 """Return other - self"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001207 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001208 if other is NotImplemented:
1209 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001210
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001211 return other.__sub__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001212
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001213 def __mul__(self, other, context=None):
1214 """Return self * other.
1215
1216 (+-) INF * 0 (or its reverse) raise InvalidOperation.
1217 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001218 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001219 if other is NotImplemented:
1220 return other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001221
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001222 if context is None:
1223 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001224
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001225 resultsign = self._sign ^ other._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001226
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001227 if self._is_special or other._is_special:
1228 ans = self._check_nans(other, context)
1229 if ans:
1230 return ans
1231
1232 if self._isinfinity():
1233 if not other:
1234 return context._raise_error(InvalidOperation, '(+-)INF * 0')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001235 return _SignedInfinity[resultsign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001236
1237 if other._isinfinity():
1238 if not self:
1239 return context._raise_error(InvalidOperation, '0 * (+-)INF')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001240 return _SignedInfinity[resultsign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001241
1242 resultexp = self._exp + other._exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001243
1244 # Special case for multiplying by zero
1245 if not self or not other:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001246 ans = _dec_from_triple(resultsign, '0', resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001247 # Fixing in case the exponent is out of bounds
1248 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001249 return ans
1250
1251 # Special case for multiplying by power of 10
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001252 if self._int == '1':
1253 ans = _dec_from_triple(resultsign, other._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001254 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001255 return ans
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001256 if other._int == '1':
1257 ans = _dec_from_triple(resultsign, self._int, resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001258 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001259 return ans
1260
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001261 op1 = _WorkRep(self)
1262 op2 = _WorkRep(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001263
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001264 ans = _dec_from_triple(resultsign, str(op1.int * op2.int), resultexp)
Christian Heimes2c181612007-12-17 20:04:13 +00001265 ans = ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001266
1267 return ans
1268 __rmul__ = __mul__
1269
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001270 def __truediv__(self, other, context=None):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001271 """Return self / other."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001272 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001273 if other is NotImplemented:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001274 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001275
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001276 if context is None:
1277 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001278
Raymond Hettingerd87ac8f2004-07-09 10:52:54 +00001279 sign = self._sign ^ other._sign
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001280
1281 if self._is_special or other._is_special:
1282 ans = self._check_nans(other, context)
1283 if ans:
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001284 return ans
1285
1286 if self._isinfinity() and other._isinfinity():
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001287 return context._raise_error(InvalidOperation, '(+-)INF/(+-)INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001288
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001289 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001290 return _SignedInfinity[sign]
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001291
1292 if other._isinfinity():
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001293 context._raise_error(Clamped, 'Division by infinity')
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001294 return _dec_from_triple(sign, '0', context.Etiny())
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001295
1296 # Special cases for zeroes
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001297 if not other:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001298 if not self:
1299 return context._raise_error(DivisionUndefined, '0 / 0')
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001300 return context._raise_error(DivisionByZero, 'x / 0', sign)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001301
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001302 if not self:
1303 exp = self._exp - other._exp
1304 coeff = 0
1305 else:
1306 # OK, so neither = 0, INF or NaN
1307 shift = len(other._int) - len(self._int) + context.prec + 1
1308 exp = self._exp - other._exp - shift
1309 op1 = _WorkRep(self)
1310 op2 = _WorkRep(other)
1311 if shift >= 0:
1312 coeff, remainder = divmod(op1.int * 10**shift, op2.int)
1313 else:
1314 coeff, remainder = divmod(op1.int, op2.int * 10**-shift)
1315 if remainder:
1316 # result is not exact; adjust to ensure correct rounding
1317 if coeff % 5 == 0:
1318 coeff += 1
1319 else:
1320 # result is exact; get as close to ideal exponent as possible
1321 ideal_exp = self._exp - other._exp
1322 while exp < ideal_exp and coeff % 10 == 0:
1323 coeff //= 10
1324 exp += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001325
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001326 ans = _dec_from_triple(sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001327 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001328
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001329 def _divide(self, other, context):
1330 """Return (self // other, self % other), to context.prec precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001331
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001332 Assumes that neither self nor other is a NaN, that self is not
1333 infinite and that other is nonzero.
1334 """
1335 sign = self._sign ^ other._sign
1336 if other._isinfinity():
1337 ideal_exp = self._exp
1338 else:
1339 ideal_exp = min(self._exp, other._exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001340
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001341 expdiff = self.adjusted() - other.adjusted()
1342 if not self or other._isinfinity() or expdiff <= -2:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001343 return (_dec_from_triple(sign, '0', 0),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001344 self._rescale(ideal_exp, context.rounding))
1345 if expdiff <= context.prec:
1346 op1 = _WorkRep(self)
1347 op2 = _WorkRep(other)
1348 if op1.exp >= op2.exp:
1349 op1.int *= 10**(op1.exp - op2.exp)
1350 else:
1351 op2.int *= 10**(op2.exp - op1.exp)
1352 q, r = divmod(op1.int, op2.int)
1353 if q < 10**context.prec:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001354 return (_dec_from_triple(sign, str(q), 0),
1355 _dec_from_triple(self._sign, str(r), ideal_exp))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001356
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001357 # Here the quotient is too large to be representable
1358 ans = context._raise_error(DivisionImpossible,
1359 'quotient too large in //, % or divmod')
1360 return ans, ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001361
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001362 def __rtruediv__(self, other, context=None):
1363 """Swaps self/other and returns __truediv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001364 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001365 if other is NotImplemented:
1366 return other
Neal Norwitzbcc0db82006-03-24 08:14:36 +00001367 return other.__truediv__(self, context=context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001368
1369 def __divmod__(self, other, context=None):
1370 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001371 Return (self // other, self % other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001372 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001373 other = _convert_other(other)
1374 if other is NotImplemented:
1375 return other
1376
1377 if context is None:
1378 context = getcontext()
1379
1380 ans = self._check_nans(other, context)
1381 if ans:
1382 return (ans, ans)
1383
1384 sign = self._sign ^ other._sign
1385 if self._isinfinity():
1386 if other._isinfinity():
1387 ans = context._raise_error(InvalidOperation, 'divmod(INF, INF)')
1388 return ans, ans
1389 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001390 return (_SignedInfinity[sign],
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001391 context._raise_error(InvalidOperation, 'INF % x'))
1392
1393 if not other:
1394 if not self:
1395 ans = context._raise_error(DivisionUndefined, 'divmod(0, 0)')
1396 return ans, ans
1397 else:
1398 return (context._raise_error(DivisionByZero, 'x // 0', sign),
1399 context._raise_error(InvalidOperation, 'x % 0'))
1400
1401 quotient, remainder = self._divide(other, context)
Christian Heimes2c181612007-12-17 20:04:13 +00001402 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001403 return quotient, remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001404
1405 def __rdivmod__(self, other, context=None):
1406 """Swaps self/other and returns __divmod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001407 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001408 if other is NotImplemented:
1409 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001410 return other.__divmod__(self, context=context)
1411
1412 def __mod__(self, other, context=None):
1413 """
1414 self % other
1415 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001416 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001417 if other is NotImplemented:
1418 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001419
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001420 if context is None:
1421 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001422
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001423 ans = self._check_nans(other, context)
1424 if ans:
1425 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001426
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001427 if self._isinfinity():
1428 return context._raise_error(InvalidOperation, 'INF % x')
1429 elif not other:
1430 if self:
1431 return context._raise_error(InvalidOperation, 'x % 0')
1432 else:
1433 return context._raise_error(DivisionUndefined, '0 % 0')
1434
1435 remainder = self._divide(other, context)[1]
Christian Heimes2c181612007-12-17 20:04:13 +00001436 remainder = remainder._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001437 return remainder
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001438
1439 def __rmod__(self, other, context=None):
1440 """Swaps self/other and returns __mod__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001441 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001442 if other is NotImplemented:
1443 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001444 return other.__mod__(self, context=context)
1445
1446 def remainder_near(self, other, context=None):
1447 """
1448 Remainder nearest to 0- abs(remainder-near) <= other/2
1449 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001450 if context is None:
1451 context = getcontext()
1452
1453 other = _convert_other(other, raiseit=True)
1454
1455 ans = self._check_nans(other, context)
1456 if ans:
1457 return ans
1458
1459 # self == +/-infinity -> InvalidOperation
1460 if self._isinfinity():
1461 return context._raise_error(InvalidOperation,
1462 'remainder_near(infinity, x)')
1463
1464 # other == 0 -> either InvalidOperation or DivisionUndefined
1465 if not other:
1466 if self:
1467 return context._raise_error(InvalidOperation,
1468 'remainder_near(x, 0)')
1469 else:
1470 return context._raise_error(DivisionUndefined,
1471 'remainder_near(0, 0)')
1472
1473 # other = +/-infinity -> remainder = self
1474 if other._isinfinity():
1475 ans = Decimal(self)
1476 return ans._fix(context)
1477
1478 # self = 0 -> remainder = self, with ideal exponent
1479 ideal_exponent = min(self._exp, other._exp)
1480 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001481 ans = _dec_from_triple(self._sign, '0', ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001482 return ans._fix(context)
1483
1484 # catch most cases of large or small quotient
1485 expdiff = self.adjusted() - other.adjusted()
1486 if expdiff >= context.prec + 1:
1487 # expdiff >= prec+1 => abs(self/other) > 10**prec
1488 return context._raise_error(DivisionImpossible)
1489 if expdiff <= -2:
1490 # expdiff <= -2 => abs(self/other) < 0.1
1491 ans = self._rescale(ideal_exponent, context.rounding)
1492 return ans._fix(context)
1493
1494 # adjust both arguments to have the same exponent, then divide
1495 op1 = _WorkRep(self)
1496 op2 = _WorkRep(other)
1497 if op1.exp >= op2.exp:
1498 op1.int *= 10**(op1.exp - op2.exp)
1499 else:
1500 op2.int *= 10**(op2.exp - op1.exp)
1501 q, r = divmod(op1.int, op2.int)
1502 # remainder is r*10**ideal_exponent; other is +/-op2.int *
1503 # 10**ideal_exponent. Apply correction to ensure that
1504 # abs(remainder) <= abs(other)/2
1505 if 2*r + (q&1) > op2.int:
1506 r -= op2.int
1507 q += 1
1508
1509 if q >= 10**context.prec:
1510 return context._raise_error(DivisionImpossible)
1511
1512 # result has same sign as self unless r is negative
1513 sign = self._sign
1514 if r < 0:
1515 sign = 1-sign
1516 r = -r
1517
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001518 ans = _dec_from_triple(sign, str(r), ideal_exponent)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001519 return ans._fix(context)
1520
1521 def __floordiv__(self, other, context=None):
1522 """self // other"""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001523 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001524 if other is NotImplemented:
1525 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001526
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001527 if context is None:
1528 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001529
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001530 ans = self._check_nans(other, context)
1531 if ans:
1532 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001533
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001534 if self._isinfinity():
1535 if other._isinfinity():
1536 return context._raise_error(InvalidOperation, 'INF // INF')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001537 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001538 return _SignedInfinity[self._sign ^ other._sign]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001539
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001540 if not other:
1541 if self:
1542 return context._raise_error(DivisionByZero, 'x // 0',
1543 self._sign ^ other._sign)
1544 else:
1545 return context._raise_error(DivisionUndefined, '0 // 0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001546
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001547 return self._divide(other, context)[0]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001548
1549 def __rfloordiv__(self, other, context=None):
1550 """Swaps self/other and returns __floordiv__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001551 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00001552 if other is NotImplemented:
1553 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001554 return other.__floordiv__(self, context=context)
1555
1556 def __float__(self):
1557 """Float representation."""
1558 return float(str(self))
1559
1560 def __int__(self):
Brett Cannon46b08022005-03-01 03:12:26 +00001561 """Converts self to an int, truncating if necessary."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001562 if self._is_special:
1563 if self._isnan():
Mark Dickinson825fce32009-09-07 18:08:12 +00001564 raise ValueError("Cannot convert NaN to integer")
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001565 elif self._isinfinity():
Mark Dickinson825fce32009-09-07 18:08:12 +00001566 raise OverflowError("Cannot convert infinity to integer")
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001567 s = (-1)**self._sign
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001568 if self._exp >= 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001569 return s*int(self._int)*10**self._exp
Raymond Hettinger605ed022004-11-24 07:28:48 +00001570 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001571 return s*int(self._int[:self._exp] or '0')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001572
Christian Heimes969fe572008-01-25 11:23:10 +00001573 __trunc__ = __int__
1574
Christian Heimes0bd4e112008-02-12 22:59:25 +00001575 def real(self):
1576 return self
Mark Dickinson315a20a2009-01-04 21:34:18 +00001577 real = property(real)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001578
Christian Heimes0bd4e112008-02-12 22:59:25 +00001579 def imag(self):
1580 return Decimal(0)
Mark Dickinson315a20a2009-01-04 21:34:18 +00001581 imag = property(imag)
Christian Heimes0bd4e112008-02-12 22:59:25 +00001582
1583 def conjugate(self):
1584 return self
1585
1586 def __complex__(self):
1587 return complex(float(self))
1588
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001589 def _fix_nan(self, context):
1590 """Decapitate the payload of a NaN to fit the context"""
1591 payload = self._int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001592
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001593 # maximum length of payload is precision if clamp=0,
1594 # precision-1 if clamp=1.
1595 max_payload_len = context.prec - context.clamp
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001596 if len(payload) > max_payload_len:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001597 payload = payload[len(payload)-max_payload_len:].lstrip('0')
1598 return _dec_from_triple(self._sign, payload, self._exp, True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001599 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001600
Raymond Hettingerdab988d2004-10-09 07:10:44 +00001601 def _fix(self, context):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001602 """Round if it is necessary to keep self within prec precision.
1603
1604 Rounds and fixes the exponent. Does not raise on a sNaN.
1605
1606 Arguments:
1607 self - Decimal instance
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001608 context - context used.
1609 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001610
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001611 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001612 if self._isnan():
1613 # decapitate payload if necessary
1614 return self._fix_nan(context)
1615 else:
1616 # self is +/-Infinity; return unaltered
Raymond Hettinger636a6b12004-09-19 01:54:09 +00001617 return Decimal(self)
1618
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001619 # if self is zero then exponent should be between Etiny and
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001620 # Emax if clamp==0, and between Etiny and Etop if clamp==1.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001621 Etiny = context.Etiny()
1622 Etop = context.Etop()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001623 if not self:
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001624 exp_max = [context.Emax, Etop][context.clamp]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001625 new_exp = min(max(self._exp, Etiny), exp_max)
1626 if new_exp != self._exp:
1627 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001628 return _dec_from_triple(self._sign, '0', new_exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001629 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001630 return Decimal(self)
1631
1632 # exp_min is the smallest allowable exponent of the result,
1633 # equal to max(self.adjusted()-context.prec+1, Etiny)
1634 exp_min = len(self._int) + self._exp - context.prec
1635 if exp_min > Etop:
1636 # overflow: exp_min > Etop iff self.adjusted() > Emax
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001637 ans = context._raise_error(Overflow, 'above Emax', self._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001638 context._raise_error(Inexact)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001639 context._raise_error(Rounded)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001640 return ans
1641
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001642 self_is_subnormal = exp_min < Etiny
1643 if self_is_subnormal:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001644 exp_min = Etiny
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001645
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001646 # round if self has too many digits
1647 if self._exp < exp_min:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001648 digits = len(self._int) + self._exp - exp_min
1649 if digits < 0:
1650 self = _dec_from_triple(self._sign, '1', exp_min-1)
1651 digits = 0
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001652 rounding_method = self._pick_rounding_function[context.rounding]
Alexander Belopolsky1a20c122011-04-12 23:03:39 -04001653 changed = rounding_method(self, digits)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001654 coeff = self._int[:digits] or '0'
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001655 if changed > 0:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001656 coeff = str(int(coeff)+1)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001657 if len(coeff) > context.prec:
1658 coeff = coeff[:-1]
1659 exp_min += 1
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001660
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001661 # check whether the rounding pushed the exponent out of range
1662 if exp_min > Etop:
1663 ans = context._raise_error(Overflow, 'above Emax', self._sign)
1664 else:
1665 ans = _dec_from_triple(self._sign, coeff, exp_min)
1666
1667 # raise the appropriate signals, taking care to respect
1668 # the precedence described in the specification
1669 if changed and self_is_subnormal:
1670 context._raise_error(Underflow)
1671 if self_is_subnormal:
1672 context._raise_error(Subnormal)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001673 if changed:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001674 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001675 context._raise_error(Rounded)
1676 if not ans:
1677 # raise Clamped on underflow to 0
1678 context._raise_error(Clamped)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001679 return ans
1680
Mark Dickinsonc69160e2010-05-04 14:35:33 +00001681 if self_is_subnormal:
1682 context._raise_error(Subnormal)
1683
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00001684 # fold down if clamp == 1 and self has too few digits
1685 if context.clamp == 1 and self._exp > Etop:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001686 context._raise_error(Clamped)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001687 self_padded = self._int + '0'*(self._exp - Etop)
1688 return _dec_from_triple(self._sign, self_padded, Etop)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001689
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001690 # here self was representable to begin with; return unchanged
1691 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001692
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001693 # for each of the rounding functions below:
1694 # self is a finite, nonzero Decimal
1695 # prec is an integer satisfying 0 <= prec < len(self._int)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001696 #
1697 # each function returns either -1, 0, or 1, as follows:
1698 # 1 indicates that self should be rounded up (away from zero)
1699 # 0 indicates that self should be truncated, and that all the
1700 # digits to be truncated are zeros (so the value is unchanged)
1701 # -1 indicates that there are nonzero digits to be truncated
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001702
1703 def _round_down(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001704 """Also known as round-towards-0, truncate."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001705 if _all_zeros(self._int, prec):
1706 return 0
1707 else:
1708 return -1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001709
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001710 def _round_up(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001711 """Rounds away from 0."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001712 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001713
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001714 def _round_half_up(self, prec):
1715 """Rounds 5 up (away from 0)"""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001716 if self._int[prec] in '56789':
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001717 return 1
1718 elif _all_zeros(self._int, prec):
1719 return 0
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001720 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001721 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001722
1723 def _round_half_down(self, prec):
1724 """Round 5 down"""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001725 if _exact_half(self._int, prec):
1726 return -1
1727 else:
1728 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001729
1730 def _round_half_even(self, prec):
1731 """Round 5 to even, rest to nearest."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001732 if _exact_half(self._int, prec) and \
1733 (prec == 0 or self._int[prec-1] in '02468'):
1734 return -1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001735 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001736 return self._round_half_up(prec)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001737
1738 def _round_ceiling(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001739 """Rounds up (not away from 0 if negative.)"""
1740 if self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001741 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001742 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001743 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001744
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001745 def _round_floor(self, prec):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001746 """Rounds down (not towards 0 if negative)"""
1747 if not self._sign:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001748 return self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001749 else:
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001750 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001751
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001752 def _round_05up(self, prec):
1753 """Round down unless digit prec-1 is 0 or 5."""
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001754 if prec and self._int[prec-1] not in '05':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001755 return self._round_down(prec)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00001756 else:
1757 return -self._round_down(prec)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001758
Alexander Belopolsky1a20c122011-04-12 23:03:39 -04001759 _pick_rounding_function = dict(
1760 ROUND_DOWN = _round_down,
1761 ROUND_UP = _round_up,
1762 ROUND_HALF_UP = _round_half_up,
1763 ROUND_HALF_DOWN = _round_half_down,
1764 ROUND_HALF_EVEN = _round_half_even,
1765 ROUND_CEILING = _round_ceiling,
1766 ROUND_FLOOR = _round_floor,
1767 ROUND_05UP = _round_05up,
1768 )
1769
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001770 def __round__(self, n=None):
1771 """Round self to the nearest integer, or to a given precision.
1772
1773 If only one argument is supplied, round a finite Decimal
1774 instance self to the nearest integer. If self is infinite or
1775 a NaN then a Python exception is raised. If self is finite
1776 and lies exactly halfway between two integers then it is
1777 rounded to the integer with even last digit.
1778
1779 >>> round(Decimal('123.456'))
1780 123
1781 >>> round(Decimal('-456.789'))
1782 -457
1783 >>> round(Decimal('-3.0'))
1784 -3
1785 >>> round(Decimal('2.5'))
1786 2
1787 >>> round(Decimal('3.5'))
1788 4
1789 >>> round(Decimal('Inf'))
1790 Traceback (most recent call last):
1791 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001792 OverflowError: cannot round an infinity
1793 >>> round(Decimal('NaN'))
1794 Traceback (most recent call last):
1795 ...
Mark Dickinsonb27406c2008-05-09 13:42:33 +00001796 ValueError: cannot round a NaN
1797
1798 If a second argument n is supplied, self is rounded to n
1799 decimal places using the rounding mode for the current
1800 context.
1801
1802 For an integer n, round(self, -n) is exactly equivalent to
1803 self.quantize(Decimal('1En')).
1804
1805 >>> round(Decimal('123.456'), 0)
1806 Decimal('123')
1807 >>> round(Decimal('123.456'), 2)
1808 Decimal('123.46')
1809 >>> round(Decimal('123.456'), -2)
1810 Decimal('1E+2')
1811 >>> round(Decimal('-Infinity'), 37)
1812 Decimal('NaN')
1813 >>> round(Decimal('sNaN123'), 0)
1814 Decimal('NaN123')
1815
1816 """
1817 if n is not None:
1818 # two-argument form: use the equivalent quantize call
1819 if not isinstance(n, int):
1820 raise TypeError('Second argument to round should be integral')
1821 exp = _dec_from_triple(0, '1', -n)
1822 return self.quantize(exp)
1823
1824 # one-argument form
1825 if self._is_special:
1826 if self.is_nan():
1827 raise ValueError("cannot round a NaN")
1828 else:
1829 raise OverflowError("cannot round an infinity")
1830 return int(self._rescale(0, ROUND_HALF_EVEN))
1831
1832 def __floor__(self):
1833 """Return the floor of self, as an integer.
1834
1835 For a finite Decimal instance self, return the greatest
1836 integer n such that n <= self. If self is infinite or a NaN
1837 then a Python exception is raised.
1838
1839 """
1840 if self._is_special:
1841 if self.is_nan():
1842 raise ValueError("cannot round a NaN")
1843 else:
1844 raise OverflowError("cannot round an infinity")
1845 return int(self._rescale(0, ROUND_FLOOR))
1846
1847 def __ceil__(self):
1848 """Return the ceiling of self, as an integer.
1849
1850 For a finite Decimal instance self, return the least integer n
1851 such that n >= self. If self is infinite or a NaN then a
1852 Python exception is raised.
1853
1854 """
1855 if self._is_special:
1856 if self.is_nan():
1857 raise ValueError("cannot round a NaN")
1858 else:
1859 raise OverflowError("cannot round an infinity")
1860 return int(self._rescale(0, ROUND_CEILING))
1861
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001862 def fma(self, other, third, context=None):
1863 """Fused multiply-add.
1864
1865 Returns self*other+third with no rounding of the intermediate
1866 product self*other.
1867
1868 self and other are multiplied together, with no rounding of
1869 the result. The third operand is then added to the result,
1870 and a single final rounding is performed.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001871 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001872
1873 other = _convert_other(other, raiseit=True)
Mark Dickinsonb455e582011-05-22 12:53:18 +01001874 third = _convert_other(third, raiseit=True)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001875
1876 # compute product; raise InvalidOperation if either operand is
1877 # a signaling NaN or if the product is zero times infinity.
1878 if self._is_special or other._is_special:
1879 if context is None:
1880 context = getcontext()
1881 if self._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001882 return context._raise_error(InvalidOperation, 'sNaN', self)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001883 if other._exp == 'N':
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001884 return context._raise_error(InvalidOperation, 'sNaN', other)
Christian Heimes8b0facf2007-12-04 19:30:01 +00001885 if self._exp == 'n':
1886 product = self
1887 elif other._exp == 'n':
1888 product = other
1889 elif self._exp == 'F':
1890 if not other:
1891 return context._raise_error(InvalidOperation,
1892 'INF * 0 in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001893 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001894 elif other._exp == 'F':
1895 if not self:
1896 return context._raise_error(InvalidOperation,
1897 '0 * INF in fma')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00001898 product = _SignedInfinity[self._sign ^ other._sign]
Christian Heimes8b0facf2007-12-04 19:30:01 +00001899 else:
1900 product = _dec_from_triple(self._sign ^ other._sign,
1901 str(int(self._int) * int(other._int)),
1902 self._exp + other._exp)
1903
Christian Heimes8b0facf2007-12-04 19:30:01 +00001904 return product.__add__(third, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001905
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001906 def _power_modulo(self, other, modulo, context=None):
1907 """Three argument version of __pow__"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001908
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001909 # if can't convert other and modulo to Decimal, raise
1910 # TypeError; there's no point returning NotImplemented (no
1911 # equivalent of __rpow__ for three argument pow)
1912 other = _convert_other(other, raiseit=True)
1913 modulo = _convert_other(modulo, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001914
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001915 if context is None:
1916 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001917
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001918 # deal with NaNs: if there are any sNaNs then first one wins,
1919 # (i.e. behaviour for NaNs is identical to that of fma)
1920 self_is_nan = self._isnan()
1921 other_is_nan = other._isnan()
1922 modulo_is_nan = modulo._isnan()
1923 if self_is_nan or other_is_nan or modulo_is_nan:
1924 if self_is_nan == 2:
1925 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001926 self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001927 if other_is_nan == 2:
1928 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001929 other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001930 if modulo_is_nan == 2:
1931 return context._raise_error(InvalidOperation, 'sNaN',
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00001932 modulo)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001933 if self_is_nan:
1934 return self._fix_nan(context)
1935 if other_is_nan:
1936 return other._fix_nan(context)
1937 return modulo._fix_nan(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00001938
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001939 # check inputs: we apply same restrictions as Python's pow()
1940 if not (self._isinteger() and
1941 other._isinteger() and
1942 modulo._isinteger()):
1943 return context._raise_error(InvalidOperation,
1944 'pow() 3rd argument not allowed '
1945 'unless all arguments are integers')
1946 if other < 0:
1947 return context._raise_error(InvalidOperation,
1948 'pow() 2nd argument cannot be '
1949 'negative when 3rd argument specified')
1950 if not modulo:
1951 return context._raise_error(InvalidOperation,
1952 'pow() 3rd argument cannot be 0')
1953
1954 # additional restriction for decimal: the modulus must be less
1955 # than 10**prec in absolute value
1956 if modulo.adjusted() >= context.prec:
1957 return context._raise_error(InvalidOperation,
1958 'insufficient precision: pow() 3rd '
1959 'argument must not have more than '
1960 'precision digits')
1961
1962 # define 0**0 == NaN, for consistency with two-argument pow
1963 # (even though it hurts!)
1964 if not other and not self:
1965 return context._raise_error(InvalidOperation,
1966 'at least one of pow() 1st argument '
1967 'and 2nd argument must be nonzero ;'
1968 '0**0 is not defined')
1969
1970 # compute sign of result
1971 if other._iseven():
1972 sign = 0
1973 else:
1974 sign = self._sign
1975
1976 # convert modulo to a Python integer, and self and other to
1977 # Decimal integers (i.e. force their exponents to be >= 0)
1978 modulo = abs(int(modulo))
1979 base = _WorkRep(self.to_integral_value())
1980 exponent = _WorkRep(other.to_integral_value())
1981
1982 # compute result using integer pow()
1983 base = (base.int % modulo * pow(10, base.exp, modulo)) % modulo
1984 for i in range(exponent.exp):
1985 base = pow(base, 10, modulo)
1986 base = pow(base, exponent.int, modulo)
1987
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00001988 return _dec_from_triple(sign, str(base), 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001989
1990 def _power_exact(self, other, p):
1991 """Attempt to compute self**other exactly.
1992
1993 Given Decimals self and other and an integer p, attempt to
1994 compute an exact result for the power self**other, with p
1995 digits of precision. Return None if self**other is not
1996 exactly representable in p digits.
1997
1998 Assumes that elimination of special cases has already been
1999 performed: self and other must both be nonspecial; self must
2000 be positive and not numerically equal to 1; other must be
2001 nonzero. For efficiency, other._exp should not be too large,
2002 so that 10**abs(other._exp) is a feasible calculation."""
2003
Mark Dickinson7ce0fa82011-06-04 18:14:23 +01002004 # In the comments below, we write x for the value of self and y for the
2005 # value of other. Write x = xc*10**xe and abs(y) = yc*10**ye, with xc
2006 # and yc positive integers not divisible by 10.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002007
2008 # The main purpose of this method is to identify the *failure*
2009 # of x**y to be exactly representable with as little effort as
2010 # possible. So we look for cheap and easy tests that
2011 # eliminate the possibility of x**y being exact. Only if all
2012 # these tests are passed do we go on to actually compute x**y.
2013
Mark Dickinson7ce0fa82011-06-04 18:14:23 +01002014 # Here's the main idea. Express y as a rational number m/n, with m and
2015 # n relatively prime and n>0. Then for x**y to be exactly
2016 # representable (at *any* precision), xc must be the nth power of a
2017 # positive integer and xe must be divisible by n. If y is negative
2018 # then additionally xc must be a power of either 2 or 5, hence a power
2019 # of 2**n or 5**n.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002020 #
2021 # There's a limit to how small |y| can be: if y=m/n as above
2022 # then:
2023 #
2024 # (1) if xc != 1 then for the result to be representable we
2025 # need xc**(1/n) >= 2, and hence also xc**|y| >= 2. So
2026 # if |y| <= 1/nbits(xc) then xc < 2**nbits(xc) <=
2027 # 2**(1/|y|), hence xc**|y| < 2 and the result is not
2028 # representable.
2029 #
2030 # (2) if xe != 0, |xe|*(1/n) >= 1, so |xe|*|y| >= 1. Hence if
2031 # |y| < 1/|xe| then the result is not representable.
2032 #
2033 # Note that since x is not equal to 1, at least one of (1) and
2034 # (2) must apply. Now |y| < 1/nbits(xc) iff |yc|*nbits(xc) <
2035 # 10**-ye iff len(str(|yc|*nbits(xc)) <= -ye.
2036 #
2037 # There's also a limit to how large y can be, at least if it's
2038 # positive: the normalized result will have coefficient xc**y,
2039 # so if it's representable then xc**y < 10**p, and y <
2040 # p/log10(xc). Hence if y*log10(xc) >= p then the result is
2041 # not exactly representable.
2042
2043 # if len(str(abs(yc*xe)) <= -ye then abs(yc*xe) < 10**-ye,
2044 # so |y| < 1/xe and the result is not representable.
2045 # Similarly, len(str(abs(yc)*xc_bits)) <= -ye implies |y|
2046 # < 1/nbits(xc).
2047
2048 x = _WorkRep(self)
2049 xc, xe = x.int, x.exp
2050 while xc % 10 == 0:
2051 xc //= 10
2052 xe += 1
2053
2054 y = _WorkRep(other)
2055 yc, ye = y.int, y.exp
2056 while yc % 10 == 0:
2057 yc //= 10
2058 ye += 1
2059
2060 # case where xc == 1: result is 10**(xe*y), with xe*y
2061 # required to be an integer
2062 if xc == 1:
Mark Dickinsona1236312010-07-08 19:03:34 +00002063 xe *= yc
2064 # result is now 10**(xe * 10**ye); xe * 10**ye must be integral
2065 while xe % 10 == 0:
2066 xe //= 10
2067 ye += 1
2068 if ye < 0:
2069 return None
2070 exponent = xe * 10**ye
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002071 if y.sign == 1:
2072 exponent = -exponent
2073 # if other is a nonnegative integer, use ideal exponent
2074 if other._isinteger() and other._sign == 0:
2075 ideal_exponent = self._exp*int(other)
2076 zeros = min(exponent-ideal_exponent, p-1)
2077 else:
2078 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002079 return _dec_from_triple(0, '1' + '0'*zeros, exponent-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002080
2081 # case where y is negative: xc must be either a power
2082 # of 2 or a power of 5.
2083 if y.sign == 1:
2084 last_digit = xc % 10
2085 if last_digit in (2,4,6,8):
2086 # quick test for power of 2
2087 if xc & -xc != xc:
2088 return None
2089 # now xc is a power of 2; e is its exponent
2090 e = _nbits(xc)-1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002091
Mark Dickinson7ce0fa82011-06-04 18:14:23 +01002092 # We now have:
2093 #
2094 # x = 2**e * 10**xe, e > 0, and y < 0.
2095 #
2096 # The exact result is:
2097 #
2098 # x**y = 5**(-e*y) * 10**(e*y + xe*y)
2099 #
2100 # provided that both e*y and xe*y are integers. Note that if
2101 # 5**(-e*y) >= 10**p, then the result can't be expressed
2102 # exactly with p digits of precision.
2103 #
2104 # Using the above, we can guard against large values of ye.
2105 # 93/65 is an upper bound for log(10)/log(5), so if
2106 #
2107 # ye >= len(str(93*p//65))
2108 #
2109 # then
2110 #
2111 # -e*y >= -y >= 10**ye > 93*p/65 > p*log(10)/log(5),
2112 #
2113 # so 5**(-e*y) >= 10**p, and the coefficient of the result
2114 # can't be expressed in p digits.
2115
2116 # emax >= largest e such that 5**e < 10**p.
2117 emax = p*93//65
2118 if ye >= len(str(emax)):
2119 return None
2120
2121 # Find -e*y and -xe*y; both must be integers
2122 e = _decimal_lshift_exact(e * yc, ye)
2123 xe = _decimal_lshift_exact(xe * yc, ye)
2124 if e is None or xe is None:
2125 return None
2126
2127 if e > emax:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002128 return None
2129 xc = 5**e
2130
2131 elif last_digit == 5:
2132 # e >= log_5(xc) if xc is a power of 5; we have
2133 # equality all the way up to xc=5**2658
2134 e = _nbits(xc)*28//65
2135 xc, remainder = divmod(5**e, xc)
2136 if remainder:
2137 return None
2138 while xc % 5 == 0:
2139 xc //= 5
2140 e -= 1
Mark Dickinson7ce0fa82011-06-04 18:14:23 +01002141
2142 # Guard against large values of ye, using the same logic as in
2143 # the 'xc is a power of 2' branch. 10/3 is an upper bound for
2144 # log(10)/log(2).
2145 emax = p*10//3
2146 if ye >= len(str(emax)):
2147 return None
2148
2149 e = _decimal_lshift_exact(e * yc, ye)
2150 xe = _decimal_lshift_exact(xe * yc, ye)
2151 if e is None or xe is None:
2152 return None
2153
2154 if e > emax:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002155 return None
2156 xc = 2**e
2157 else:
2158 return None
2159
2160 if xc >= 10**p:
2161 return None
2162 xe = -e-xe
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002163 return _dec_from_triple(0, str(xc), xe)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002164
2165 # now y is positive; find m and n such that y = m/n
2166 if ye >= 0:
2167 m, n = yc*10**ye, 1
2168 else:
2169 if xe != 0 and len(str(abs(yc*xe))) <= -ye:
2170 return None
2171 xc_bits = _nbits(xc)
2172 if xc != 1 and len(str(abs(yc)*xc_bits)) <= -ye:
2173 return None
2174 m, n = yc, 10**(-ye)
2175 while m % 2 == n % 2 == 0:
2176 m //= 2
2177 n //= 2
2178 while m % 5 == n % 5 == 0:
2179 m //= 5
2180 n //= 5
2181
2182 # compute nth root of xc*10**xe
2183 if n > 1:
2184 # if 1 < xc < 2**n then xc isn't an nth power
2185 if xc != 1 and xc_bits <= n:
2186 return None
2187
2188 xe, rem = divmod(xe, n)
2189 if rem != 0:
2190 return None
2191
2192 # compute nth root of xc using Newton's method
2193 a = 1 << -(-_nbits(xc)//n) # initial estimate
2194 while True:
2195 q, r = divmod(xc, a**(n-1))
2196 if a <= q:
2197 break
2198 else:
2199 a = (a*(n-1) + q)//n
2200 if not (a == q and r == 0):
2201 return None
2202 xc = a
2203
2204 # now xc*10**xe is the nth root of the original xc*10**xe
2205 # compute mth power of xc*10**xe
2206
2207 # if m > p*100//_log10_lb(xc) then m > p/log10(xc), hence xc**m >
2208 # 10**p and the result is not representable.
2209 if xc > 1 and m > p*100//_log10_lb(xc):
2210 return None
2211 xc = xc**m
2212 xe *= m
2213 if xc > 10**p:
2214 return None
2215
2216 # by this point the result *is* exactly representable
2217 # adjust the exponent to get as close as possible to the ideal
2218 # exponent, if necessary
2219 str_xc = str(xc)
2220 if other._isinteger() and other._sign == 0:
2221 ideal_exponent = self._exp*int(other)
2222 zeros = min(xe-ideal_exponent, p-len(str_xc))
2223 else:
2224 zeros = 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002225 return _dec_from_triple(0, str_xc+'0'*zeros, xe-zeros)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002226
2227 def __pow__(self, other, modulo=None, context=None):
2228 """Return self ** other [ % modulo].
2229
2230 With two arguments, compute self**other.
2231
2232 With three arguments, compute (self**other) % modulo. For the
2233 three argument form, the following restrictions on the
2234 arguments hold:
2235
2236 - all three arguments must be integral
2237 - other must be nonnegative
2238 - either self or other (or both) must be nonzero
2239 - modulo must be nonzero and must have at most p digits,
2240 where p is the context precision.
2241
2242 If any of these restrictions is violated the InvalidOperation
2243 flag is raised.
2244
2245 The result of pow(self, other, modulo) is identical to the
2246 result that would be obtained by computing (self**other) %
2247 modulo with unbounded precision, but is computed more
2248 efficiently. It is always exact.
2249 """
2250
2251 if modulo is not None:
2252 return self._power_modulo(other, modulo, context)
2253
2254 other = _convert_other(other)
2255 if other is NotImplemented:
2256 return other
2257
2258 if context is None:
2259 context = getcontext()
2260
2261 # either argument is a NaN => result is NaN
2262 ans = self._check_nans(other, context)
2263 if ans:
2264 return ans
2265
2266 # 0**0 = NaN (!), x**0 = 1 for nonzero x (including +/-Infinity)
2267 if not other:
2268 if not self:
2269 return context._raise_error(InvalidOperation, '0 ** 0')
2270 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002271 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002272
2273 # result has sign 1 iff self._sign is 1 and other is an odd integer
2274 result_sign = 0
2275 if self._sign == 1:
2276 if other._isinteger():
2277 if not other._iseven():
2278 result_sign = 1
2279 else:
2280 # -ve**noninteger = NaN
2281 # (-0)**noninteger = 0**noninteger
2282 if self:
2283 return context._raise_error(InvalidOperation,
2284 'x ** y with x negative and y not an integer')
2285 # negate self, without doing any unwanted rounding
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002286 self = self.copy_negate()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002287
2288 # 0**(+ve or Inf)= 0; 0**(-ve or -Inf) = Infinity
2289 if not self:
2290 if other._sign == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002291 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002292 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002293 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002294
2295 # Inf**(+ve or Inf) = Inf; Inf**(-ve or -Inf) = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002296 if self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002297 if other._sign == 0:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002298 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002299 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002300 return _dec_from_triple(result_sign, '0', 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002301
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002302 # 1**other = 1, but the choice of exponent and the flags
2303 # depend on the exponent of self, and on whether other is a
2304 # positive integer, a negative integer, or neither
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002305 if self == _One:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002306 if other._isinteger():
2307 # exp = max(self._exp*max(int(other), 0),
2308 # 1-context.prec) but evaluating int(other) directly
2309 # is dangerous until we know other is small (other
2310 # could be 1e999999999)
2311 if other._sign == 1:
2312 multiplier = 0
2313 elif other > context.prec:
2314 multiplier = context.prec
2315 else:
2316 multiplier = int(other)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002317
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002318 exp = self._exp * multiplier
2319 if exp < 1-context.prec:
2320 exp = 1-context.prec
2321 context._raise_error(Rounded)
2322 else:
2323 context._raise_error(Inexact)
2324 context._raise_error(Rounded)
2325 exp = 1-context.prec
2326
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002327 return _dec_from_triple(result_sign, '1'+'0'*-exp, exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002328
2329 # compute adjusted exponent of self
2330 self_adj = self.adjusted()
2331
2332 # self ** infinity is infinity if self > 1, 0 if self < 1
2333 # self ** -infinity is infinity if self < 1, 0 if self > 1
2334 if other._isinfinity():
2335 if (other._sign == 0) == (self_adj < 0):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002336 return _dec_from_triple(result_sign, '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002337 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002338 return _SignedInfinity[result_sign]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002339
2340 # from here on, the result always goes through the call
2341 # to _fix at the end of this function.
2342 ans = None
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002343 exact = False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002344
2345 # crude test to catch cases of extreme overflow/underflow. If
2346 # log10(self)*other >= 10**bound and bound >= len(str(Emax))
2347 # then 10**bound >= 10**len(str(Emax)) >= Emax+1 and hence
2348 # self**other >= 10**(Emax+1), so overflow occurs. The test
2349 # for underflow is similar.
2350 bound = self._log10_exp_bound() + other.adjusted()
2351 if (self_adj >= 0) == (other._sign == 0):
2352 # self > 1 and other +ve, or self < 1 and other -ve
2353 # possibility of overflow
2354 if bound >= len(str(context.Emax)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002355 ans = _dec_from_triple(result_sign, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002356 else:
2357 # self > 1 and other -ve, or self < 1 and other +ve
2358 # possibility of underflow to 0
2359 Etiny = context.Etiny()
2360 if bound >= len(str(-Etiny)):
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002361 ans = _dec_from_triple(result_sign, '1', Etiny-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002362
2363 # try for an exact result with precision +1
2364 if ans is None:
2365 ans = self._power_exact(other, context.prec + 1)
Mark Dickinsone42f1bb2010-07-08 19:09:16 +00002366 if ans is not None:
2367 if result_sign == 1:
2368 ans = _dec_from_triple(1, ans._int, ans._exp)
2369 exact = True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002370
2371 # usual case: inexact result, x**y computed directly as exp(y*log(x))
2372 if ans is None:
2373 p = context.prec
2374 x = _WorkRep(self)
2375 xc, xe = x.int, x.exp
2376 y = _WorkRep(other)
2377 yc, ye = y.int, y.exp
2378 if y.sign == 1:
2379 yc = -yc
2380
2381 # compute correctly rounded result: start with precision +3,
2382 # then increase precision until result is unambiguously roundable
2383 extra = 3
2384 while True:
2385 coeff, exp = _dpower(xc, xe, yc, ye, p+extra)
2386 if coeff % (5*10**(len(str(coeff))-p-1)):
2387 break
2388 extra += 3
2389
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002390 ans = _dec_from_triple(result_sign, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002391
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002392 # unlike exp, ln and log10, the power function respects the
2393 # rounding mode; no need to switch to ROUND_HALF_EVEN here
2394
2395 # There's a difficulty here when 'other' is not an integer and
2396 # the result is exact. In this case, the specification
2397 # requires that the Inexact flag be raised (in spite of
2398 # exactness), but since the result is exact _fix won't do this
2399 # for us. (Correspondingly, the Underflow signal should also
2400 # be raised for subnormal results.) We can't directly raise
2401 # these signals either before or after calling _fix, since
2402 # that would violate the precedence for signals. So we wrap
2403 # the ._fix call in a temporary context, and reraise
2404 # afterwards.
2405 if exact and not other._isinteger():
2406 # pad with zeros up to length context.prec+1 if necessary; this
2407 # ensures that the Rounded signal will be raised.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002408 if len(ans._int) <= context.prec:
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002409 expdiff = context.prec + 1 - len(ans._int)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002410 ans = _dec_from_triple(ans._sign, ans._int+'0'*expdiff,
2411 ans._exp-expdiff)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002412
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002413 # create a copy of the current context, with cleared flags/traps
2414 newcontext = context.copy()
2415 newcontext.clear_flags()
2416 for exception in _signals:
2417 newcontext.traps[exception] = 0
2418
2419 # round in the new context
2420 ans = ans._fix(newcontext)
2421
2422 # raise Inexact, and if necessary, Underflow
2423 newcontext._raise_error(Inexact)
2424 if newcontext.flags[Subnormal]:
2425 newcontext._raise_error(Underflow)
2426
2427 # propagate signals to the original context; _fix could
2428 # have raised any of Overflow, Underflow, Subnormal,
2429 # Inexact, Rounded, Clamped. Overflow needs the correct
2430 # arguments. Note that the order of the exceptions is
2431 # important here.
2432 if newcontext.flags[Overflow]:
2433 context._raise_error(Overflow, 'above Emax', ans._sign)
2434 for exception in Underflow, Subnormal, Inexact, Rounded, Clamped:
2435 if newcontext.flags[exception]:
2436 context._raise_error(exception)
2437
2438 else:
2439 ans = ans._fix(context)
2440
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002441 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002442
2443 def __rpow__(self, other, context=None):
2444 """Swaps self/other and returns __pow__."""
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002445 other = _convert_other(other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00002446 if other is NotImplemented:
2447 return other
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002448 return other.__pow__(self, context=context)
2449
2450 def normalize(self, context=None):
2451 """Normalize- strip trailing 0s, change anything equal to 0 to 0e0"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002452
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002453 if context is None:
2454 context = getcontext()
2455
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002456 if self._is_special:
2457 ans = self._check_nans(context=context)
2458 if ans:
2459 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002460
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002461 dup = self._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002462 if dup._isinfinity():
2463 return dup
2464
2465 if not dup:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002466 return _dec_from_triple(dup._sign, '0', 0)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00002467 exp_max = [context.Emax, context.Etop()][context.clamp]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002468 end = len(dup._int)
2469 exp = dup._exp
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002470 while dup._int[end-1] == '0' and exp < exp_max:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002471 exp += 1
2472 end -= 1
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002473 return _dec_from_triple(dup._sign, dup._int[:end], exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002474
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002475 def quantize(self, exp, rounding=None, context=None, watchexp=True):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002476 """Quantize self so its exponent is the same as that of exp.
2477
2478 Similar to self._rescale(exp._exp) but with error checking.
2479 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002480 exp = _convert_other(exp, raiseit=True)
2481
2482 if context is None:
2483 context = getcontext()
2484 if rounding is None:
2485 rounding = context.rounding
2486
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002487 if self._is_special or exp._is_special:
2488 ans = self._check_nans(exp, context)
2489 if ans:
2490 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002491
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002492 if exp._isinfinity() or self._isinfinity():
2493 if exp._isinfinity() and self._isinfinity():
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002494 return Decimal(self) # if both are inf, it is OK
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002495 return context._raise_error(InvalidOperation,
2496 'quantize with one INF')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002497
2498 # if we're not watching exponents, do a simple rescale
2499 if not watchexp:
2500 ans = self._rescale(exp._exp, rounding)
2501 # raise Inexact and Rounded where appropriate
2502 if ans._exp > self._exp:
2503 context._raise_error(Rounded)
2504 if ans != self:
2505 context._raise_error(Inexact)
2506 return ans
2507
2508 # exp._exp should be between Etiny and Emax
2509 if not (context.Etiny() <= exp._exp <= context.Emax):
2510 return context._raise_error(InvalidOperation,
2511 'target exponent out of bounds in quantize')
2512
2513 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002514 ans = _dec_from_triple(self._sign, '0', exp._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002515 return ans._fix(context)
2516
2517 self_adjusted = self.adjusted()
2518 if self_adjusted > context.Emax:
2519 return context._raise_error(InvalidOperation,
2520 'exponent of quantize result too large for current context')
2521 if self_adjusted - exp._exp + 1 > context.prec:
2522 return context._raise_error(InvalidOperation,
2523 'quantize result has too many digits for current context')
2524
2525 ans = self._rescale(exp._exp, rounding)
2526 if ans.adjusted() > context.Emax:
2527 return context._raise_error(InvalidOperation,
2528 'exponent of quantize result too large for current context')
2529 if len(ans._int) > context.prec:
2530 return context._raise_error(InvalidOperation,
2531 'quantize result has too many digits for current context')
2532
2533 # raise appropriate flags
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002534 if ans and ans.adjusted() < context.Emin:
2535 context._raise_error(Subnormal)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002536 if ans._exp > self._exp:
2537 if ans != self:
2538 context._raise_error(Inexact)
2539 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002540
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002541 # call to fix takes care of any necessary folddown, and
2542 # signals Clamped if necessary
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002543 ans = ans._fix(context)
2544 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002545
2546 def same_quantum(self, other):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002547 """Return True if self and other have the same exponent; otherwise
2548 return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002549
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002550 If either operand is a special value, the following rules are used:
2551 * return True if both operands are infinities
2552 * return True if both operands are NaNs
2553 * otherwise, return False.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002554 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002555 other = _convert_other(other, raiseit=True)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002556 if self._is_special or other._is_special:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00002557 return (self.is_nan() and other.is_nan() or
2558 self.is_infinite() and other.is_infinite())
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002559 return self._exp == other._exp
2560
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002561 def _rescale(self, exp, rounding):
2562 """Rescale self so that the exponent is exp, either by padding with zeros
2563 or by truncating digits, using the given rounding mode.
2564
2565 Specials are returned without change. This operation is
2566 quiet: it raises no flags, and uses no information from the
2567 context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002568
2569 exp = exp to scale to (an integer)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002570 rounding = rounding mode
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002571 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002572 if self._is_special:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002573 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002574 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002575 return _dec_from_triple(self._sign, '0', exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002576
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002577 if self._exp >= exp:
2578 # pad answer with zeros if necessary
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002579 return _dec_from_triple(self._sign,
2580 self._int + '0'*(self._exp - exp), exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002581
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002582 # too many digits; round and lose data. If self.adjusted() <
2583 # exp-1, replace self by 10**(exp-1) before rounding
2584 digits = len(self._int) + self._exp - exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002585 if digits < 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002586 self = _dec_from_triple(self._sign, '1', exp-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002587 digits = 0
Alexander Belopolsky1a20c122011-04-12 23:03:39 -04002588 this_function = self._pick_rounding_function[rounding]
2589 changed = this_function(self, digits)
Christian Heimescbf3b5c2007-12-03 21:02:03 +00002590 coeff = self._int[:digits] or '0'
2591 if changed == 1:
2592 coeff = str(int(coeff)+1)
2593 return _dec_from_triple(self._sign, coeff, exp)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002594
Christian Heimesf16baeb2008-02-29 14:57:44 +00002595 def _round(self, places, rounding):
2596 """Round a nonzero, nonspecial Decimal to a fixed number of
2597 significant figures, using the given rounding mode.
2598
2599 Infinities, NaNs and zeros are returned unaltered.
2600
2601 This operation is quiet: it raises no flags, and uses no
2602 information from the context.
2603
2604 """
2605 if places <= 0:
2606 raise ValueError("argument should be at least 1 in _round")
2607 if self._is_special or not self:
2608 return Decimal(self)
2609 ans = self._rescale(self.adjusted()+1-places, rounding)
2610 # it can happen that the rescale alters the adjusted exponent;
2611 # for example when rounding 99.97 to 3 significant figures.
2612 # When this happens we end up with an extra 0 at the end of
2613 # the number; a second rescale fixes this.
2614 if ans.adjusted() != self.adjusted():
2615 ans = ans._rescale(ans.adjusted()+1-places, rounding)
2616 return ans
2617
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002618 def to_integral_exact(self, rounding=None, context=None):
2619 """Rounds to a nearby integer.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002620
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002621 If no rounding mode is specified, take the rounding mode from
2622 the context. This method raises the Rounded and Inexact flags
2623 when appropriate.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002624
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002625 See also: to_integral_value, which does exactly the same as
2626 this method except that it doesn't raise Inexact or Rounded.
2627 """
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002628 if self._is_special:
2629 ans = self._check_nans(context=context)
2630 if ans:
2631 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002632 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002633 if self._exp >= 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002634 return Decimal(self)
2635 if not self:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002636 return _dec_from_triple(self._sign, '0', 0)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002637 if context is None:
2638 context = getcontext()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002639 if rounding is None:
2640 rounding = context.rounding
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002641 ans = self._rescale(0, rounding)
2642 if ans != self:
2643 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00002644 context._raise_error(Rounded)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002645 return ans
2646
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002647 def to_integral_value(self, rounding=None, context=None):
2648 """Rounds to the nearest integer, without raising inexact, rounded."""
2649 if context is None:
2650 context = getcontext()
2651 if rounding is None:
2652 rounding = context.rounding
2653 if self._is_special:
2654 ans = self._check_nans(context=context)
2655 if ans:
2656 return ans
2657 return Decimal(self)
2658 if self._exp >= 0:
2659 return Decimal(self)
2660 else:
2661 return self._rescale(0, rounding)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002662
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002663 # the method name changed, but we provide also the old one, for compatibility
2664 to_integral = to_integral_value
2665
2666 def sqrt(self, context=None):
2667 """Return the square root of self."""
Christian Heimes0348fb62008-03-26 12:55:56 +00002668 if context is None:
2669 context = getcontext()
2670
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002671 if self._is_special:
2672 ans = self._check_nans(context=context)
2673 if ans:
2674 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002675
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002676 if self._isinfinity() and self._sign == 0:
2677 return Decimal(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002678
2679 if not self:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002680 # exponent = self._exp // 2. sqrt(-0) = -0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002681 ans = _dec_from_triple(self._sign, '0', self._exp // 2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002682 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002683
2684 if self._sign == 1:
2685 return context._raise_error(InvalidOperation, 'sqrt(-x), x > 0')
2686
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002687 # At this point self represents a positive number. Let p be
2688 # the desired precision and express self in the form c*100**e
2689 # with c a positive real number and e an integer, c and e
2690 # being chosen so that 100**(p-1) <= c < 100**p. Then the
2691 # (exact) square root of self is sqrt(c)*10**e, and 10**(p-1)
2692 # <= sqrt(c) < 10**p, so the closest representable Decimal at
2693 # precision p is n*10**e where n = round_half_even(sqrt(c)),
2694 # the closest integer to sqrt(c) with the even integer chosen
2695 # in the case of a tie.
2696 #
2697 # To ensure correct rounding in all cases, we use the
2698 # following trick: we compute the square root to an extra
2699 # place (precision p+1 instead of precision p), rounding down.
2700 # Then, if the result is inexact and its last digit is 0 or 5,
2701 # we increase the last digit to 1 or 6 respectively; if it's
2702 # exact we leave the last digit alone. Now the final round to
2703 # p places (or fewer in the case of underflow) will round
2704 # correctly and raise the appropriate flags.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002705
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002706 # use an extra digit of precision
2707 prec = context.prec+1
2708
2709 # write argument in the form c*100**e where e = self._exp//2
2710 # is the 'ideal' exponent, to be used if the square root is
2711 # exactly representable. l is the number of 'digits' of c in
2712 # base 100, so that 100**(l-1) <= c < 100**l.
2713 op = _WorkRep(self)
2714 e = op.exp >> 1
2715 if op.exp & 1:
2716 c = op.int * 10
2717 l = (len(self._int) >> 1) + 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002718 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002719 c = op.int
2720 l = len(self._int)+1 >> 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002721
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002722 # rescale so that c has exactly prec base 100 'digits'
2723 shift = prec-l
2724 if shift >= 0:
2725 c *= 100**shift
2726 exact = True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002727 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002728 c, remainder = divmod(c, 100**-shift)
2729 exact = not remainder
2730 e -= shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002731
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002732 # find n = floor(sqrt(c)) using Newton's method
2733 n = 10**prec
2734 while True:
2735 q = c//n
2736 if n <= q:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002737 break
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002738 else:
2739 n = n + q >> 1
2740 exact = exact and n*n == c
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002741
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002742 if exact:
2743 # result is exact; rescale to use ideal exponent e
2744 if shift >= 0:
2745 # assert n % 10**shift == 0
2746 n //= 10**shift
2747 else:
2748 n *= 10**-shift
2749 e += shift
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002750 else:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002751 # result is not exact; fix last digit as described above
2752 if n % 5 == 0:
2753 n += 1
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002754
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002755 ans = _dec_from_triple(0, str(n), e)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002756
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002757 # round, and fit to current context
2758 context = context._shallow_copy()
2759 rounding = context._set_rounding(ROUND_HALF_EVEN)
Raymond Hettingerdab988d2004-10-09 07:10:44 +00002760 ans = ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002761 context.rounding = rounding
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002762
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002763 return ans
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002764
2765 def max(self, other, context=None):
2766 """Returns the larger value.
2767
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002768 Like max(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:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002790 # If both operands are finite and equal in numerical value
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002791 # then an ordering is applied:
2792 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002793 # If the signs differ then max returns the operand with the
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002794 # positive sign and min returns the operand with the negative sign
2795 #
Guido van Rossumd8faa362007-04-27 19:54:29 +00002796 # If the signs are the same then the exponent is used to select
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002797 # the result. This is exactly the ordering used in compare_total.
2798 c = self.compare_total(other)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002799
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002800 if c == -1:
2801 ans = other
2802 else:
2803 ans = self
2804
Christian Heimes2c181612007-12-17 20:04:13 +00002805 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002806
2807 def min(self, other, context=None):
2808 """Returns the smaller value.
2809
Guido van Rossumd8faa362007-04-27 19:54:29 +00002810 Like min(self, other) except if one is not a number, returns
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002811 NaN (and signals if one is sNaN). Also rounds.
2812 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002813 other = _convert_other(other, raiseit=True)
2814
2815 if context is None:
2816 context = getcontext()
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002817
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002818 if self._is_special or other._is_special:
Guido van Rossumd8faa362007-04-27 19:54:29 +00002819 # If one operand is a quiet NaN and the other is number, then the
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002820 # number is always returned
2821 sn = self._isnan()
2822 on = other._isnan()
2823 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00002824 if on == 1 and sn == 0:
2825 return self._fix(context)
2826 if sn == 1 and on == 0:
2827 return other._fix(context)
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002828 return self._check_nans(other, context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002829
Christian Heimes77c02eb2008-02-09 02:18:51 +00002830 c = self._cmp(other)
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00002831 if c == 0:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002832 c = self.compare_total(other)
2833
2834 if c == -1:
2835 ans = self
2836 else:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002837 ans = other
Raymond Hettinger636a6b12004-09-19 01:54:09 +00002838
Christian Heimes2c181612007-12-17 20:04:13 +00002839 return ans._fix(context)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002840
2841 def _isinteger(self):
2842 """Returns whether self is an integer"""
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002843 if self._is_special:
2844 return False
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002845 if self._exp >= 0:
2846 return True
2847 rest = self._int[self._exp:]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002848 return rest == '0'*len(rest)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002849
2850 def _iseven(self):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002851 """Returns True if self is even. Assumes self is an integer."""
2852 if not self or self._exp > 0:
2853 return True
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002854 return self._int[-1+self._exp] in '02468'
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002855
2856 def adjusted(self):
2857 """Return the adjusted exponent of self"""
2858 try:
2859 return self._exp + len(self._int) - 1
Guido van Rossumd8faa362007-04-27 19:54:29 +00002860 # If NaN or Infinity, self._exp is string
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00002861 except TypeError:
2862 return 0
2863
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002864 def canonical(self, context=None):
2865 """Returns the same Decimal object.
2866
2867 As we do not have different encodings for the same number, the
2868 received object already is in its canonical form.
2869 """
2870 return self
2871
2872 def compare_signal(self, other, context=None):
2873 """Compares self to the other operand numerically.
2874
2875 It's pretty much like compare(), but all NaNs signal, with signaling
2876 NaNs taking precedence over quiet NaNs.
2877 """
Christian Heimes77c02eb2008-02-09 02:18:51 +00002878 other = _convert_other(other, raiseit = True)
2879 ans = self._compare_check_nans(other, context)
2880 if ans:
2881 return ans
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002882 return self.compare(other, context=context)
2883
2884 def compare_total(self, other):
2885 """Compares self to other using the abstract representations.
2886
2887 This is not like the standard compare, which use their numerical
2888 value. Note that a total ordering is defined for all possible abstract
2889 representations.
2890 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002891 other = _convert_other(other, raiseit=True)
2892
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002893 # if one is negative and the other is positive, it's easy
2894 if self._sign and not other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002895 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002896 if not self._sign and other._sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002897 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002898 sign = self._sign
2899
2900 # let's handle both NaN types
2901 self_nan = self._isnan()
2902 other_nan = other._isnan()
2903 if self_nan or other_nan:
2904 if self_nan == other_nan:
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002905 # compare payloads as though they're integers
2906 self_key = len(self._int), self._int
2907 other_key = len(other._int), other._int
2908 if self_key < other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002909 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002910 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002911 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002912 return _NegativeOne
Mark Dickinsond314e1b2009-08-28 13:39:53 +00002913 if self_key > other_key:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002914 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002915 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002916 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002917 return _One
2918 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002919
2920 if sign:
2921 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002922 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002923 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002924 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002925 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002926 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002927 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002928 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002929 else:
2930 if self_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002931 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002932 if other_nan == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002933 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002934 if self_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002935 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002936 if other_nan == 2:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002937 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002938
2939 if self < other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002940 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002941 if self > other:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002942 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002943
2944 if self._exp < other._exp:
2945 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002946 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002947 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002948 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002949 if self._exp > other._exp:
2950 if sign:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002951 return _NegativeOne
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002952 else:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002953 return _One
2954 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002955
2956
2957 def compare_total_mag(self, other):
2958 """Compares self to other using abstract repr., ignoring sign.
2959
2960 Like compare_total, but with operand's sign ignored and assumed to be 0.
2961 """
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00002962 other = _convert_other(other, raiseit=True)
2963
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002964 s = self.copy_abs()
2965 o = other.copy_abs()
2966 return s.compare_total(o)
2967
2968 def copy_abs(self):
2969 """Returns a copy with the sign set to 0. """
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002970 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002971
2972 def copy_negate(self):
2973 """Returns a copy with the sign inverted."""
2974 if self._sign:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002975 return _dec_from_triple(0, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002976 else:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002977 return _dec_from_triple(1, self._int, self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002978
2979 def copy_sign(self, other):
2980 """Returns self with the sign of other."""
Mark Dickinson84230a12010-02-18 14:49:50 +00002981 other = _convert_other(other, raiseit=True)
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00002982 return _dec_from_triple(other._sign, self._int,
2983 self._exp, self._is_special)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002984
2985 def exp(self, context=None):
2986 """Returns e ** self."""
2987
2988 if context is None:
2989 context = getcontext()
2990
2991 # exp(NaN) = NaN
2992 ans = self._check_nans(context=context)
2993 if ans:
2994 return ans
2995
2996 # exp(-Infinity) = 0
2997 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00002998 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00002999
3000 # exp(0) = 1
3001 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003002 return _One
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003003
3004 # exp(Infinity) = Infinity
3005 if self._isinfinity() == 1:
3006 return Decimal(self)
3007
3008 # the result is now guaranteed to be inexact (the true
3009 # mathematical result is transcendental). There's no need to
3010 # raise Rounded and Inexact here---they'll always be raised as
3011 # a result of the call to _fix.
3012 p = context.prec
3013 adj = self.adjusted()
3014
3015 # we only need to do any computation for quite a small range
3016 # of adjusted exponents---for example, -29 <= adj <= 10 for
3017 # the default context. For smaller exponent the result is
3018 # indistinguishable from 1 at the given precision, while for
3019 # larger exponent the result either overflows or underflows.
3020 if self._sign == 0 and adj > len(str((context.Emax+1)*3)):
3021 # overflow
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003022 ans = _dec_from_triple(0, '1', context.Emax+1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003023 elif self._sign == 1 and adj > len(str((-context.Etiny()+1)*3)):
3024 # underflow to 0
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003025 ans = _dec_from_triple(0, '1', context.Etiny()-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003026 elif self._sign == 0 and adj < -p:
3027 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003028 ans = _dec_from_triple(0, '1' + '0'*(p-1) + '1', -p)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003029 elif self._sign == 1 and adj < -p-1:
3030 # p+1 digits; final round will raise correct flags
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003031 ans = _dec_from_triple(0, '9'*(p+1), -p-1)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003032 # general case
3033 else:
3034 op = _WorkRep(self)
3035 c, e = op.int, op.exp
3036 if op.sign == 1:
3037 c = -c
3038
3039 # compute correctly rounded result: increase precision by
3040 # 3 digits at a time until we get an unambiguously
3041 # roundable result
3042 extra = 3
3043 while True:
3044 coeff, exp = _dexp(c, e, p+extra)
3045 if coeff % (5*10**(len(str(coeff))-p-1)):
3046 break
3047 extra += 3
3048
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003049 ans = _dec_from_triple(0, str(coeff), exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003050
3051 # at this stage, ans should round correctly with *any*
3052 # rounding mode, not just with ROUND_HALF_EVEN
3053 context = context._shallow_copy()
3054 rounding = context._set_rounding(ROUND_HALF_EVEN)
3055 ans = ans._fix(context)
3056 context.rounding = rounding
3057
3058 return ans
3059
3060 def is_canonical(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003061 """Return True if self is canonical; otherwise return False.
3062
3063 Currently, the encoding of a Decimal instance is always
3064 canonical, so this method returns True for any Decimal.
3065 """
3066 return True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003067
3068 def is_finite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003069 """Return True if self is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003070
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003071 A Decimal instance is considered finite if it is neither
3072 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003073 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003074 return not self._is_special
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003075
3076 def is_infinite(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003077 """Return True if self is infinite; otherwise return False."""
3078 return self._exp == 'F'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003079
3080 def is_nan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003081 """Return True if self is a qNaN or sNaN; otherwise return False."""
3082 return self._exp in ('n', 'N')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003083
3084 def is_normal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003085 """Return True if self is a normal number; otherwise return False."""
3086 if self._is_special or not self:
3087 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003088 if context is None:
3089 context = getcontext()
Mark Dickinson06bb6742009-10-20 13:38:04 +00003090 return context.Emin <= self.adjusted()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003091
3092 def is_qnan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003093 """Return True if self is a quiet NaN; otherwise return False."""
3094 return self._exp == 'n'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003095
3096 def is_signed(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003097 """Return True if self is negative; otherwise return False."""
3098 return self._sign == 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003099
3100 def is_snan(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003101 """Return True if self is a signaling NaN; otherwise return False."""
3102 return self._exp == 'N'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003103
3104 def is_subnormal(self, context=None):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003105 """Return True if self is subnormal; otherwise return False."""
3106 if self._is_special or not self:
3107 return False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003108 if context is None:
3109 context = getcontext()
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003110 return self.adjusted() < context.Emin
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003111
3112 def is_zero(self):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00003113 """Return True if self is a zero; otherwise return False."""
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003114 return not self._is_special and self._int == '0'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003115
3116 def _ln_exp_bound(self):
3117 """Compute a lower bound for the adjusted exponent of self.ln().
3118 In other words, compute r such that self.ln() >= 10**r. Assumes
3119 that self is finite and positive and that self != 1.
3120 """
3121
3122 # for 0.1 <= x <= 10 we use the inequalities 1-1/x <= ln(x) <= x-1
3123 adj = self._exp + len(self._int) - 1
3124 if adj >= 1:
3125 # argument >= 10; we use 23/10 = 2.3 as a lower bound for ln(10)
3126 return len(str(adj*23//10)) - 1
3127 if adj <= -2:
3128 # argument <= 0.1
3129 return len(str((-1-adj)*23//10)) - 1
3130 op = _WorkRep(self)
3131 c, e = op.int, op.exp
3132 if adj == 0:
3133 # 1 < self < 10
3134 num = str(c-10**-e)
3135 den = str(c)
3136 return len(num) - len(den) - (num < den)
3137 # adj == -1, 0.1 <= self < 1
3138 return e + len(str(10**-e - c)) - 1
3139
3140
3141 def ln(self, context=None):
3142 """Returns the natural (base e) logarithm of self."""
3143
3144 if context is None:
3145 context = getcontext()
3146
3147 # ln(NaN) = NaN
3148 ans = self._check_nans(context=context)
3149 if ans:
3150 return ans
3151
3152 # ln(0.0) == -Infinity
3153 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003154 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003155
3156 # ln(Infinity) = Infinity
3157 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003158 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003159
3160 # ln(1.0) == 0.0
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003161 if self == _One:
3162 return _Zero
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003163
3164 # ln(negative) raises InvalidOperation
3165 if self._sign == 1:
3166 return context._raise_error(InvalidOperation,
3167 'ln of a negative value')
3168
3169 # result is irrational, so necessarily inexact
3170 op = _WorkRep(self)
3171 c, e = op.int, op.exp
3172 p = context.prec
3173
3174 # correctly rounded result: repeatedly increase precision by 3
3175 # until we get an unambiguously roundable result
3176 places = p - self._ln_exp_bound() + 2 # at least p+3 places
3177 while True:
3178 coeff = _dlog(c, e, places)
3179 # assert len(str(abs(coeff)))-p >= 1
3180 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3181 break
3182 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003183 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003184
3185 context = context._shallow_copy()
3186 rounding = context._set_rounding(ROUND_HALF_EVEN)
3187 ans = ans._fix(context)
3188 context.rounding = rounding
3189 return ans
3190
3191 def _log10_exp_bound(self):
3192 """Compute a lower bound for the adjusted exponent of self.log10().
3193 In other words, find r such that self.log10() >= 10**r.
3194 Assumes that self is finite and positive and that self != 1.
3195 """
3196
3197 # For x >= 10 or x < 0.1 we only need a bound on the integer
3198 # part of log10(self), and this comes directly from the
3199 # exponent of x. For 0.1 <= x <= 10 we use the inequalities
3200 # 1-1/x <= log(x) <= x-1. If x > 1 we have |log10(x)| >
3201 # (1-1/x)/2.31 > 0. If x < 1 then |log10(x)| > (1-x)/2.31 > 0
3202
3203 adj = self._exp + len(self._int) - 1
3204 if adj >= 1:
3205 # self >= 10
3206 return len(str(adj))-1
3207 if adj <= -2:
3208 # self < 0.1
3209 return len(str(-1-adj))-1
3210 op = _WorkRep(self)
3211 c, e = op.int, op.exp
3212 if adj == 0:
3213 # 1 < self < 10
3214 num = str(c-10**-e)
3215 den = str(231*c)
3216 return len(num) - len(den) - (num < den) + 2
3217 # adj == -1, 0.1 <= self < 1
3218 num = str(10**-e-c)
3219 return len(num) + e - (num < "231") - 1
3220
3221 def log10(self, context=None):
3222 """Returns the base 10 logarithm of self."""
3223
3224 if context is None:
3225 context = getcontext()
3226
3227 # log10(NaN) = NaN
3228 ans = self._check_nans(context=context)
3229 if ans:
3230 return ans
3231
3232 # log10(0.0) == -Infinity
3233 if not self:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003234 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003235
3236 # log10(Infinity) = Infinity
3237 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003238 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003239
3240 # log10(negative or -Infinity) raises InvalidOperation
3241 if self._sign == 1:
3242 return context._raise_error(InvalidOperation,
3243 'log10 of a negative value')
3244
3245 # log10(10**n) = n
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003246 if self._int[0] == '1' and self._int[1:] == '0'*(len(self._int) - 1):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003247 # answer may need rounding
3248 ans = Decimal(self._exp + len(self._int) - 1)
3249 else:
3250 # result is irrational, so necessarily inexact
3251 op = _WorkRep(self)
3252 c, e = op.int, op.exp
3253 p = context.prec
3254
3255 # correctly rounded result: repeatedly increase precision
3256 # until result is unambiguously roundable
3257 places = p-self._log10_exp_bound()+2
3258 while True:
3259 coeff = _dlog10(c, e, places)
3260 # assert len(str(abs(coeff)))-p >= 1
3261 if coeff % (5*10**(len(str(abs(coeff)))-p-1)):
3262 break
3263 places += 3
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003264 ans = _dec_from_triple(int(coeff<0), str(abs(coeff)), -places)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003265
3266 context = context._shallow_copy()
3267 rounding = context._set_rounding(ROUND_HALF_EVEN)
3268 ans = ans._fix(context)
3269 context.rounding = rounding
3270 return ans
3271
3272 def logb(self, context=None):
3273 """ Returns the exponent of the magnitude of self's MSD.
3274
3275 The result is the integer which is the exponent of the magnitude
3276 of the most significant digit of self (as though it were truncated
3277 to a single digit while maintaining the value of that digit and
3278 without limiting the resulting exponent).
3279 """
3280 # logb(NaN) = NaN
3281 ans = self._check_nans(context=context)
3282 if ans:
3283 return ans
3284
3285 if context is None:
3286 context = getcontext()
3287
3288 # logb(+/-Inf) = +Inf
3289 if self._isinfinity():
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003290 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003291
3292 # logb(0) = -Inf, DivisionByZero
3293 if not self:
3294 return context._raise_error(DivisionByZero, 'logb(0)', 1)
3295
3296 # otherwise, simply return the adjusted exponent of self, as a
3297 # Decimal. Note that no attempt is made to fit the result
3298 # into the current context.
Mark Dickinson56df8872009-10-07 19:23:50 +00003299 ans = Decimal(self.adjusted())
3300 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003301
3302 def _islogical(self):
3303 """Return True if self is a logical operand.
3304
Christian Heimes679db4a2008-01-18 09:56:22 +00003305 For being logical, it must be a finite number with a sign of 0,
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003306 an exponent of 0, and a coefficient whose digits must all be
3307 either 0 or 1.
3308 """
3309 if self._sign != 0 or self._exp != 0:
3310 return False
3311 for dig in self._int:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003312 if dig not in '01':
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003313 return False
3314 return True
3315
3316 def _fill_logical(self, context, opa, opb):
3317 dif = context.prec - len(opa)
3318 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003319 opa = '0'*dif + opa
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003320 elif dif < 0:
3321 opa = opa[-context.prec:]
3322 dif = context.prec - len(opb)
3323 if dif > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003324 opb = '0'*dif + opb
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003325 elif dif < 0:
3326 opb = opb[-context.prec:]
3327 return opa, opb
3328
3329 def logical_and(self, other, context=None):
3330 """Applies an 'and' operation between self and other's digits."""
3331 if context is None:
3332 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003333
3334 other = _convert_other(other, raiseit=True)
3335
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003336 if not self._islogical() or not other._islogical():
3337 return context._raise_error(InvalidOperation)
3338
3339 # fill to context.prec
3340 (opa, opb) = self._fill_logical(context, self._int, other._int)
3341
3342 # make the operation, and clean starting zeroes
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003343 result = "".join([str(int(a)&int(b)) for a,b in zip(opa,opb)])
3344 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003345
3346 def logical_invert(self, context=None):
3347 """Invert all its digits."""
3348 if context is None:
3349 context = getcontext()
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003350 return self.logical_xor(_dec_from_triple(0,'1'*context.prec,0),
3351 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003352
3353 def logical_or(self, other, context=None):
3354 """Applies an 'or' operation between self and other's digits."""
3355 if context is None:
3356 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003357
3358 other = _convert_other(other, raiseit=True)
3359
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003360 if not self._islogical() or not other._islogical():
3361 return context._raise_error(InvalidOperation)
3362
3363 # fill to context.prec
3364 (opa, opb) = self._fill_logical(context, self._int, other._int)
3365
3366 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003367 result = "".join([str(int(a)|int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003368 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003369
3370 def logical_xor(self, other, context=None):
3371 """Applies an 'xor' operation between self and other's digits."""
3372 if context is None:
3373 context = getcontext()
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003374
3375 other = _convert_other(other, raiseit=True)
3376
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003377 if not self._islogical() or not other._islogical():
3378 return context._raise_error(InvalidOperation)
3379
3380 # fill to context.prec
3381 (opa, opb) = self._fill_logical(context, self._int, other._int)
3382
3383 # make the operation, and clean starting zeroes
Mark Dickinson315a20a2009-01-04 21:34:18 +00003384 result = "".join([str(int(a)^int(b)) for a,b in zip(opa,opb)])
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003385 return _dec_from_triple(0, result.lstrip('0') or '0', 0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003386
3387 def max_mag(self, other, context=None):
3388 """Compares the values numerically with their sign ignored."""
3389 other = _convert_other(other, raiseit=True)
3390
3391 if context is None:
3392 context = getcontext()
3393
3394 if self._is_special or other._is_special:
3395 # If one operand is a quiet NaN and the other is number, then the
3396 # number is always returned
3397 sn = self._isnan()
3398 on = other._isnan()
3399 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003400 if on == 1 and sn == 0:
3401 return self._fix(context)
3402 if sn == 1 and on == 0:
3403 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003404 return self._check_nans(other, context)
3405
Christian Heimes77c02eb2008-02-09 02:18:51 +00003406 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003407 if c == 0:
3408 c = self.compare_total(other)
3409
3410 if c == -1:
3411 ans = other
3412 else:
3413 ans = self
3414
Christian Heimes2c181612007-12-17 20:04:13 +00003415 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003416
3417 def min_mag(self, other, context=None):
3418 """Compares the values numerically with their sign ignored."""
3419 other = _convert_other(other, raiseit=True)
3420
3421 if context is None:
3422 context = getcontext()
3423
3424 if self._is_special or other._is_special:
3425 # If one operand is a quiet NaN and the other is number, then the
3426 # number is always returned
3427 sn = self._isnan()
3428 on = other._isnan()
3429 if sn or on:
Facundo Batista708d5812008-12-11 04:20:07 +00003430 if on == 1 and sn == 0:
3431 return self._fix(context)
3432 if sn == 1 and on == 0:
3433 return other._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003434 return self._check_nans(other, context)
3435
Christian Heimes77c02eb2008-02-09 02:18:51 +00003436 c = self.copy_abs()._cmp(other.copy_abs())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003437 if c == 0:
3438 c = self.compare_total(other)
3439
3440 if c == -1:
3441 ans = self
3442 else:
3443 ans = other
3444
Christian Heimes2c181612007-12-17 20:04:13 +00003445 return ans._fix(context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003446
3447 def next_minus(self, context=None):
3448 """Returns the largest representable number smaller than itself."""
3449 if context is None:
3450 context = getcontext()
3451
3452 ans = self._check_nans(context=context)
3453 if ans:
3454 return ans
3455
3456 if self._isinfinity() == -1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003457 return _NegativeInfinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003458 if self._isinfinity() == 1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003459 return _dec_from_triple(0, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003460
3461 context = context.copy()
3462 context._set_rounding(ROUND_FLOOR)
3463 context._ignore_all_flags()
3464 new_self = self._fix(context)
3465 if new_self != self:
3466 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003467 return self.__sub__(_dec_from_triple(0, '1', context.Etiny()-1),
3468 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003469
3470 def next_plus(self, context=None):
3471 """Returns the smallest representable number larger than itself."""
3472 if context is None:
3473 context = getcontext()
3474
3475 ans = self._check_nans(context=context)
3476 if ans:
3477 return ans
3478
3479 if self._isinfinity() == 1:
Mark Dickinson627cf6a2009-01-03 12:11:47 +00003480 return _Infinity
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003481 if self._isinfinity() == -1:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003482 return _dec_from_triple(1, '9'*context.prec, context.Etop())
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003483
3484 context = context.copy()
3485 context._set_rounding(ROUND_CEILING)
3486 context._ignore_all_flags()
3487 new_self = self._fix(context)
3488 if new_self != self:
3489 return new_self
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003490 return self.__add__(_dec_from_triple(0, '1', context.Etiny()-1),
3491 context)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003492
3493 def next_toward(self, other, context=None):
3494 """Returns the number closest to self, in the direction towards other.
3495
3496 The result is the closest representable number to self
3497 (excluding self) that is in the direction towards other,
3498 unless both have the same value. If the two operands are
3499 numerically equal, then the result is a copy of self with the
3500 sign set to be the same as the sign of other.
3501 """
3502 other = _convert_other(other, raiseit=True)
3503
3504 if context is None:
3505 context = getcontext()
3506
3507 ans = self._check_nans(other, context)
3508 if ans:
3509 return ans
3510
Christian Heimes77c02eb2008-02-09 02:18:51 +00003511 comparison = self._cmp(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003512 if comparison == 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003513 return self.copy_sign(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003514
3515 if comparison == -1:
3516 ans = self.next_plus(context)
3517 else: # comparison == 1
3518 ans = self.next_minus(context)
3519
3520 # decide which flags to raise using value of ans
3521 if ans._isinfinity():
3522 context._raise_error(Overflow,
3523 'Infinite result from next_toward',
3524 ans._sign)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003525 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003526 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003527 elif ans.adjusted() < context.Emin:
3528 context._raise_error(Underflow)
3529 context._raise_error(Subnormal)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003530 context._raise_error(Inexact)
Mark Dickinsonc69160e2010-05-04 14:35:33 +00003531 context._raise_error(Rounded)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003532 # if precision == 1 then we don't raise Clamped for a
3533 # result 0E-Etiny.
3534 if not ans:
3535 context._raise_error(Clamped)
3536
3537 return ans
3538
3539 def number_class(self, context=None):
3540 """Returns an indication of the class of self.
3541
3542 The class is one of the following strings:
Christian Heimes5fb7c2a2007-12-24 08:52:31 +00003543 sNaN
3544 NaN
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003545 -Infinity
3546 -Normal
3547 -Subnormal
3548 -Zero
3549 +Zero
3550 +Subnormal
3551 +Normal
3552 +Infinity
3553 """
3554 if self.is_snan():
3555 return "sNaN"
3556 if self.is_qnan():
3557 return "NaN"
3558 inf = self._isinfinity()
3559 if inf == 1:
3560 return "+Infinity"
3561 if inf == -1:
3562 return "-Infinity"
3563 if self.is_zero():
3564 if self._sign:
3565 return "-Zero"
3566 else:
3567 return "+Zero"
3568 if context is None:
3569 context = getcontext()
3570 if self.is_subnormal(context=context):
3571 if self._sign:
3572 return "-Subnormal"
3573 else:
3574 return "+Subnormal"
3575 # just a normal, regular, boring number, :)
3576 if self._sign:
3577 return "-Normal"
3578 else:
3579 return "+Normal"
3580
3581 def radix(self):
3582 """Just returns 10, as this is Decimal, :)"""
3583 return Decimal(10)
3584
3585 def rotate(self, other, context=None):
3586 """Returns a rotated copy of self, value-of-other times."""
3587 if context is None:
3588 context = getcontext()
3589
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003590 other = _convert_other(other, raiseit=True)
3591
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003592 ans = self._check_nans(other, context)
3593 if ans:
3594 return ans
3595
3596 if other._exp != 0:
3597 return context._raise_error(InvalidOperation)
3598 if not (-context.prec <= int(other) <= context.prec):
3599 return context._raise_error(InvalidOperation)
3600
3601 if self._isinfinity():
3602 return Decimal(self)
3603
3604 # get values, pad if necessary
3605 torot = int(other)
3606 rotdig = self._int
3607 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003608 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003609 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003610 elif topad < 0:
3611 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003612
3613 # let's rotate!
3614 rotated = rotdig[torot:] + rotdig[:torot]
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003615 return _dec_from_triple(self._sign,
3616 rotated.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003617
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003618 def scaleb(self, other, context=None):
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003619 """Returns self operand after adding the second value to its exp."""
3620 if context is None:
3621 context = getcontext()
3622
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003623 other = _convert_other(other, raiseit=True)
3624
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003625 ans = self._check_nans(other, context)
3626 if ans:
3627 return ans
3628
3629 if other._exp != 0:
3630 return context._raise_error(InvalidOperation)
3631 liminf = -2 * (context.Emax + context.prec)
3632 limsup = 2 * (context.Emax + context.prec)
3633 if not (liminf <= int(other) <= limsup):
3634 return context._raise_error(InvalidOperation)
3635
3636 if self._isinfinity():
3637 return Decimal(self)
3638
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003639 d = _dec_from_triple(self._sign, self._int, self._exp + int(other))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003640 d = d._fix(context)
3641 return d
3642
3643 def shift(self, other, context=None):
3644 """Returns a shifted copy of self, value-of-other times."""
3645 if context is None:
3646 context = getcontext()
3647
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003648 other = _convert_other(other, raiseit=True)
3649
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003650 ans = self._check_nans(other, context)
3651 if ans:
3652 return ans
3653
3654 if other._exp != 0:
3655 return context._raise_error(InvalidOperation)
3656 if not (-context.prec <= int(other) <= context.prec):
3657 return context._raise_error(InvalidOperation)
3658
3659 if self._isinfinity():
3660 return Decimal(self)
3661
3662 # get values, pad if necessary
3663 torot = int(other)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003664 rotdig = self._int
3665 topad = context.prec - len(rotdig)
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003666 if topad > 0:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003667 rotdig = '0'*topad + rotdig
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003668 elif topad < 0:
3669 rotdig = rotdig[-topad:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003670
3671 # let's shift!
3672 if torot < 0:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003673 shifted = rotdig[:torot]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003674 else:
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003675 shifted = rotdig + '0'*torot
3676 shifted = shifted[-context.prec:]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003677
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003678 return _dec_from_triple(self._sign,
Mark Dickinsona2d1fe02009-10-29 12:23:02 +00003679 shifted.lstrip('0') or '0', self._exp)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003680
Guido van Rossumd8faa362007-04-27 19:54:29 +00003681 # Support for pickling, copy, and deepcopy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003682 def __reduce__(self):
3683 return (self.__class__, (str(self),))
3684
3685 def __copy__(self):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003686 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003687 return self # I'm immutable; therefore I am my own clone
3688 return self.__class__(str(self))
3689
3690 def __deepcopy__(self, memo):
Benjamin Petersond69fe2a2010-02-03 02:59:43 +00003691 if type(self) is Decimal:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003692 return self # My components are also immutable
3693 return self.__class__(str(self))
3694
Mark Dickinson79f52032009-03-17 23:12:51 +00003695 # PEP 3101 support. the _localeconv keyword argument should be
3696 # considered private: it's provided for ease of testing only.
3697 def __format__(self, specifier, context=None, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00003698 """Format a Decimal instance according to the given specifier.
3699
3700 The specifier should be a standard format specifier, with the
3701 form described in PEP 3101. Formatting types 'e', 'E', 'f',
Mark Dickinson79f52032009-03-17 23:12:51 +00003702 'F', 'g', 'G', 'n' and '%' are supported. If the formatting
3703 type is omitted it defaults to 'g' or 'G', depending on the
3704 value of context.capitals.
Christian Heimesf16baeb2008-02-29 14:57:44 +00003705 """
3706
3707 # Note: PEP 3101 says that if the type is not present then
3708 # there should be at least one digit after the decimal point.
3709 # We take the liberty of ignoring this requirement for
3710 # Decimal---it's presumably there to make sure that
3711 # format(float, '') behaves similarly to str(float).
3712 if context is None:
3713 context = getcontext()
3714
Mark Dickinson79f52032009-03-17 23:12:51 +00003715 spec = _parse_format_specifier(specifier, _localeconv=_localeconv)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003716
Mark Dickinson79f52032009-03-17 23:12:51 +00003717 # special values don't care about the type or precision
Christian Heimesf16baeb2008-02-29 14:57:44 +00003718 if self._is_special:
Mark Dickinson79f52032009-03-17 23:12:51 +00003719 sign = _format_sign(self._sign, spec)
3720 body = str(self.copy_abs())
3721 return _format_align(sign, body, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003722
3723 # a type of None defaults to 'g' or 'G', depending on context
Christian Heimesf16baeb2008-02-29 14:57:44 +00003724 if spec['type'] is None:
3725 spec['type'] = ['g', 'G'][context.capitals]
Mark Dickinson79f52032009-03-17 23:12:51 +00003726
3727 # if type is '%', adjust exponent of self accordingly
3728 if spec['type'] == '%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003729 self = _dec_from_triple(self._sign, self._int, self._exp+2)
3730
3731 # round if necessary, taking rounding mode from the context
3732 rounding = context.rounding
3733 precision = spec['precision']
3734 if precision is not None:
3735 if spec['type'] in 'eE':
3736 self = self._round(precision+1, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003737 elif spec['type'] in 'fF%':
3738 self = self._rescale(-precision, rounding)
Mark Dickinson79f52032009-03-17 23:12:51 +00003739 elif spec['type'] in 'gG' and len(self._int) > precision:
3740 self = self._round(precision, rounding)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003741 # special case: zeros with a positive exponent can't be
3742 # represented in fixed point; rescale them to 0e0.
Mark Dickinson79f52032009-03-17 23:12:51 +00003743 if not self and self._exp > 0 and spec['type'] in 'fF%':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003744 self = self._rescale(0, rounding)
3745
3746 # figure out placement of the decimal point
3747 leftdigits = self._exp + len(self._int)
Mark Dickinson79f52032009-03-17 23:12:51 +00003748 if spec['type'] in 'eE':
Christian Heimesf16baeb2008-02-29 14:57:44 +00003749 if not self and precision is not None:
3750 dotplace = 1 - precision
3751 else:
3752 dotplace = 1
Mark Dickinson79f52032009-03-17 23:12:51 +00003753 elif spec['type'] in 'fF%':
3754 dotplace = leftdigits
Christian Heimesf16baeb2008-02-29 14:57:44 +00003755 elif spec['type'] in 'gG':
3756 if self._exp <= 0 and leftdigits > -6:
3757 dotplace = leftdigits
3758 else:
3759 dotplace = 1
3760
Mark Dickinson79f52032009-03-17 23:12:51 +00003761 # find digits before and after decimal point, and get exponent
3762 if dotplace < 0:
3763 intpart = '0'
3764 fracpart = '0'*(-dotplace) + self._int
3765 elif dotplace > len(self._int):
3766 intpart = self._int + '0'*(dotplace-len(self._int))
3767 fracpart = ''
Christian Heimesf16baeb2008-02-29 14:57:44 +00003768 else:
Mark Dickinson79f52032009-03-17 23:12:51 +00003769 intpart = self._int[:dotplace] or '0'
3770 fracpart = self._int[dotplace:]
3771 exp = leftdigits-dotplace
Christian Heimesf16baeb2008-02-29 14:57:44 +00003772
Mark Dickinson79f52032009-03-17 23:12:51 +00003773 # done with the decimal-specific stuff; hand over the rest
3774 # of the formatting to the _format_number function
3775 return _format_number(self._sign, intpart, fracpart, exp, spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00003776
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00003777def _dec_from_triple(sign, coefficient, exponent, special=False):
3778 """Create a decimal instance directly, without any validation,
3779 normalization (e.g. removal of leading zeros) or argument
3780 conversion.
3781
3782 This function is for *internal use only*.
3783 """
3784
3785 self = object.__new__(Decimal)
3786 self._sign = sign
3787 self._int = coefficient
3788 self._exp = exponent
3789 self._is_special = special
3790
3791 return self
3792
Raymond Hettinger82417ca2009-02-03 03:54:28 +00003793# Register Decimal as a kind of Number (an abstract base class).
3794# However, do not register it as Real (because Decimals are not
3795# interoperable with floats).
3796_numbers.Number.register(Decimal)
3797
3798
Guido van Rossumd8faa362007-04-27 19:54:29 +00003799##### Context class #######################################################
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003800
Thomas Wouters89f507f2006-12-13 04:49:30 +00003801class _ContextManager(object):
3802 """Context manager class to support localcontext().
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003803
Thomas Wouters89f507f2006-12-13 04:49:30 +00003804 Sets a copy of the supplied context in __enter__() and restores
3805 the previous decimal context in __exit__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003806 """
3807 def __init__(self, new_context):
Thomas Wouters89f507f2006-12-13 04:49:30 +00003808 self.new_context = new_context.copy()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003809 def __enter__(self):
3810 self.saved_context = getcontext()
3811 setcontext(self.new_context)
3812 return self.new_context
3813 def __exit__(self, t, v, tb):
3814 setcontext(self.saved_context)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00003815
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003816class Context(object):
3817 """Contains the context for a Decimal instance.
3818
3819 Contains:
3820 prec - precision (for use in rounding, division, square roots..)
Guido van Rossumd8faa362007-04-27 19:54:29 +00003821 rounding - rounding type (how you round)
Raymond Hettingerbf440692004-07-10 14:14:37 +00003822 traps - If traps[exception] = 1, then the exception is
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003823 raised when it is caused. Otherwise, a value is
3824 substituted in.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003825 flags - When an exception is caused, flags[exception] is set.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003826 (Whether or not the trap_enabler is set)
3827 Should be reset by user of Decimal instance.
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003828 Emin - Minimum exponent
3829 Emax - Maximum exponent
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003830 capitals - If 1, 1*10^1 is printed as 1E+1.
3831 If 0, printed as 1e1
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003832 clamp - If 1, change exponents if too high (Default 0)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003833 """
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003834
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003835 def __init__(self, prec=None, rounding=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003836 traps=None, flags=None,
Raymond Hettinger0ea241e2004-07-04 13:53:24 +00003837 Emin=None, Emax=None,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003838 capitals=None, clamp=None,
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003839 _ignored_flags=None):
Mark Dickinson0dd8f782010-07-08 21:15:36 +00003840 # Set defaults; for everything except flags and _ignored_flags,
3841 # inherit from DefaultContext.
3842 try:
3843 dc = DefaultContext
3844 except NameError:
3845 pass
3846
3847 self.prec = prec if prec is not None else dc.prec
3848 self.rounding = rounding if rounding is not None else dc.rounding
3849 self.Emin = Emin if Emin is not None else dc.Emin
3850 self.Emax = Emax if Emax is not None else dc.Emax
3851 self.capitals = capitals if capitals is not None else dc.capitals
3852 self.clamp = clamp if clamp is not None else dc.clamp
3853
Raymond Hettingerabf8a562004-10-12 09:12:16 +00003854 if _ignored_flags is None:
Mark Dickinson0dd8f782010-07-08 21:15:36 +00003855 self._ignored_flags = []
3856 else:
3857 self._ignored_flags = _ignored_flags
3858
3859 if traps is None:
3860 self.traps = dc.traps.copy()
3861 elif not isinstance(traps, dict):
3862 self.traps = dict((s, int(s in traps)) for s in _signals)
3863 else:
3864 self.traps = traps
3865
3866 if flags is None:
3867 self.flags = dict.fromkeys(_signals, 0)
3868 elif not isinstance(flags, dict):
3869 self.flags = dict((s, int(s in flags)) for s in _signals)
3870 else:
3871 self.flags = flags
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003872
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003873 def __repr__(self):
Raymond Hettingerbf440692004-07-10 14:14:37 +00003874 """Show the current context."""
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003875 s = []
Guido van Rossumd8faa362007-04-27 19:54:29 +00003876 s.append('Context(prec=%(prec)d, rounding=%(rounding)s, '
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003877 'Emin=%(Emin)d, Emax=%(Emax)d, capitals=%(capitals)d, '
3878 'clamp=%(clamp)d'
Guido van Rossumd8faa362007-04-27 19:54:29 +00003879 % vars(self))
3880 names = [f.__name__ for f, v in self.flags.items() if v]
3881 s.append('flags=[' + ', '.join(names) + ']')
3882 names = [t.__name__ for t, v in self.traps.items() if v]
3883 s.append('traps=[' + ', '.join(names) + ']')
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003884 return ', '.join(s) + ')'
3885
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003886 def clear_flags(self):
3887 """Reset all flags to zero"""
3888 for flag in self.flags:
Raymond Hettingerb1b605e2004-07-04 01:55:39 +00003889 self.flags[flag] = 0
Raymond Hettingerd9c0a7a2004-07-03 10:02:28 +00003890
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003891 def _shallow_copy(self):
3892 """Returns a shallow copy from self."""
Christian Heimes2c181612007-12-17 20:04:13 +00003893 nc = Context(self.prec, self.rounding, self.traps,
3894 self.flags, self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003895 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003896 return nc
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003897
3898 def copy(self):
3899 """Returns a deep copy from self."""
Guido van Rossumd8faa362007-04-27 19:54:29 +00003900 nc = Context(self.prec, self.rounding, self.traps.copy(),
Christian Heimes2c181612007-12-17 20:04:13 +00003901 self.flags.copy(), self.Emin, self.Emax,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003902 self.capitals, self.clamp, self._ignored_flags)
Raymond Hettinger9fce44b2004-08-08 04:03:24 +00003903 return nc
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00003904 __copy__ = copy
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003905
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003906 def _raise_error(self, condition, explanation = None, *args):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003907 """Handles an error
3908
3909 If the flag is in _ignored_flags, returns the default response.
Raymond Hettinger86173da2008-02-01 20:38:12 +00003910 Otherwise, it sets the flag, then, if the corresponding
Stefan Krah2eb4a072010-05-19 15:52:31 +00003911 trap_enabler is set, it reraises the exception. Otherwise, it returns
Raymond Hettinger86173da2008-02-01 20:38:12 +00003912 the default value after setting the flag.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003913 """
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003914 error = _condition_map.get(condition, condition)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003915 if error in self._ignored_flags:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003916 # Don't touch the flag
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003917 return error().handle(self, *args)
3918
Raymond Hettinger86173da2008-02-01 20:38:12 +00003919 self.flags[error] = 1
Raymond Hettingerbf440692004-07-10 14:14:37 +00003920 if not self.traps[error]:
Guido van Rossumd8faa362007-04-27 19:54:29 +00003921 # The errors define how to handle themselves.
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003922 return condition().handle(self, *args)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003923
3924 # Errors should only be risked on copies of the context
Guido van Rossumd8faa362007-04-27 19:54:29 +00003925 # self._ignored_flags = []
Collin Winterce36ad82007-08-30 01:19:48 +00003926 raise error(explanation)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003927
3928 def _ignore_all_flags(self):
3929 """Ignore all flags, if they are raised"""
Raymond Hettingerfed52962004-07-14 15:41:57 +00003930 return self._ignore_flags(*_signals)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003931
3932 def _ignore_flags(self, *flags):
3933 """Ignore the flags, if they are raised"""
3934 # Do not mutate-- This way, copies of a context leave the original
3935 # alone.
3936 self._ignored_flags = (self._ignored_flags + list(flags))
3937 return list(flags)
3938
3939 def _regard_flags(self, *flags):
3940 """Stop ignoring the flags, if they are raised"""
3941 if flags and isinstance(flags[0], (tuple,list)):
3942 flags = flags[0]
3943 for flag in flags:
3944 self._ignored_flags.remove(flag)
3945
Nick Coghland1abd252008-07-15 15:46:38 +00003946 # We inherit object.__hash__, so we must deny this explicitly
3947 __hash__ = None
Raymond Hettinger5aa478b2004-07-09 10:02:53 +00003948
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003949 def Etiny(self):
3950 """Returns Etiny (= Emin - prec + 1)"""
3951 return int(self.Emin - self.prec + 1)
3952
3953 def Etop(self):
Raymond Hettingere0f15812004-07-05 05:36:39 +00003954 """Returns maximum exponent (= Emax - prec + 1)"""
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003955 return int(self.Emax - self.prec + 1)
3956
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003957 def _set_rounding(self, type):
3958 """Sets the rounding type.
3959
3960 Sets the rounding type, and returns the current (previous)
3961 rounding type. Often used like:
3962
3963 context = context.copy()
3964 # so you don't change the calling context
3965 # if an error occurs in the middle.
3966 rounding = context._set_rounding(ROUND_UP)
3967 val = self.__sub__(other, context=context)
3968 context._set_rounding(rounding)
3969
3970 This will make it round up for that operation.
3971 """
3972 rounding = self.rounding
3973 self.rounding= type
3974 return rounding
3975
Raymond Hettingerfed52962004-07-14 15:41:57 +00003976 def create_decimal(self, num='0'):
Christian Heimesa62da1d2008-01-12 19:39:10 +00003977 """Creates a new Decimal instance but using self as context.
3978
3979 This method implements the to-number operation of the
3980 IBM Decimal specification."""
3981
3982 if isinstance(num, str) and num != num.strip():
3983 return self._raise_error(ConversionSyntax,
3984 "no trailing or leading whitespace is "
3985 "permitted.")
3986
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003987 d = Decimal(num, context=self)
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00003988 if d._isnan() and len(d._int) > self.prec - self.clamp:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003989 return self._raise_error(ConversionSyntax,
3990 "diagnostic info too long in NaN")
Raymond Hettingerdab988d2004-10-09 07:10:44 +00003991 return d._fix(self)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00003992
Raymond Hettinger771ed762009-01-03 19:20:32 +00003993 def create_decimal_from_float(self, f):
3994 """Creates a new Decimal instance from a float but rounding using self
3995 as the context.
3996
3997 >>> context = Context(prec=5, rounding=ROUND_DOWN)
3998 >>> context.create_decimal_from_float(3.1415926535897932)
3999 Decimal('3.1415')
4000 >>> context = Context(prec=5, traps=[Inexact])
4001 >>> context.create_decimal_from_float(3.1415926535897932)
4002 Traceback (most recent call last):
4003 ...
4004 decimal.Inexact: None
4005
4006 """
4007 d = Decimal.from_float(f) # An exact conversion
4008 return d._fix(self) # Apply the context rounding
4009
Guido van Rossumd8faa362007-04-27 19:54:29 +00004010 # Methods
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004011 def abs(self, a):
4012 """Returns the absolute value of the operand.
4013
4014 If the operand is negative, the result is the same as using the minus
Guido van Rossumd8faa362007-04-27 19:54:29 +00004015 operation on the operand. Otherwise, the result is the same as using
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004016 the plus operation on the operand.
4017
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004018 >>> ExtendedContext.abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004019 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004020 >>> ExtendedContext.abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004021 Decimal('100')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004022 >>> ExtendedContext.abs(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004023 Decimal('101.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004024 >>> ExtendedContext.abs(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004025 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004026 >>> ExtendedContext.abs(-1)
4027 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004028 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004029 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004030 return a.__abs__(context=self)
4031
4032 def add(self, a, b):
4033 """Return the sum of the two operands.
4034
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004035 >>> ExtendedContext.add(Decimal('12'), Decimal('7.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004036 Decimal('19.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004037 >>> ExtendedContext.add(Decimal('1E+2'), Decimal('1.01E+4'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004038 Decimal('1.02E+4')
Mark Dickinson84230a12010-02-18 14:49:50 +00004039 >>> ExtendedContext.add(1, Decimal(2))
4040 Decimal('3')
4041 >>> ExtendedContext.add(Decimal(8), 5)
4042 Decimal('13')
4043 >>> ExtendedContext.add(5, 5)
4044 Decimal('10')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004045 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004046 a = _convert_other(a, raiseit=True)
4047 r = a.__add__(b, context=self)
4048 if r is NotImplemented:
4049 raise TypeError("Unable to convert %s to Decimal" % b)
4050 else:
4051 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004052
4053 def _apply(self, a):
Raymond Hettingerdab988d2004-10-09 07:10:44 +00004054 return str(a._fix(self))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004055
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004056 def canonical(self, a):
4057 """Returns the same Decimal object.
4058
4059 As we do not have different encodings for the same number, the
4060 received object already is in its canonical form.
4061
4062 >>> ExtendedContext.canonical(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004063 Decimal('2.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004064 """
4065 return a.canonical(context=self)
4066
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004067 def compare(self, a, b):
4068 """Compares values numerically.
4069
4070 If the signs of the operands differ, a value representing each operand
4071 ('-1' if the operand is less than zero, '0' if the operand is zero or
4072 negative zero, or '1' if the operand is greater than zero) is used in
4073 place of that operand for the comparison instead of the actual
4074 operand.
4075
4076 The comparison is then effected by subtracting the second operand from
4077 the first and then returning a value according to the result of the
4078 subtraction: '-1' if the result is less than zero, '0' if the result is
4079 zero or negative zero, or '1' if the result is greater than zero.
4080
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004081 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004082 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004083 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004084 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004085 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('2.10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004086 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004087 >>> ExtendedContext.compare(Decimal('3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004088 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004089 >>> ExtendedContext.compare(Decimal('2.1'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004090 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004091 >>> ExtendedContext.compare(Decimal('-3'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004092 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004093 >>> ExtendedContext.compare(1, 2)
4094 Decimal('-1')
4095 >>> ExtendedContext.compare(Decimal(1), 2)
4096 Decimal('-1')
4097 >>> ExtendedContext.compare(1, Decimal(2))
4098 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004099 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004100 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004101 return a.compare(b, context=self)
4102
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004103 def compare_signal(self, a, b):
4104 """Compares the values of the two operands numerically.
4105
4106 It's pretty much like compare(), but all NaNs signal, with signaling
4107 NaNs taking precedence over quiet NaNs.
4108
4109 >>> c = ExtendedContext
4110 >>> c.compare_signal(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004111 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004112 >>> c.compare_signal(Decimal('2.1'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004113 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004114 >>> c.flags[InvalidOperation] = 0
4115 >>> print(c.flags[InvalidOperation])
4116 0
4117 >>> c.compare_signal(Decimal('NaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004118 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004119 >>> print(c.flags[InvalidOperation])
4120 1
4121 >>> c.flags[InvalidOperation] = 0
4122 >>> print(c.flags[InvalidOperation])
4123 0
4124 >>> c.compare_signal(Decimal('sNaN'), Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004125 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004126 >>> print(c.flags[InvalidOperation])
4127 1
Mark Dickinson84230a12010-02-18 14:49:50 +00004128 >>> c.compare_signal(-1, 2)
4129 Decimal('-1')
4130 >>> c.compare_signal(Decimal(-1), 2)
4131 Decimal('-1')
4132 >>> c.compare_signal(-1, Decimal(2))
4133 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004134 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004135 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004136 return a.compare_signal(b, context=self)
4137
4138 def compare_total(self, a, b):
4139 """Compares two operands using their abstract representation.
4140
4141 This is not like the standard compare, which use their numerical
4142 value. Note that a total ordering is defined for all possible abstract
4143 representations.
4144
4145 >>> ExtendedContext.compare_total(Decimal('12.73'), Decimal('127.9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004146 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004147 >>> ExtendedContext.compare_total(Decimal('-127'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004148 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004149 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004150 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004151 >>> ExtendedContext.compare_total(Decimal('12.30'), Decimal('12.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004152 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004153 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('12.300'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004154 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004155 >>> ExtendedContext.compare_total(Decimal('12.3'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004156 Decimal('-1')
Mark Dickinson84230a12010-02-18 14:49:50 +00004157 >>> ExtendedContext.compare_total(1, 2)
4158 Decimal('-1')
4159 >>> ExtendedContext.compare_total(Decimal(1), 2)
4160 Decimal('-1')
4161 >>> ExtendedContext.compare_total(1, Decimal(2))
4162 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004163 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004164 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004165 return a.compare_total(b)
4166
4167 def compare_total_mag(self, a, b):
4168 """Compares two operands using their abstract representation ignoring sign.
4169
4170 Like compare_total, but with operand's sign ignored and assumed to be 0.
4171 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004172 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004173 return a.compare_total_mag(b)
4174
4175 def copy_abs(self, a):
4176 """Returns a copy of the operand with the sign set to 0.
4177
4178 >>> ExtendedContext.copy_abs(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004179 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004180 >>> ExtendedContext.copy_abs(Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004181 Decimal('100')
Mark Dickinson84230a12010-02-18 14:49:50 +00004182 >>> ExtendedContext.copy_abs(-1)
4183 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004184 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004185 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004186 return a.copy_abs()
4187
4188 def copy_decimal(self, a):
Mark Dickinson84230a12010-02-18 14:49:50 +00004189 """Returns a copy of the decimal object.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004190
4191 >>> ExtendedContext.copy_decimal(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004192 Decimal('2.1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004193 >>> ExtendedContext.copy_decimal(Decimal('-1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004194 Decimal('-1.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004195 >>> ExtendedContext.copy_decimal(1)
4196 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004197 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004198 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004199 return Decimal(a)
4200
4201 def copy_negate(self, a):
4202 """Returns a copy of the operand with the sign inverted.
4203
4204 >>> ExtendedContext.copy_negate(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004205 Decimal('-101.5')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004206 >>> ExtendedContext.copy_negate(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004207 Decimal('101.5')
Mark Dickinson84230a12010-02-18 14:49:50 +00004208 >>> ExtendedContext.copy_negate(1)
4209 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004210 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004211 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004212 return a.copy_negate()
4213
4214 def copy_sign(self, a, b):
4215 """Copies the second operand's sign to the first one.
4216
4217 In detail, it returns a copy of the first operand with the sign
4218 equal to the sign of the second operand.
4219
4220 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004221 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004222 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004223 Decimal('1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004224 >>> ExtendedContext.copy_sign(Decimal( '1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004225 Decimal('-1.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004226 >>> ExtendedContext.copy_sign(Decimal('-1.50'), Decimal('-7.33'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004227 Decimal('-1.50')
Mark Dickinson84230a12010-02-18 14:49:50 +00004228 >>> ExtendedContext.copy_sign(1, -2)
4229 Decimal('-1')
4230 >>> ExtendedContext.copy_sign(Decimal(1), -2)
4231 Decimal('-1')
4232 >>> ExtendedContext.copy_sign(1, Decimal(-2))
4233 Decimal('-1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004234 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004235 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004236 return a.copy_sign(b)
4237
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004238 def divide(self, a, b):
4239 """Decimal division in a specified context.
4240
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004241 >>> ExtendedContext.divide(Decimal('1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004242 Decimal('0.333333333')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004243 >>> ExtendedContext.divide(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004244 Decimal('0.666666667')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004245 >>> ExtendedContext.divide(Decimal('5'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004246 Decimal('2.5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004247 >>> ExtendedContext.divide(Decimal('1'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004248 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004249 >>> ExtendedContext.divide(Decimal('12'), Decimal('12'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004250 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004251 >>> ExtendedContext.divide(Decimal('8.00'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004252 Decimal('4.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004253 >>> ExtendedContext.divide(Decimal('2.400'), Decimal('2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004254 Decimal('1.20')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004255 >>> ExtendedContext.divide(Decimal('1000'), Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004256 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004257 >>> ExtendedContext.divide(Decimal('1000'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004258 Decimal('1000')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004259 >>> ExtendedContext.divide(Decimal('2.40E+6'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004260 Decimal('1.20E+6')
Mark Dickinson84230a12010-02-18 14:49:50 +00004261 >>> ExtendedContext.divide(5, 5)
4262 Decimal('1')
4263 >>> ExtendedContext.divide(Decimal(5), 5)
4264 Decimal('1')
4265 >>> ExtendedContext.divide(5, Decimal(5))
4266 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004267 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004268 a = _convert_other(a, raiseit=True)
4269 r = a.__truediv__(b, context=self)
4270 if r is NotImplemented:
4271 raise TypeError("Unable to convert %s to Decimal" % b)
4272 else:
4273 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004274
4275 def divide_int(self, a, b):
4276 """Divides two numbers and returns the integer part of the result.
4277
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004278 >>> ExtendedContext.divide_int(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004279 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004280 >>> ExtendedContext.divide_int(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004281 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004282 >>> ExtendedContext.divide_int(Decimal('1'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004283 Decimal('3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004284 >>> ExtendedContext.divide_int(10, 3)
4285 Decimal('3')
4286 >>> ExtendedContext.divide_int(Decimal(10), 3)
4287 Decimal('3')
4288 >>> ExtendedContext.divide_int(10, Decimal(3))
4289 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004290 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004291 a = _convert_other(a, raiseit=True)
4292 r = a.__floordiv__(b, context=self)
4293 if r is NotImplemented:
4294 raise TypeError("Unable to convert %s to Decimal" % b)
4295 else:
4296 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004297
4298 def divmod(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004299 """Return (a // b, a % b).
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004300
4301 >>> ExtendedContext.divmod(Decimal(8), Decimal(3))
4302 (Decimal('2'), Decimal('2'))
4303 >>> ExtendedContext.divmod(Decimal(8), Decimal(4))
4304 (Decimal('2'), Decimal('0'))
Mark Dickinson84230a12010-02-18 14:49:50 +00004305 >>> ExtendedContext.divmod(8, 4)
4306 (Decimal('2'), Decimal('0'))
4307 >>> ExtendedContext.divmod(Decimal(8), 4)
4308 (Decimal('2'), Decimal('0'))
4309 >>> ExtendedContext.divmod(8, Decimal(4))
4310 (Decimal('2'), Decimal('0'))
Mark Dickinsonc53796e2010-01-06 16:22:15 +00004311 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004312 a = _convert_other(a, raiseit=True)
4313 r = a.__divmod__(b, context=self)
4314 if r is NotImplemented:
4315 raise TypeError("Unable to convert %s to Decimal" % b)
4316 else:
4317 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004318
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004319 def exp(self, a):
4320 """Returns e ** a.
4321
4322 >>> c = ExtendedContext.copy()
4323 >>> c.Emin = -999
4324 >>> c.Emax = 999
4325 >>> c.exp(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004326 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004327 >>> c.exp(Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004328 Decimal('0.367879441')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004329 >>> c.exp(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004330 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004331 >>> c.exp(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004332 Decimal('2.71828183')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004333 >>> c.exp(Decimal('0.693147181'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004334 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004335 >>> c.exp(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004336 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004337 >>> c.exp(10)
4338 Decimal('22026.4658')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004339 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004340 a =_convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004341 return a.exp(context=self)
4342
4343 def fma(self, a, b, c):
4344 """Returns a multiplied by b, plus c.
4345
4346 The first two operands are multiplied together, using multiply,
4347 the third operand is then added to the result of that
4348 multiplication, using add, all with only one final rounding.
4349
4350 >>> ExtendedContext.fma(Decimal('3'), Decimal('5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004351 Decimal('22')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004352 >>> ExtendedContext.fma(Decimal('3'), Decimal('-5'), Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004353 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004354 >>> ExtendedContext.fma(Decimal('888565290'), Decimal('1557.96930'), Decimal('-86087.7578'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004355 Decimal('1.38435736E+12')
Mark Dickinson84230a12010-02-18 14:49:50 +00004356 >>> ExtendedContext.fma(1, 3, 4)
4357 Decimal('7')
4358 >>> ExtendedContext.fma(1, Decimal(3), 4)
4359 Decimal('7')
4360 >>> ExtendedContext.fma(1, 3, Decimal(4))
4361 Decimal('7')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004362 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004363 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004364 return a.fma(b, c, context=self)
4365
4366 def is_canonical(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004367 """Return True if the operand is canonical; otherwise return False.
4368
4369 Currently, the encoding of a Decimal instance is always
4370 canonical, so this method returns True for any Decimal.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004371
4372 >>> ExtendedContext.is_canonical(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004373 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004374 """
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004375 return a.is_canonical()
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004376
4377 def is_finite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004378 """Return True if the operand is finite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004379
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004380 A Decimal instance is considered finite if it is neither
4381 infinite nor a NaN.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004382
4383 >>> ExtendedContext.is_finite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004384 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004385 >>> ExtendedContext.is_finite(Decimal('-0.3'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004386 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004387 >>> ExtendedContext.is_finite(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004388 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004389 >>> ExtendedContext.is_finite(Decimal('Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004390 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004391 >>> ExtendedContext.is_finite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004392 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004393 >>> ExtendedContext.is_finite(1)
4394 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004395 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004396 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004397 return a.is_finite()
4398
4399 def is_infinite(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004400 """Return True if the operand is infinite; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004401
4402 >>> ExtendedContext.is_infinite(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004403 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004404 >>> ExtendedContext.is_infinite(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004405 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004406 >>> ExtendedContext.is_infinite(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004407 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004408 >>> ExtendedContext.is_infinite(1)
4409 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004410 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004411 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004412 return a.is_infinite()
4413
4414 def is_nan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004415 """Return True if the operand is a qNaN or sNaN;
4416 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004417
4418 >>> ExtendedContext.is_nan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004419 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004420 >>> ExtendedContext.is_nan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004421 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004422 >>> ExtendedContext.is_nan(Decimal('-sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004423 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004424 >>> ExtendedContext.is_nan(1)
4425 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004426 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004427 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004428 return a.is_nan()
4429
4430 def is_normal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004431 """Return True if the operand is a normal number;
4432 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004433
4434 >>> c = ExtendedContext.copy()
4435 >>> c.Emin = -999
4436 >>> c.Emax = 999
4437 >>> c.is_normal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004438 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004439 >>> c.is_normal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004440 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004441 >>> c.is_normal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004442 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004443 >>> c.is_normal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004444 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004445 >>> c.is_normal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004446 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004447 >>> c.is_normal(1)
4448 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004449 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004450 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004451 return a.is_normal(context=self)
4452
4453 def is_qnan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004454 """Return True if the operand is a quiet NaN; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004455
4456 >>> ExtendedContext.is_qnan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004457 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004458 >>> ExtendedContext.is_qnan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004459 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004460 >>> ExtendedContext.is_qnan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004461 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004462 >>> ExtendedContext.is_qnan(1)
4463 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004464 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004465 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004466 return a.is_qnan()
4467
4468 def is_signed(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004469 """Return True if the operand is negative; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004470
4471 >>> ExtendedContext.is_signed(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004472 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004473 >>> ExtendedContext.is_signed(Decimal('-12'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004474 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004475 >>> ExtendedContext.is_signed(Decimal('-0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004476 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004477 >>> ExtendedContext.is_signed(8)
4478 False
4479 >>> ExtendedContext.is_signed(-8)
4480 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004481 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004482 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004483 return a.is_signed()
4484
4485 def is_snan(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004486 """Return True if the operand is a signaling NaN;
4487 otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004488
4489 >>> ExtendedContext.is_snan(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004490 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004491 >>> ExtendedContext.is_snan(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004492 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004493 >>> ExtendedContext.is_snan(Decimal('sNaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004494 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004495 >>> ExtendedContext.is_snan(1)
4496 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004497 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004498 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004499 return a.is_snan()
4500
4501 def is_subnormal(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004502 """Return True if the operand is subnormal; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004503
4504 >>> c = ExtendedContext.copy()
4505 >>> c.Emin = -999
4506 >>> c.Emax = 999
4507 >>> c.is_subnormal(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004508 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004509 >>> c.is_subnormal(Decimal('0.1E-999'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004510 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004511 >>> c.is_subnormal(Decimal('0.00'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004512 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004513 >>> c.is_subnormal(Decimal('-Inf'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004514 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004515 >>> c.is_subnormal(Decimal('NaN'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004516 False
Mark Dickinson84230a12010-02-18 14:49:50 +00004517 >>> c.is_subnormal(1)
4518 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004519 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004520 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004521 return a.is_subnormal(context=self)
4522
4523 def is_zero(self, a):
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004524 """Return True if the operand is a zero; otherwise return False.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004525
4526 >>> ExtendedContext.is_zero(Decimal('0'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004527 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004528 >>> ExtendedContext.is_zero(Decimal('2.50'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004529 False
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004530 >>> ExtendedContext.is_zero(Decimal('-0E+2'))
Guido van Rossum8ce8a782007-11-01 19:42:39 +00004531 True
Mark Dickinson84230a12010-02-18 14:49:50 +00004532 >>> ExtendedContext.is_zero(1)
4533 False
4534 >>> ExtendedContext.is_zero(0)
4535 True
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004536 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004537 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004538 return a.is_zero()
4539
4540 def ln(self, a):
4541 """Returns the natural (base e) logarithm of the operand.
4542
4543 >>> c = ExtendedContext.copy()
4544 >>> c.Emin = -999
4545 >>> c.Emax = 999
4546 >>> c.ln(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004547 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004548 >>> c.ln(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004549 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004550 >>> c.ln(Decimal('2.71828183'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004551 Decimal('1.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004552 >>> c.ln(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004553 Decimal('2.30258509')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004554 >>> c.ln(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004555 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004556 >>> c.ln(1)
4557 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004558 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004559 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004560 return a.ln(context=self)
4561
4562 def log10(self, a):
4563 """Returns the base 10 logarithm of the operand.
4564
4565 >>> c = ExtendedContext.copy()
4566 >>> c.Emin = -999
4567 >>> c.Emax = 999
4568 >>> c.log10(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004569 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004570 >>> c.log10(Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004571 Decimal('-3')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004572 >>> c.log10(Decimal('1.000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004573 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004574 >>> c.log10(Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004575 Decimal('0.301029996')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004576 >>> c.log10(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004577 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004578 >>> c.log10(Decimal('70'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004579 Decimal('1.84509804')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004580 >>> c.log10(Decimal('+Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004581 Decimal('Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004582 >>> c.log10(0)
4583 Decimal('-Infinity')
4584 >>> c.log10(1)
4585 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004586 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004587 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004588 return a.log10(context=self)
4589
4590 def logb(self, a):
4591 """ Returns the exponent of the magnitude of the operand's MSD.
4592
4593 The result is the integer which is the exponent of the magnitude
4594 of the most significant digit of the operand (as though the
4595 operand were truncated to a single digit while maintaining the
4596 value of that digit and without limiting the resulting exponent).
4597
4598 >>> ExtendedContext.logb(Decimal('250'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004599 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004600 >>> ExtendedContext.logb(Decimal('2.50'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004601 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004602 >>> ExtendedContext.logb(Decimal('0.03'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004603 Decimal('-2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004604 >>> ExtendedContext.logb(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004605 Decimal('-Infinity')
Mark Dickinson84230a12010-02-18 14:49:50 +00004606 >>> ExtendedContext.logb(1)
4607 Decimal('0')
4608 >>> ExtendedContext.logb(10)
4609 Decimal('1')
4610 >>> ExtendedContext.logb(100)
4611 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004612 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004613 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004614 return a.logb(context=self)
4615
4616 def logical_and(self, a, b):
4617 """Applies the logical operation 'and' between each operand's digits.
4618
4619 The operands must be both logical numbers.
4620
4621 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004622 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004623 >>> ExtendedContext.logical_and(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004624 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004625 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004626 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004627 >>> ExtendedContext.logical_and(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004628 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004629 >>> ExtendedContext.logical_and(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004630 Decimal('1000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004631 >>> ExtendedContext.logical_and(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004632 Decimal('10')
Mark Dickinson84230a12010-02-18 14:49:50 +00004633 >>> ExtendedContext.logical_and(110, 1101)
4634 Decimal('100')
4635 >>> ExtendedContext.logical_and(Decimal(110), 1101)
4636 Decimal('100')
4637 >>> ExtendedContext.logical_and(110, Decimal(1101))
4638 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004639 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004640 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004641 return a.logical_and(b, context=self)
4642
4643 def logical_invert(self, a):
4644 """Invert all the digits in the operand.
4645
4646 The operand must be a logical number.
4647
4648 >>> ExtendedContext.logical_invert(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004649 Decimal('111111111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004650 >>> ExtendedContext.logical_invert(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004651 Decimal('111111110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004652 >>> ExtendedContext.logical_invert(Decimal('111111111'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004653 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004654 >>> ExtendedContext.logical_invert(Decimal('101010101'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004655 Decimal('10101010')
Mark Dickinson84230a12010-02-18 14:49:50 +00004656 >>> ExtendedContext.logical_invert(1101)
4657 Decimal('111110010')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004658 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004659 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004660 return a.logical_invert(context=self)
4661
4662 def logical_or(self, a, b):
4663 """Applies the logical operation 'or' between each operand's digits.
4664
4665 The operands must be both logical numbers.
4666
4667 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004668 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004669 >>> ExtendedContext.logical_or(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004670 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004671 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004672 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004673 >>> ExtendedContext.logical_or(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004674 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004675 >>> ExtendedContext.logical_or(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004676 Decimal('1110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004677 >>> ExtendedContext.logical_or(Decimal('1110'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004678 Decimal('1110')
Mark Dickinson84230a12010-02-18 14:49:50 +00004679 >>> ExtendedContext.logical_or(110, 1101)
4680 Decimal('1111')
4681 >>> ExtendedContext.logical_or(Decimal(110), 1101)
4682 Decimal('1111')
4683 >>> ExtendedContext.logical_or(110, Decimal(1101))
4684 Decimal('1111')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004685 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004686 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004687 return a.logical_or(b, context=self)
4688
4689 def logical_xor(self, a, b):
4690 """Applies the logical operation 'xor' between each operand's digits.
4691
4692 The operands must be both logical numbers.
4693
4694 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004695 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004696 >>> ExtendedContext.logical_xor(Decimal('0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004697 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004698 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004699 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004700 >>> ExtendedContext.logical_xor(Decimal('1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004701 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004702 >>> ExtendedContext.logical_xor(Decimal('1100'), Decimal('1010'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004703 Decimal('110')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004704 >>> ExtendedContext.logical_xor(Decimal('1111'), Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004705 Decimal('1101')
Mark Dickinson84230a12010-02-18 14:49:50 +00004706 >>> ExtendedContext.logical_xor(110, 1101)
4707 Decimal('1011')
4708 >>> ExtendedContext.logical_xor(Decimal(110), 1101)
4709 Decimal('1011')
4710 >>> ExtendedContext.logical_xor(110, Decimal(1101))
4711 Decimal('1011')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004712 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004713 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004714 return a.logical_xor(b, context=self)
4715
Mark Dickinson84230a12010-02-18 14:49:50 +00004716 def max(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004717 """max compares two values numerically and returns the maximum.
4718
4719 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004720 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004721 operation. If they are numerically equal then the left-hand operand
4722 is chosen as the result. Otherwise the maximum (closer to positive
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004723 infinity) of the two operands is chosen as the result.
4724
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004725 >>> ExtendedContext.max(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004726 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004727 >>> ExtendedContext.max(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004728 Decimal('3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004729 >>> ExtendedContext.max(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004730 Decimal('1')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004731 >>> ExtendedContext.max(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004732 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004733 >>> ExtendedContext.max(1, 2)
4734 Decimal('2')
4735 >>> ExtendedContext.max(Decimal(1), 2)
4736 Decimal('2')
4737 >>> ExtendedContext.max(1, Decimal(2))
4738 Decimal('2')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004739 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004740 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004741 return a.max(b, context=self)
4742
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004743 def max_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004744 """Compares the values numerically with their sign ignored.
4745
4746 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('NaN'))
4747 Decimal('7')
4748 >>> ExtendedContext.max_mag(Decimal('7'), Decimal('-10'))
4749 Decimal('-10')
4750 >>> ExtendedContext.max_mag(1, -2)
4751 Decimal('-2')
4752 >>> ExtendedContext.max_mag(Decimal(1), -2)
4753 Decimal('-2')
4754 >>> ExtendedContext.max_mag(1, Decimal(-2))
4755 Decimal('-2')
4756 """
4757 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004758 return a.max_mag(b, context=self)
4759
Mark Dickinson84230a12010-02-18 14:49:50 +00004760 def min(self, a, b):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004761 """min compares two values numerically and returns the minimum.
4762
4763 If either operand is a NaN then the general rules apply.
Christian Heimes679db4a2008-01-18 09:56:22 +00004764 Otherwise, the operands are compared as though by the compare
Guido van Rossumd8faa362007-04-27 19:54:29 +00004765 operation. If they are numerically equal then the left-hand operand
4766 is chosen as the result. Otherwise the minimum (closer to negative
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004767 infinity) of the two operands is chosen as the result.
4768
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004769 >>> ExtendedContext.min(Decimal('3'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004770 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004771 >>> ExtendedContext.min(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004772 Decimal('-10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004773 >>> ExtendedContext.min(Decimal('1.0'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004774 Decimal('1.0')
Raymond Hettingerd6c700a2004-08-17 06:39:37 +00004775 >>> ExtendedContext.min(Decimal('7'), Decimal('NaN'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004776 Decimal('7')
Mark Dickinson84230a12010-02-18 14:49:50 +00004777 >>> ExtendedContext.min(1, 2)
4778 Decimal('1')
4779 >>> ExtendedContext.min(Decimal(1), 2)
4780 Decimal('1')
4781 >>> ExtendedContext.min(1, Decimal(29))
4782 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004783 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004784 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004785 return a.min(b, context=self)
4786
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004787 def min_mag(self, a, b):
Mark Dickinson84230a12010-02-18 14:49:50 +00004788 """Compares the values numerically with their sign ignored.
4789
4790 >>> ExtendedContext.min_mag(Decimal('3'), Decimal('-2'))
4791 Decimal('-2')
4792 >>> ExtendedContext.min_mag(Decimal('-3'), Decimal('NaN'))
4793 Decimal('-3')
4794 >>> ExtendedContext.min_mag(1, -2)
4795 Decimal('1')
4796 >>> ExtendedContext.min_mag(Decimal(1), -2)
4797 Decimal('1')
4798 >>> ExtendedContext.min_mag(1, Decimal(-2))
4799 Decimal('1')
4800 """
4801 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004802 return a.min_mag(b, context=self)
4803
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004804 def minus(self, a):
4805 """Minus corresponds to unary prefix minus in Python.
4806
4807 The operation is evaluated using the same rules as subtract; the
4808 operation minus(a) is calculated as subtract('0', a) where the '0'
4809 has the same exponent as the operand.
4810
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004811 >>> ExtendedContext.minus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004812 Decimal('-1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004813 >>> ExtendedContext.minus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004814 Decimal('1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00004815 >>> ExtendedContext.minus(1)
4816 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004817 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004818 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004819 return a.__neg__(context=self)
4820
4821 def multiply(self, a, b):
4822 """multiply multiplies two operands.
4823
4824 If either operand is a special value then the general rules apply.
Mark Dickinson84230a12010-02-18 14:49:50 +00004825 Otherwise, the operands are multiplied together
4826 ('long multiplication'), resulting in a number which may be as long as
4827 the sum of the lengths of the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004828
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004829 >>> ExtendedContext.multiply(Decimal('1.20'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004830 Decimal('3.60')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004831 >>> ExtendedContext.multiply(Decimal('7'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004832 Decimal('21')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004833 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('0.8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004834 Decimal('0.72')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004835 >>> ExtendedContext.multiply(Decimal('0.9'), Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004836 Decimal('-0.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004837 >>> ExtendedContext.multiply(Decimal('654321'), Decimal('654321'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004838 Decimal('4.28135971E+11')
Mark Dickinson84230a12010-02-18 14:49:50 +00004839 >>> ExtendedContext.multiply(7, 7)
4840 Decimal('49')
4841 >>> ExtendedContext.multiply(Decimal(7), 7)
4842 Decimal('49')
4843 >>> ExtendedContext.multiply(7, Decimal(7))
4844 Decimal('49')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004845 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004846 a = _convert_other(a, raiseit=True)
4847 r = a.__mul__(b, context=self)
4848 if r is NotImplemented:
4849 raise TypeError("Unable to convert %s to Decimal" % b)
4850 else:
4851 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004852
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004853 def next_minus(self, a):
4854 """Returns the largest representable number smaller than a.
4855
4856 >>> c = ExtendedContext.copy()
4857 >>> c.Emin = -999
4858 >>> c.Emax = 999
4859 >>> ExtendedContext.next_minus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004860 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004861 >>> c.next_minus(Decimal('1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004862 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004863 >>> ExtendedContext.next_minus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004864 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004865 >>> c.next_minus(Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004866 Decimal('9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004867 >>> c.next_minus(1)
4868 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004869 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004870 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004871 return a.next_minus(context=self)
4872
4873 def next_plus(self, a):
4874 """Returns the smallest representable number larger than a.
4875
4876 >>> c = ExtendedContext.copy()
4877 >>> c.Emin = -999
4878 >>> c.Emax = 999
4879 >>> ExtendedContext.next_plus(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004880 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004881 >>> c.next_plus(Decimal('-1E-1007'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004882 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004883 >>> ExtendedContext.next_plus(Decimal('-1.00000003'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004884 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004885 >>> c.next_plus(Decimal('-Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004886 Decimal('-9.99999999E+999')
Mark Dickinson84230a12010-02-18 14:49:50 +00004887 >>> c.next_plus(1)
4888 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004889 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004890 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004891 return a.next_plus(context=self)
4892
4893 def next_toward(self, a, b):
4894 """Returns the number closest to a, in direction towards b.
4895
4896 The result is the closest representable number from the first
4897 operand (but not the first operand) that is in the direction
4898 towards the second operand, unless the operands have the same
4899 value.
4900
4901 >>> c = ExtendedContext.copy()
4902 >>> c.Emin = -999
4903 >>> c.Emax = 999
4904 >>> c.next_toward(Decimal('1'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004905 Decimal('1.00000001')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004906 >>> c.next_toward(Decimal('-1E-1007'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004907 Decimal('-0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004908 >>> c.next_toward(Decimal('-1.00000003'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004909 Decimal('-1.00000002')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004910 >>> c.next_toward(Decimal('1'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004911 Decimal('0.999999999')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004912 >>> c.next_toward(Decimal('1E-1007'), Decimal('-100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004913 Decimal('0E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004914 >>> c.next_toward(Decimal('-1.00000003'), Decimal('-10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004915 Decimal('-1.00000004')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004916 >>> c.next_toward(Decimal('0.00'), Decimal('-0.0000'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004917 Decimal('-0.00')
Mark Dickinson84230a12010-02-18 14:49:50 +00004918 >>> c.next_toward(0, 1)
4919 Decimal('1E-1007')
4920 >>> c.next_toward(Decimal(0), 1)
4921 Decimal('1E-1007')
4922 >>> c.next_toward(0, Decimal(1))
4923 Decimal('1E-1007')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004924 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004925 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004926 return a.next_toward(b, context=self)
4927
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004928 def normalize(self, a):
Raymond Hettingere0f15812004-07-05 05:36:39 +00004929 """normalize reduces an operand to its simplest form.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004930
4931 Essentially a plus operation with all trailing zeros removed from the
4932 result.
4933
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004934 >>> ExtendedContext.normalize(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004935 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004936 >>> ExtendedContext.normalize(Decimal('-2.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004937 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004938 >>> ExtendedContext.normalize(Decimal('1.200'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004939 Decimal('1.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004940 >>> ExtendedContext.normalize(Decimal('-120'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004941 Decimal('-1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004942 >>> ExtendedContext.normalize(Decimal('120.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004943 Decimal('1.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00004944 >>> ExtendedContext.normalize(Decimal('0.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00004945 Decimal('0')
Mark Dickinson84230a12010-02-18 14:49:50 +00004946 >>> ExtendedContext.normalize(6)
4947 Decimal('6')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004948 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004949 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00004950 return a.normalize(context=self)
4951
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004952 def number_class(self, a):
4953 """Returns an indication of the class of the operand.
4954
4955 The class is one of the following strings:
4956 -sNaN
4957 -NaN
4958 -Infinity
4959 -Normal
4960 -Subnormal
4961 -Zero
4962 +Zero
4963 +Subnormal
4964 +Normal
4965 +Infinity
4966
4967 >>> c = Context(ExtendedContext)
4968 >>> c.Emin = -999
4969 >>> c.Emax = 999
4970 >>> c.number_class(Decimal('Infinity'))
4971 '+Infinity'
4972 >>> c.number_class(Decimal('1E-10'))
4973 '+Normal'
4974 >>> c.number_class(Decimal('2.50'))
4975 '+Normal'
4976 >>> c.number_class(Decimal('0.1E-999'))
4977 '+Subnormal'
4978 >>> c.number_class(Decimal('0'))
4979 '+Zero'
4980 >>> c.number_class(Decimal('-0'))
4981 '-Zero'
4982 >>> c.number_class(Decimal('-0.1E-999'))
4983 '-Subnormal'
4984 >>> c.number_class(Decimal('-1E-10'))
4985 '-Normal'
4986 >>> c.number_class(Decimal('-2.50'))
4987 '-Normal'
4988 >>> c.number_class(Decimal('-Infinity'))
4989 '-Infinity'
4990 >>> c.number_class(Decimal('NaN'))
4991 'NaN'
4992 >>> c.number_class(Decimal('-NaN'))
4993 'NaN'
4994 >>> c.number_class(Decimal('sNaN'))
4995 'sNaN'
Mark Dickinson84230a12010-02-18 14:49:50 +00004996 >>> c.number_class(123)
4997 '+Normal'
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004998 """
Mark Dickinson84230a12010-02-18 14:49:50 +00004999 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005000 return a.number_class(context=self)
5001
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005002 def plus(self, a):
5003 """Plus corresponds to unary prefix plus in Python.
5004
5005 The operation is evaluated using the same rules as add; the
5006 operation plus(a) is calculated as add('0', a) where the '0'
5007 has the same exponent as the operand.
5008
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005009 >>> ExtendedContext.plus(Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005010 Decimal('1.3')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005011 >>> ExtendedContext.plus(Decimal('-1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005012 Decimal('-1.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005013 >>> ExtendedContext.plus(-1)
5014 Decimal('-1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005015 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005016 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005017 return a.__pos__(context=self)
5018
5019 def power(self, a, b, modulo=None):
5020 """Raises a to the power of b, to modulo if given.
5021
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005022 With two arguments, compute a**b. If a is negative then b
5023 must be integral. The result will be inexact unless b is
5024 integral and the result is finite and can be expressed exactly
5025 in 'precision' digits.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005026
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005027 With three arguments, compute (a**b) % modulo. For the
5028 three argument form, the following restrictions on the
5029 arguments hold:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005030
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005031 - all three arguments must be integral
5032 - b must be nonnegative
5033 - at least one of a or b must be nonzero
5034 - modulo must be nonzero and have at most 'precision' digits
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005035
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005036 The result of pow(a, b, modulo) is identical to the result
5037 that would be obtained by computing (a**b) % modulo with
5038 unbounded precision, but is computed more efficiently. It is
5039 always exact.
5040
5041 >>> c = ExtendedContext.copy()
5042 >>> c.Emin = -999
5043 >>> c.Emax = 999
5044 >>> c.power(Decimal('2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005045 Decimal('8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005046 >>> c.power(Decimal('-2'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005047 Decimal('-8')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005048 >>> c.power(Decimal('2'), Decimal('-3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005049 Decimal('0.125')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005050 >>> c.power(Decimal('1.7'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005051 Decimal('69.7575744')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005052 >>> c.power(Decimal('10'), Decimal('0.301029996'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005053 Decimal('2.00000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005054 >>> c.power(Decimal('Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005055 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005056 >>> c.power(Decimal('Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005057 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005058 >>> c.power(Decimal('Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005059 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005060 >>> c.power(Decimal('-Infinity'), Decimal('-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005061 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005062 >>> c.power(Decimal('-Infinity'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005063 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005064 >>> c.power(Decimal('-Infinity'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005065 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005066 >>> c.power(Decimal('-Infinity'), Decimal('2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005067 Decimal('Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005068 >>> c.power(Decimal('0'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005069 Decimal('NaN')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005070
5071 >>> c.power(Decimal('3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005072 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005073 >>> c.power(Decimal('-3'), Decimal('7'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005074 Decimal('-11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005075 >>> c.power(Decimal('-3'), Decimal('8'), Decimal('16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005076 Decimal('1')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005077 >>> c.power(Decimal('3'), Decimal('7'), Decimal('-16'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005078 Decimal('11')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005079 >>> c.power(Decimal('23E12345'), Decimal('67E189'), Decimal('123456789'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005080 Decimal('11729830')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005081 >>> c.power(Decimal('-0'), Decimal('17'), Decimal('1729'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005082 Decimal('-0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005083 >>> c.power(Decimal('-23'), Decimal('0'), Decimal('65537'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005084 Decimal('1')
Mark Dickinson84230a12010-02-18 14:49:50 +00005085 >>> ExtendedContext.power(7, 7)
5086 Decimal('823543')
5087 >>> ExtendedContext.power(Decimal(7), 7)
5088 Decimal('823543')
5089 >>> ExtendedContext.power(7, Decimal(7), 2)
5090 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005091 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005092 a = _convert_other(a, raiseit=True)
5093 r = a.__pow__(b, modulo, context=self)
5094 if r is NotImplemented:
5095 raise TypeError("Unable to convert %s to Decimal" % b)
5096 else:
5097 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005098
5099 def quantize(self, a, b):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005100 """Returns a value equal to 'a' (rounded), having the exponent of 'b'.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005101
5102 The coefficient of the result is derived from that of the left-hand
Guido van Rossumd8faa362007-04-27 19:54:29 +00005103 operand. It may be rounded using the current rounding setting (if the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005104 exponent is being increased), multiplied by a positive power of ten (if
5105 the exponent is being decreased), or is unchanged (if the exponent is
5106 already equal to that of the right-hand operand).
5107
5108 Unlike other operations, if the length of the coefficient after the
5109 quantize operation would be greater than precision then an Invalid
Guido van Rossumd8faa362007-04-27 19:54:29 +00005110 operation condition is raised. This guarantees that, unless there is
5111 an error condition, the exponent of the result of a quantize is always
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005112 equal to that of the right-hand operand.
5113
5114 Also unlike other operations, quantize will never raise Underflow, even
5115 if the result is subnormal and inexact.
5116
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005117 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.001'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005118 Decimal('2.170')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005119 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.01'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005120 Decimal('2.17')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005121 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('0.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005122 Decimal('2.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005123 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005124 Decimal('2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005125 >>> ExtendedContext.quantize(Decimal('2.17'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005126 Decimal('0E+1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005127 >>> ExtendedContext.quantize(Decimal('-Inf'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005128 Decimal('-Infinity')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005129 >>> ExtendedContext.quantize(Decimal('2'), Decimal('Infinity'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005130 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005131 >>> ExtendedContext.quantize(Decimal('-0.1'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005132 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005133 >>> ExtendedContext.quantize(Decimal('-0'), Decimal('1e+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005134 Decimal('-0E+5')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005135 >>> ExtendedContext.quantize(Decimal('+35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005136 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005137 >>> ExtendedContext.quantize(Decimal('-35236450.6'), Decimal('1e-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005138 Decimal('NaN')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005139 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005140 Decimal('217.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005141 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005142 Decimal('217')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005143 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005144 Decimal('2.2E+2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005145 >>> ExtendedContext.quantize(Decimal('217'), Decimal('1e+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005146 Decimal('2E+2')
Mark Dickinson84230a12010-02-18 14:49:50 +00005147 >>> ExtendedContext.quantize(1, 2)
5148 Decimal('1')
5149 >>> ExtendedContext.quantize(Decimal(1), 2)
5150 Decimal('1')
5151 >>> ExtendedContext.quantize(1, Decimal(2))
5152 Decimal('1')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005153 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005154 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005155 return a.quantize(b, context=self)
5156
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005157 def radix(self):
5158 """Just returns 10, as this is Decimal, :)
5159
5160 >>> ExtendedContext.radix()
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005161 Decimal('10')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005162 """
5163 return Decimal(10)
5164
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005165 def remainder(self, a, b):
5166 """Returns the remainder from integer division.
5167
5168 The result is the residue of the dividend after the operation of
Guido van Rossumd8faa362007-04-27 19:54:29 +00005169 calculating integer division as described for divide-integer, rounded
5170 to precision digits if necessary. The sign of the result, if
5171 non-zero, is the same as that of the original dividend.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005172
5173 This operation will fail under the same conditions as integer division
5174 (that is, if integer division on the same two operands would fail, the
5175 remainder cannot be calculated).
5176
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005177 >>> ExtendedContext.remainder(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005178 Decimal('2.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005179 >>> ExtendedContext.remainder(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005180 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005181 >>> ExtendedContext.remainder(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005182 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005183 >>> ExtendedContext.remainder(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005184 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005185 >>> ExtendedContext.remainder(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005186 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005187 >>> ExtendedContext.remainder(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005188 Decimal('1.0')
Mark Dickinson84230a12010-02-18 14:49:50 +00005189 >>> ExtendedContext.remainder(22, 6)
5190 Decimal('4')
5191 >>> ExtendedContext.remainder(Decimal(22), 6)
5192 Decimal('4')
5193 >>> ExtendedContext.remainder(22, Decimal(6))
5194 Decimal('4')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005195 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005196 a = _convert_other(a, raiseit=True)
5197 r = a.__mod__(b, context=self)
5198 if r is NotImplemented:
5199 raise TypeError("Unable to convert %s to Decimal" % b)
5200 else:
5201 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005202
5203 def remainder_near(self, a, b):
5204 """Returns to be "a - b * n", where n is the integer nearest the exact
5205 value of "x / b" (if two integers are equally near then the even one
Guido van Rossumd8faa362007-04-27 19:54:29 +00005206 is chosen). If the result is equal to 0 then its sign will be the
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005207 sign of a.
5208
5209 This operation will fail under the same conditions as integer division
5210 (that is, if integer division on the same two operands would fail, the
5211 remainder cannot be calculated).
5212
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005213 >>> ExtendedContext.remainder_near(Decimal('2.1'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005214 Decimal('-0.9')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005215 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('6'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005216 Decimal('-2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005217 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005218 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005219 >>> ExtendedContext.remainder_near(Decimal('-10'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005220 Decimal('-1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005221 >>> ExtendedContext.remainder_near(Decimal('10.2'), Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005222 Decimal('0.2')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005223 >>> ExtendedContext.remainder_near(Decimal('10'), Decimal('0.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005224 Decimal('0.1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005225 >>> ExtendedContext.remainder_near(Decimal('3.6'), Decimal('1.3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005226 Decimal('-0.3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005227 >>> ExtendedContext.remainder_near(3, 11)
5228 Decimal('3')
5229 >>> ExtendedContext.remainder_near(Decimal(3), 11)
5230 Decimal('3')
5231 >>> ExtendedContext.remainder_near(3, Decimal(11))
5232 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005233 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005234 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005235 return a.remainder_near(b, context=self)
5236
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005237 def rotate(self, a, b):
5238 """Returns a rotated copy of a, b times.
5239
5240 The coefficient of the result is a rotated copy of the digits in
5241 the coefficient of the first operand. The number of places of
5242 rotation is taken from the absolute value of the second operand,
5243 with the rotation being to the left if the second operand is
5244 positive or to the right otherwise.
5245
5246 >>> ExtendedContext.rotate(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005247 Decimal('400000003')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005248 >>> ExtendedContext.rotate(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005249 Decimal('12')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005250 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005251 Decimal('891234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005252 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005253 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005254 >>> ExtendedContext.rotate(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005255 Decimal('345678912')
Mark Dickinson84230a12010-02-18 14:49:50 +00005256 >>> ExtendedContext.rotate(1333333, 1)
5257 Decimal('13333330')
5258 >>> ExtendedContext.rotate(Decimal(1333333), 1)
5259 Decimal('13333330')
5260 >>> ExtendedContext.rotate(1333333, Decimal(1))
5261 Decimal('13333330')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005262 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005263 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005264 return a.rotate(b, context=self)
5265
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005266 def same_quantum(self, a, b):
5267 """Returns True if the two operands have the same exponent.
5268
5269 The result is never affected by either the sign or the coefficient of
5270 either operand.
5271
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005272 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.001'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005273 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005274 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('0.01'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005275 True
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005276 >>> ExtendedContext.same_quantum(Decimal('2.17'), Decimal('1'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005277 False
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005278 >>> ExtendedContext.same_quantum(Decimal('Inf'), Decimal('-Inf'))
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005279 True
Mark Dickinson84230a12010-02-18 14:49:50 +00005280 >>> ExtendedContext.same_quantum(10000, -1)
5281 True
5282 >>> ExtendedContext.same_quantum(Decimal(10000), -1)
5283 True
5284 >>> ExtendedContext.same_quantum(10000, Decimal(-1))
5285 True
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005286 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005287 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005288 return a.same_quantum(b)
5289
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005290 def scaleb (self, a, b):
5291 """Returns the first operand after adding the second value its exp.
5292
5293 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005294 Decimal('0.0750')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005295 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005296 Decimal('7.50')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005297 >>> ExtendedContext.scaleb(Decimal('7.50'), Decimal('3'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005298 Decimal('7.50E+3')
Mark Dickinson84230a12010-02-18 14:49:50 +00005299 >>> ExtendedContext.scaleb(1, 4)
5300 Decimal('1E+4')
5301 >>> ExtendedContext.scaleb(Decimal(1), 4)
5302 Decimal('1E+4')
5303 >>> ExtendedContext.scaleb(1, Decimal(4))
5304 Decimal('1E+4')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005305 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005306 a = _convert_other(a, raiseit=True)
5307 return a.scaleb(b, context=self)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005308
5309 def shift(self, a, b):
5310 """Returns a shifted copy of a, b times.
5311
5312 The coefficient of the result is a shifted copy of the digits
5313 in the coefficient of the first operand. The number of places
5314 to shift is taken from the absolute value of the second operand,
5315 with the shift being to the left if the second operand is
5316 positive or to the right otherwise. Digits shifted into the
5317 coefficient are zeros.
5318
5319 >>> ExtendedContext.shift(Decimal('34'), Decimal('8'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005320 Decimal('400000000')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005321 >>> ExtendedContext.shift(Decimal('12'), Decimal('9'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005322 Decimal('0')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005323 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('-2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005324 Decimal('1234567')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005325 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005326 Decimal('123456789')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005327 >>> ExtendedContext.shift(Decimal('123456789'), Decimal('+2'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005328 Decimal('345678900')
Mark Dickinson84230a12010-02-18 14:49:50 +00005329 >>> ExtendedContext.shift(88888888, 2)
5330 Decimal('888888800')
5331 >>> ExtendedContext.shift(Decimal(88888888), 2)
5332 Decimal('888888800')
5333 >>> ExtendedContext.shift(88888888, Decimal(2))
5334 Decimal('888888800')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005335 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005336 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005337 return a.shift(b, context=self)
5338
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005339 def sqrt(self, a):
Guido van Rossumd8faa362007-04-27 19:54:29 +00005340 """Square root of a non-negative number to context precision.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005341
5342 If the result must be inexact, it is rounded using the round-half-even
5343 algorithm.
5344
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005345 >>> ExtendedContext.sqrt(Decimal('0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005346 Decimal('0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005347 >>> ExtendedContext.sqrt(Decimal('-0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005348 Decimal('-0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005349 >>> ExtendedContext.sqrt(Decimal('0.39'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005350 Decimal('0.624499800')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005351 >>> ExtendedContext.sqrt(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005352 Decimal('10')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005353 >>> ExtendedContext.sqrt(Decimal('1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005354 Decimal('1')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005355 >>> ExtendedContext.sqrt(Decimal('1.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005356 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005357 >>> ExtendedContext.sqrt(Decimal('1.00'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005358 Decimal('1.0')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005359 >>> ExtendedContext.sqrt(Decimal('7'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005360 Decimal('2.64575131')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005361 >>> ExtendedContext.sqrt(Decimal('10'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005362 Decimal('3.16227766')
Mark Dickinson84230a12010-02-18 14:49:50 +00005363 >>> ExtendedContext.sqrt(2)
5364 Decimal('1.41421356')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005365 >>> ExtendedContext.prec
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005366 9
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005367 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005368 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005369 return a.sqrt(context=self)
5370
5371 def subtract(self, a, b):
Georg Brandlf33d01d2005-08-22 19:35:18 +00005372 """Return the difference between the two operands.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005373
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005374 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005375 Decimal('0.23')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005376 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('1.30'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005377 Decimal('0.00')
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005378 >>> ExtendedContext.subtract(Decimal('1.3'), Decimal('2.07'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005379 Decimal('-0.77')
Mark Dickinson84230a12010-02-18 14:49:50 +00005380 >>> ExtendedContext.subtract(8, 5)
5381 Decimal('3')
5382 >>> ExtendedContext.subtract(Decimal(8), 5)
5383 Decimal('3')
5384 >>> ExtendedContext.subtract(8, Decimal(5))
5385 Decimal('3')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005386 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005387 a = _convert_other(a, raiseit=True)
5388 r = a.__sub__(b, context=self)
5389 if r is NotImplemented:
5390 raise TypeError("Unable to convert %s to Decimal" % b)
5391 else:
5392 return r
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005393
5394 def to_eng_string(self, a):
5395 """Converts a number to a string, using scientific notation.
5396
5397 The operation is not affected by the context.
5398 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005399 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005400 return a.to_eng_string(context=self)
5401
5402 def to_sci_string(self, a):
5403 """Converts a number to a string, using scientific notation.
5404
5405 The operation is not affected by the context.
5406 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005407 a = _convert_other(a, raiseit=True)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005408 return a.__str__(context=self)
5409
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005410 def to_integral_exact(self, a):
5411 """Rounds to an integer.
5412
5413 When the operand has a negative exponent, the result is the same
5414 as using the quantize() operation using the given operand as the
5415 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5416 of the operand as the precision setting; Inexact and Rounded flags
5417 are allowed in this operation. The rounding mode is taken from the
5418 context.
5419
5420 >>> ExtendedContext.to_integral_exact(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005421 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005422 >>> ExtendedContext.to_integral_exact(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005423 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005424 >>> ExtendedContext.to_integral_exact(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005425 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005426 >>> ExtendedContext.to_integral_exact(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005427 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005428 >>> ExtendedContext.to_integral_exact(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005429 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005430 >>> ExtendedContext.to_integral_exact(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005431 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005432 >>> ExtendedContext.to_integral_exact(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005433 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005434 >>> ExtendedContext.to_integral_exact(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005435 Decimal('-Infinity')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005436 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005437 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005438 return a.to_integral_exact(context=self)
5439
5440 def to_integral_value(self, a):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005441 """Rounds to an integer.
5442
5443 When the operand has a negative exponent, the result is the same
5444 as using the quantize() operation using the given operand as the
5445 left-hand-operand, 1E+0 as the right-hand-operand, and the precision
5446 of the operand as the precision setting, except that no flags will
Guido van Rossumd8faa362007-04-27 19:54:29 +00005447 be set. The rounding mode is taken from the context.
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005448
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005449 >>> ExtendedContext.to_integral_value(Decimal('2.1'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005450 Decimal('2')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005451 >>> ExtendedContext.to_integral_value(Decimal('100'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005452 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005453 >>> ExtendedContext.to_integral_value(Decimal('100.0'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005454 Decimal('100')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005455 >>> ExtendedContext.to_integral_value(Decimal('101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005456 Decimal('102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005457 >>> ExtendedContext.to_integral_value(Decimal('-101.5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005458 Decimal('-102')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005459 >>> ExtendedContext.to_integral_value(Decimal('10E+5'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005460 Decimal('1.0E+6')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005461 >>> ExtendedContext.to_integral_value(Decimal('7.89E+77'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005462 Decimal('7.89E+77')
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005463 >>> ExtendedContext.to_integral_value(Decimal('-Inf'))
Christian Heimes68f5fbe2008-02-14 08:27:37 +00005464 Decimal('-Infinity')
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005465 """
Mark Dickinson84230a12010-02-18 14:49:50 +00005466 a = _convert_other(a, raiseit=True)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005467 return a.to_integral_value(context=self)
5468
5469 # the method name changed, but we provide also the old one, for compatibility
5470 to_integral = to_integral_value
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005471
5472class _WorkRep(object):
5473 __slots__ = ('sign','int','exp')
Raymond Hettinger17931de2004-10-27 06:21:46 +00005474 # sign: 0 or 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005475 # int: int
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005476 # exp: None, int, or string
5477
5478 def __init__(self, value=None):
5479 if value is None:
5480 self.sign = None
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005481 self.int = 0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005482 self.exp = None
Raymond Hettinger17931de2004-10-27 06:21:46 +00005483 elif isinstance(value, Decimal):
5484 self.sign = value._sign
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005485 self.int = int(value._int)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005486 self.exp = value._exp
Raymond Hettinger17931de2004-10-27 06:21:46 +00005487 else:
5488 # assert isinstance(value, tuple)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005489 self.sign = value[0]
5490 self.int = value[1]
5491 self.exp = value[2]
5492
5493 def __repr__(self):
5494 return "(%r, %r, %r)" % (self.sign, self.int, self.exp)
5495
5496 __str__ = __repr__
5497
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005498
5499
Christian Heimes2c181612007-12-17 20:04:13 +00005500def _normalize(op1, op2, prec = 0):
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005501 """Normalizes op1, op2 to have the same exp and length of coefficient.
5502
5503 Done during addition.
5504 """
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005505 if op1.exp < op2.exp:
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005506 tmp = op2
5507 other = op1
5508 else:
5509 tmp = op1
5510 other = op2
5511
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005512 # Let exp = min(tmp.exp - 1, tmp.adjusted() - precision - 1).
5513 # Then adding 10**exp to tmp has the same effect (after rounding)
5514 # as adding any positive quantity smaller than 10**exp; similarly
5515 # for subtraction. So if other is smaller than 10**exp we replace
5516 # it with 10**exp. This avoids tmp.exp - other.exp getting too large.
Christian Heimes2c181612007-12-17 20:04:13 +00005517 tmp_len = len(str(tmp.int))
5518 other_len = len(str(other.int))
5519 exp = tmp.exp + min(-1, tmp_len - prec - 2)
5520 if other_len + other.exp - 1 < exp:
5521 other.int = 1
5522 other.exp = exp
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005523
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005524 tmp.int *= 10 ** (tmp.exp - other.exp)
5525 tmp.exp = other.exp
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005526 return op1, op2
5527
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005528##### Integer arithmetic functions used by ln, log10, exp and __pow__ #####
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005529
Raymond Hettingerdb213a22010-11-27 08:09:40 +00005530_nbits = int.bit_length
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005531
Mark Dickinson7ce0fa82011-06-04 18:14:23 +01005532def _decimal_lshift_exact(n, e):
5533 """ Given integers n and e, return n * 10**e if it's an integer, else None.
5534
5535 The computation is designed to avoid computing large powers of 10
5536 unnecessarily.
5537
5538 >>> _decimal_lshift_exact(3, 4)
5539 30000
5540 >>> _decimal_lshift_exact(300, -999999999) # returns None
5541
5542 """
5543 if n == 0:
5544 return 0
5545 elif e >= 0:
5546 return n * 10**e
5547 else:
5548 # val_n = largest power of 10 dividing n.
5549 str_n = str(abs(n))
5550 val_n = len(str_n) - len(str_n.rstrip('0'))
5551 return None if val_n < -e else n // 10**-e
5552
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005553def _sqrt_nearest(n, a):
5554 """Closest integer to the square root of the positive integer n. a is
5555 an initial approximation to the square root. Any positive integer
5556 will do for a, but the closer a is to the square root of n the
5557 faster convergence will be.
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005558
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005559 """
5560 if n <= 0 or a <= 0:
5561 raise ValueError("Both arguments to _sqrt_nearest should be positive.")
5562
5563 b=0
5564 while a != b:
5565 b, a = a, a--n//a>>1
5566 return a
5567
5568def _rshift_nearest(x, shift):
5569 """Given an integer x and a nonnegative integer shift, return closest
5570 integer to x / 2**shift; use round-to-even in case of a tie.
5571
5572 """
5573 b, q = 1 << shift, x >> shift
5574 return q + (2*(x & (b-1)) + (q&1) > b)
5575
5576def _div_nearest(a, b):
5577 """Closest integer to a/b, a and b positive integers; rounds to even
5578 in the case of a tie.
5579
5580 """
5581 q, r = divmod(a, b)
5582 return q + (2*r + (q&1) > b)
5583
5584def _ilog(x, M, L = 8):
5585 """Integer approximation to M*log(x/M), with absolute error boundable
5586 in terms only of x/M.
5587
5588 Given positive integers x and M, return an integer approximation to
5589 M * log(x/M). For L = 8 and 0.1 <= x/M <= 10 the difference
5590 between the approximation and the exact result is at most 22. For
5591 L = 8 and 1.0 <= x/M <= 10.0 the difference is at most 15. In
5592 both cases these are upper bounds on the error; it will usually be
5593 much smaller."""
5594
5595 # The basic algorithm is the following: let log1p be the function
5596 # log1p(x) = log(1+x). Then log(x/M) = log1p((x-M)/M). We use
5597 # the reduction
5598 #
5599 # log1p(y) = 2*log1p(y/(1+sqrt(1+y)))
5600 #
5601 # repeatedly until the argument to log1p is small (< 2**-L in
5602 # absolute value). For small y we can use the Taylor series
5603 # expansion
5604 #
5605 # log1p(y) ~ y - y**2/2 + y**3/3 - ... - (-y)**T/T
5606 #
5607 # truncating at T such that y**T is small enough. The whole
5608 # computation is carried out in a form of fixed-point arithmetic,
5609 # with a real number z being represented by an integer
5610 # approximation to z*M. To avoid loss of precision, the y below
5611 # is actually an integer approximation to 2**R*y*M, where R is the
5612 # number of reductions performed so far.
5613
5614 y = x-M
5615 # argument reduction; R = number of reductions performed
5616 R = 0
5617 while (R <= L and abs(y) << L-R >= M or
5618 R > L and abs(y) >> R-L >= M):
5619 y = _div_nearest((M*y) << 1,
5620 M + _sqrt_nearest(M*(M+_rshift_nearest(y, R)), M))
5621 R += 1
5622
5623 # Taylor series with T terms
5624 T = -int(-10*len(str(M))//(3*L))
5625 yshift = _rshift_nearest(y, R)
5626 w = _div_nearest(M, T)
5627 for k in range(T-1, 0, -1):
5628 w = _div_nearest(M, k) - _div_nearest(yshift*w, M)
5629
5630 return _div_nearest(w*y, M)
5631
5632def _dlog10(c, e, p):
5633 """Given integers c, e and p with c > 0, p >= 0, compute an integer
5634 approximation to 10**p * log10(c*10**e), with an absolute error of
5635 at most 1. Assumes that c*10**e is not exactly 1."""
5636
5637 # increase precision by 2; compensate for this by dividing
5638 # final result by 100
5639 p += 2
5640
5641 # write c*10**e as d*10**f with either:
5642 # f >= 0 and 1 <= d <= 10, or
5643 # f <= 0 and 0.1 <= d <= 1.
5644 # Thus for c*10**e close to 1, f = 0
5645 l = len(str(c))
5646 f = e+l - (e+l >= 1)
5647
5648 if p > 0:
5649 M = 10**p
5650 k = e+p-f
5651 if k >= 0:
5652 c *= 10**k
5653 else:
5654 c = _div_nearest(c, 10**-k)
5655
5656 log_d = _ilog(c, M) # error < 5 + 22 = 27
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005657 log_10 = _log10_digits(p) # error < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005658 log_d = _div_nearest(log_d*M, log_10)
5659 log_tenpower = f*M # exact
5660 else:
5661 log_d = 0 # error < 2.31
Neal Norwitz2f99b242008-08-24 05:48:10 +00005662 log_tenpower = _div_nearest(f, 10**-p) # error < 0.5
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005663
5664 return _div_nearest(log_tenpower+log_d, 100)
5665
5666def _dlog(c, e, p):
5667 """Given integers c, e and p with c > 0, compute an integer
5668 approximation to 10**p * log(c*10**e), with an absolute error of
5669 at most 1. Assumes that c*10**e is not exactly 1."""
5670
5671 # Increase precision by 2. The precision increase is compensated
5672 # for at the end with a division by 100.
5673 p += 2
5674
5675 # rewrite c*10**e as d*10**f with either f >= 0 and 1 <= d <= 10,
5676 # or f <= 0 and 0.1 <= d <= 1. Then we can compute 10**p * log(c*10**e)
5677 # as 10**p * log(d) + 10**p*f * log(10).
5678 l = len(str(c))
5679 f = e+l - (e+l >= 1)
5680
5681 # compute approximation to 10**p*log(d), with error < 27
5682 if p > 0:
5683 k = e+p-f
5684 if k >= 0:
5685 c *= 10**k
5686 else:
5687 c = _div_nearest(c, 10**-k) # error of <= 0.5 in c
5688
5689 # _ilog magnifies existing error in c by a factor of at most 10
5690 log_d = _ilog(c, 10**p) # error < 5 + 22 = 27
5691 else:
5692 # p <= 0: just approximate the whole thing by 0; error < 2.31
5693 log_d = 0
5694
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005695 # compute approximation to f*10**p*log(10), with error < 11.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005696 if f:
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005697 extra = len(str(abs(f)))-1
5698 if p + extra >= 0:
5699 # error in f * _log10_digits(p+extra) < |f| * 1 = |f|
5700 # after division, error < |f|/10**extra + 0.5 < 10 + 0.5 < 11
5701 f_log_ten = _div_nearest(f*_log10_digits(p+extra), 10**extra)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005702 else:
5703 f_log_ten = 0
5704 else:
5705 f_log_ten = 0
5706
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005707 # error in sum < 11+27 = 38; error after division < 0.38 + 0.5 < 1
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005708 return _div_nearest(f_log_ten + log_d, 100)
5709
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005710class _Log10Memoize(object):
5711 """Class to compute, store, and allow retrieval of, digits of the
5712 constant log(10) = 2.302585.... This constant is needed by
5713 Decimal.ln, Decimal.log10, Decimal.exp and Decimal.__pow__."""
5714 def __init__(self):
5715 self.digits = "23025850929940456840179914546843642076011014886"
5716
5717 def getdigits(self, p):
5718 """Given an integer p >= 0, return floor(10**p)*log(10).
5719
5720 For example, self.getdigits(3) returns 2302.
5721 """
5722 # digits are stored as a string, for quick conversion to
5723 # integer in the case that we've already computed enough
5724 # digits; the stored digits should always be correct
5725 # (truncated, not rounded to nearest).
5726 if p < 0:
5727 raise ValueError("p should be nonnegative")
5728
5729 if p >= len(self.digits):
5730 # compute p+3, p+6, p+9, ... digits; continue until at
5731 # least one of the extra digits is nonzero
5732 extra = 3
5733 while True:
5734 # compute p+extra digits, correct to within 1ulp
5735 M = 10**(p+extra+2)
5736 digits = str(_div_nearest(_ilog(10*M, M), 100))
5737 if digits[-extra:] != '0'*extra:
5738 break
5739 extra += 3
5740 # keep all reliable digits so far; remove trailing zeros
5741 # and next nonzero digit
5742 self.digits = digits.rstrip('0')[:-1]
5743 return int(self.digits[:p+1])
5744
5745_log10_digits = _Log10Memoize().getdigits
5746
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005747def _iexp(x, M, L=8):
5748 """Given integers x and M, M > 0, such that x/M is small in absolute
5749 value, compute an integer approximation to M*exp(x/M). For 0 <=
5750 x/M <= 2.4, the absolute error in the result is bounded by 60 (and
5751 is usually much smaller)."""
5752
5753 # Algorithm: to compute exp(z) for a real number z, first divide z
5754 # by a suitable power R of 2 so that |z/2**R| < 2**-L. Then
5755 # compute expm1(z/2**R) = exp(z/2**R) - 1 using the usual Taylor
5756 # series
5757 #
5758 # expm1(x) = x + x**2/2! + x**3/3! + ...
5759 #
5760 # Now use the identity
5761 #
5762 # expm1(2x) = expm1(x)*(expm1(x)+2)
5763 #
5764 # R times to compute the sequence expm1(z/2**R),
5765 # expm1(z/2**(R-1)), ... , exp(z/2), exp(z).
5766
5767 # Find R such that x/2**R/M <= 2**-L
5768 R = _nbits((x<<L)//M)
5769
5770 # Taylor series. (2**L)**T > M
5771 T = -int(-10*len(str(M))//(3*L))
5772 y = _div_nearest(x, T)
5773 Mshift = M<<R
5774 for i in range(T-1, 0, -1):
5775 y = _div_nearest(x*(Mshift + y), Mshift * i)
5776
5777 # Expansion
5778 for k in range(R-1, -1, -1):
5779 Mshift = M<<(k+2)
5780 y = _div_nearest(y*(y+Mshift), Mshift)
5781
5782 return M+y
5783
5784def _dexp(c, e, p):
5785 """Compute an approximation to exp(c*10**e), with p decimal places of
5786 precision.
5787
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005788 Returns integers d, f such that:
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005789
5790 10**(p-1) <= d <= 10**p, and
5791 (d-1)*10**f < exp(c*10**e) < (d+1)*10**f
5792
5793 In other words, d*10**f is an approximation to exp(c*10**e) with p
5794 digits of precision, and with an error in d of at most 1. This is
5795 almost, but not quite, the same as the error being < 1ulp: when d
5796 = 10**(p-1) the error could be up to 10 ulp."""
5797
5798 # we'll call iexp with M = 10**(p+2), giving p+3 digits of precision
5799 p += 2
5800
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005801 # compute log(10) with extra precision = adjusted exponent of c*10**e
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005802 extra = max(0, e + len(str(c)) - 1)
5803 q = p + extra
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005804
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005805 # compute quotient c*10**e/(log(10)) = c*10**(e+q)/(log(10)*10**q),
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005806 # rounding down
5807 shift = e+q
5808 if shift >= 0:
5809 cshift = c*10**shift
5810 else:
5811 cshift = c//10**-shift
Guido van Rossum8ce8a782007-11-01 19:42:39 +00005812 quot, rem = divmod(cshift, _log10_digits(q))
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005813
5814 # reduce remainder back to original precision
5815 rem = _div_nearest(rem, 10**extra)
5816
5817 # error in result of _iexp < 120; error after division < 0.62
5818 return _div_nearest(_iexp(rem, 10**p), 1000), quot - p + 3
5819
5820def _dpower(xc, xe, yc, ye, p):
5821 """Given integers xc, xe, yc and ye representing Decimals x = xc*10**xe and
5822 y = yc*10**ye, compute x**y. Returns a pair of integers (c, e) such that:
5823
5824 10**(p-1) <= c <= 10**p, and
5825 (c-1)*10**e < x**y < (c+1)*10**e
5826
5827 in other words, c*10**e is an approximation to x**y with p digits
5828 of precision, and with an error in c of at most 1. (This is
5829 almost, but not quite, the same as the error being < 1ulp: when c
5830 == 10**(p-1) we can only guarantee error < 10ulp.)
5831
5832 We assume that: x is positive and not equal to 1, and y is nonzero.
5833 """
5834
5835 # Find b such that 10**(b-1) <= |y| <= 10**b
5836 b = len(str(abs(yc))) + ye
5837
5838 # log(x) = lxc*10**(-p-b-1), to p+b+1 places after the decimal point
5839 lxc = _dlog(xc, xe, p+b+1)
5840
5841 # compute product y*log(x) = yc*lxc*10**(-p-b-1+ye) = pc*10**(-p-1)
5842 shift = ye-b
5843 if shift >= 0:
5844 pc = lxc*yc*10**shift
5845 else:
5846 pc = _div_nearest(lxc*yc, 10**-shift)
5847
5848 if pc == 0:
5849 # we prefer a result that isn't exactly 1; this makes it
5850 # easier to compute a correctly rounded result in __pow__
5851 if ((len(str(xc)) + xe >= 1) == (yc > 0)): # if x**y > 1:
5852 coeff, exp = 10**(p-1)+1, 1-p
5853 else:
5854 coeff, exp = 10**p-1, -p
5855 else:
5856 coeff, exp = _dexp(pc, -(p+1), p+1)
5857 coeff = _div_nearest(coeff, 10)
5858 exp += 1
5859
5860 return coeff, exp
5861
5862def _log10_lb(c, correction = {
5863 '1': 100, '2': 70, '3': 53, '4': 40, '5': 31,
5864 '6': 23, '7': 16, '8': 10, '9': 5}):
5865 """Compute a lower bound for 100*log10(c) for a positive integer c."""
5866 if c <= 0:
5867 raise ValueError("The argument to _log10_lb should be nonnegative.")
5868 str_c = str(c)
5869 return 100*len(str_c) - correction[str_c[0]]
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005870
Guido van Rossumd8faa362007-04-27 19:54:29 +00005871##### Helper Functions ####################################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005872
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005873def _convert_other(other, raiseit=False, allow_float=False):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005874 """Convert other to Decimal.
5875
5876 Verifies that it's ok to use in an implicit construction.
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005877 If allow_float is true, allow conversion from float; this
5878 is used in the comparison methods (__eq__ and friends).
5879
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005880 """
5881 if isinstance(other, Decimal):
5882 return other
Walter Dörwaldaa97f042007-05-03 21:05:51 +00005883 if isinstance(other, int):
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005884 return Decimal(other)
Mark Dickinsonac256ab2010-04-03 11:08:14 +00005885 if allow_float and isinstance(other, float):
5886 return Decimal.from_float(other)
5887
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005888 if raiseit:
5889 raise TypeError("Unable to convert %s to Decimal" % other)
Raymond Hettinger267b8682005-03-27 10:47:39 +00005890 return NotImplemented
Raymond Hettinger636a6b12004-09-19 01:54:09 +00005891
Mark Dickinson08ade6f2010-06-11 10:44:52 +00005892def _convert_for_comparison(self, other, equality_op=False):
5893 """Given a Decimal instance self and a Python object other, return
Mark Dickinson1c164a62010-06-11 16:49:20 +00005894 a pair (s, o) of Decimal instances such that "s op o" is
Mark Dickinson08ade6f2010-06-11 10:44:52 +00005895 equivalent to "self op other" for any of the 6 comparison
5896 operators "op".
5897
5898 """
5899 if isinstance(other, Decimal):
5900 return self, other
5901
5902 # Comparison with a Rational instance (also includes integers):
5903 # self op n/d <=> self*d op n (for n and d integers, d positive).
5904 # A NaN or infinity can be left unchanged without affecting the
5905 # comparison result.
5906 if isinstance(other, _numbers.Rational):
5907 if not self._is_special:
5908 self = _dec_from_triple(self._sign,
5909 str(int(self._int) * other.denominator),
5910 self._exp)
5911 return self, Decimal(other.numerator)
5912
5913 # Comparisons with float and complex types. == and != comparisons
5914 # with complex numbers should succeed, returning either True or False
5915 # as appropriate. Other comparisons return NotImplemented.
5916 if equality_op and isinstance(other, _numbers.Complex) and other.imag == 0:
5917 other = other.real
5918 if isinstance(other, float):
5919 return self, Decimal.from_float(other)
5920 return NotImplemented, NotImplemented
5921
5922
Guido van Rossumd8faa362007-04-27 19:54:29 +00005923##### Setup Specific Contexts ############################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005924
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005925# The default context prototype used by Context()
Raymond Hettingerfed52962004-07-14 15:41:57 +00005926# Is mutable, so that new contexts can have different default values
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005927
5928DefaultContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005929 prec=28, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005930 traps=[DivisionByZero, Overflow, InvalidOperation],
5931 flags=[],
Raymond Hettinger99148e72004-07-14 19:56:56 +00005932 Emax=999999999,
5933 Emin=-999999999,
Mark Dickinsonb1d8e322010-05-22 18:35:36 +00005934 capitals=1,
5935 clamp=0
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005936)
5937
5938# Pre-made alternate contexts offered by the specification
5939# Don't change these; the user should be able to select these
5940# contexts and be able to reproduce results from other implementations
5941# of the spec.
5942
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005943BasicContext = Context(
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005944 prec=9, rounding=ROUND_HALF_UP,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005945 traps=[DivisionByZero, Overflow, InvalidOperation, Clamped, Underflow],
5946 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005947)
5948
Raymond Hettinger9ec3e3b2004-07-03 13:48:56 +00005949ExtendedContext = Context(
Raymond Hettinger6ea48452004-07-03 12:26:21 +00005950 prec=9, rounding=ROUND_HALF_EVEN,
Raymond Hettingerbf440692004-07-10 14:14:37 +00005951 traps=[],
5952 flags=[],
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00005953)
5954
5955
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005956##### crud for parsing strings #############################################
Christian Heimes23daade02008-02-25 12:39:23 +00005957#
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005958# Regular expression used for parsing numeric strings. Additional
5959# comments:
5960#
5961# 1. Uncomment the two '\s*' lines to allow leading and/or trailing
5962# whitespace. But note that the specification disallows whitespace in
5963# a numeric string.
5964#
5965# 2. For finite numbers (not infinities and NaNs) the body of the
5966# number between the optional sign and the optional exponent must have
5967# at least one decimal digit, possibly after the decimal point. The
Mark Dickinson345adc42009-08-02 10:14:23 +00005968# lookahead expression '(?=\d|\.\d)' checks this.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005969
5970import re
Benjamin Peterson41181742008-07-02 20:22:54 +00005971_parser = re.compile(r""" # A numeric string consists of:
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005972# \s*
Benjamin Peterson41181742008-07-02 20:22:54 +00005973 (?P<sign>[-+])? # an optional sign, followed by either...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005974 (
Mark Dickinson345adc42009-08-02 10:14:23 +00005975 (?=\d|\.\d) # ...a number (with at least one digit)
5976 (?P<int>\d*) # having a (possibly empty) integer part
5977 (\.(?P<frac>\d*))? # followed by an optional fractional part
5978 (E(?P<exp>[-+]?\d+))? # followed by an optional exponent, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005979 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005980 Inf(inity)? # ...an infinity, or...
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005981 |
Benjamin Peterson41181742008-07-02 20:22:54 +00005982 (?P<signal>s)? # ...an (optionally signaling)
5983 NaN # NaN
Mark Dickinson345adc42009-08-02 10:14:23 +00005984 (?P<diag>\d*) # with (possibly empty) diagnostic info.
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005985 )
5986# \s*
Christian Heimesa62da1d2008-01-12 19:39:10 +00005987 \Z
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00005988""", re.VERBOSE | re.IGNORECASE).match
5989
Christian Heimescbf3b5c2007-12-03 21:02:03 +00005990_all_zeros = re.compile('0*$').match
5991_exact_half = re.compile('50*$').match
Christian Heimesf16baeb2008-02-29 14:57:44 +00005992
5993##### PEP3101 support functions ##############################################
Mark Dickinson79f52032009-03-17 23:12:51 +00005994# The functions in this section have little to do with the Decimal
5995# class, and could potentially be reused or adapted for other pure
Christian Heimesf16baeb2008-02-29 14:57:44 +00005996# Python numeric classes that want to implement __format__
5997#
5998# A format specifier for Decimal looks like:
5999#
Eric Smith984bb582010-11-25 16:08:06 +00006000# [[fill]align][sign][#][0][minimumwidth][,][.precision][type]
Christian Heimesf16baeb2008-02-29 14:57:44 +00006001
6002_parse_format_specifier_regex = re.compile(r"""\A
6003(?:
6004 (?P<fill>.)?
6005 (?P<align>[<>=^])
6006)?
6007(?P<sign>[-+ ])?
Eric Smith984bb582010-11-25 16:08:06 +00006008(?P<alt>\#)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00006009(?P<zeropad>0)?
6010(?P<minimumwidth>(?!0)\d+)?
Mark Dickinson79f52032009-03-17 23:12:51 +00006011(?P<thousands_sep>,)?
Christian Heimesf16baeb2008-02-29 14:57:44 +00006012(?:\.(?P<precision>0|(?!0)\d+))?
Mark Dickinson79f52032009-03-17 23:12:51 +00006013(?P<type>[eEfFgGn%])?
Christian Heimesf16baeb2008-02-29 14:57:44 +00006014\Z
6015""", re.VERBOSE)
6016
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00006017del re
6018
Mark Dickinson79f52032009-03-17 23:12:51 +00006019# The locale module is only needed for the 'n' format specifier. The
6020# rest of the PEP 3101 code functions quite happily without it, so we
6021# don't care too much if locale isn't present.
6022try:
6023 import locale as _locale
6024except ImportError:
6025 pass
6026
6027def _parse_format_specifier(format_spec, _localeconv=None):
Christian Heimesf16baeb2008-02-29 14:57:44 +00006028 """Parse and validate a format specifier.
6029
6030 Turns a standard numeric format specifier into a dict, with the
6031 following entries:
6032
6033 fill: fill character to pad field to minimum width
6034 align: alignment type, either '<', '>', '=' or '^'
6035 sign: either '+', '-' or ' '
6036 minimumwidth: nonnegative integer giving minimum width
Mark Dickinson79f52032009-03-17 23:12:51 +00006037 zeropad: boolean, indicating whether to pad with zeros
6038 thousands_sep: string to use as thousands separator, or ''
6039 grouping: grouping for thousands separators, in format
6040 used by localeconv
6041 decimal_point: string to use for decimal point
Christian Heimesf16baeb2008-02-29 14:57:44 +00006042 precision: nonnegative integer giving precision, or None
6043 type: one of the characters 'eEfFgG%', or None
Christian Heimesf16baeb2008-02-29 14:57:44 +00006044
6045 """
6046 m = _parse_format_specifier_regex.match(format_spec)
6047 if m is None:
6048 raise ValueError("Invalid format specifier: " + format_spec)
6049
6050 # get the dictionary
6051 format_dict = m.groupdict()
6052
Mark Dickinson79f52032009-03-17 23:12:51 +00006053 # zeropad; defaults for fill and alignment. If zero padding
6054 # is requested, the fill and align fields should be absent.
Christian Heimesf16baeb2008-02-29 14:57:44 +00006055 fill = format_dict['fill']
6056 align = format_dict['align']
Mark Dickinson79f52032009-03-17 23:12:51 +00006057 format_dict['zeropad'] = (format_dict['zeropad'] is not None)
6058 if format_dict['zeropad']:
6059 if fill is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006060 raise ValueError("Fill character conflicts with '0'"
6061 " in format specifier: " + format_spec)
Mark Dickinson79f52032009-03-17 23:12:51 +00006062 if align is not None:
Christian Heimesf16baeb2008-02-29 14:57:44 +00006063 raise ValueError("Alignment conflicts with '0' in "
6064 "format specifier: " + format_spec)
Christian Heimesf16baeb2008-02-29 14:57:44 +00006065 format_dict['fill'] = fill or ' '
Mark Dickinson46ab5d02009-09-08 20:22:46 +00006066 # PEP 3101 originally specified that the default alignment should
6067 # be left; it was later agreed that right-aligned makes more sense
6068 # for numeric types. See http://bugs.python.org/issue6857.
6069 format_dict['align'] = align or '>'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006070
Mark Dickinson79f52032009-03-17 23:12:51 +00006071 # default sign handling: '-' for negative, '' for positive
Christian Heimesf16baeb2008-02-29 14:57:44 +00006072 if format_dict['sign'] is None:
6073 format_dict['sign'] = '-'
6074
Christian Heimesf16baeb2008-02-29 14:57:44 +00006075 # minimumwidth defaults to 0; precision remains None if not given
6076 format_dict['minimumwidth'] = int(format_dict['minimumwidth'] or '0')
6077 if format_dict['precision'] is not None:
6078 format_dict['precision'] = int(format_dict['precision'])
6079
6080 # if format type is 'g' or 'G' then a precision of 0 makes little
6081 # sense; convert it to 1. Same if format type is unspecified.
6082 if format_dict['precision'] == 0:
Mark Dickinson7718d2b2009-09-07 16:21:56 +00006083 if format_dict['type'] is None or format_dict['type'] in 'gG':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006084 format_dict['precision'] = 1
6085
Mark Dickinson79f52032009-03-17 23:12:51 +00006086 # determine thousands separator, grouping, and decimal separator, and
6087 # add appropriate entries to format_dict
6088 if format_dict['type'] == 'n':
6089 # apart from separators, 'n' behaves just like 'g'
6090 format_dict['type'] = 'g'
6091 if _localeconv is None:
6092 _localeconv = _locale.localeconv()
6093 if format_dict['thousands_sep'] is not None:
6094 raise ValueError("Explicit thousands separator conflicts with "
6095 "'n' type in format specifier: " + format_spec)
6096 format_dict['thousands_sep'] = _localeconv['thousands_sep']
6097 format_dict['grouping'] = _localeconv['grouping']
6098 format_dict['decimal_point'] = _localeconv['decimal_point']
6099 else:
6100 if format_dict['thousands_sep'] is None:
6101 format_dict['thousands_sep'] = ''
6102 format_dict['grouping'] = [3, 0]
6103 format_dict['decimal_point'] = '.'
Christian Heimesf16baeb2008-02-29 14:57:44 +00006104
6105 return format_dict
6106
Mark Dickinson79f52032009-03-17 23:12:51 +00006107def _format_align(sign, body, spec):
6108 """Given an unpadded, non-aligned numeric string 'body' and sign
Ezio Melotti42da6632011-03-15 05:18:48 +02006109 string 'sign', add padding and alignment conforming to the given
Mark Dickinson79f52032009-03-17 23:12:51 +00006110 format specifier dictionary 'spec' (as produced by
6111 parse_format_specifier).
Christian Heimesf16baeb2008-02-29 14:57:44 +00006112
6113 """
Christian Heimesf16baeb2008-02-29 14:57:44 +00006114 # how much extra space do we have to play with?
Mark Dickinson79f52032009-03-17 23:12:51 +00006115 minimumwidth = spec['minimumwidth']
6116 fill = spec['fill']
6117 padding = fill*(minimumwidth - len(sign) - len(body))
Christian Heimesf16baeb2008-02-29 14:57:44 +00006118
Mark Dickinson79f52032009-03-17 23:12:51 +00006119 align = spec['align']
Christian Heimesf16baeb2008-02-29 14:57:44 +00006120 if align == '<':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006121 result = sign + body + padding
Mark Dickinsonad416342009-03-17 18:10:15 +00006122 elif align == '>':
6123 result = padding + sign + body
Christian Heimesf16baeb2008-02-29 14:57:44 +00006124 elif align == '=':
6125 result = sign + padding + body
Mark Dickinson79f52032009-03-17 23:12:51 +00006126 elif align == '^':
Christian Heimesf16baeb2008-02-29 14:57:44 +00006127 half = len(padding)//2
6128 result = padding[:half] + sign + body + padding[half:]
Mark Dickinson79f52032009-03-17 23:12:51 +00006129 else:
6130 raise ValueError('Unrecognised alignment field')
Christian Heimesf16baeb2008-02-29 14:57:44 +00006131
Christian Heimesf16baeb2008-02-29 14:57:44 +00006132 return result
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +00006133
Mark Dickinson79f52032009-03-17 23:12:51 +00006134def _group_lengths(grouping):
6135 """Convert a localeconv-style grouping into a (possibly infinite)
6136 iterable of integers representing group lengths.
6137
6138 """
6139 # The result from localeconv()['grouping'], and the input to this
6140 # function, should be a list of integers in one of the
6141 # following three forms:
6142 #
6143 # (1) an empty list, or
6144 # (2) nonempty list of positive integers + [0]
6145 # (3) list of positive integers + [locale.CHAR_MAX], or
6146
6147 from itertools import chain, repeat
6148 if not grouping:
6149 return []
6150 elif grouping[-1] == 0 and len(grouping) >= 2:
6151 return chain(grouping[:-1], repeat(grouping[-2]))
6152 elif grouping[-1] == _locale.CHAR_MAX:
6153 return grouping[:-1]
6154 else:
6155 raise ValueError('unrecognised format for grouping')
6156
6157def _insert_thousands_sep(digits, spec, min_width=1):
6158 """Insert thousands separators into a digit string.
6159
6160 spec is a dictionary whose keys should include 'thousands_sep' and
6161 'grouping'; typically it's the result of parsing the format
6162 specifier using _parse_format_specifier.
6163
6164 The min_width keyword argument gives the minimum length of the
6165 result, which will be padded on the left with zeros if necessary.
6166
6167 If necessary, the zero padding adds an extra '0' on the left to
6168 avoid a leading thousands separator. For example, inserting
6169 commas every three digits in '123456', with min_width=8, gives
6170 '0,123,456', even though that has length 9.
6171
6172 """
6173
6174 sep = spec['thousands_sep']
6175 grouping = spec['grouping']
6176
6177 groups = []
6178 for l in _group_lengths(grouping):
Mark Dickinson79f52032009-03-17 23:12:51 +00006179 if l <= 0:
6180 raise ValueError("group length should be positive")
6181 # max(..., 1) forces at least 1 digit to the left of a separator
6182 l = min(max(len(digits), min_width, 1), l)
6183 groups.append('0'*(l - len(digits)) + digits[-l:])
6184 digits = digits[:-l]
6185 min_width -= l
6186 if not digits and min_width <= 0:
6187 break
Mark Dickinson7303b592009-03-18 08:25:36 +00006188 min_width -= len(sep)
Mark Dickinson79f52032009-03-17 23:12:51 +00006189 else:
6190 l = max(len(digits), min_width, 1)
6191 groups.append('0'*(l - len(digits)) + digits[-l:])
6192 return sep.join(reversed(groups))
6193
6194def _format_sign(is_negative, spec):
6195 """Determine sign character."""
6196
6197 if is_negative:
6198 return '-'
6199 elif spec['sign'] in ' +':
6200 return spec['sign']
6201 else:
6202 return ''
6203
6204def _format_number(is_negative, intpart, fracpart, exp, spec):
6205 """Format a number, given the following data:
6206
6207 is_negative: true if the number is negative, else false
6208 intpart: string of digits that must appear before the decimal point
6209 fracpart: string of digits that must come after the point
6210 exp: exponent, as an integer
6211 spec: dictionary resulting from parsing the format specifier
6212
6213 This function uses the information in spec to:
6214 insert separators (decimal separator and thousands separators)
6215 format the sign
6216 format the exponent
6217 add trailing '%' for the '%' type
6218 zero-pad if necessary
6219 fill and align if necessary
6220 """
6221
6222 sign = _format_sign(is_negative, spec)
6223
Eric Smith984bb582010-11-25 16:08:06 +00006224 if fracpart or spec['alt']:
Mark Dickinson79f52032009-03-17 23:12:51 +00006225 fracpart = spec['decimal_point'] + fracpart
6226
6227 if exp != 0 or spec['type'] in 'eE':
6228 echar = {'E': 'E', 'e': 'e', 'G': 'E', 'g': 'e'}[spec['type']]
6229 fracpart += "{0}{1:+}".format(echar, exp)
6230 if spec['type'] == '%':
6231 fracpart += '%'
6232
6233 if spec['zeropad']:
6234 min_width = spec['minimumwidth'] - len(fracpart) - len(sign)
6235 else:
6236 min_width = 0
6237 intpart = _insert_thousands_sep(intpart, spec, min_width)
6238
6239 return _format_align(sign, intpart+fracpart, spec)
6240
6241
Guido van Rossumd8faa362007-04-27 19:54:29 +00006242##### Useful Constants (internal use only) ################################
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006243
Guido van Rossumd8faa362007-04-27 19:54:29 +00006244# Reusable defaults
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006245_Infinity = Decimal('Inf')
6246_NegativeInfinity = Decimal('-Inf')
Mark Dickinsonf9236412009-01-02 23:23:21 +00006247_NaN = Decimal('NaN')
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006248_Zero = Decimal(0)
6249_One = Decimal(1)
6250_NegativeOne = Decimal(-1)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006251
Mark Dickinson627cf6a2009-01-03 12:11:47 +00006252# _SignedInfinity[sign] is infinity w/ that sign
6253_SignedInfinity = (_Infinity, _NegativeInfinity)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006254
Mark Dickinsondc787d22010-05-23 13:33:13 +00006255# Constants related to the hash implementation; hash(x) is based
6256# on the reduction of x modulo _PyHASH_MODULUS
6257import sys
6258_PyHASH_MODULUS = sys.hash_info.modulus
6259# hash values to use for positive and negative infinities, and nans
6260_PyHASH_INF = sys.hash_info.inf
6261_PyHASH_NAN = sys.hash_info.nan
6262del sys
6263
6264# _PyHASH_10INV is the inverse of 10 modulo the prime _PyHASH_MODULUS
6265_PyHASH_10INV = pow(10, _PyHASH_MODULUS - 2, _PyHASH_MODULUS)
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006266
Raymond Hettinger7c85fa42004-07-01 11:01:35 +00006267
6268if __name__ == '__main__':
Raymond Hettinger6d7e26e2011-02-01 23:54:43 +00006269 import doctest, decimal
6270 doctest.testmod(decimal)